Run FFmpeg & see percentage progress + ETA.
Project description
Example:
⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 23% 0:00:04 00:15
Where:
23%
is the percentage progress.0:00:04
is the time (H:MM:SS) elapsed.00:15
is the estimated time until the FFmpeg process completes.
Installation:
pip install better-ffmpeg-progress --upgrade
Usage:
Create an instance of the FfmpegProcess
class and supply a list of arguments like you would to subprocess.run()
.
Simple Example:
from better_ffmpeg_progress import FfmpegProcess
# Pass a list of FFmpeg arguments, like you would if using subprocess.run()
process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
# Use the run method to run the FFmpeg command.
process.run()
Advanced Example:
from better_ffmpeg_progress import FfmpegProcess
def handle_progress_info(percentage, speed, eta, estimated_filesize):
print(f"Estimated Output Filesize: {estimated_filesize / 1_000_000} MB")
def handle_success():
# Code to run if the FFmpeg process completes successfully.
pass
def handle_error():
# Code to run if the FFmpeg process encounters an error.
pass
# Pass a list of FFmpeg arguments, like you would if using subprocess.run()
process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
ffmpeg_output_path = 'ffmpeg_output.txt'
# Use the run method to run the FFmpeg command.
process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
The run
method takes the following optional arguments:
-
progress_handler
-
You can create a function if you would like to do something with the following values:
- Percentage progress. [float]
- Speed, e.g.
22.3x
which means that 22.3 seconds of the input are processed every second. [string] - ETA in seconds. [float]
- Estimated output filesize in bytes. [float]
- Note: This is not accurate. Please take the value with a grain of salt.
The values will be
None
if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
-
-
ffmpeg_output_file
- A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename[<input_filename>].txt
. -
success_handler
- A function to run if the FFmpeg process completes successfully. -
error_handler
- A function to run if the FFmpeg process encounters an error.
Changelog:
[19/09/2022]
- Add the ability to specify a
success_handler
argument, a function to run if the FFmpeg process completes successfully. - Add 0.001 to tqdm's
total
parameter to prevent the chance of gettingTqdmWarning: clamping frac to range [0, 1]
[21/12/2022]
- [v2.0.7] Fix
'estimated_size' referenced before assignment
error. - [v2.0.7] The progress bar now uses 1 decimal place for seconds processed and total duration.
[22/12/2022]
- [v2.0.8] Add the ability to specify an
error_handler
argument, a function to run if the FFmpeg process encounters an error. - [v2.0.9] Fix a typo (commit da45a84)
[07/02/2022]
- [v2.1.0] Update function name to fix
'process_complete_handler' is not defined
error.
[05/11/2023]
[22/04/2024]
- [v2.1.3] Fix issue #20
[28/04/2024]
- [v2.1.4] Fix issue #21
[02/05/2024]
[18/10/2024]
- [v2.1.6] Notify the user if the input filepath or filename is incorrect.
- [v2.1.7] Refactor to use threads and queues.
[19/10/2024]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for better_ffmpeg_progress-2.1.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1b53687a174a92eaed692baa2b21ec2873acf2e3c96b45526595e9786987c7d |
|
MD5 | 03e3f5c0b877e2298481b31cd3177a11 |
|
BLAKE2b-256 | 9a7ffed7a5506cca95a0de2b2fab3486c332389113c7874716a63311fa0f4e5e |
Hashes for better_ffmpeg_progress-2.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 720f03708c75b1e00a646ef8debc687f3e0a347c29333c29139ba92831c61c68 |
|
MD5 | 4125e6393a1997248dc81bd08665b10e |
|
BLAKE2b-256 | 39de19e471859a737bb4e94848a6cc56e13e4989d753c2d91ff2c51b5c072e2e |