Hoolihan ·
Hoolihan is a JavaScript module to help build Ffmpeg command-line options, and run Ffmpeg with those options as a NodeJS child process. You, must "bring your own" build of ffmpeg and ffprobe, and Hoolihan does some work to read the capabilities of your particular build.
Installing / Getting started
Hoolihan includes mocha, chai, and eslint as devDependencies. Use the optional --production
flag when installing to omit them.
npm install hoolihan [--production]
See Configuration for how to point Hoolihan at your builds of Ffmpeg and Ffprobe.
Developing
Setting up Dev
git clone https://github.com/bradcordeiro/hoolihan.gitcd hoolihan/npm install
Versioning
Hoolihan uses SemVer for versioning.
Configuration
Hoolihan uses dotenv to know where your Ffmpeg and Ffprobe binaries are, as well as the default font file to be used for Ffmpeg's drawtext
filter. Create a file named .env
in your project root with the following variables, set to your desired values. Spaces are allowed in binary locations, for instance if using a dockerized Ffmpeg binary:
# .env FFMPEG_BIN=docker run --rm myimages/ffmpegFFPROBE_BIN=/usr/local/bin/ffprobeDRAWTEXTFONT=/Users/administrator/Library/Fonts/AverageMono.ttf
Tests
Numerous tests are included, most of them written before this module got any real-world use. Pull requests with new tests are welcome. To run, install mocha and chai, then:
npm test
Style guide
Uses the Airbnb JavaScript Style Guide. Eslint is listed as a devDependency, and a .eslintrc.json
is checked into source control.
API Reference
Please see the wiki.
Licensing
Released under a Creative Commons Attribution-NonCommercial 4.0 International Public License.