Skip to content

Commit

Permalink
Correct licensing
Browse files Browse the repository at this point in the history
Because I just found out that akrennmair/libmp3lame-js is licensed
under LGPL which is in conflict with the original license of the
project. The license note should reflect this.
Also add a quick note to warn about licensing conflict, and clarify the
separate worker for different output format.
  • Loading branch information
mayppong committed Nov 21, 2014
1 parent 265d3cc commit 619f362
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Recorder.js
A plugin for recording/exporting the output of Web Audio API nodes

### Quick Note
Using akrennmair/libmp3lame-js for mp3 support causes conflict in licensing (see the license section below). I'm not sure if this can be merged back to the original or not. I'm also not sure which license override which. Use at your own risk; or if you happen to be a lawyer, please explain this to me? Thanks!

## A plugin for recording/exporting the output of Web Audio API nodes

### Syntax
#### Constructor
Expand All @@ -14,7 +17,7 @@ Creates a recorder instance.
---------
#### Config

- **workerPath** - Path to recorder.js worker script. Defaults to 'js/recorderjs/recorderWorker.js'
- **workerPath** - Path to recorder.js worker script. Defaults to 'js/recorderjs/recorderWorker.js'. For the mp3 output format, you will need to use the 'recorderWorkerMP3.js'.
- **bufferLen** - The length of the buffer that the internal JavaScriptNode uses to capture the audio. Can be tweaked if experiencing performance issues. Defaults to 4096.
- **callback** - A default callback to be used with `exportAudio`.
- **type** - The type of the Blob generated by `exportAudio`. Defaults to 'audio/wav'.
Expand Down Expand Up @@ -65,12 +68,9 @@ This will set the configuration for Recorder by passing in a config object.

This method will force a download using the new anchor link *download* attribute. Filename defaults to 'output.wav'.

## License (MIT)

Copyright © 2013 Matt Diamond

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
## License

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Original mattdiamond/Recorderjs is licensed under MIT.
akrennmair/libmp3lame-js is licensed under the same license as LAME which is LGPL.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
I'm not sure how this will all works since I don't have a law degree. I wish it's just all WTFPL2.

0 comments on commit 619f362

Please sign in to comment.