cffmpeg-static v5.0.0

ffmpeg-static

ffmpeg static binaries for Mac OSX, Linux, Windows.

Supports macOS (64-bit and arm64), Linux (32 and 64-bit, armhf, arm64), Windows (32 and 64-bit). The ffmpeg version currently used is 5.0.

Note: The version of ffmpeg-static follows SemVer. When releasing new versions, we do not consider breaking changes in ffmpeg itself, but only the JS interface (see below). For example, ffmpeg-static@4.5.0 downloads ffmpeg 5.0. To prevent an ffmpeg-static upgrade downloading backwards-incompatible ffmpeg versions, use a strict version range for it or use a lockfile.

Also check out node-ffmpeg-installer!

Installation

This module is installed via npm:

$ npm install ffmpeg-static

Note: During installation, it will download the appropriate ffmpeg binary from the b5.0 GitHub release. Use and distribution of the binary releases of FFmpeg are covered by their respective license.

Custom binaries url

To use a mirror of the ffmpeg-static binaries use npm config property ffmpeg_binaries_url. Default is https://github.com/eugeneware/ffmpeg-static/releases/download.

npm install ffmpeg-static --ffmpeg_binaries_url=https://cdn.npmmirror.com/binaries/ffmpeg-static

Or add property into your .npmrc file.

ffmpeg_binaries_url=https://cdn.npmmirror.com/binaries/ffmpeg-static

Another option is to use the FFMPEG_BINARIES_URL environment variable.

env export FFMPEG_BINARIES_URL=https://cdn.npmmirror.com/binaries/ffmpeg-static npm install ffmpeg-static

Electron & other cross-platform packaging tools

Because ffmpeg-static will download a binary specific to the OS/platform, you need to purge node_modules before (re-)packaging your app for a different OS/platform (read more in #35).

Example Usage

Returns the path of a statically linked ffmpeg binary on the local filesystem.

var pathToFfmpeg = require('ffmpeg-static');
console.log(pathToFfmpeg);

/Users/j/playground/node_modules/ffmpeg-static/ffmpeg

Check the example script for a more thorough example.

Sources of the binaries

The build script downloads binaries from these locations:

• Windows x64 builds
• Windows x86 builds
• Linux x64/x86/ARM/ARM64 builds
• macOS x64 (Intel) & ARM64 (Apple Silicon) builds

The build script extracts build information and (when possible) the license file from the downloaded package or the distribution server. Please consult the individual build's project site for exact source versions, which you can locate based on the version information included in the README file.

Show your support

This npm package includes statically linked binaries that are produced by the following individuals. Please consider supporting and donating to them who have been providing quality binary builds for many years:

• Linux builds: John Van Sickle
• macOS builds: Helmut K. C. Tessarek

Building the project

The unzip, tar CLI executables need to be installed. On macOS, use brew install gnu-tar xz.