Skip to content

althonos/ffpb

Repository files navigation

ffpb stars

Not smart. Not comprehensive. Not guaranteed to work.

Source PyPI AppVeyor Format License Changelog Downloads

ffpb is an FFmpeg progress formatter. It will attempt to display a nice progress bar in the output, based on the raw ffmpeg output, as well as an adaptative ETA timer.

Showcase

https://github.com/althonos/ffpb/raw/master/static/showcase.v1.gif

(yes, my laptop can't encode shit)

Usage

ffpb is is not even self-aware. Any argument given to the ffpb command is transparently given to the ffmpeg binary on your system, without any form of validation. So if you know how to use the FFmpeg CLI, you know how to use ffpb !

Using as a library

ffpb can be used as a library: use the ffpb.main function:

ffpb.main(argv=None, stream=sys.stderr, encoding=None, tqdm=tqdm):
argv
The arguments to pass to ffmpeg, as an argument list.
stream
The stream to which to write the progress bar and the output messages.
encoding
The encoding of the terminal, used to decode the ffmpeg output. Defaults to locale.getpreferredencoding(), or UTF-8 is locales are not available.
tqdm
The progress bar factory to use. A subclass of tqdm.tqdm is expected. Check althonos/ffpb#19 to see how you can use this to wrap ffpb in your own UI.

Installation

Install from PyPI:

$ pip install --user ffpb

Alternatively, download a development version from the GitHub master branch:

$ pip install https://github.com/althonos/ffpb/archive/master.zip

Or if you use an Arch-based distro, download from the AUR