@ffprobe-installer/ffprobe

Platform independent binary installer of FFprobe for node projects

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@ffprobe-installer/ffprobe
47161.4.19 months ago6 years agoMinified + gzip package size for @ffprobe-installer/ffprobe in KB

Readme

node-ffprobe-installer
All Contributors
npm npm xo
Build Status Codecov
Platform independent binary installer of FFprobe for node projects. Useful for tools that should "just work" in 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 lets 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:
  • Linux (armhf, arm64, ia32, x64) (20210724-c253b18): https://www.johnvansickle.com/ffmpeg/
  • macOS (x64) (103117-g1f58503013): https://evermeet.cx/ffmpeg/
  • macOS (arm64) (4.4.1): https://formulae.brew.sh/formula/ffmpeg
  • Windows 32-bit (20210804-7ab0207): https://github.com/sudo-nautilus/FFmpeg-Builds-Win32/
  • Windows 64-bit (20210804-3b29864): https://www.gyan.dev/ffmpeg/builds/

For version updates, submit issue or pull request.

Upload new versions

In every updated platforms/* directory:
npm run upload

See also

Contributors ✨

Thanks goes to these wonderful people (emoji key):
<td align="center"><a href="https://jonasdautel.dev"><img src="https://avatars3.githubusercontent.com/u/16684499?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonas Dautel</b></sub></a><br /><a href="https://github.com/SavageCore/node-ffprobe-installer/commits?author=SNRSE" title="Code">💻</a></td>
<td align="center"><a href="https://kikobeats.com"><img src="https://avatars2.githubusercontent.com/u/2096101?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kiko Beats</b></sub></a><br /><a href="https://github.com/SavageCore/node-ffprobe-installer/commits?author=Kikobeats" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/kaandok"><img src="https://avatars0.githubusercontent.com/u/472836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kaan Ozdokmeci</b></sub></a><br /><a href="https://github.com/SavageCore/node-ffprobe-installer/commits?author=kaandok" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/sw360cab"><img src="https://avatars0.githubusercontent.com/u/777866?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sergio Maria Matone</b></sub></a><br /><a href="https://github.com/SavageCore/node-ffprobe-installer/commits?author=sw360cab" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/xemle"><img src="https://avatars.githubusercontent.com/u/261850?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sebastian</b></sub></a><br /><a href="https://github.com/SavageCore/node-ffprobe-installer/commits?author=xemle" title="Code">💻</a></td>



This project follows the all-contributors specification. Contributions of any kind are welcome!