From b46a12d049889d980c4a05643ea78067a8eab748 Mon Sep 17 00:00:00 2001 From: MayP Date: Thu, 20 Nov 2014 21:34:03 -0800 Subject: [PATCH] Correct licensing 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. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 77be1db0..01f0c5c5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ ## 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! + + ### Syntax #### Constructor var rec = new Recorder(source [, config]) @@ -14,7 +18,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'. @@ -65,12 +69,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. \ No newline at end of file +I'm not sure how this will all works since I don't have a law degree. I wish it's just all WTFPL2. \ No newline at end of file