blurbox 0.1.0__tar.gz

blurbox-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+# Generated by blurbox_shortcut.ps1; holds paths specific to one PC
+*.lnk
+__pycache__/
+.venv/
+.pytest_cache/

blurbox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raffaele Mancuso
+
+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.

blurbox-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.5
+Name: blurbox
+Version: 0.1.0
+Summary: Cover areas of a video with a black box, blur or pixelation: a desktop GUI around ffmpeg
+Author: Raffaele Mancuso
+License-Expression: MIT
+License-File: LICENSE
+Keywords: anonymize,blur,ffmpeg,gui,pixelate,redact,video
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: X11 Applications
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Conversion
+Requires-Python: >=3.11
+Requires-Dist: av>=18
+Requires-Dist: pillow>=10
+Description-Content-Type: text/markdown
+
+# blurbox
+
+A small desktop tool to hide parts of a video: draw one or more rectangles on
+the frame and cover each with a black box, a blur or pixelation, for the
+whole video or only during chosen time ranges. It is a GUI around ffmpeg and
+runs on Windows and Linux.
+
+## Requirements
+
+- Python 3.11 or newer
+- ffmpeg and ffprobe on `PATH` (they are separate programs, not installed
+  with blurbox); a full build is recommended, so the encoders used to keep
+  the source codec (libx265, libsvtav1, libvpx-vp9, libopus) are available.
+  On Windows, e.g. the "full" build from [gyan.dev](https://www.gyan.dev/ffmpeg/builds/);
+  on Linux, your distribution's `ffmpeg` package
+- Tk: included with Python on Windows; on Linux `pacman -S tk` (Arch) or
+  `apt install python3-tk` (Debian/Ubuntu)
+
+## Installing
+
+With [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/), which
+put the `blurbox` command on your `PATH` in an environment of its own:
+
+```sh
+uv tool install blurbox
+# or
+pipx install blurbox
+```
+
+Then start it, optionally with a video or a project file to open:
+
+```sh
+blurbox [video | project.json]
+```
+
+On Windows the command starts without a console window.
+
+## Running from a source checkout
+
+```sh
+uv run --script blurbox.py [video | project.json]
+```
+
+On Windows, `blurbox_shortcut.ps1` creates `blurbox.lnk`,
+a shortcut that starts the tool without a console window; add `-Desktop` for
+a copy on the Desktop. Drop a video or a project onto the shortcut to open
+it. Rerun the script after reinstalling uv or moving this folder, since a
+shortcut stores absolute paths.
+
+## Using it
+
+- **Areas**: drag on the frame to draw the selected area, drag inside any
+  area to select and move it, drag an edge or corner of the selected area
+  (it shows white handles) to resize it, "New area" to add another. The
+  mouse cursor shows which of these a drag will do. Each area has its own
+  effect, strength and time ranges; with no ranges it covers the whole
+  video.
+- **Whole frame**: tick it to make the selected area cover the entire
+  picture (e.g. blur everything from 0:12 to 0:15); untick it to get its
+  rectangle back.
+- **Seeking**: click or drag the timeline, use the step buttons (hold them
+  to repeat), or the keys ←/→ (1 s) and Shift+←/→ (one frame).
+- **Time ranges**: I and O put the current time in Start and End, Enter adds
+  the range, a double-click on a range edits it, Esc cancels the edit. The
+  timeline shows the selected area's ranges in red, the others' in grey.
+- **Show effect** (E) draws every active area's effect on the frame, using
+  the same ffmpeg filters as the render.
+- **Projects**: Ctrl+S saves the areas, quality and position as JSON,
+  Ctrl+O opens a project. The video is found relative to the project file
+  first, so a folder with both can be moved to another PC.
+
+## Output
+
+The render keeps the source's codec family (H.264, HEVC, VP9, AV1), bit depth
+and colour metadata (HDR included), every audio track, subtitles and chapters.
+Anything the chosen container cannot hold is converted (losslessly where
+possible) or left out, and a dialog lists it before rendering starts.
+
+The quality setting is x264/x265-style CRF: lower means better and larger.
+The same number looks better with HEVC than with H.264, so 22–24 is usually
+enough for HEVC sources.
+
+## Development
+
+```sh
+uv sync            # creates .venv with the dependencies and pytest
+uv run pytest      # the test suite, about 20 s
+```
+
+`pyproject.toml` repeats the dependencies of the script's inline metadata
+(which `uv run --script` and the shortcut use); keep the two in sync.
+
+The tests are in three files:
+
+- `tests/test_logic.py`: time parsing, areas, filtergraphs and the stream
+  plan, with no ffmpeg run
+- `tests/test_media.py`: builds small videos with ffmpeg once per session,
+  then checks probing, frame reading against a plain sequential decode, the
+  live preview against the real render frame by frame, 10-bit and HDR
+  preservation, and the streams in rendered files
+- `tests/test_app.py`: drives the GUI through real Tk events (areas, ranges,
+  keys, seeking, projects); needs a display
+
+Tests that need ffmpeg or a display are skipped when these are missing;
+`-m "not gui"` or `-m "not media"` deselects them explicitly.

blurbox-0.1.0/README.md

@@ -0,0 +1,105 @@
+# blurbox
+
+A small desktop tool to hide parts of a video: draw one or more rectangles on
+the frame and cover each with a black box, a blur or pixelation, for the
+whole video or only during chosen time ranges. It is a GUI around ffmpeg and
+runs on Windows and Linux.
+
+## Requirements
+
+- Python 3.11 or newer
+- ffmpeg and ffprobe on `PATH` (they are separate programs, not installed
+  with blurbox); a full build is recommended, so the encoders used to keep
+  the source codec (libx265, libsvtav1, libvpx-vp9, libopus) are available.
+  On Windows, e.g. the "full" build from [gyan.dev](https://www.gyan.dev/ffmpeg/builds/);
+  on Linux, your distribution's `ffmpeg` package
+- Tk: included with Python on Windows; on Linux `pacman -S tk` (Arch) or
+  `apt install python3-tk` (Debian/Ubuntu)
+
+## Installing
+
+With [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/), which
+put the `blurbox` command on your `PATH` in an environment of its own:
+
+```sh
+uv tool install blurbox
+# or
+pipx install blurbox
+```
+
+Then start it, optionally with a video or a project file to open:
+
+```sh
+blurbox [video | project.json]
+```
+
+On Windows the command starts without a console window.
+
+## Running from a source checkout
+
+```sh
+uv run --script blurbox.py [video | project.json]
+```
+
+On Windows, `blurbox_shortcut.ps1` creates `blurbox.lnk`,
+a shortcut that starts the tool without a console window; add `-Desktop` for
+a copy on the Desktop. Drop a video or a project onto the shortcut to open
+it. Rerun the script after reinstalling uv or moving this folder, since a
+shortcut stores absolute paths.
+
+## Using it
+
+- **Areas**: drag on the frame to draw the selected area, drag inside any
+  area to select and move it, drag an edge or corner of the selected area
+  (it shows white handles) to resize it, "New area" to add another. The
+  mouse cursor shows which of these a drag will do. Each area has its own
+  effect, strength and time ranges; with no ranges it covers the whole
+  video.
+- **Whole frame**: tick it to make the selected area cover the entire
+  picture (e.g. blur everything from 0:12 to 0:15); untick it to get its
+  rectangle back.
+- **Seeking**: click or drag the timeline, use the step buttons (hold them
+  to repeat), or the keys ←/→ (1 s) and Shift+←/→ (one frame).
+- **Time ranges**: I and O put the current time in Start and End, Enter adds
+  the range, a double-click on a range edits it, Esc cancels the edit. The
+  timeline shows the selected area's ranges in red, the others' in grey.
+- **Show effect** (E) draws every active area's effect on the frame, using
+  the same ffmpeg filters as the render.
+- **Projects**: Ctrl+S saves the areas, quality and position as JSON,
+  Ctrl+O opens a project. The video is found relative to the project file
+  first, so a folder with both can be moved to another PC.
+
+## Output
+
+The render keeps the source's codec family (H.264, HEVC, VP9, AV1), bit depth
+and colour metadata (HDR included), every audio track, subtitles and chapters.
+Anything the chosen container cannot hold is converted (losslessly where
+possible) or left out, and a dialog lists it before rendering starts.
+
+The quality setting is x264/x265-style CRF: lower means better and larger.
+The same number looks better with HEVC than with H.264, so 22–24 is usually
+enough for HEVC sources.
+
+## Development
+
+```sh
+uv sync            # creates .venv with the dependencies and pytest
+uv run pytest      # the test suite, about 20 s
+```
+
+`pyproject.toml` repeats the dependencies of the script's inline metadata
+(which `uv run --script` and the shortcut use); keep the two in sync.
+
+The tests are in three files:
+
+- `tests/test_logic.py`: time parsing, areas, filtergraphs and the stream
+  plan, with no ffmpeg run
+- `tests/test_media.py`: builds small videos with ffmpeg once per session,
+  then checks probing, frame reading against a plain sequential decode, the
+  live preview against the real render frame by frame, 10-bit and HDR
+  preservation, and the streams in rendered files
+- `tests/test_app.py`: drives the GUI through real Tk events (areas, ranges,
+  keys, seeking, projects); needs a display
+
+Tests that need ffmpeg or a display are skipped when these are missing;
+`-m "not gui"` or `-m "not media"` deselects them explicitly.