@ffprobe-installer/ffprobe

Platform independent binary installer of FFprobe for node projects

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
2620Jun 9, 2021Sep 19, 2016Minified + gzip package size for @ffprobe-installer/ffprobe in KB

Readme

node-ffprobe-installer

npm npm xo

Travis AppVeyor Codecov Tidelift

Platform independent binary installer of FFprobe for node projects. Useful for tools that should "just work" on multiple environments.

Installs a binary of ffprobe for the current platform and provides a path and version. Supports Linux, Windows 7+ and MacOS 10.9+.

A combination of package.json fields optionalDependencies, cpu, and os let's the installer only download the binary for the current platform. See also Warnings during install.

Install

npm install --save @ffprobe-installer/ffprobe

Usage examples

const ffprobe = require('@ffprobe-installer/ffprobe');
console.log(ffprobe.path, ffprobe.version);

process.spawn()

const ffprobePath = require('@ffprobe-installer/ffprobe').path;
const spawn = require('child_process').spawn;
const ffprobe = spawn(ffprobePath, args);
ffprobe.on('exit', onExit);

fluent-ffmpeg

const ffprobePath = require('@ffprobe-installer/ffprobe').path;
const ffmpeg = require('fluent-ffmpeg');
ffmpeg.setFfprobePath(ffprobePath);

Warnings during install

To automatically choose the binary to install, optionalDependencies are used. This currently outputs warnings in the console, an issue for that is tracked by the npm team here.

Known Issues

AWS and/or Elastic Beanstalk

If you get permissions issues, try adding a .npmrc file with the following:

unsafe-perm=true

See node-ffmpeg-installer/issues/21

Wrong path under Electron with Asar enabled

It's a known issue that Asar breaks native paths. As a workaround, if you use Asar, you can do something like this:

const ffprobePath = require('@ffprobe-installer/ffprobe').path.replace(
    'app.asar',
    'app.asar.unpacked'
);

The binaries

Downloaded from the sources listed at ffmpeg.org:

Upload new versions

In every updated platforms/* directory:

npm run upload

See also

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.