Skip to content

CGuichard/pffmpeg

Repository files navigation

PFFmpeg

PFFmpeg logo

Progress bar for FFmpeg

Language License Documentation Style Lint Security Tests

Pull Request · Bug Report · Feature Request


Documentation: https://cguichard.github.io/pffmpeg

Source Code: https://github.com/CGuichard/pffmpeg


The FFmpeg command line tool is a universal media converter. It can read a wide variety of inputs, filter and transcode them into a plethora of output formats. For new user it can be extremely convoluted to use, and read the output. When converting a video file for the first time, understanding the progress of the current task from the output is quite the confusing task.

This is where PFFmpeg comes in. It's CLI is just on top of FFmpeg's, and delegates everything to it. The output of the FFmpeg is parsed and "patched" to display a progress bar while running an action such as a video compression. PFFmpeg philosophy is to alter as little as possible the FFmpeg experience, and simply add the progress bar when needed, unlike other project who just wrap and hide all of the output behind a progress bar. In terms of style, the rich progress bar was chosen.

Table of Contents

Quick start

Install PFFmpeg with pip (from PyPI):

pip install pffmpeg

You can use any ffmpeg command with pffmpeg:

# Print help
pffmpeg -h

# Print version
pffmpeg -version

# Video processing
pffmpeg -i input.mp4 output.mp4

Demo:

Demo pffmpeg

Contributing

If you want to contribute to this project or understand how it works, please check CONTRIBUTING.md.

Any contribution is greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.