-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
feb8fe8
commit 49cd051
Showing
7 changed files
with
1,565 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# ISC License | ||
|
||
Copyright (c) Jahr 2021, Kristjan ESPERANTO | ||
|
||
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
# WebM Writer for JavaScript | ||
|
||
This is a JavaScript-based WebM video encoder based on the ideas from [Whammy][]. It allows you to turn a series of | ||
Canvas frames into a WebM video. | ||
|
||
This implementation allows you to create very large video files (exceeding the size of available memory), because when | ||
running in a privileged context like a Chrome extension or Electron app, it can stream chunks immediately to a file on disk | ||
using [Chrome's FileWriter][] while the video is being constructed, instead of needing to buffer the entire video in | ||
memory before saving can begin. Video sizes in excess of 4GB can be written. The implementation currently tops out at | ||
32GB, but this could be extended. | ||
|
||
When a FileWriter is not available, it can instead buffer the video in memory as a series of Blobs which are eventually | ||
returned to the calling code as one composite Blob. This Blob can be displayed in a <video> element, transmitted | ||
to a server, or used for some other purpose. Note that some browsers size limits on Blobs, particularly mobile | ||
browsers, check out the [Blob size limits][]. | ||
|
||
[Chrome's FileWriter]: https://developer.chrome.com/apps/fileSystem | ||
[Whammy]: https://github.com/antimatter15/whammy | ||
[Blob size limits]: https://github.com/eligrey/FileSaver.js/ | ||
|
||
## Compatibility | ||
|
||
Because this code relies on browser support for encoding a Canvas as a WebP image (using `toDataURL()`), it is presently | ||
only supported in Google Chrome, or a similar environment like Electron. It will throw an exception on other browsers or | ||
on vanilla Node. | ||
|
||
## Usage (Chrome) | ||
|
||
Download the script from the [Releases tab][] above. You should end up with a `webm-writer-x.x.x.js` file to add to your | ||
project. | ||
|
||
[Releases tab]: https://github.com/thenickdude/webm-writer-js/releases | ||
|
||
Include the script in your header: | ||
|
||
```html | ||
<script type="text/javascript" src="webm-writer-0.3.0.js"></script> | ||
``` | ||
|
||
First construct the writer, passing in any options you want to customize: | ||
|
||
```js | ||
var videoWriter = new WebMWriter({ | ||
quality: 0.95, // WebM image quality from 0.0 (worst) to 0.99999 (best), 1.00 (VP8L lossless) is not supported | ||
fileWriter: null, // FileWriter in order to stream to a file instead of buffering to memory (optional) | ||
fd: null, // Node.js file handle to write to instead of buffering to memory (optional) | ||
|
||
// You must supply one of: | ||
frameDuration: null, // Duration of frames in milliseconds | ||
frameRate: null, // Number of frames per second | ||
|
||
transparent: false, // True if an alpha channel should be included in the video | ||
alphaQuality: undefined, // Allows you to set the quality level of the alpha channel separately. | ||
// If not specified this defaults to the same value as `quality`. | ||
}); | ||
``` | ||
|
||
Add as many Canvas frames as you like to build your video: | ||
|
||
```js | ||
videoWriter.addFrame(canvas); | ||
``` | ||
|
||
You can override the duration of a specific frame in milliseconds like so: | ||
|
||
```js | ||
videoWriter.addFrame(canvas, 100); | ||
``` | ||
|
||
Note that if the canvas' dimensions change between frames, the resulting WebM video may not be compatible with all players, | ||
because the frame dimensions will differ from the overall track's dimensions. This could be improved in the future. | ||
|
||
When you're done, you must call `complete()` to finish writing the video: | ||
|
||
```js | ||
videoWriter.complete(); | ||
``` | ||
|
||
`complete()` returns a Promise which resolves when writing is completed. | ||
|
||
If you didn't supply a `fileWriter` or `fd` in the options, the Promise will resolve to Blob which represents the video. You | ||
could display this blob in an HTML5 <video> tag: | ||
|
||
```js | ||
videoWriter.complete().then(function(webMBlob) { | ||
$("video").attr("src", URL.createObjectURL(webMBlob)); | ||
}); | ||
``` | ||
|
||
## Usage (Electron) | ||
|
||
The video encoder can use Node.js file APIs to write the video to disk when running under Electron. There is an example | ||
in `test/electron`. Run `npm install` in that directory to fetch required libraries, then `npm start` to launch Electron. | ||
|
||
## Transparent WebM support | ||
|
||
Transparent WebM files are supported, check out the example in test/transparent. However, because I'm re-using Chrome's | ||
WebP encoder to create the alpha channel, and the alpha channel is taken from the Y channel of a YUV-encoded WebP frame, | ||
and Y values are clamped by Chrome to be in the range 22-240 instead of the full 0-255 range, the encoded video can | ||
neither be fully opaque or fully transparent :(. | ||
|
||
Sorry, I wasn't able to find a workaround to get that to work. | ||
|
||
## License | ||
|
||
This project is licensed under the WTFPLv2 https://en.wikipedia.org/wiki/WTFPL |
Oops, something went wrong.