├── .gitignore ├── .npmignore ├── test ├── test.webm ├── test-frame1.jpg ├── test-frame2.jpg ├── README.md ├── bench.js └── test.js ├── .github └── FUNDING.yml ├── package.json ├── .gitmodules ├── LICENSE.MP4 ├── LICENSE.WEBM ├── README.md ├── Makefile ├── COPYING.GPLv2 └── COPYING.LGPLv2.1 /.gitignore: -------------------------------------------------------------------------------- 1 | /node_modules/ 2 | /ffmpeg*.js 3 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | /.npmignore 2 | /.gitmodules 3 | /Makefile 4 | /build/ 5 | /test/ 6 | -------------------------------------------------------------------------------- /test/test.webm: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nasa8x/ffmpeg.js/master/test/test.webm -------------------------------------------------------------------------------- /test/test-frame1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nasa8x/ffmpeg.js/master/test/test-frame1.jpg -------------------------------------------------------------------------------- /test/test-frame2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nasa8x/ffmpeg.js/master/test/test-frame2.jpg -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | custom: https://www.blockchain.com/btc/payment_request?address=3LKKbbi34MHYRQSLV3ZiDGoKgUmCjhTumT&message=Kagami+open+source+projects+support 2 | -------------------------------------------------------------------------------- /test/README.md: -------------------------------------------------------------------------------- 1 | test.webm is part of Elephants Dream movie. 2 | 3 | ``` 4 | (c) copyright 2006, Blender Foundation / Netherlands Media Art Institute / www.elephantsdream.org 5 | ``` 6 | -------------------------------------------------------------------------------- /test/bench.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | // Do simple benchmark. 4 | // Usage: `node bench.js [test.mkv]' 5 | 6 | var fs = require("fs"); 7 | var path = require("path"); 8 | var ffmpeg = require("../ffmpeg-webm"); 9 | 10 | var testDataName = path.basename(process.argv[2] || "test.webm"); 11 | var testDataPath = process.argv[2] || path.join(__dirname, "test.webm"); 12 | var testData = new Uint8Array(fs.readFileSync(testDataPath)); 13 | 14 | ffmpeg({ 15 | MEMFS: [{name: testDataName, data: testData}], 16 | arguments: ["-i", testDataName, "-c:v", "libvpx", "-an", "-f", "null", "-"], 17 | stdin: function() {}, 18 | }); 19 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ffmpeg.js", 3 | "version": "3.1.9001", 4 | "description": "Port of FFmpeg with Emscripten", 5 | "main": "ffmpeg-webm.js", 6 | "scripts": { 7 | "test": "mocha test/test.js" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/Kagami/ffmpeg.js.git" 12 | }, 13 | "keywords": [ 14 | "asm.js", 15 | "emscripten", 16 | "ffmpeg", 17 | "video" 18 | ], 19 | "author": "Kagami Hiiragi", 20 | "license": "(LGPL-2.1+ OR GPL-2.0)", 21 | "bugs": { 22 | "url": "https://github.com/Kagami/ffmpeg.js/issues" 23 | }, 24 | "homepage": "https://github.com/Kagami/ffmpeg.js#readme", 25 | "devDependencies": { 26 | "chai": "*", 27 | "mocha": "*", 28 | "webworker-threads": "^0.7.8" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "build/libvpx"] 2 | path = build/libvpx 3 | url = https://chromium.googlesource.com/webm/libvpx 4 | ignore = dirty 5 | [submodule "build/opus"] 6 | path = build/opus 7 | url = https://github.com/xiph/opus.git 8 | ignore = dirty 9 | [submodule "build/libass"] 10 | path = build/libass 11 | url = https://github.com/libass/libass.git 12 | ignore = dirty 13 | [submodule "build/fribidi"] 14 | path = build/fribidi 15 | url = https://github.com/behdad/fribidi.git 16 | ignore = dirty 17 | [submodule "build/lame"] 18 | path = build/lame 19 | url = https://github.com/rbrito/lame.git 20 | ignore = dirty 21 | [submodule "build/x264"] 22 | path = build/x264 23 | url = https://git.videolan.org/git/x264.git 24 | ignore = dirty 25 | [submodule "build/freetype"] 26 | path = build/freetype 27 | url = https://git.savannah.gnu.org/git/freetype/freetype2.git 28 | ignore = dirty 29 | [submodule "build/ffmpeg-webm"] 30 | path = build/ffmpeg-webm 31 | url = https://git.ffmpeg.org/ffmpeg.git 32 | ignore = dirty 33 | [submodule "build/ffmpeg-mp4"] 34 | path = build/ffmpeg-mp4 35 | url = https://git.ffmpeg.org/ffmpeg.git 36 | ignore = dirty 37 | -------------------------------------------------------------------------------- /LICENSE.MP4: -------------------------------------------------------------------------------- 1 | This software uses code of FFmpeg licensed under 2 | the GPLv2 3 | and its source can be downloaded here . 4 | 5 | ============================================================================== 6 | 7 | This software uses code of LAME licensed under 8 | the LGPLv2.1 9 | and its source can be downloaded here . 10 | 11 | ============================================================================== 12 | 13 | This software uses code of x264 licensed under the GPLv2 14 | and its source can be 15 | downloaded here . 16 | 17 | ============================================================================== 18 | 19 | ffmpeg.js - Port of FFmpeg with Emscripten 20 | Copyright (C) 2015 Kagami Hiiragi 21 | 22 | This library is free software; you can redistribute it and/or 23 | modify it under the terms of the GNU Lesser General Public 24 | License as published by the Free Software Foundation; either 25 | version 2.1 of the License, or (at your option) any later version. 26 | 27 | This library is distributed in the hope that it will be useful, 28 | but WITHOUT ANY WARRANTY; without even the implied warranty of 29 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 30 | Lesser General Public License for more details. 31 | 32 | You should have received a copy of the GNU Lesser General Public 33 | License along with this library; if not, write to the Free Software 34 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 35 | -------------------------------------------------------------------------------- /LICENSE.WEBM: -------------------------------------------------------------------------------- 1 | This software uses code of FFmpeg licensed under 2 | the LGPLv2.1 3 | and its source can be downloaded here . 4 | 5 | ============================================================================== 6 | 7 | Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, 8 | Jean-Marc Valin, Timothy B. Terriberry, 9 | CSIRO, Gregory Maxwell, Mark Borgerding, 10 | Erik de Castro Lopo 11 | 12 | Redistribution and use in source and binary forms, with or without 13 | modification, are permitted provided that the following conditions 14 | are met: 15 | 16 | - Redistributions of source code must retain the above copyright 17 | notice, this list of conditions and the following disclaimer. 18 | 19 | - Redistributions in binary form must reproduce the above copyright 20 | notice, this list of conditions and the following disclaimer in the 21 | documentation and/or other materials provided with the distribution. 22 | 23 | - Neither the name of Internet Society, IETF or IETF Trust, nor the 24 | names of specific contributors, may be used to endorse or promote 25 | products derived from this software without specific prior written 26 | permission. 27 | 28 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 29 | ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 30 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 31 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 32 | OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 33 | EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 34 | PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 35 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 36 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 37 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 38 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 39 | 40 | Opus is subject to the royalty-free patent licenses which are 41 | specified at: 42 | 43 | Xiph.Org Foundation: 44 | https://datatracker.ietf.org/ipr/1524/ 45 | 46 | Microsoft Corporation: 47 | https://datatracker.ietf.org/ipr/1914/ 48 | 49 | Broadcom Corporation: 50 | https://datatracker.ietf.org/ipr/1526/ 51 | 52 | ============================================================================== 53 | 54 | This software uses code of FreeType licensed under 55 | the FreeType Project LICENSE 56 | 57 | and its source can be downloaded here . 58 | 59 | ============================================================================== 60 | 61 | This software uses code of fribidi licensed under 62 | the LGPLv2.1 63 | and its source can be downloaded here . 64 | 65 | ============================================================================== 66 | 67 | Permission to use, copy, modify, and/or distribute this software for any 68 | purpose with or without fee is hereby granted, provided that the above 69 | copyright notice and this permission notice appear in all copies. 70 | 71 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 72 | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 73 | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 74 | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 75 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 76 | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 77 | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 78 | 79 | ============================================================================== 80 | 81 | Copyright (c) 2010, The WebM Project authors. All rights reserved. 82 | 83 | Redistribution and use in source and binary forms, with or without 84 | modification, are permitted provided that the following conditions are 85 | met: 86 | 87 | * Redistributions of source code must retain the above copyright 88 | notice, this list of conditions and the following disclaimer. 89 | 90 | * Redistributions in binary form must reproduce the above copyright 91 | notice, this list of conditions and the following disclaimer in 92 | the documentation and/or other materials provided with the 93 | distribution. 94 | 95 | * Neither the name of Google, nor the WebM Project, nor the names 96 | of its contributors may be used to endorse or promote products 97 | derived from this software without specific prior written 98 | permission. 99 | 100 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 101 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 102 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 103 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 104 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 105 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 106 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 107 | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 108 | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 109 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 110 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 111 | 112 | ============================================================================== 113 | 114 | ffmpeg.js - Port of FFmpeg with Emscripten 115 | Copyright (C) 2015 Kagami Hiiragi 116 | 117 | This library is free software; you can redistribute it and/or 118 | modify it under the terms of the GNU Lesser General Public 119 | License as published by the Free Software Foundation; either 120 | version 2.1 of the License, or (at your option) any later version. 121 | 122 | This library is distributed in the hope that it will be useful, 123 | but WITHOUT ANY WARRANTY; without even the implied warranty of 124 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 125 | Lesser General Public License for more details. 126 | 127 | You should have received a copy of the GNU Lesser General Public 128 | License along with this library; if not, write to the Free Software 129 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ffmpeg.js 2 | 3 | [![NPM](https://nodei.co/npm/ffmpeg.js.png?downloads=true)](https://www.npmjs.com/package/ffmpeg.js) 4 | 5 | This library provides FFmpeg builds ported to JavaScript using [Emscripten project](https://github.com/kripken/emscripten). Builds are optimized for in-browser use: minimal size for faster loading, asm.js, performance tunings, etc. Though they work in Node as well. 6 | 7 | ## Builds 8 | 9 | Currently available builds (additional builds may be added in future): 10 | * `ffmpeg-webm.js` - WebM encoding (VP8 & Opus encoders, popular decoders). 11 | * `ffmpeg-worker-webm.js` - Web Worker version of `ffmpeg-webm.js`. 12 | * `ffmpeg-mp4.js` - MP4 encoding (H.264 & AAC & MP3 encoders, popular decoders). 13 | * `ffmpeg-worker-mp4.js` - Web Worker version of `ffmpeg-mp4.js`. 14 | 15 | Note: only NPM releases contain abovementioned files. 16 | 17 | ## Version scheme 18 | 19 | ffmpeg.js uses the following version pattern: `major.minor.9ddd`, where: 20 | * **major** - FFmpeg's major version number used in the builds. 21 | * **minor** - FFmpeg's minor version. 22 | * **ddd** - ffmpeg.js own patch version. Should not be confused with FFmpeg's patch version number. 23 | 24 | Example: `2.7.9005` 25 | 26 | ## Usage 27 | 28 | See documentation on [Module object](https://kripken.github.io/emscripten-site/docs/api_reference/module.html#affecting-execution) for the list of options that you can pass. 29 | 30 | ### Sync run 31 | 32 | ffmpeg.js provides common module API, `ffmpeg-webm.js` is the default module. Add its name after the slash if you need another build, e.g. `require("ffmpeg.js/ffmpeg-mp4.js")`. 33 | 34 | ```js 35 | var ffmpeg = require("ffmpeg.js"); 36 | var stdout = ""; 37 | var stderr = ""; 38 | // Print FFmpeg's version. 39 | ffmpeg({ 40 | arguments: ["-version"], 41 | print: function(data) { stdout += data + "\n"; }, 42 | printErr: function(data) { stderr += data + "\n"; }, 43 | onExit: function(code) { 44 | console.log("Process exited with code " + code); 45 | console.log(stdout); 46 | }, 47 | }); 48 | ``` 49 | 50 | Use e.g. [browserify](https://github.com/substack/node-browserify) in case of Browser. 51 | 52 | ### Via Web Worker 53 | 54 | ffmpeg.js also provides wrapper for main function with Web Worker interface to offload the work to a different process. Worker sends the following messages: 55 | * `{type: "ready"}` - Worker loaded and ready to accept commands. 56 | * `{type: "run"}` - Worker started the job. 57 | * `{type: "stdout", data: ""}` - FFmpeg printed to stdout. 58 | * `{type: "stderr", data: ""}` - FFmpeg printed to stderr. 59 | * `{type: "exit", data: ""}` - FFmpeg exited. 60 | * `{type: "done", data: ""}` - Job finished with some result. 61 | * `{type: "error", data: ""}` - Error occurred. 62 | 63 | You can send the following messages to the worker: 64 | * `{type: "run", ...opts}` - Start new job with provided options. 65 | 66 | ```js 67 | var stdout = ""; 68 | var stderr = ""; 69 | var worker = new Worker("ffmpeg-worker-webm.js"); 70 | worker.onmessage = function(e) { 71 | var msg = e.data; 72 | switch (msg.type) { 73 | case "ready": 74 | worker.postMessage({type: "run", arguments: ["-version"]}); 75 | break; 76 | case "stdout": 77 | stdout += msg.data + "\n"; 78 | break; 79 | case "stderr": 80 | stderr += msg.data + "\n"; 81 | break; 82 | case "exit": 83 | console.log("Process exited with code " + msg.data); 84 | console.log(stdout); 85 | worker.terminate(); 86 | break; 87 | } 88 | }; 89 | ``` 90 | 91 | This works in Browser as is, use e.g. [webworker-threads](https://github.com/audreyt/node-webworker-threads) Web Worker implementation in Node. 92 | 93 | ### Files 94 | 95 | Empscripten supports several types of [file systems](https://kripken.github.io/emscripten-site/docs/api_reference/Filesystem-API.html#file-systems). ffmpeg.js uses [MEMFS](https://kripken.github.io/emscripten-site/docs/api_reference/Filesystem-API.html#memfs) to store the input/output files in FFmpeg's working directory. You need to pass *Array* of *Object* to `MEMFS` option with the following keys: 96 | * **name** *(String)* - File name, can't contain slashes. 97 | * **data** *(ArrayBuffer/ArrayBufferView/Array)* - File data. 98 | 99 | ffmpeg.js resulting object has `MEMFS` option with the same structure and contains files which weren't passed to the input, i.e. new files created by FFmpeg. 100 | 101 | ```js 102 | var ffmpeg = require("ffmpeg.js"); 103 | var fs = require("fs"); 104 | var testData = new Uint8Array(fs.readFileSync("test.webm")); 105 | // Encode test video to VP8. 106 | var result = ffmpeg({ 107 | MEMFS: [{name: "test.webm", data: testData}], 108 | arguments: ["-i", "test.webm", "-c:v", "libvpx", "-an", "out.webm"], 109 | // Ignore stdin read requests. 110 | stdin: function() {}, 111 | }); 112 | // Write out.webm to disk. 113 | var out = result.MEMFS[0]; 114 | fs.writeFileSync(out.name, Buffer(out.data)); 115 | ``` 116 | 117 | You can also mount other FS by passing *Array* of *Object* to `mounts` option with the following keys: 118 | * **type** *(String)* - Name of the file system. 119 | * **opts** *(Object)* - Underlying file system options. 120 | * **mountpoint** *(String)* - Mount path, must start with a slash, must not contain other slashes and also the following paths are blacklisted: `/tmp`, `/home`, `/dev`, `/work`. Mount directory will be created automatically before mount. 121 | 122 | See documentation of [FS.mount](https://kripken.github.io/emscripten-site/docs/api_reference/Filesystem-API.html#FS.mount) for more details. 123 | 124 | ```js 125 | var ffmpeg = require("ffmpeg.js"); 126 | ffmpeg({ 127 | // Mount /data inside application to the current directory. 128 | mounts: [{type: "NODEFS", opts: {root: "."}, mountpoint: "/data"}], 129 | arguments: ["-i", "/data/test.webm", "-c:v", "libvpx", "-an", "/data/out.webm"], 130 | stdin: function() {}, 131 | }); 132 | // out.webm was written to the current directory. 133 | ``` 134 | 135 | ## Build instructions 136 | Tips, use a [docker](https://www.docker.com/) container (basic ubuntu is good) 137 | 138 | ```bash 139 | apt-get update 140 | apt-get -y install wget python git automake libtool build-essential cmake libglib2.0-dev closure-compiler 141 | 142 | cd /root # or /home/whatever 143 | wget https://s3.amazonaws.com/mozilla-games/emscripten/releases/emsdk-portable.tar.gz 144 | tar xzvf emsdk-portable.tar.gz 145 | cd emsdk-portable 146 | ./emsdk update 147 | ./emsdk install latest 148 | ./emsdk activate latest 149 | source ./emsdk_env.sh 150 | 151 | cd /root # or /home/whatever 152 | git clone https://github.com/Kagami/ffmpeg.js.git 153 | cd ffmpeg.js 154 | git submodule init 155 | git submodule update --recursive 156 | 157 | make all 158 | ``` 159 | 160 | ## Credits 161 | 162 | Thanks to [videoconverter.js](https://bgrins.github.io/videoconverter.js/) for inspiration. And of course to all great projects which made this library possible: FFmpeg, Emscripten, asm.js, node.js and many others. 163 | 164 | ## License 165 | 166 | Own library code licensed under LGPL 2.1 or later. 167 | 168 | ### WebM build 169 | 170 | This build uses LGPL version of FFmpeg and thus available under LGPL 2.1 or later. See [here](https://www.ffmpeg.org/legal.html) for more details and FFmpeg's license information. 171 | 172 | Included libraries: 173 | * libopus [licensed under BSD](https://git.xiph.org/?p=opus.git;a=blob;f=COPYING). 174 | * freetype [licensed under FreeType Project LICENSE](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/FTL.TXT). 175 | * fribidi [licensed under LGPL](https://github.com/behdad/fribidi/blob/master/COPYING). 176 | * libass [licensed under ISC](https://github.com/libass/libass/blob/master/COPYING). 177 | * libvpx [licensed under BSD](https://chromium.googlesource.com/webm/libvpx/+/master/LICENSE). 178 | 179 | See [LICENSE.WEBM](https://github.com/Kagami/ffmpeg.js/blob/master/LICENSE.WEBM) for the full text of software licenses used in this build. 180 | 181 | ### MP4 build 182 | 183 | This build uses GPL version of FFmpeg and thus available under GPL 2.0. It also includes patent encumbered H.264, AAC and MP3 encoders. Make sure to contact lawyer before using it in your country. 184 | 185 | Included libraries: 186 | * x264 [licensed under GPL](https://git.videolan.org/?p=x264.git;a=blob;f=COPYING). 187 | * LAME [licensed under LGPL](https://github.com/rbrito/lame/blob/origin/COPYING). 188 | 189 | See [LICENSE.MP4](https://github.com/Kagami/ffmpeg.js/blob/master/LICENSE.MP4) for the full text of software licenses used in this build. 190 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Compile FFmpeg and all its dependencies to JavaScript. 2 | # You need emsdk environment installed and activated, see: 3 | # . 4 | 5 | PRE_JS = build/pre.js 6 | POST_JS_SYNC = build/post-sync.js 7 | POST_JS_WORKER = build/post-worker.js 8 | 9 | COMMON_FILTERS = aresample scale crop overlay 10 | COMMON_DEMUXERS = matroska ogg avi mov flv mpegps image2 mp3 concat 11 | COMMON_DECODERS = \ 12 | vp8 vp9 theora \ 13 | mpeg2video mpeg4 h264 hevc \ 14 | png mjpeg \ 15 | vorbis opus \ 16 | mp3 ac3 aac \ 17 | ass ssa srt webvtt 18 | 19 | WEBM_MUXERS = webm ogg null image2 20 | WEBM_ENCODERS = libvpx_vp8 libopus mjpeg 21 | FFMPEG_WEBM_BC = build/ffmpeg-webm/ffmpeg.bc 22 | LIBASS_PC_PATH = ../freetype/dist/lib/pkgconfig:../fribidi/dist/lib/pkgconfig 23 | FFMPEG_WEBM_PC_PATH_ = \ 24 | $(LIBASS_PC_PATH):\ 25 | ../libass/dist/lib/pkgconfig:\ 26 | ../opus/dist/lib/pkgconfig 27 | FFMPEG_WEBM_PC_PATH = $(subst : ,:,$(FFMPEG_WEBM_PC_PATH_)) 28 | LIBASS_DEPS = \ 29 | build/fribidi/dist/lib/libfribidi.so \ 30 | build/freetype/dist/lib/libfreetype.so 31 | WEBM_SHARED_DEPS = \ 32 | $(LIBASS_DEPS) \ 33 | build/libass/dist/lib/libass.so \ 34 | build/opus/dist/lib/libopus.so \ 35 | build/libvpx/dist/lib/libvpx.so 36 | 37 | MP4_MUXERS = mp4 mp3 null 38 | MP4_ENCODERS = libx264 libmp3lame aac 39 | FFMPEG_MP4_BC = build/ffmpeg-mp4/ffmpeg.bc 40 | FFMPEG_MP4_PC_PATH = ../x264/dist/lib/pkgconfig 41 | MP4_SHARED_DEPS = \ 42 | build/lame/dist/lib/libmp3lame.so \ 43 | build/x264/dist/lib/libx264.so 44 | 45 | all: webm mp4 46 | webm: ffmpeg-webm.js ffmpeg-worker-webm.js 47 | mp4: ffmpeg-mp4.js ffmpeg-worker-mp4.js 48 | 49 | clean: clean-js \ 50 | clean-freetype clean-fribidi clean-libass \ 51 | clean-opus clean-libvpx clean-ffmpeg-webm \ 52 | clean-lame clean-x264 clean-ffmpeg-mp4 53 | clean-js: 54 | rm -f -- ffmpeg*.js 55 | clean-opus: 56 | -cd build/opus && rm -rf dist && make clean 57 | clean-freetype: 58 | -cd build/freetype && rm -rf dist && make clean 59 | clean-fribidi: 60 | -cd build/fribidi && rm -rf dist && make clean 61 | clean-libass: 62 | -cd build/libass && rm -rf dist && make clean 63 | clean-libvpx: 64 | -cd build/libvpx && rm -rf dist && make clean 65 | clean-lame: 66 | -cd build/lame && rm -rf dist && make clean 67 | clean-x264: 68 | -cd build/x264 && rm -rf dist && make clean 69 | clean-ffmpeg-webm: 70 | -cd build/ffmpeg-webm && rm -f ffmpeg.bc && make clean 71 | clean-ffmpeg-mp4: 72 | -cd build/ffmpeg-mp4 && rm -f ffmpeg.bc && make clean 73 | 74 | build/opus/configure: 75 | cd build/opus && ./autogen.sh 76 | 77 | build/opus/dist/lib/libopus.so: build/opus/configure 78 | cd build/opus && \ 79 | emconfigure ./configure \ 80 | CFLAGS=-O3 \ 81 | --prefix="$$(pwd)/dist" \ 82 | --disable-static \ 83 | --disable-doc \ 84 | --disable-extra-programs \ 85 | --disable-asm \ 86 | --disable-rtcd \ 87 | --disable-intrinsics \ 88 | && \ 89 | emmake make -j8 && \ 90 | emmake make install 91 | 92 | build/freetype/builds/unix/configure: 93 | cd build/freetype && ./autogen.sh 94 | 95 | # XXX(Kagami): host/build flags are used to enable cross-compiling 96 | # (values must differ) but there should be some better way to achieve 97 | # that: it probably isn't possible to build on x86 now. 98 | build/freetype/dist/lib/libfreetype.so: build/freetype/builds/unix/configure 99 | cd build/freetype && \ 100 | git reset --hard && \ 101 | patch -p1 < ../freetype-asmjs.patch && \ 102 | emconfigure ./configure \ 103 | CFLAGS="-O3" \ 104 | --prefix="$$(pwd)/dist" \ 105 | --host=x86-none-linux \ 106 | --build=x86_64 \ 107 | --disable-static \ 108 | \ 109 | --without-zlib \ 110 | --without-bzip2 \ 111 | --without-png \ 112 | --without-harfbuzz \ 113 | && \ 114 | emmake make -j8 && \ 115 | emmake make install 116 | 117 | build/fribidi/configure: 118 | cd build/fribidi && ./bootstrap 119 | 120 | build/fribidi/dist/lib/libfribidi.so: build/fribidi/configure 121 | cd build/fribidi && \ 122 | git reset --hard && \ 123 | patch -p1 < ../fribidi-make.patch && \ 124 | emconfigure ./configure \ 125 | CFLAGS=-O3 \ 126 | NM=llvm-nm \ 127 | --prefix="$$(pwd)/dist" \ 128 | --disable-dependency-tracking \ 129 | --disable-debug \ 130 | --without-glib \ 131 | && \ 132 | emmake make -j8 && \ 133 | emmake make install 134 | 135 | build/libass/configure: 136 | cd build/libass && ./autogen.sh 137 | 138 | build/libass/dist/lib/libass.so: build/libass/configure $(LIBASS_DEPS) 139 | cd build/libass && \ 140 | EM_PKG_CONFIG_PATH=$(LIBASS_PC_PATH) emconfigure ./configure \ 141 | CFLAGS="-O3" \ 142 | --prefix="$$(pwd)/dist" \ 143 | --disable-static \ 144 | --disable-enca \ 145 | --disable-fontconfig \ 146 | --disable-require-system-font-provider \ 147 | --disable-harfbuzz \ 148 | --disable-asm \ 149 | && \ 150 | emmake make -j8 && \ 151 | emmake make install 152 | 153 | build/libvpx/dist/lib/libvpx.so: 154 | cd build/libvpx && \ 155 | emconfigure ./configure \ 156 | --prefix="$$(pwd)/dist" \ 157 | --target=generic-gnu \ 158 | --disable-dependency-tracking \ 159 | --disable-multithread \ 160 | --disable-runtime-cpu-detect \ 161 | --enable-shared \ 162 | --disable-static \ 163 | \ 164 | --disable-examples \ 165 | --disable-docs \ 166 | --disable-unit-tests \ 167 | --disable-webm-io \ 168 | --disable-libyuv \ 169 | --disable-vp8-decoder \ 170 | --disable-vp9 \ 171 | && \ 172 | emmake make -j8 && \ 173 | emmake make install 174 | 175 | build/lame/dist/lib/libmp3lame.so: 176 | cd build/lame && \ 177 | git reset --hard && \ 178 | patch -p1 < ../lame-configure.patch && \ 179 | emconfigure ./configure \ 180 | --prefix="$$(pwd)/dist" \ 181 | --host=x86-none-linux \ 182 | --disable-static \ 183 | \ 184 | --disable-gtktest \ 185 | --disable-analyzer-hooks \ 186 | --disable-decoder \ 187 | --disable-frontend \ 188 | && \ 189 | emmake make -j8 && \ 190 | emmake make install 191 | 192 | build/x264/dist/lib/libx264.so: 193 | cd build/x264 && \ 194 | git reset --hard && \ 195 | patch -p1 < ../x264-configure.patch && \ 196 | emconfigure ./configure \ 197 | --prefix="$$(pwd)/dist" \ 198 | --extra-cflags="-Wno-unknown-warning-option" \ 199 | --host=x86-none-linux \ 200 | --disable-cli \ 201 | --enable-shared \ 202 | --disable-opencl \ 203 | --disable-thread \ 204 | --disable-asm \ 205 | \ 206 | --disable-avs \ 207 | --disable-swscale \ 208 | --disable-lavf \ 209 | --disable-ffms \ 210 | --disable-gpac \ 211 | --disable-lsmash \ 212 | && \ 213 | emmake make -j8 && \ 214 | emmake make install 215 | 216 | # TODO(Kagami): Emscripten documentation recommends to always use shared 217 | # libraries but it's not possible in case of ffmpeg because it has 218 | # multiple declarations of `ff_log2_tab` symbol. GCC builds FFmpeg fine 219 | # though because it uses version scripts and so `ff_log2_tag` symbols 220 | # are not exported to the shared libraries. Seems like `emcc` ignores 221 | # them. We need to file bugreport to upstream. See also: 222 | # - 223 | # - 224 | # - 225 | FFMPEG_COMMON_ARGS = \ 226 | --cc=emcc \ 227 | --enable-cross-compile \ 228 | --target-os=none \ 229 | --arch=x86 \ 230 | --disable-runtime-cpudetect \ 231 | --disable-asm \ 232 | --disable-fast-unaligned \ 233 | --disable-pthreads \ 234 | --disable-w32threads \ 235 | --disable-os2threads \ 236 | --disable-debug \ 237 | --disable-stripping \ 238 | \ 239 | --disable-all \ 240 | --enable-ffmpeg \ 241 | --enable-avcodec \ 242 | --enable-avformat \ 243 | --enable-avutil \ 244 | --enable-swresample \ 245 | --enable-swscale \ 246 | --enable-avfilter \ 247 | --disable-network \ 248 | --disable-d3d11va \ 249 | --disable-dxva2 \ 250 | --disable-vaapi \ 251 | --disable-vda \ 252 | --disable-vdpau \ 253 | $(addprefix --enable-decoder=,$(COMMON_DECODERS)) \ 254 | $(addprefix --enable-demuxer=,$(COMMON_DEMUXERS)) \ 255 | --enable-protocol=file \ 256 | $(addprefix --enable-filter=,$(COMMON_FILTERS)) \ 257 | --disable-bzlib \ 258 | --disable-iconv \ 259 | --disable-libxcb \ 260 | --disable-lzma \ 261 | --disable-sdl \ 262 | --disable-securetransport \ 263 | --disable-xlib \ 264 | --disable-zlib 265 | 266 | build/ffmpeg-webm/ffmpeg.bc: $(WEBM_SHARED_DEPS) 267 | cd build/ffmpeg-webm && \ 268 | git reset --hard && \ 269 | patch -p1 < ../ffmpeg-disable-arc4random.patch && \ 270 | patch -p1 < ../ffmpeg-default-font.patch && \ 271 | patch -p1 < ../ffmpeg-disable-monotonic.patch && \ 272 | EM_PKG_CONFIG_PATH=$(FFMPEG_WEBM_PC_PATH) emconfigure ./configure \ 273 | $(FFMPEG_COMMON_ARGS) \ 274 | $(addprefix --enable-encoder=,$(WEBM_ENCODERS)) \ 275 | $(addprefix --enable-muxer=,$(WEBM_MUXERS)) \ 276 | --enable-filter=subtitles \ 277 | --enable-libass \ 278 | --enable-libopus \ 279 | --enable-libvpx \ 280 | --extra-cflags="-I../libvpx/dist/include" \ 281 | --extra-ldflags="-L../libvpx/dist/lib" \ 282 | && \ 283 | emmake make -j8 && \ 284 | cp ffmpeg ffmpeg.bc 285 | 286 | build/ffmpeg-mp4/ffmpeg.bc: $(MP4_SHARED_DEPS) 287 | cd build/ffmpeg-mp4 && \ 288 | git reset --hard && \ 289 | patch -p1 < ../ffmpeg-disable-arc4random.patch && \ 290 | patch -p1 < ../ffmpeg-disable-monotonic.patch && \ 291 | EM_PKG_CONFIG_PATH=$(FFMPEG_MP4_PC_PATH) emconfigure ./configure \ 292 | $(FFMPEG_COMMON_ARGS) \ 293 | $(addprefix --enable-encoder=,$(MP4_ENCODERS)) \ 294 | $(addprefix --enable-muxer=,$(MP4_MUXERS)) \ 295 | --enable-gpl \ 296 | --enable-libmp3lame \ 297 | --enable-libx264 \ 298 | --extra-cflags="-I../lame/dist/include" \ 299 | --extra-ldflags="-L../lame/dist/lib" \ 300 | && \ 301 | emmake make -j8 && \ 302 | cp ffmpeg ffmpeg.bc 303 | 304 | # Compile bitcode to JavaScript. 305 | # NOTE(Kagami): Bump heap size to 64M, default 16M is not enough even 306 | # for simple tests and 32M tends to run slower than 64M. 307 | EMCC_COMMON_ARGS = \ 308 | --closure 1 \ 309 | -s TOTAL_MEMORY=67108864 \ 310 | -s OUTLINING_LIMIT=20000 \ 311 | -O3 --memory-init-file 0 \ 312 | --pre-js $(PRE_JS) \ 313 | -o $@ 314 | 315 | ffmpeg-webm.js: $(FFMPEG_WEBM_BC) $(PRE_JS) $(POST_JS_SYNC) 316 | emcc $(FFMPEG_WEBM_BC) $(WEBM_SHARED_DEPS) \ 317 | --post-js $(POST_JS_SYNC) \ 318 | $(EMCC_COMMON_ARGS) 319 | 320 | ffmpeg-worker-webm.js: $(FFMPEG_WEBM_BC) $(PRE_JS) $(POST_JS_WORKER) 321 | emcc $(FFMPEG_WEBM_BC) $(WEBM_SHARED_DEPS) \ 322 | --post-js $(POST_JS_WORKER) \ 323 | $(EMCC_COMMON_ARGS) 324 | 325 | ffmpeg-mp4.js: $(FFMPEG_MP4_BC) $(PRE_JS) $(POST_JS_SYNC) 326 | emcc $(FFMPEG_MP4_BC) $(MP4_SHARED_DEPS) \ 327 | --post-js $(POST_JS_SYNC) \ 328 | $(EMCC_COMMON_ARGS) 329 | 330 | ffmpeg-worker-mp4.js: $(FFMPEG_MP4_BC) $(PRE_JS) $(POST_JS_WORKER) 331 | emcc $(FFMPEG_MP4_BC) $(MP4_SHARED_DEPS) \ 332 | --post-js $(POST_JS_WORKER) \ 333 | $(EMCC_COMMON_ARGS) 334 | -------------------------------------------------------------------------------- /test/test.js: -------------------------------------------------------------------------------- 1 | // TODO(Kagami): In-browser tests with karma. 2 | var expect = require("chai").expect; 3 | var fs = require("fs"); 4 | var path = require("path"); 5 | var Worker = require("webworker-threads").Worker; 6 | var ffmpeg_webm = require("../ffmpeg-webm"); 7 | var ffmpeg_mp4 = require("../ffmpeg-mp4"); 8 | 9 | function noop() {} 10 | var testDataPath = path.join(__dirname, "test.webm"); 11 | var testData = new Uint8Array(fs.readFileSync(testDataPath)); 12 | // Mute uncaughtException warnings. 13 | process.setMaxListeners(30); 14 | 15 | describe("WebM", function() { 16 | this.timeout(10000); 17 | 18 | describe("Sync", function() { 19 | it("should print version to stdout", function(done) { 20 | var stdout = ""; 21 | var stderr = ""; 22 | ffmpeg_webm({ 23 | arguments: ["-version"], 24 | print: function(data) { stdout += data + "\n"; }, 25 | printErr: function(data) { stderr += data + "\n"; }, 26 | onExit: function(code) { 27 | expect(code).to.equal(0); 28 | expect(stderr).to.be.empty; 29 | expect(stdout).to.match(/^ffmpeg version /); 30 | done(); 31 | }, 32 | }); 33 | }); 34 | 35 | it("shouldn't return input files at MEMFS", function() { 36 | var res = ffmpeg_webm({ 37 | arguments: [], 38 | print: noop, 39 | printErr: noop, 40 | MEMFS: [ 41 | {name: "test.mkv", data: new Uint8Array(1)}, 42 | {name: "222.webm", data: new Uint8Array(10)}, 43 | ], 44 | }); 45 | expect(res.MEMFS).to.be.empty; 46 | }); 47 | 48 | it("should show metadata of test file at NODEFS", function() { 49 | var stderr = ""; 50 | ffmpeg_webm({ 51 | arguments: ["-i", "/data/test.webm"], 52 | print: noop, 53 | printErr: function(data) { stderr += data + "\n"; }, 54 | mounts: [{type: "NODEFS", opts: {root: "test"}, mountpoint: "/data"}], 55 | }); 56 | expect(stderr).to.match(/^Input.*matroska,webm/m); 57 | expect(stderr).to.match(/^\s+Stream.*Video: vp8/m); 58 | expect(stderr).to.match(/^\s+Stream.*Audio: vorbis/m); 59 | }); 60 | 61 | it("should encode test file to WebM/VP8 at MEMFS", function() { 62 | this.timeout(60000); 63 | var code; 64 | var res = ffmpeg_webm({ 65 | arguments: [ 66 | "-i", "test.webm", 67 | "-frames:v", "5", "-c:v", "libvpx", 68 | "-an", 69 | "out.webm", 70 | ], 71 | stdin: noop, 72 | print: noop, 73 | printErr: noop, 74 | onExit: function(v) {code = v}, 75 | MEMFS: [{name: "test.webm", data: testData}], 76 | }); 77 | expect(code).to.equal(0); 78 | expect(res.MEMFS).to.have.length(1); 79 | var file = res.MEMFS[0]; 80 | expect(file.name).to.equal("out.webm"); 81 | expect(file.data.length).to.be.above(0); 82 | expect(file.data).to.be.an.instanceof(Uint8Array); 83 | }); 84 | 85 | it("should encode test file to WebM/Opus at MEMFS", function() { 86 | this.timeout(60000); 87 | var code; 88 | var res = ffmpeg_webm({ 89 | arguments: [ 90 | "-i", "test.webm", 91 | "-vn", 92 | "-c:a", "libopus", 93 | "out.webm", 94 | ], 95 | stdin: noop, 96 | print: noop, 97 | printErr: noop, 98 | onExit: function(v) {code = v}, 99 | MEMFS: [{name: "test.webm", data: testData}], 100 | }); 101 | expect(code).to.equal(0); 102 | expect(res.MEMFS).to.have.length(1); 103 | var file = res.MEMFS[0]; 104 | expect(file.name).to.equal("out.webm"); 105 | expect(file.data.length).to.be.above(0); 106 | expect(file.data).to.be.an.instanceof(Uint8Array); 107 | }); 108 | 109 | it("should accept ArrayBuffer in MEMFS input", function() { 110 | var code; 111 | ffmpeg_webm({ 112 | arguments: [ 113 | "-i", "test.webm", 114 | "-vn", 115 | "-frames:a", "1", "-c:a", "libopus", 116 | "-f", "null", "-", 117 | ], 118 | stdin: noop, 119 | print: noop, 120 | printErr: noop, 121 | onExit: function(v) {code = v}, 122 | MEMFS: [{name: "test.webm", data: testData.buffer}], 123 | }); 124 | expect(code).to.equal(0); 125 | }); 126 | 127 | it("should accept Array in MEMFS input", function() { 128 | var data = Array.prototype.slice.call(testData); 129 | var code; 130 | ffmpeg_webm({ 131 | arguments: [ 132 | "-i", "test.webm", 133 | "-vn", 134 | "-frames:a", "1", "-c:a", "libopus", 135 | "-f", "null", "-", 136 | ], 137 | stdin: noop, 138 | print: noop, 139 | printErr: noop, 140 | onExit: function(v) {code = v}, 141 | MEMFS: [{name: "test.webm", data: data}], 142 | }); 143 | expect(code).to.equal(0); 144 | }); 145 | 146 | it("should accept Uint16Array in MEMFS input", function() { 147 | var data = new Uint16Array(testData.buffer); 148 | var code; 149 | ffmpeg_webm({ 150 | arguments: [ 151 | "-i", "test.webm", 152 | "-vn", 153 | "-frames:a", "1", "-c:a", "libopus", 154 | "-f", "null", "-", 155 | ], 156 | stdin: noop, 157 | print: noop, 158 | printErr: noop, 159 | onExit: function(v) {code = v}, 160 | MEMFS: [{name: "test.webm", data: data}], 161 | }); 162 | expect(code).to.equal(0); 163 | }); 164 | 165 | it("should work with crazy output name", function() { 166 | var code; 167 | var res = ffmpeg_webm({ 168 | arguments: [ 169 | "-i", "test.webm", 170 | "-vn", 171 | "-frames:a", "1", "-c:a", "libopus", 172 | "-f", "webm", "toString", 173 | ], 174 | stdin: noop, 175 | print: noop, 176 | printErr: noop, 177 | onExit: function(v) {code = v}, 178 | MEMFS: [{name: "test.webm", data: testData}], 179 | }); 180 | expect(code).to.equal(0); 181 | expect(res.MEMFS).to.have.length(1); 182 | var file = res.MEMFS[0]; 183 | expect(file.name).to.equal("toString"); 184 | expect(file.data.length).to.be.above(0); 185 | expect(file.data).to.be.an.instanceof(Uint8Array); 186 | }); 187 | 188 | it("should work with other crazy output name", function() { 189 | var res = ffmpeg_webm({ 190 | arguments: [ 191 | "-i", "test.webm", 192 | "-vn", 193 | "-frames:a", "1", "-c:a", "libopus", 194 | "-f", "webm", "__proto__", 195 | ], 196 | stdin: noop, 197 | print: noop, 198 | printErr: noop, 199 | MEMFS: [{name: "test.webm", data: testData}], 200 | }); 201 | expect(res.MEMFS).to.have.length(1); 202 | expect(res.MEMFS[0].name).to.equal("__proto__"); 203 | expect(res.MEMFS[0].data.length).to.be.above(0); 204 | }); 205 | 206 | it("should return empty array for empty output", function() { 207 | var res = ffmpeg_webm({ 208 | arguments: [ 209 | "-i", "test.webm", 210 | "-vf", "not_existent", 211 | "out.webm", 212 | ], 213 | stdin: noop, 214 | print: noop, 215 | printErr: noop, 216 | MEMFS: [{name: "test.webm", data: testData}], 217 | }); 218 | expect(res.MEMFS).to.have.length(1); 219 | expect(res.MEMFS[0].name).to.equal("out.webm"); 220 | expect(res.MEMFS[0].data.length).to.equal(0); 221 | }); 222 | 223 | it("should have subtitles filter", function() { 224 | var code; 225 | var res = ffmpeg_webm({ 226 | arguments: [ 227 | "-i", "test.webm", 228 | "-frames:v", "1", "-c:v", "libvpx", 229 | "-vf", "subtitles=test.webm", 230 | "-an", "-f", "null", "-", 231 | ], 232 | stdin: noop, 233 | print: noop, 234 | printErr: noop, 235 | onExit: function(v) {code = v}, 236 | MEMFS: [{name: "test.webm", data: testData}], 237 | }); 238 | expect(code).to.equal(0); 239 | }); 240 | 241 | it("should have Ogg muxer", function() { 242 | var res = ffmpeg_webm({ 243 | arguments: [ 244 | "-i", "test.webm", 245 | "-vn", 246 | "-frames:a", "1", "-c:a", "libopus", 247 | "out.ogg", 248 | ], 249 | stdin: noop, 250 | print: noop, 251 | printErr: noop, 252 | MEMFS: [{name: "test.webm", data: testData}], 253 | }); 254 | expect(res.MEMFS).to.have.length(1); 255 | var file = res.MEMFS[0]; 256 | expect(file.name).to.equal("out.ogg"); 257 | expect(file.data.length).to.be.above(0); 258 | expect(file.data).to.be.an.instanceof(Uint8Array); 259 | }); 260 | 261 | it("should encode sequence of frames to WebM", function() { 262 | var res = ffmpeg_webm({ 263 | // FIXME(Kagami): pattern_type=sequence doesn't work with NODEFS 264 | // for some reason. 265 | arguments: [ 266 | "-pattern_type", "glob", 267 | "-i", "/data/test-frame*.jpg", 268 | "out.webm", 269 | ], 270 | stdin: noop, 271 | print: noop, 272 | printErr: noop, 273 | mounts: [{type: "NODEFS", opts: {root: "test"}, mountpoint: "/data"}], 274 | }); 275 | var file = res.MEMFS[0]; 276 | expect(file.name).to.equal("out.webm"); 277 | expect(file.data.length).to.be.above(0); 278 | }); 279 | }); 280 | 281 | describe("Worker", function() { 282 | it("should print version to stdout", function(done) { 283 | var stdout = ""; 284 | var stderr = ""; 285 | var worker = new Worker("ffmpeg-worker-webm.js"); 286 | worker.onerror = done; 287 | worker.onmessage = function(e) { 288 | var msg = e.data; 289 | switch (msg.type) { 290 | case "ready": 291 | worker.postMessage({type: "run", arguments: ["-version"]}); 292 | break; 293 | case "stdout": 294 | stdout += msg.data + "\n"; 295 | break; 296 | case "stderr": 297 | stderr += msg.data + "\n"; 298 | break; 299 | case "exit": 300 | expect(stderr).to.be.empty; 301 | expect(msg.data).to.equal(0); 302 | expect(stdout).to.match(/^ffmpeg version /); 303 | // FIXME(Kagami): This cause segfault on Node 6.x. 304 | // worker.terminate(); 305 | done(); 306 | break; 307 | } 308 | }; 309 | }); 310 | 311 | // FIXME(Kagami): Blocked by: 312 | // . 313 | it.skip("should encode test file to WebM/VP8 at MEMFS", function(done) { 314 | this.timeout(60000); 315 | var worker = new Worker("ffmpeg-worker-webm.js"); 316 | worker.onerror = done; 317 | worker.onmessage = function(e) { 318 | var msg = e.data; 319 | switch (msg.type) { 320 | case "ready": 321 | worker.postMessage({ 322 | type: "run", 323 | arguments: [ 324 | "-i", "test.webm", 325 | "-frames:v", "5", "-c:v", "libvpx", 326 | "-an", 327 | "out.webm", 328 | ], 329 | MEMFS: [{name: "test.webm", data: testData}], 330 | }); 331 | break; 332 | case "done": 333 | var mem = res.data.MEMFS; 334 | expect(mem).to.have.length(1); 335 | expect(mem[0].name).to.equal("out.webm"); 336 | expect(mem[0].data.length).to.be.above(0); 337 | worker.terminate(); 338 | done(); 339 | break; 340 | } 341 | }; 342 | }); 343 | }); 344 | }); 345 | 346 | describe("MP4", function() { 347 | this.timeout(10000); 348 | 349 | describe("Sync", function() { 350 | it("should print version to stdout", function(done) { 351 | var stdout = ""; 352 | var stderr = ""; 353 | ffmpeg_mp4({ 354 | arguments: ["-version"], 355 | print: function(data) { stdout += data + "\n"; }, 356 | printErr: function(data) { stderr += data + "\n"; }, 357 | onExit: function(code) { 358 | expect(code).to.equal(0); 359 | expect(stderr).to.be.empty; 360 | expect(stdout).to.match(/^ffmpeg version /); 361 | done(); 362 | }, 363 | }); 364 | }); 365 | 366 | it("should encode test file to MP4/H.264/MP3 at MEMFS", function() { 367 | this.timeout(60000); 368 | var code; 369 | var res = ffmpeg_mp4({ 370 | arguments: [ 371 | "-i", "test.webm", 372 | "-frames:v", "5", "-c:v", "libx264", 373 | "-c:a", "libmp3lame", 374 | "out.mp4", 375 | ], 376 | stdin: noop, 377 | print: noop, 378 | printErr: noop, 379 | onExit: function(v) {code = v}, 380 | MEMFS: [{name: "test.webm", data: testData}], 381 | }); 382 | expect(code).to.equal(0); 383 | expect(res.MEMFS).to.have.length(1); 384 | var file = res.MEMFS[0]; 385 | expect(file.name).to.equal("out.mp4"); 386 | expect(file.data.length).to.be.above(0); 387 | expect(file.data).to.be.an.instanceof(Uint8Array); 388 | }); 389 | 390 | it("should encode test file to MP4/AAC at MEMFS", function() { 391 | var res = ffmpeg_mp4({ 392 | arguments: [ 393 | "-i", "test.webm", 394 | "-vn", 395 | "-frames:a", "1", "-c:a", "aac", 396 | "out.mp4", 397 | ], 398 | stdin: noop, 399 | print: noop, 400 | printErr: noop, 401 | MEMFS: [{name: "test.webm", data: testData}], 402 | }); 403 | expect(res.MEMFS).to.have.length(1); 404 | var file = res.MEMFS[0]; 405 | expect(file.name).to.equal("out.mp4"); 406 | expect(file.data.length).to.be.above(0); 407 | }); 408 | }); 409 | 410 | // TODO(Kagami): Test worker builds with Karma. node-webworker-threads 411 | // has too many bugs. 412 | describe.skip("Worker", function() { 413 | it("should print version to stdout", function(done) { 414 | var stdout = ""; 415 | var stderr = ""; 416 | var worker = new Worker("ffmpeg-worker-mp4.js"); 417 | worker.onerror = done; 418 | worker.onmessage = function(e) { 419 | var msg = e.data; 420 | switch (msg.type) { 421 | case "ready": 422 | worker.postMessage({type: "run", arguments: ["-version"]}); 423 | break; 424 | case "stdout": 425 | stdout += msg.data + "\n"; 426 | break; 427 | case "stderr": 428 | stderr += msg.data + "\n"; 429 | break; 430 | case "exit": 431 | expect(stderr).to.be.empty; 432 | expect(msg.data).to.equal(0); 433 | expect(stdout).to.match(/^ffmpeg version /); 434 | worker.terminate(); 435 | done(); 436 | break; 437 | } 438 | }; 439 | }); 440 | }); 441 | }); 442 | -------------------------------------------------------------------------------- /COPYING.GPLv2: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /COPYING.LGPLv2.1: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | --------------------------------------------------------------------------------