<div align="center">
[](https://pypistats.org/packages/better-ffmpeg-progress)
[](https://pypistats.org/packages/better-ffmpeg-progress)
[](LICENSE.txt)
# Better FFmpeg Progress
Runs an FFmpeg command and shows a progress bar with percentage progress, time elapsed and ETA.
</div>
FFmpeg outputs something like:
```
frame= 692 fps= 58 q=28.0 size= 5376KiB time=00:00:28.77 bitrate=1530.3kbits/s speed=2.43x
```
Better FFmpeg Progress outputs something like:
```
⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 23% 0:00:04 00:15
```
Where:
- `Processing abc.webm` is the description of the progresss bar.
- `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.
As you can see, the output of Better FFmpeg Progress is much more useful.
## 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:
```py
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:
```py
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() or subprocess.Popen()
process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
# Use the run method to run the FFmpeg command.
process.run(
progress_bar_description="Converting file...",
progress_handler=handle_progress_info,
log_file="ffmpeg_log.txt",
success_handler=handle_success,
error_handler=handle_error,
)
```
## Optional Arguments
An instance of the `FfmpegProcess` class takes the following **optional** arguments:
- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: "verbose"
- `print_stderr_new_line`: If better progress information cannot be shown, print FFmpeg stderr in a new line instead of replacing the current line in the terminal. Default: False
- `print_detected_duration`: Print the detected duration of the input file. Default: True
The `run` method takes the following **optional** arguments:
- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
- `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 current values of these metrics as arguments, every 0.1s.
- `log_file` - The filepath to save the FFmpeg log to.
- `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 getting `TqdmWarning: 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](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/da45a8416856ab7d3c7b748db5703fa3dbc65f60))
[07/02/2022]
- [v2.1.0] [Update function name](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/572fe8a0d71957d00b833134a4d35170630203fa) to fix `'process_complete_handler' is not defined` error.
[05/11/2023]
- [v2.1.2] [Do not exit the Python interpreter after the FFmpeg process is complete](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/0a358810773835297faae688689c6e0d8a5859ae)
[22/04/2024]
- [v2.1.3] Fix issue [#20](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/20)
[28/04/2024]
- [v2.1.4] Fix issue [#21](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/21)
[02/05/2024]
- [v2.1.5] Fix issue [#23](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/23) and make an error message more specific. [Here](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/a6ef7f26d080b684144021301f3b2aa5e0834dae) is the relevant commit.
[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]
- [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
[20/10/2024]
- [v2.1.9] Do not clear the terminal before showing the progress bar.
- [v2.2.0] Add the ability to set a custom description for the progress bar.
[22/10/2024]
- [v2.2.1] Only create a log file if the `log_file` parameter is specified and always create a log file if the FFmpeg process fails.
[28/10/2024]
- [v2.2.2] Make printing the detected duration of the input file optional.
[29/10/2024]
- [v2.3.0] Set `shell=True` to support piping.
- [v2.3.1] Kill FFmpeg process(es) on KeyboardInterrupt
[31/10/2024]
- [v2.4.0] Print FFmpeg stderr if better progress information cannot be shown.
- [v2.4.0] Flush the stream when printing FFmpeg stderr to ensure that it is printed immediately.
- [v2.5.0] Add an option to print FFmpeg stderr on a new line if better progress information cannot be shown.
[11/11/2024]
- [v2.5.1] Print the correct log file.
[12/11/2024]
- [v2.5.2] Drain any remaining FFmpeg stderr after the process ends.
- [v2.5.3] Write FFmpeg stderr to the log file in real time.
- [v2.5.4] Include progress info in stderr if the duration of the input file cannot be detected.
- [v2.5.5] Print detected errors in the terminal and only set `shell=True` if shell operators are detected.
[13/11/2024]
- [v2.5.6] Detect a wider range of errors.
Raw data
{
"_id": null,
"home_page": "https://github.com/CrypticSignal/better-ffmpeg-progress",
"name": "better-ffmpeg-progress",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ffmpeg, progress",
"author": "GitHub.com/CrypticSignal",
"author_email": "theaudiophile@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/20/78/36cb54ef1134464eeb3f6c6ec5f33e26fea2d73fbac4012060e9b19f5afb/better_ffmpeg_progress-2.5.6.tar.gz",
"platform": null,
"description": "<div align=\"center\">\r\n\r\n[](https://pypistats.org/packages/better-ffmpeg-progress)\r\n[](https://pypistats.org/packages/better-ffmpeg-progress)\r\n\r\n[](LICENSE.txt)\r\n\r\n# Better FFmpeg Progress\r\nRuns an FFmpeg command and shows a progress bar with percentage progress, time elapsed and ETA.\r\n</div>\r\n\r\nFFmpeg outputs something like:\r\n```\r\nframe= 692 fps= 58 q=28.0 size= 5376KiB time=00:00:28.77 bitrate=1530.3kbits/s speed=2.43x\r\n```\r\nBetter FFmpeg Progress outputs something like:\r\n```\r\n\u280f Processing abc.webm \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u257a\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 23% 0:00:04 00:15\r\n```\r\nWhere:\r\n- `Processing abc.webm` is the description of the progresss bar.\r\n- `23%` is the percentage progress.\r\n- `0:00:04` is the time (H:MM:SS) elapsed.\r\n- `00:15` is the estimated time until the FFmpeg process completes.\r\n\r\nAs you can see, the output of Better FFmpeg Progress is much more useful.\r\n\r\n## Installation\r\n```\r\npip install better-ffmpeg-progress --upgrade\r\n```\r\n\r\n## Usage\r\nCreate an instance of the `FfmpegProcess` class and supply a list of arguments like you would to `subprocess.run()`.\r\n\r\nSimple Example:\r\n```py\r\nfrom better_ffmpeg_progress import FfmpegProcess\r\n# Pass a list of FFmpeg arguments, like you would if using subprocess.run()\r\nprocess = FfmpegProcess([\"ffmpeg\", \"-i\", \"input.mp4\", \"-c:a\", \"libmp3lame\", \"output.mp3\"])\r\n# Use the run method to run the FFmpeg command.\r\nprocess.run()\r\n```\r\n\r\nAdvanced Example:\r\n```py\r\nfrom better_ffmpeg_progress import FfmpegProcess\r\n\r\ndef handle_progress_info(percentage, speed, eta, estimated_filesize):\r\n print(f\"Estimated Output Filesize: {estimated_filesize / 1_000_000} MB\")\r\n\r\ndef handle_success():\r\n # Code to run if the FFmpeg process completes successfully.\r\n pass\r\n\r\ndef handle_error():\r\n # Code to run if the FFmpeg process encounters an error.\r\n pass\r\n\r\n# Pass a list of FFmpeg arguments, like you would if using subprocess.run() or subprocess.Popen()\r\nprocess = FfmpegProcess([\"ffmpeg\", \"-i\", \"input.mp4\", \"-c:a\", \"libmp3lame\", \"output.mp3\"])\r\n\r\n# Use the run method to run the FFmpeg command.\r\nprocess.run(\r\n progress_bar_description=\"Converting file...\",\r\n progress_handler=handle_progress_info,\r\n log_file=\"ffmpeg_log.txt\",\r\n success_handler=handle_success,\r\n error_handler=handle_error,\r\n)\r\n```\r\n\r\n## Optional Arguments\r\nAn instance of the `FfmpegProcess` class takes the following **optional** arguments:\r\n\r\n- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: \"verbose\"\r\n- `print_stderr_new_line`: If better progress information cannot be shown, print FFmpeg stderr in a new line instead of replacing the current line in the terminal. Default: False\r\n- `print_detected_duration`: Print the detected duration of the input file. Default: True\r\n\r\nThe `run` method takes the following **optional** arguments:\r\n- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.\r\n- `progress_handler`\r\n - You can create a function if you would like to do something with the following values:\r\n - Percentage progress. [float]\r\n - Speed, e.g. `22.3x` which means that 22.3 seconds of the input are processed every second. [string]\r\n - ETA in seconds. [float]\r\n - Estimated output filesize in bytes. [float]\r\n - _Note: This is not accurate. Please take the value with a grain of salt._\r\n\r\n The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.\r\n\r\n- `log_file` - The filepath to save the FFmpeg log to.\r\n- `success_handler` - A function to run if the FFmpeg process completes successfully.\r\n- `error_handler` - A function to run if the FFmpeg process encounters an error.\r\n\r\n## Changelog\r\n[19/09/2022]\r\n- Add the ability to specify a `success_handler` argument, a function to run if the FFmpeg process completes successfully.\r\n- Add 0.001 to tqdm's `total` parameter to prevent the chance of getting `TqdmWarning: clamping frac to range [0, 1]`\r\n\r\n[21/12/2022]\r\n- [v2.0.7] Fix `'estimated_size' referenced before assignment` error.\r\n- [v2.0.7] The progress bar now uses 1 decimal place for seconds processed and total duration.\r\n\r\n[22/12/2022]\r\n- [v2.0.8] Add the ability to specify an `error_handler` argument, a function to run if the FFmpeg process encounters an error.\r\n- [v2.0.9] Fix a typo (commit [da45a84](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/da45a8416856ab7d3c7b748db5703fa3dbc65f60))\r\n\r\n[07/02/2022]\r\n- [v2.1.0] [Update function name](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/572fe8a0d71957d00b833134a4d35170630203fa) to fix `'process_complete_handler' is not defined` error.\r\n\r\n[05/11/2023]\r\n- [v2.1.2] [Do not exit the Python interpreter after the FFmpeg process is complete](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/0a358810773835297faae688689c6e0d8a5859ae)\r\n\r\n[22/04/2024]\r\n- [v2.1.3] Fix issue [#20](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/20)\r\n\r\n[28/04/2024]\r\n- [v2.1.4] Fix issue [#21](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/21)\r\n\r\n[02/05/2024]\r\n- [v2.1.5] Fix issue [#23](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/23) and make an error message more specific. [Here](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/a6ef7f26d080b684144021301f3b2aa5e0834dae) is the relevant commit.\r\n\r\n[18/10/2024]\r\n- [v2.1.6] Notify the user if the input filepath or filename is incorrect.\r\n- [v2.1.7] Refactor to use threads and queues.\r\n\r\n[19/10/2024]\r\n- [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).\r\n\r\n[20/10/2024]\r\n- [v2.1.9] Do not clear the terminal before showing the progress bar.\r\n- [v2.2.0] Add the ability to set a custom description for the progress bar.\r\n\r\n[22/10/2024]\r\n- [v2.2.1] Only create a log file if the `log_file` parameter is specified and always create a log file if the FFmpeg process fails.\r\n\r\n[28/10/2024]\r\n- [v2.2.2] Make printing the detected duration of the input file optional.\r\n\r\n[29/10/2024]\r\n- [v2.3.0] Set `shell=True` to support piping.\r\n- [v2.3.1] Kill FFmpeg process(es) on KeyboardInterrupt\r\n\r\n[31/10/2024]\r\n- [v2.4.0] Print FFmpeg stderr if better progress information cannot be shown.\r\n- [v2.4.0] Flush the stream when printing FFmpeg stderr to ensure that it is printed immediately.\r\n- [v2.5.0] Add an option to print FFmpeg stderr on a new line if better progress information cannot be shown.\r\n\r\n[11/11/2024]\r\n- [v2.5.1] Print the correct log file.\r\n\r\n[12/11/2024]\r\n- [v2.5.2] Drain any remaining FFmpeg stderr after the process ends.\r\n- [v2.5.3] Write FFmpeg stderr to the log file in real time.\r\n- [v2.5.4] Include progress info in stderr if the duration of the input file cannot be detected.\r\n- [v2.5.5] Print detected errors in the terminal and only set `shell=True` if shell operators are detected.\r\n\r\n[13/11/2024]\r\n- [v2.5.6] Detect a wider range of errors.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Run FFmpeg & see percentage progress + ETA.",
"version": "2.5.6",
"project_urls": {
"Homepage": "https://github.com/CrypticSignal/better-ffmpeg-progress"
},
"split_keywords": [
"ffmpeg",
" progress"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb6cc52cfa31f79ea4da67025797c4360f1e15f3707819cb34f46a2c4b448470",
"md5": "74ebcd40f2e12ef68dd78f0f50da25d7",
"sha256": "2de63dc487ef29f4cafe1a30113dd7cfae637f578e2b8c7059c106029219a757"
},
"downloads": -1,
"filename": "better_ffmpeg_progress-2.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74ebcd40f2e12ef68dd78f0f50da25d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9111,
"upload_time": "2024-11-13T00:01:57",
"upload_time_iso_8601": "2024-11-13T00:01:57.592029Z",
"url": "https://files.pythonhosted.org/packages/eb/6c/c52cfa31f79ea4da67025797c4360f1e15f3707819cb34f46a2c4b448470/better_ffmpeg_progress-2.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "207836cb54ef1134464eeb3f6c6ec5f33e26fea2d73fbac4012060e9b19f5afb",
"md5": "3076ed1d9d7d7f7fc16fea0bef51da21",
"sha256": "e99381f9d68f79b38b15d6ddfe3ab60b15342f2af2e4f3004116e15b105ae160"
},
"downloads": -1,
"filename": "better_ffmpeg_progress-2.5.6.tar.gz",
"has_sig": false,
"md5_digest": "3076ed1d9d7d7f7fc16fea0bef51da21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8644,
"upload_time": "2024-11-13T00:01:59",
"upload_time_iso_8601": "2024-11-13T00:01:59.241220Z",
"url": "https://files.pythonhosted.org/packages/20/78/36cb54ef1134464eeb3f6c6ec5f33e26fea2d73fbac4012060e9b19f5afb/better_ffmpeg_progress-2.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 00:01:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CrypticSignal",
"github_project": "better-ffmpeg-progress",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "better-ffmpeg-progress"
}
JSON
