# ffmpeg-progress-yield
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[](https://pypi.org/project/ffmpeg-progress-yield) [](https://github.com/slhck/ffmpeg-normalize/actions/workflows/python-package.yml)
Run an ffmpeg command with its progress yielded.
Contents:
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [As a library](#as-a-library)
- [On the command line](#on-the-command-line)
- [Caveats](#caveats)
- [Contributors](#contributors)
- [License](#license)
-------------
## Requirements
- Python 3.8 or higher
- ffmpeg v3.1 or above from <http://ffmpeg.org/> installed in your \$PATH
## Installation
pip3 install ffmpeg-progress-yield
Or download this repository, then run `pip install .`.
## Usage
### As a library
In your Python project, import the helper class and run `run_command_with_progress`.
For more information see the [API documentation](https://htmlpreview.github.io/?https://github.com/slhck/ffmpeg-progress-yield/blob/master/docs/ffmpeg_progress_yield.html).
Example:
```python
from ffmpeg_progress_yield import FfmpegProgress
cmd = [
"ffmpeg", "-i", "test/test.mp4", "-c:v", "libx264", "-vf", "scale=1920x1080", "-preset", "fast", "-f", "null", "/dev/null",
]
ff = FfmpegProgress(cmd)
for progress in ff.run_command_with_progress():
print(f"{progress}/100")
```
The command will yield the current progress in percent as a float number.
`run_command_with_progress` takes a `duration_override` argument where you can manually override the duration of the command in seconds. This is useful if your input doesn't have an implicit duration (e.g. if you use `testsrc`).
If you have `tqdm` installed, you can create a fancy progress bar:
```python
from tqdm import tqdm
from ffmpeg_progress_yield import FfmpegProgress
cmd = [
"ffmpeg", "-i", "test/test.mp4", "-c:v", "libx264", "-vf", "scale=1920x1080", "-preset", "fast", "-f", "null", "/dev/null",
]
ff = FfmpegProgress(cmd)
with tqdm(total=100, position=1, desc="Test") as pbar:
for progress in ff.run_command_with_progress():
pbar.update(progress - pbar.n)
# get the output
print(ff.stderr)
```
You can also quit the command by calling `.quit()`:
```python
ff = FfmpegProgress(cmd)
for progress in ff.run_command_with_progress():
if progress > 50:
ff.quit()
break
```
This will send a hard quit to the ffmpeg process, and may not wait for it to finish. To quit gracefully, use `.quit_gracefully()` instead, which sends 'q' to the ffmpeg process, and waits for it to finish.
This is probably most useful in asynchronous environments, where you can run the command in a separate thread, and quit it from the main thread (e.g. using a [Condition Variable](https://docs.python.org/3/library/threading.html#threading.Condition)).
### On the command line
Simply prefix your ffmpeg command with `ffmpeg-progress-yield`:
```bash
ffmpeg-progress-yield ffmpeg -i input.mp4 output.mp4
```
It will show a progress bar, and once the command is done, show the ffmpeg stderr output.
If you want to manually override the duration to, say, 12.5 seconds (e.g. because your input doesn't have an implicit one):
```bash
ffmpeg-progress-yield --duration 12.5 ffmpeg -f lavfi -i testsrc -t 12.5 output.mp4
```
## Caveats
Currently, we do not differentiate between `stderr` and `stdout`. This means progress will be mixed with the ffmpeg log.
You can also check out [`ffmpeg-progress`](https://github.com/Tatsh/ffmpeg-progress) for a similar project with a different feature set.
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://slhck.info/"><img src="https://avatars.githubusercontent.com/u/582444?v=4?s=100" width="100px;" alt="Werner Robitza"/><br /><sub><b>Werner Robitza</b></sub></a><br /><a href="https://github.com/slhck/ffmpeg-progress-yield/commits?author=slhck" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/WyattBlue"><img src="https://avatars.githubusercontent.com/u/57511737?v=4?s=100" width="100px;" alt="WyattBlue"/><br /><sub><b>WyattBlue</b></sub></a><br /><a href="https://github.com/slhck/ffmpeg-progress-yield/commits?author=WyattBlue" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kskadart"><img src="https://avatars.githubusercontent.com/u/120260513?v=4?s=100" width="100px;" alt="Kirill Konovalov"/><br /><sub><b>Kirill Konovalov</b></sub></a><br /><a href="https://github.com/slhck/ffmpeg-progress-yield/commits?author=kskadart" title="Code">💻</a></td>
</tr>
</tbody>
<tfoot>
<tr>
<td align="center" size="13px" colspan="7">
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
</img>
</td>
</tr>
</tfoot>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
## License
The MIT License (MIT)
Copyright (c) 2021-2023 Werner Robitza
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# Changelog
## v0.7.8 (2023-06-01)
* Image handling.
Check if image2 inputs use looping or not, and set duration to infinity if needed
## v0.7.6 (2023-05-30)
* Always use duration_override if present.
## v0.7.5 (2023-05-30)
* Fix duration for multiple inputs, fixes #13.
* Fix 'Test' string in tqdm.
## v0.7.4 (2023-05-06)
* Fix: round percentage numbers.
## v0.7.3 (2023-05-05)
* Update readme.
* Add progress as percent, fixes #12.
## v0.7.2 (2023-03-04)
* Do not print input information when probing, addresses #10.
## v0.7.1 (2023-02-24)
* Fix types in CI.
* Remove unneeded import.
* Typo.
* Docs: add @kskadart as a contributor.
* Fix formatting.
* Fix types.
* Feat(ffprobe): FEAT-0001 try to get duration by ffprobe in case if loglevel=error.
* Fix CI file.
## v0.7.0 (2023-01-24)
* Add duration override to API.
* Remove manifest.in.
* Add mypy settings.
## v0.6.1 (2022-12-18)
* Add py.typed.
* Move API docs to existing section.
## v0.6.0 (2022-12-17)
* Link to API docs.
* Add API docs.
* Add export.
* Bump requirements to python 3.8 or higher.
* Document methods.
* Remove unused import.
* Docs: add @WyattBlue as a contributor.
* Docs: add @slhck as a contributor.
* Unhide to_ms.
* Add type hints + simplify.
* Add python CI badge.
* Fix quit tests.
* Add all-contributors.
* Add pytest to dev requirements.
* Add github workflows.
* Formatting.
* Fix a few type and formatting errors.
## v0.5.0 (2022-12-12)
* Add stderr callback method.
* Update README.
* Add graceful quit method.
* Add a GIF in the readme.
## v0.4.0 (2022-12-11)
* Add a quit method, fixes #4.
## v0.3.0 (2022-08-02)
* Update python requirements.
## v0.2.0 (2021-11-21)
* Add a usage option.
## v0.1.2 (2021-08-14)
* Remove universal_newlines for Windows compat.
## v0.1.1 (2021-07-01)
* Remove stats_period option for backwards compatibility, fixes #2.
## v0.1.0 (2021-06-30)
* Format code with black.
* Yield 0 in progress and improve logic.
* Set universal_newlines to true and add kwargs support.
* Increase stats period.
* Document method.
* Add typing.
* Also check for 0 in output.
* Update gitignore.
* Drop python 3.5 support.
* Update badge link.
## v0.0.4 (2021-03-10)
* Add python_requires to setup.py.
## v0.0.3 (2021-03-06)
* Remove release script.
## v0.0.2 (2021-03-06)
* Fix release script.
* Remove support for older versions.
* Format setup.py.
* Remove requirement for command to start with ffmpeg.
* Add link to similar project.
* Add changelog.
* Rename project.
* Initial commit.
Raw data
{
"_id": null,
"home_page": "https://github.com/slhck/ffmpeg-progress-yield",
"name": "ffmpeg-progress-yield",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ffmpeg",
"author": "Werner Robitza",
"author_email": "werner.robitza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/42/4d4a0471c56e7c493bb919b3518a7390f2f6b5110fd00bde909f97883807/ffmpeg-progress-yield-0.7.8.tar.gz",
"platform": null,
"description": "# ffmpeg-progress-yield\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[](#contributors-)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n[](https://pypi.org/project/ffmpeg-progress-yield) [](https://github.com/slhck/ffmpeg-normalize/actions/workflows/python-package.yml)\n\nRun an ffmpeg command with its progress yielded.\n\n\n\nContents:\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n - [As a library](#as-a-library)\n - [On the command line](#on-the-command-line)\n- [Caveats](#caveats)\n- [Contributors](#contributors)\n- [License](#license)\n\n-------------\n\n## Requirements\n\n- Python 3.8 or higher\n- ffmpeg v3.1 or above from <http://ffmpeg.org/> installed in your \\$PATH\n\n## Installation\n\n pip3 install ffmpeg-progress-yield\n\nOr download this repository, then run `pip install .`.\n\n## Usage\n\n### As a library\n\nIn your Python project, import the helper class and run `run_command_with_progress`.\n\nFor more information see the [API documentation](https://htmlpreview.github.io/?https://github.com/slhck/ffmpeg-progress-yield/blob/master/docs/ffmpeg_progress_yield.html).\n\nExample:\n\n```python\nfrom ffmpeg_progress_yield import FfmpegProgress\n\ncmd = [\n \"ffmpeg\", \"-i\", \"test/test.mp4\", \"-c:v\", \"libx264\", \"-vf\", \"scale=1920x1080\", \"-preset\", \"fast\", \"-f\", \"null\", \"/dev/null\",\n]\n\nff = FfmpegProgress(cmd)\nfor progress in ff.run_command_with_progress():\n print(f\"{progress}/100\")\n```\n\nThe command will yield the current progress in percent as a float number.\n\n`run_command_with_progress` takes a `duration_override` argument where you can manually override the duration of the command in seconds. This is useful if your input doesn't have an implicit duration (e.g. if you use `testsrc`).\n\nIf you have `tqdm` installed, you can create a fancy progress bar:\n\n```python\nfrom tqdm import tqdm\nfrom ffmpeg_progress_yield import FfmpegProgress\n\ncmd = [\n \"ffmpeg\", \"-i\", \"test/test.mp4\", \"-c:v\", \"libx264\", \"-vf\", \"scale=1920x1080\", \"-preset\", \"fast\", \"-f\", \"null\", \"/dev/null\",\n]\n\nff = FfmpegProgress(cmd)\nwith tqdm(total=100, position=1, desc=\"Test\") as pbar:\n for progress in ff.run_command_with_progress():\n pbar.update(progress - pbar.n)\n\n# get the output\nprint(ff.stderr)\n```\n\nYou can also quit the command by calling `.quit()`:\n\n```python\nff = FfmpegProgress(cmd)\nfor progress in ff.run_command_with_progress():\n if progress > 50:\n ff.quit()\n break\n```\n\nThis will send a hard quit to the ffmpeg process, and may not wait for it to finish. To quit gracefully, use `.quit_gracefully()` instead, which sends 'q' to the ffmpeg process, and waits for it to finish.\n\nThis is probably most useful in asynchronous environments, where you can run the command in a separate thread, and quit it from the main thread (e.g. using a [Condition Variable](https://docs.python.org/3/library/threading.html#threading.Condition)).\n\n### On the command line\n\nSimply prefix your ffmpeg command with `ffmpeg-progress-yield`:\n\n```bash\nffmpeg-progress-yield ffmpeg -i input.mp4 output.mp4\n```\n\nIt will show a progress bar, and once the command is done, show the ffmpeg stderr output.\n\nIf you want to manually override the duration to, say, 12.5 seconds (e.g. because your input doesn't have an implicit one):\n\n```bash\nffmpeg-progress-yield --duration 12.5 ffmpeg -f lavfi -i testsrc -t 12.5 output.mp4\n```\n\n## Caveats\n\nCurrently, we do not differentiate between `stderr` and `stdout`. This means progress will be mixed with the ffmpeg log.\n\nYou can also check out [`ffmpeg-progress`](https://github.com/Tatsh/ffmpeg-progress) for a similar project with a different feature set.\n\n## Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://slhck.info/\"><img src=\"https://avatars.githubusercontent.com/u/582444?v=4?s=100\" width=\"100px;\" alt=\"Werner Robitza\"/><br /><sub><b>Werner Robitza</b></sub></a><br /><a href=\"https://github.com/slhck/ffmpeg-progress-yield/commits?author=slhck\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/WyattBlue\"><img src=\"https://avatars.githubusercontent.com/u/57511737?v=4?s=100\" width=\"100px;\" alt=\"WyattBlue\"/><br /><sub><b>WyattBlue</b></sub></a><br /><a href=\"https://github.com/slhck/ffmpeg-progress-yield/commits?author=WyattBlue\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/kskadart\"><img src=\"https://avatars.githubusercontent.com/u/120260513?v=4?s=100\" width=\"100px;\" alt=\"Kirill Konovalov\"/><br /><sub><b>Kirill Konovalov</b></sub></a><br /><a href=\"https://github.com/slhck/ffmpeg-progress-yield/commits?author=kskadart\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n <tfoot>\n <tr>\n <td align=\"center\" size=\"13px\" colspan=\"7\">\n <img src=\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\">\n <a href=\"https://all-contributors.js.org/docs/en/bot/usage\">Add your contributions</a>\n </img>\n </td>\n </tr>\n </tfoot>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2021-2023 Werner Robitza\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n# Changelog\n\n\n## v0.7.8 (2023-06-01)\n\n* Image handling.\n\n Check if image2 inputs use looping or not, and set duration to infinity if needed\n\n\n## v0.7.6 (2023-05-30)\n\n* Always use duration_override if present.\n\n\n## v0.7.5 (2023-05-30)\n\n* Fix duration for multiple inputs, fixes #13.\n\n* Fix 'Test' string in tqdm.\n\n\n## v0.7.4 (2023-05-06)\n\n* Fix: round percentage numbers.\n\n\n## v0.7.3 (2023-05-05)\n\n* Update readme.\n\n* Add progress as percent, fixes #12.\n\n\n## v0.7.2 (2023-03-04)\n\n* Do not print input information when probing, addresses #10.\n\n\n## v0.7.1 (2023-02-24)\n\n* Fix types in CI.\n\n* Remove unneeded import.\n\n* Typo.\n\n* Docs: add @kskadart as a contributor.\n\n* Fix formatting.\n\n* Fix types.\n\n* Feat(ffprobe): FEAT-0001 try to get duration by ffprobe in case if loglevel=error.\n\n* Fix CI file.\n\n\n## v0.7.0 (2023-01-24)\n\n* Add duration override to API.\n\n* Remove manifest.in.\n\n* Add mypy settings.\n\n\n## v0.6.1 (2022-12-18)\n\n* Add py.typed.\n\n* Move API docs to existing section.\n\n\n## v0.6.0 (2022-12-17)\n\n* Link to API docs.\n\n* Add API docs.\n\n* Add export.\n\n* Bump requirements to python 3.8 or higher.\n\n* Document methods.\n\n* Remove unused import.\n\n* Docs: add @WyattBlue as a contributor.\n\n* Docs: add @slhck as a contributor.\n\n* Unhide to_ms.\n\n* Add type hints + simplify.\n\n* Add python CI badge.\n\n* Fix quit tests.\n\n* Add all-contributors.\n\n* Add pytest to dev requirements.\n\n* Add github workflows.\n\n* Formatting.\n\n* Fix a few type and formatting errors.\n\n\n## v0.5.0 (2022-12-12)\n\n* Add stderr callback method.\n\n* Update README.\n\n* Add graceful quit method.\n\n* Add a GIF in the readme.\n\n\n## v0.4.0 (2022-12-11)\n\n* Add a quit method, fixes #4.\n\n\n## v0.3.0 (2022-08-02)\n\n* Update python requirements.\n\n\n## v0.2.0 (2021-11-21)\n\n* Add a usage option.\n\n\n## v0.1.2 (2021-08-14)\n\n* Remove universal_newlines for Windows compat.\n\n\n## v0.1.1 (2021-07-01)\n\n* Remove stats_period option for backwards compatibility, fixes #2.\n\n\n## v0.1.0 (2021-06-30)\n\n* Format code with black.\n\n* Yield 0 in progress and improve logic.\n\n* Set universal_newlines to true and add kwargs support.\n\n* Increase stats period.\n\n* Document method.\n\n* Add typing.\n\n* Also check for 0 in output.\n\n* Update gitignore.\n\n* Drop python 3.5 support.\n\n* Update badge link.\n\n\n## v0.0.4 (2021-03-10)\n\n* Add python_requires to setup.py.\n\n\n## v0.0.3 (2021-03-06)\n\n* Remove release script.\n\n\n## v0.0.2 (2021-03-06)\n\n* Fix release script.\n\n* Remove support for older versions.\n\n* Format setup.py.\n\n* Remove requirement for command to start with ffmpeg.\n\n* Add link to similar project.\n\n* Add changelog.\n\n* Rename project.\n\n* Initial commit.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Run an ffmpeg command with progress",
"version": "0.7.8",
"project_urls": {
"Homepage": "https://github.com/slhck/ffmpeg-progress-yield"
},
"split_keywords": [
"ffmpeg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eab6ba9d4b4ca272222f2858c8d2fac6ca9d74fb6494ea0449a3a07dafc07c56",
"md5": "30569f47c1f8b6a48d688faad10096f9",
"sha256": "732ef90d78f8b5c0b78be289050589299d128d03063be55a9deab80d67319a21"
},
"downloads": -1,
"filename": "ffmpeg_progress_yield-0.7.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "30569f47c1f8b6a48d688faad10096f9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 10447,
"upload_time": "2023-06-01T07:00:17",
"upload_time_iso_8601": "2023-06-01T07:00:17.751114Z",
"url": "https://files.pythonhosted.org/packages/ea/b6/ba9d4b4ca272222f2858c8d2fac6ca9d74fb6494ea0449a3a07dafc07c56/ffmpeg_progress_yield-0.7.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec424d4a0471c56e7c493bb919b3518a7390f2f6b5110fd00bde909f97883807",
"md5": "e9529e84f76ea31f7a45fdd436493d11",
"sha256": "9ae6ae5f832ae7c7b0f6518f1341fe6eee1ba8fc9d3400cba1cba38f2eaa461e"
},
"downloads": -1,
"filename": "ffmpeg-progress-yield-0.7.8.tar.gz",
"has_sig": false,
"md5_digest": "e9529e84f76ea31f7a45fdd436493d11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 45543,
"upload_time": "2023-06-01T07:00:19",
"upload_time_iso_8601": "2023-06-01T07:00:19.235737Z",
"url": "https://files.pythonhosted.org/packages/ec/42/4d4a0471c56e7c493bb919b3518a7390f2f6b5110fd00bde909f97883807/ffmpeg-progress-yield-0.7.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 07:00:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "slhck",
"github_project": "ffmpeg-progress-yield",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ffmpeg-progress-yield"
}
JSON
