A colored progress bar for FFmpeg.
javascript
Jesús 3e78834fbf
add documentation listformat
3 months ago
lib rebrand 3 months ago
resources/screencasts v1.1.1 8 months ago
.eslintrc v1.4.1 7 months ago
.gitignore rebrand 3 months ago
.jsdoc.json v1.1.1 8 months ago
.npmignore v1.1.1 8 months ago
AUTHORS authors 3 months ago
CONTRIBUTING.md rebrand 3 months ago
LICENSE rebrand 3 months ago
README.md fix URL Author for npm 3 months ago
allformat.txt add documentation listformat 3 months ago
package-lock.json rebrand 3 months ago
package.json version 1.1.1 3 months ago
yarn.lock v1.5.0 5 months ago

README.md

ff-cli npm


ff-cli is a colored progress bar for FFmpeg.
Simply use ffmpeg-bar instead of ffmpeg.

Contents

  1. Installation
  2. Usage
  3. Configuration
  4. Requirements
  5. Compatibility
  6. Contribute
  7. Author

Installation

$ npm install --global ff-cli

Usage

The installation process adds the ffmpeg-bar command to your system. This is a transparent wrapper, passing all commands to ffmpeg.

To use it, simply launch ffmpeg-bar instead of ffmpeg, or replace ffmpeg with ffmpeg-bar inside your scripts.

As long as no errors are encountered, the output of ffmpeg-bar will consist of a progress bar, the estimated time until process completion and a percentage.

Examples
$> ffmpeg-bar -i input.mp4 output.avi
$> ffmpeg-bar -i input.avi -b:v 64k -bufsize 64k output.avi
$> ffmpeg-bar -i in.mkv -map_metadata:s:a 0:g out.mkv

Configuration

For configuration purposes, ff-cli exposes these environmental variables:

BAR_FILENAME_LENGTH

The maximum number of characters of the filename label displayed next to the progress bar beam (default: 20)

Example
$> BAR_FILENAME_LENGTH=7 ffmpeg-bar -i in.mp4 output.mp4
BAR_BEAM_RATIO

The share of (available) horizontal display real estate the progress bar beam should occupy (default: 0.75)

Example
$> BAR_BAR_SIZE_RATIO=0.5 ffmpeg-bar -i in.mp4 output.mp4

Requirements

Compatibility

Tested on

  • macOS 10.13, 10.14 Beta
  • Windows 10 1803
  • Ubuntu 18.04

Contribute Contributors Wanted

Read the contribution documentation.

License

GPL-3.0 or later

Author

The ff-cli contributors are in the file AUTHORS.