# Bufferer
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[](https://pypi.org/project/bufferer)
[](https://github.com/slhck/bufferer/actions/workflows/python-package.yml)
Inserts fake rebuffering events into video, optionally with skipping frames.
Author: Werner Robitza <werner.robitza@gmail.com>
Contents:
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Caveats](#caveats)
- [API](#api)
- [Acknowledgements](#acknowledgements)
- [Helpful info](#helpful-info)
- [Contributors](#contributors)
- [License](#license)
## Requirements
- Python 3.8 or higher
- FFmpeg:
- download a static build from [their website](http://ffmpeg.org/download.html))
- put the `ffmpeg` executable in your `$PATH`
## Installation
pip3 install bufferer
Or clone this repository, then run the tool with `python -m bufferer`.
## Usage
```
bufferer [-hfne] -i <input> -b <buflist> -o <output>
[-v <vcodec>] [-a <acodec>]
[-x <pixfmt>]
[-s <spinner>] [--disable-spinner] [-p <speed>]
[-t <trim>]
[-r <brightness>]
[-l <blur>]
[--audio-disable]
[--black-frame]
[--force-framerate]
[--skipping]
[--verbose] [--version]
-h --help show help message
-f --force force overwrite output files
-n --dry-run only print final command, do not run
-i --input <input> input video file
-b --buflist <buflist> list of buffering events in format "[[x1,y1], [x2,y2],...]" or
"[x1,y1], [x2,y2], ..." where x = position of event in seconds, y = duration of event
-o --output <output> output video file
-v --vcodec <vcodec> video encoder to use (see `ffmpeg -encoders`) [default: ffv1]
-a --acodec <acodec> audio encoder to use (see `ffmpeg -encoders`) [default: pcm_s16le]
-x --pixfmt <pixfmt> set pixel format for output [default: yuv420p]
-s --spinner <spinner> path to spinner animated file or video [default: spinners/spinner-256-white.png]
-e --disable-spinner disable spinner, just show stopped video
-p --speed <speed> speed of the spinner, rounded to integer [default: 2]
-t --trim <trim> trim video to length in seconds or "HH:MM:SS.msec" format
-r --brightness <brightness> change brightness during buffering, use values between -1.0 and 1.0 [default: 0.0]
-l --blur <blur> change blur during buffering, value specifies kernel size [default: 5]
-c --black-frame start with a black frame if there is buffering at position 0.0
--audio-disable disable audio for the output, even if input contains audio
--force-framerate force output framerate to be the same as the input video file
--skipping insert frame freezes with skipping (without indicator) at the <buflist> locations and durations
--verbose show verbose output
--version show version
```
## Caveats
- The time stamps for the buffering list must be given in media time. If, for example, you want an initial loading time of 5 seconds, and then a stalling event to occur 10 seconds into the video, specify `[[0, 5], [10, 5]]`.
- You need to pick a proper output file format for the codecs you choose. Use `.avi` for the FFV1 and PCM WAV defaults.
- Make sure to select the right pixel format as output, e.g. `--pixfmt yuv420p` for higher compatibility.
## API
The program exposes an API that you can use yourself:
```python
from bufferer import Bufferer
b = Bufferer(input_video, output_video, buflist=[[0, 5], [10, 5]])
b.insert_buf_audiovisual()
```
For more usage please read [the docs](https://htmlpreview.github.io/?https://github.com/slhck/bufferer/blob/master/docs/bufferer.html).
## Acknowledgements
- Big Buck Bunny: Blender Foundation
- Free spinners from http://preloaders.net/en/free
- Click from http://metronomer.com/
- Count from https://www.youtube.com/watch?v=U03lLvhBzOw
## Helpful info
To generate AV sync samples:
```bash
ffmpeg \
-y \
-f lavfi -i testsrc=duration=60:size=320x240:rate=60,format=pix_fmts=yuv420p \
-i click_and_count.m4a
<output>
```
A sample for input:
```bash
ffmpeg -y -f lavfi \
-i testsrc=duration=10:size=640x480:rate=60,format=pix_fmts=yuv420p \
-i spinners/click_and_count.m4a \
-vf 'drawtext=fontfile=/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf:text=%{n}:fontsize=72:r=60:x=(w-tw)/2: y=h-(2*lh): fontcolor=white: box=1: boxcolor=0x00000099' \
-shortest \
-c:v libx264 -preset ultrafast \
-c:a copy \
test/tmp.mp4
```
Sample command to test buffering:
```bash
ffmpeg \
-y \
-f lavfi -i testsrc=duration=60:size=320x240:rate=60,format=pix_fmts=yuv420p \
-i spinners/click_and_count.m4a \
-filter_complex " \
[0:v] \
loop=loop=240:size=1:start=0, setpts=N/FRAME_RATE/TB, \
loop=loop=30:size=1:start=840, setpts=N/FRAME_RATE/TB, \
loop=loop=84:size=1:start=1140, setpts=N/FRAME_RATE/TB, \
loop=loop=48:size=1:start=1548, setpts=N/FRAME_RATE/TB \
[stallvid]; \
movie=filename=spinners/spinner-64-white.png:loop=0, setpts=N/(FRAME_RATE*TB)*2 \
[spinner]; \
[stallvid][spinner] \
overlay=(main_w-overlay_w)/2:(main_h-overlay_h)/2:shortest=1:\
enable='between(t,0,4.0)+between(t,14.0,14.5)+between(t,19.0,20.4)+between(t,25.8,26.6)' \
[outv];
[1:a] \
aloop=loop=192000:size=1:start=0, asetpts=N/SAMPLE_RATE/TB, \
aloop=loop=24000:size=1:start=672000, asetpts=N/SAMPLE_RATE/TB, \
aloop=loop=67200:size=1:start=912000, asetpts=N/SAMPLE_RATE/TB, \
aloop=loop=38400:size=1:start=1238399, asetpts=N/SAMPLE_RATE/TB, \
volume=0:enable='between(t,0,4.0)+between(t,14.0,14.5)+between(t,19.0,20.4)+between(t,25.8,26.6)' \
[outa] \
" -shortest -map "[outv]" -map "[outa]" output.mp4
```
## 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="https://github.com/davidlindero"><img src="https://avatars.githubusercontent.com/u/5320473?v=4?s=100" width="100px;" alt="David Lindero"/><br /><sub><b>David Lindero</b></sub></a><br /><a href="https://github.com/slhck/bufferer/commits?author=davidlindero" 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
bufferer, Copyright (c) 2017-2022 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/slhck/bufferer",
"name": "bufferer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Werner Robitza",
"author_email": "werner.robitza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f6/a1/bf5538de12e08f10de50181c4de6e6f177736642ef5542fc068e9392d4b9/bufferer-0.22.1.tar.gz",
"platform": null,
"description": "# Bufferer\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/bufferer)\n\n[](https://github.com/slhck/bufferer/actions/workflows/python-package.yml)\n\nInserts fake rebuffering events into video, optionally with skipping frames.\n\nAuthor: Werner Robitza <werner.robitza@gmail.com>\n\n\n\nContents:\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Caveats](#caveats)\n- [API](#api)\n- [Acknowledgements](#acknowledgements)\n- [Helpful info](#helpful-info)\n- [Contributors](#contributors)\n- [License](#license)\n\n## Requirements\n\n- Python 3.8 or higher\n- FFmpeg:\n - download a static build from [their website](http://ffmpeg.org/download.html))\n - put the `ffmpeg` executable in your `$PATH`\n\n## Installation\n\n pip3 install bufferer\n\nOr clone this repository, then run the tool with `python -m bufferer`.\n\n## Usage\n\n```\nbufferer [-hfne] -i <input> -b <buflist> -o <output>\n [-v <vcodec>] [-a <acodec>]\n [-x <pixfmt>]\n [-s <spinner>] [--disable-spinner] [-p <speed>]\n [-t <trim>]\n [-r <brightness>]\n [-l <blur>]\n [--audio-disable]\n [--black-frame]\n [--force-framerate]\n [--skipping]\n [--verbose] [--version]\n\n-h --help show help message\n-f --force force overwrite output files\n-n --dry-run only print final command, do not run\n-i --input <input> input video file\n-b --buflist <buflist> list of buffering events in format \"[[x1,y1], [x2,y2],...]\" or\n \"[x1,y1], [x2,y2], ...\" where x = position of event in seconds, y = duration of event\n-o --output <output> output video file\n-v --vcodec <vcodec> video encoder to use (see `ffmpeg -encoders`) [default: ffv1]\n-a --acodec <acodec> audio encoder to use (see `ffmpeg -encoders`) [default: pcm_s16le]\n-x --pixfmt <pixfmt> set pixel format for output [default: yuv420p]\n-s --spinner <spinner> path to spinner animated file or video [default: spinners/spinner-256-white.png]\n-e --disable-spinner disable spinner, just show stopped video\n-p --speed <speed> speed of the spinner, rounded to integer [default: 2]\n-t --trim <trim> trim video to length in seconds or \"HH:MM:SS.msec\" format\n-r --brightness <brightness> change brightness during buffering, use values between -1.0 and 1.0 [default: 0.0]\n-l --blur <blur> change blur during buffering, value specifies kernel size [default: 5]\n-c --black-frame start with a black frame if there is buffering at position 0.0\n--audio-disable disable audio for the output, even if input contains audio\n--force-framerate force output framerate to be the same as the input video file\n--skipping insert frame freezes with skipping (without indicator) at the <buflist> locations and durations\n--verbose show verbose output\n--version show version\n```\n\n## Caveats\n\n- The time stamps for the buffering list must be given in media time. If, for example, you want an initial loading time of 5 seconds, and then a stalling event to occur 10 seconds into the video, specify `[[0, 5], [10, 5]]`.\n- You need to pick a proper output file format for the codecs you choose. Use `.avi` for the FFV1 and PCM WAV defaults.\n- Make sure to select the right pixel format as output, e.g. `--pixfmt yuv420p` for higher compatibility.\n\n## API\n\nThe program exposes an API that you can use yourself:\n\n```python\nfrom bufferer import Bufferer\n\nb = Bufferer(input_video, output_video, buflist=[[0, 5], [10, 5]])\nb.insert_buf_audiovisual()\n```\n\nFor more usage please read [the docs](https://htmlpreview.github.io/?https://github.com/slhck/bufferer/blob/master/docs/bufferer.html).\n\n## Acknowledgements\n\n- Big Buck Bunny: Blender Foundation\n- Free spinners from http://preloaders.net/en/free\n- Click from http://metronomer.com/\n- Count from https://www.youtube.com/watch?v=U03lLvhBzOw\n\n## Helpful info\n\nTo generate AV sync samples:\n\n```bash\nffmpeg \\\n-y \\\n-f lavfi -i testsrc=duration=60:size=320x240:rate=60,format=pix_fmts=yuv420p \\\n-i click_and_count.m4a\n<output>\n```\n\nA sample for input:\n\n```bash\nffmpeg -y -f lavfi \\\n -i testsrc=duration=10:size=640x480:rate=60,format=pix_fmts=yuv420p \\\n -i spinners/click_and_count.m4a \\\n -vf 'drawtext=fontfile=/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf:text=%{n}:fontsize=72:r=60:x=(w-tw)/2: y=h-(2*lh): fontcolor=white: box=1: boxcolor=0x00000099' \\\n -shortest \\\n -c:v libx264 -preset ultrafast \\\n -c:a copy \\\n test/tmp.mp4\n```\n\nSample command to test buffering:\n\n```bash\nffmpeg \\\n-y \\\n-f lavfi -i testsrc=duration=60:size=320x240:rate=60,format=pix_fmts=yuv420p \\\n-i spinners/click_and_count.m4a \\\n-filter_complex \" \\\n [0:v] \\\n loop=loop=240:size=1:start=0, setpts=N/FRAME_RATE/TB, \\\n loop=loop=30:size=1:start=840, setpts=N/FRAME_RATE/TB, \\\n loop=loop=84:size=1:start=1140, setpts=N/FRAME_RATE/TB, \\\n loop=loop=48:size=1:start=1548, setpts=N/FRAME_RATE/TB \\\n [stallvid]; \\\n movie=filename=spinners/spinner-64-white.png:loop=0, setpts=N/(FRAME_RATE*TB)*2 \\\n [spinner]; \\\n [stallvid][spinner] \\\n overlay=(main_w-overlay_w)/2:(main_h-overlay_h)/2:shortest=1:\\\n enable='between(t,0,4.0)+between(t,14.0,14.5)+between(t,19.0,20.4)+between(t,25.8,26.6)' \\\n [outv];\n [1:a] \\\n aloop=loop=192000:size=1:start=0, asetpts=N/SAMPLE_RATE/TB, \\\n aloop=loop=24000:size=1:start=672000, asetpts=N/SAMPLE_RATE/TB, \\\n aloop=loop=67200:size=1:start=912000, asetpts=N/SAMPLE_RATE/TB, \\\n aloop=loop=38400:size=1:start=1238399, asetpts=N/SAMPLE_RATE/TB, \\\n volume=0:enable='between(t,0,4.0)+between(t,14.0,14.5)+between(t,19.0,20.4)+between(t,25.8,26.6)' \\\n [outa] \\\n\" -shortest -map \"[outv]\" -map \"[outa]\" output.mp4\n```\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=\"https://github.com/davidlindero\"><img src=\"https://avatars.githubusercontent.com/u/5320473?v=4?s=100\" width=\"100px;\" alt=\"David Lindero\"/><br /><sub><b>David Lindero</b></sub></a><br /><a href=\"https://github.com/slhck/bufferer/commits?author=davidlindero\" 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\nbufferer, Copyright (c) 2017-2022 Werner Robitza\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Insert fake buffering events into video files.",
"version": "0.22.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b57be542c70cb66beb2cfaaa8d1d861f50643e4fabe02c2ac4024c0921cc37bb",
"md5": "06da62e3ffbf29078fbfe2ee6c054660",
"sha256": "c94a9f708b44e9c17bea403137844976fc3cba9a461b93588bada08024464d6d"
},
"downloads": -1,
"filename": "bufferer-0.22.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "06da62e3ffbf29078fbfe2ee6c054660",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 13059,
"upload_time": "2023-01-08T15:51:23",
"upload_time_iso_8601": "2023-01-08T15:51:23.321882Z",
"url": "https://files.pythonhosted.org/packages/b5/7b/e542c70cb66beb2cfaaa8d1d861f50643e4fabe02c2ac4024c0921cc37bb/bufferer-0.22.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6a1bf5538de12e08f10de50181c4de6e6f177736642ef5542fc068e9392d4b9",
"md5": "705c9318b54820746e8cc8da7f671684",
"sha256": "c5eb01dfc602ecf6ffdd73515b367c2854b439d77798f04b0093a8d256742220"
},
"downloads": -1,
"filename": "bufferer-0.22.1.tar.gz",
"has_sig": false,
"md5_digest": "705c9318b54820746e8cc8da7f671684",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1156769,
"upload_time": "2023-01-08T15:51:25",
"upload_time_iso_8601": "2023-01-08T15:51:25.455548Z",
"url": "https://files.pythonhosted.org/packages/f6/a1/bf5538de12e08f10de50181c4de6e6f177736642ef5542fc068e9392d4b9/bufferer-0.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-08 15:51:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "slhck",
"github_project": "bufferer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bufferer"
}
JSON
