Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/75lb/handbrake-js
Video encoding / transcoding / converting for node.js
https://github.com/75lb/handbrake-js
batch ffmpeg handbrake javascript nodejs video video-encoding
Last synced: about 3 hours ago
JSON representation
Video encoding / transcoding / converting for node.js
- Host: GitHub
- URL: https://github.com/75lb/handbrake-js
- Owner: 75lb
- License: other
- Created: 2013-02-14T20:59:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-05-03T15:22:21.000Z (over 1 year ago)
- Last Synced: 2024-05-22T03:03:25.069Z (6 months ago)
- Topics: batch, ffmpeg, handbrake, javascript, nodejs, video, video-encoding
- Language: JavaScript
- Homepage:
- Size: 5.46 MB
- Stars: 549
- Watchers: 17
- Forks: 69
- Open Issues: 5
-
Metadata Files:
- Readme: README.hbs
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/handbrake-js)
[](https://www.npmjs.org/package/handbrake-js)
[](https://github.com/75lb/handbrake-js/network/dependents?dependent_type=REPOSITORY)
[](https://github.com/75lb/handbrake-js/network/dependents?dependent_type=PACKAGE)
[](https://github.com/75lb/handbrake-js/actions/workflows/node.js.yml)
[](https://github.com/feross/standard)
***Upgraders, please read the [release notes](https://github.com/75lb/handbrake-js/releases).***
# handbrake-js
Handbrake-js is [Handbrake](http://handbrake.fr) ([v1.6.1](https://github.com/HandBrake/HandBrake/releases/tag/1.6.1)) for [node.js](http://nodejs.org). It aspires to provide a lean and stable foundation for building video transcoding software in node.js.
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs. It can process most common multimedia files and any DVD or BluRay sources that do not contain any copy protection.
Outputs:
* File Containers: .MP4(.M4V) and .MKV
* Video Encoders: H.264(x264), H.265(x265) MPEG-4 and MPEG-2 (libav), VP8 (libvpx) and Theora(libtheora)
* Audio Encoders: AAC, CoreAudio AAC/HE-AAC (OS X Only), MP3, Flac, AC3, or Vorbis
* Audio Pass-thru: AC-3, DTS, DTS-HD, AAC and MP3 tracks
[Read more about the features](https://handbrake.fr/features.php).
### Compatible Platforms
Tested on Mac OSX, Ubuntu 14, Windows XP, Windows 7 and Windows 8.1.
**Ubuntu 14.04 notice**: Transcoding to MP4 fails on Ubuntu since 14.04 [for this reason](https://forum.handbrake.fr/viewtopic.php?f=13&t=30044).
## Installation
### System Requirements
Just [node.js](http://nodejs.org). On Mac and Windows, every else is installed automatically. However on Linux, you must install HandbrakeCLI manually with these commands:
```
sudo add-apt-repository --yes ppa:stebbins/handbrake-releases
sudo apt-get update -qq
sudo apt-get install -qq handbrake-cli
```
### As a library
Move into your project directory then run:
```sh
$ npm install handbrake-js --save
```
*Mac / Linux users may need to run with `sudo`*.
Now you can begin encoding from your app.
```js
const hbjs = require('handbrake-js')
hbjs.spawn({ input: 'something.avi', output: 'something.m4v' })
.on('error', err => {
// invalid user input, no video found etc
})
.on('progress', progress => {
console.log(
'Percent complete: %s, ETA: %s',
progress.percentComplete,
progress.eta
)
})
```
### As a command-line app
From any directory run the following:
```sh
$ npm install -g handbrake-js
```
*Mac / Linux users may need to run with `sudo`*.
Now, you can call `handbrake` as you would HandbrakeCLI, using all the usual [options](https://handbrake.fr/docs/en/latest/cli/cli-guide.html). By default, just statistics are output, passing `--verbose` prints the raw HandbrakeCLI output. This command will transcode an AVI to the more universal H.264 (mp4):
```
$ handbrake --input 'some episode.avi' --output 'some episode.mp4' --preset Normal
Task % done FPS Avg FPS ETA
Encoding 1.07 131.76 158.12 00h21m11s
```
## HandbrakeCLI Path
In some situations or environments (e.g. Docker) you may need to specify a custom HandbrakeCLI path. You can either specify the path in an environment variable:
```sh
HANDBRAKECLI_PATH="./example/HandbrakeCLI"
```
..or pass `HandbrakeCLIPath` as an option, programmatically. See the API documentation below for instructions. Also, see the [examples folder](https://github.com/75lb/handbrake-js/tree/master/examples) for example code.
# API Reference
{{#module name="handbrake-js"}}
{{>body~}}
{{>member-index~}}
{{>separator~}}
{{>members~}}
{{/module}}
* * *
© 2013-24 Lloyd Brookes <[email protected]>.
Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
Handbrake ([Authors](https://github.com/HandBrake/HandBrake/blob/master/AUTHORS.markdown)) is licensed by [GNU General Public License Version 2](https://github.com/HandBrake/HandBrake/blob/master/LICENSE).