https://github.com/sidneys/ffmpeg-progressbar-cli

A colored progress bar for FFmpeg.
https://github.com/sidneys/ffmpeg-progressbar-cli

cli colored ffmpeg ffmpeg-wrapper node nodejs progress-bar progressbar terminal wrapper

Last synced: 2 days ago
JSON representation

A colored progress bar for FFmpeg.

• Host: GitHub
• URL: https://github.com/sidneys/ffmpeg-progressbar-cli
• Owner: sidneys
• License: mit
• Created: 2018-08-02T14:03:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T22:59:26.000Z (over 2 years ago)
• Last Synced: 2025-01-08T02:09:35.697Z (16 days ago)
• Topics: cli, colored, ffmpeg, ffmpeg-wrapper, node, nodejs, progress-bar, progressbar, terminal, wrapper
• Language: JavaScript
• Homepage: https://npmjs.com/package/ffmpeg-progressbar-cli
• Size: 159 KB
• Stars: 215
• Watchers: 7
• Forks: 22
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ffmpeg-progressbar-cli [![npm](https://img.shields.io/npm/v/ffmpeg-progressbar-cli.svg?style=flat-square)](https://npmjs.com/package/ffmpeg-progressbar-cli)



  


  ffmpeg-progressbar-cli is a colored progress bar for FFmpeg.


  Simply use ffmpeg-bar instead of ffmpeg.





## Contents

1. [Installation](#installation)

1. [Usage](#usage)

1. [Configuration](#configuration)

1. [Requirements](#requirements)

1. [Compatibility](#compatibility)

1. [Contribute](#contribute)

1. [Author](#author)

##  Installation

```bash

$ npm install --global ffmpeg-progressbar-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

```bash

$> ffmpeg-bar -i input.mp4 output.avi

```

```bash

$> ffmpeg-bar -i input.avi -b:v 64k -bufsize 64k output.avi

```

```bash

$> ffmpeg-bar -i in.mkv -map_metadata:s:a 0:g out.mkv

```

##  Configuration

For configuration purposes, `ffmpeg-progressbar-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

```bash

$> 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

```bash

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

```

##  Requirements

 - [Node.js](https://nodejs.org/), v8.11 or later

 - [FFmpeg](https://ffmpeg.org/), installed correctly

##  Compatibility

Tested on

 - macOS 10.13, 10.14 Beta

 - Windows 10 1803

 - Ubuntu 18.04

##  Contribute ![Contributors Wanted](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)

Read the contribution [documentation](https://github.com/sidneys/ffmpeg-progressbar-cli/blob/master/CONTRIBUTING.md).

##  License

MIT

##  Author

[sidneys](http://sidneys.github.io) 2018