iterframes 0.4.0__tar.gz

iterframes-0.4.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Bug Description
+
+A clear and concise description of what the bug is.
+
+## Code Example
+
+```python
+import iterframes
+
+# Minimal code example that reproduces the issue
+for frame in iterframes.read("video.mp4"):
+    ...
+```
+
+## Error Message
+
+```
+Full error message and traceback if applicable
+```
+
+## Video
+
+The container and codec of the video, as printed by
+`ffprobe -hide_banner video.mp4`. Attach the file if you can share it.
+
+## Environment
+
+- **OS:** [e.g., macOS 15, Ubuntu 24.04]
+- **Python version:** [e.g., 3.13.2]
+- **iterframes version:** [`iterframes.__version__`]
+- **FFmpeg version:** [`iterframes.FFMPEG_VERSION`]
+- **Installation method:** [wheel from PyPI, from source]

iterframes-0.4.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature Request
+about: Suggest a new feature for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Feature Description
+
+A clear and concise description of the feature you'd like to see added.
+
+## Use Case
+
+Describe the use case or problem this feature would solve.
+
+## Example Usage
+
+```python
+import iterframes
+
+# How you would like to use this feature
+```
+
+## Alternatives Considered
+
+Have you considered any alternative solutions or features?

iterframes-0.4.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+## Description
+
+<!-- What does this change and why? Link related issues, e.g. "Closes #123". -->
+
+## Checklist
+
+- [ ] `cargo fmt` and `cargo clippy --all-targets -- -D warnings` pass
+- [ ] `uv run --no-sync pre-commit run -a` passes
+- [ ] Tests added or updated, and `uv run --no-sync pytest` passes
+- [ ] Docs and `CHANGELOG.md` updated

iterframes-0.4.0/.github/workflows/ci.yaml

@@ -0,0 +1,225 @@
+# Wheel build matrix adapted from `maturin generate-ci github`. Every wheel
+# links a static FFmpeg, which build.rs builds with scripts/build-ffmpeg.sh
+# into build/ffmpeg, and is abi3, so a single wheel per platform covers
+# every CPython from 3.11 on. Edit by hand.
+name: CI
+
+# Releases come from release-please, in this workflow: a push to main
+# updates its release pull request, and merging that pull request creates
+# the tag and a draft GitHub release, then the jobs below attach the
+# wheels, publish them to PyPI, and publish the release.
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' }}
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+      version: ${{ steps.release.outputs.version }}
+    steps:
+      # Reads release-please-config.json and .release-please-manifest.json.
+      # With the default GITHUB_TOKEN, its tag and pull request start no
+      # other workflow, which is why the release jobs live here.
+      - uses: googleapis/release-please-action@v4
+        id: release
+
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.1.0
+      - name: Install build tools
+        # Clippy runs build.rs, which builds FFmpeg and generates its
+        # bindings with libclang.
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libclang-dev nasm pkg-config
+      - name: Cache FFmpeg
+        uses: actions/cache@v6
+        with:
+          path: build/ffmpeg
+          key: ffmpeg-lint-${{ hashFiles('scripts/build-ffmpeg.sh') }}
+      - name: Check Rust formatting
+        run: cargo fmt --check
+      - name: Lint Rust
+        run: cargo clippy --all-targets -- -D warnings
+      - name: Lint Python
+        run: |
+          uvx ruff@0.16.8 check .
+          uvx ruff@0.16.8 format --check .
+
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          # Native runners for each architecture: FFmpeg is compiled in the
+          # manylinux container, so there is no cross-compilation to set up.
+          - runner: ubuntu-24.04
+            target: x86_64
+          - runner: ubuntu-24.04-arm
+            target: aarch64
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache FFmpeg
+        uses: actions/cache@v6
+        with:
+          path: build/ffmpeg
+          key: ffmpeg-linux-${{ matrix.platform.target }}-${{ hashFiles('scripts/build-ffmpeg.sh') }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: 2_28
+          # libclang, for the bindings build.rs generates.
+          before-script-linux: dnf install -y clang-devel
+      - name: Upload wheels
+        uses: actions/upload-artifact@v7
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.1.0
+      - name: Run tests
+        shell: bash
+        run: |
+          # The oldest and newest supported Pythons load the same abi3 wheel.
+          for python in 3.11 3.14; do
+            uv sync --frozen --no-install-project --python $python
+            uv pip install --reinstall-package iterframes dist/*.whl
+            uv run --no-sync pytest
+          done
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          # Apple silicon only: Apple is phasing out Intel Macs.
+          - runner: macos-15
+            target: aarch64
+    env:
+      # Read by both the FFmpeg build and maturin, which tags the wheel.
+      MACOSX_DEPLOYMENT_TARGET: "11.0"
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache FFmpeg
+        uses: actions/cache@v6
+        with:
+          path: build/ffmpeg
+          key: ffmpeg-macos-${{ matrix.platform.target }}-${{ hashFiles('scripts/build-ffmpeg.sh') }}
+      - name: Install pkg-config
+        run: command -v pkg-config || brew install pkgconf
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v7
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.1.0
+      - name: Run tests
+        shell: bash
+        run: |
+          uv sync --frozen --no-install-project
+          uv pip install --reinstall-package iterframes dist/*.whl
+          uv run --no-sync pytest
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v7
+        with:
+          name: wheels-sdist
+          path: dist
+
+  release:
+    name: Attach to the GitHub release
+    runs-on: ubuntu-latest
+    if: ${{ needs.release-please.outputs.release_created == 'true' }}
+    needs: [release-please, lint, linux, macos, sdist]
+    permissions:
+      # Used to sign the attestations
+      id-token: write
+      # Used to upload the files to the draft release
+      contents: write
+      # Used to generate artifact attestation
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v8
+      - name: Generate artifact attestation
+        uses: actions/attest@v4
+        with:
+          subject-path: 'wheels-*/*'
+      - name: Upload to the draft release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: >
+          gh release upload ${{ needs.release-please.outputs.tag_name }}
+          wheels-*/* --clobber --repo ${{ github.repository }}
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [release-please, release]
+    # Naming an environment records the run under Deployments, where the
+    # release can also be gated behind a review.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/iterframes/${{ needs.release-please.outputs.version }}
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.1.0
+      - name: Publish to PyPI
+        # Trusted publishing: PyPI mints a short-lived token from the job's
+        # OIDC identity, so no API token is stored. "always" fails loudly if
+        # that identity is missing instead of falling back.
+        run: uv publish --trusted-publishing always 'wheels-*/*'
+
+  publish-release:
+    name: Publish the GitHub release
+    runs-on: ubuntu-latest
+    # Last, so that the release only shows once its files are attached and
+    # on PyPI.
+    needs: [release-please, publish]
+    permissions:
+      contents: write
+    steps:
+      - name: Publish the draft release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: >
+          gh release edit ${{ needs.release-please.outputs.tag_name }}
+          --draft=false --repo ${{ github.repository }}

iterframes-0.4.0/.gitignore

@@ -0,0 +1,158 @@
+## IDE ##
+
+.idea/
+.vscode/
+
+## Rust related files ##
+
+# Generated by Cargo
+debug/
+target/
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+## Python related files ##
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+wheelhouse/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# MacOS files
+.DS_Store

iterframes-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        # mkdocs.yml uses !!python/name tags for the Material emoji extension.
+        args: [--unsafe]
+      - id: check-toml
+      - id: check-added-large-files
+      - id: mixed-line-ending
+        args: [ --fix=lf ]
+        exclude: "make.bat"
+  # Run the local toolchain: the third-party Rust hook mirrors are stale.
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: cargo fmt --
+        language: system
+        types: [rust]
+        pass_filenames: false
+      - id: cargo-clippy
+        name: cargo clippy
+        entry: cargo clippy --all-targets -- -D warnings
+        language: system
+        types: [rust]
+        pass_filenames: false
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.8
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [--fix]

iterframes-0.4.0/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  jobs:
+    # The docs are plain Markdown, so only the docs group is installed and
+    # the extension, which would need FFmpeg, is not compiled.
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --only-group docs
+
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false

iterframes-0.4.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}

iterframes-0.4.0/AGENTS.md

@@ -0,0 +1,149 @@
+# AGENTS.md
+
+Working notes for coding agents (and humans) touching this repository.
+
+## What this project is
+
+`iterframes` is a Python extension module written in Rust with
+[PyO3](https://pyo3.rs/) and built by [maturin](https://www.maturin.rs/).
+It decodes videos with a static FFmpeg, through bindings that `build.rs`
+generates and `src/ffmpeg.rs` wraps, and yields
+the frames as NumPy arrays of RGB pixels.
+
+The point of the project is a plain Python loop over the frames in which
+decoding overlaps with expensive work on each frame, such as model
+inference: while the caller processes one frame, a background thread
+decodes the next ones. Keep that true, and say so in the docs.
+
+The package uses maturin's mixed layout: the compiled module is installed
+as `iterframes.iterframes`, and `iterframes/__init__.py` wraps its
+`FrameReader` into `read` and `read_all`.
+
+## How decoding works
+
+- `FrameReader::new` spawns a thread (`src/decoder.rs`) that demuxes,
+  decodes, and converts each frame to RGB24 with swscale, and sends it
+  through a bounded crossbeam channel of `prefetch_frames` slots.
+- RGB frames are allocated with an alignment of 1, so their rows have no
+  padding and Python can use them as contiguous arrays.
+- Every call into FFmpeg, and so almost all the `unsafe` code, lives in
+  `src/ffmpeg.rs`, behind small RAII types. Keep it that way: the rest of
+  the crate stays safe.
+- `__next__` waits on the channel with the GIL released (`py.detach`) and
+  wraps the frame in a `Frame`, whose buffer protocol hands the pixels to
+  NumPy without a copy. The buffer protocol needs `abi3-py311`.
+- The decoder thread never takes the GIL, so it keeps decoding while
+  Python code holds it. Never attach to Python there (no `Python::attach`,
+  no Python objects in `decoder.rs`); `test_benchmark.py` checks the
+  overlap.
+- Errors travel through the channel and become Python exceptions in
+  `impl From<Error> for PyErr`. A closed channel means the end of the video.
+- Dropping the reader closes the channel; the thread notices on its next
+  send and returns. Never `unwrap` a send.
+
+## FFmpeg
+
+- Every build, local or CI, links the static FFmpeg that `build.rs`
+  builds with `scripts/build-ffmpeg.sh` into `build/ffmpeg` (or
+  `$ITERFRAMES_FFMPEG_DIR`) the first time, under a file lock, logging to
+  `build/ffmpeg.log`. The script is a no-op when `VERSION` in that
+  directory matches what it would build. There is no system FFmpeg mode.
+- `build.rs` links the libraries through `pkg-config --static` and runs
+  bindgen on the headers, keeping only `av*_`/`sws_` items. Enums are
+  newtype structs: use `.0` for the raw value. Function-like macros such
+  as `AVERROR` are written by hand in the `sys` module of `src/ffmpeg.rs`.
+- The build disables autodetection, so the wheel depends on libc and
+  system frameworks only; dav1d is added for AV1.
+- Keep the build LGPL: never pass `--enable-gpl` or `--enable-nonfree`.
+- Hardware decoding (`device="mps"` / `"cuda"`, PyTorch's names, mapped
+  to FFmpeg's in `hardware_devices` in `src/lib.rs`): VideoToolbox on
+  macOS; on Linux the `*_cuvid`
+  decoders, which load the NVIDIA driver with dlopen and resize on the
+  GPU. Both add no library to the wheel. The macOS build needs clang's
+  compiler-rt for `@available`, which `build.rs` links.
+- NVDEC has never run on a GPU in this project: CI has none, and the
+  `cuda` tests skip when the device does not open. The same goes for
+  `on_device=True` (`CudaFrame`, `Plane`, `src/dlpack.rs`), which waits on
+  cuvid's copy with CUDA driver calls found through dlopen
+  (`ffmpeg::cuda`).
+
+## Layout
+
+| Path | Contents |
+| --- | --- |
+| `src/lib.rs` | PyO3 module: `Frame`, `FrameReader`, error mapping, module init |
+| `src/decoder.rs` | Decoding thread |
+| `src/ffmpeg.rs` | Safe wrappers over the FFmpeg calls the crate needs |
+| `src/dlpack.rs` | DLPack capsules for the planes of `CudaFrame` |
+| `iterframes/__init__.py` | `read`, `read_all` |
+| `build.rs` | Builds and links FFmpeg, generates its bindings |
+| `scripts/build-ffmpeg.sh` | Static FFmpeg and dav1d, run by `build.rs` |
+| `tests/` | pytest suite; frames are compared with PyAV |
+| `docs/` | MkDocs site published on Read the Docs |
+
+## Environment
+
+Requires [uv](https://docs.astral.sh/uv/), a Rust toolchain, and what
+FFmpeg needs to build: a C compiler, `make`, `curl`, `python3`,
+`pkg-config`, libclang (see `docs/development.md`).
+
+```bash
+uv venv -p 3.14                # once
+uv sync --frozen               # dev dependencies
+uv run maturin develop --uv    # build FFmpeg (first time) and the extension
+```
+
+**`uv run` re-syncs the project by default and overwrites the module that
+`maturin develop` just built.** Always run tests and scripts as:
+
+```bash
+uv run --no-sync pytest
+```
+
+## Checks to run before proposing a change
+
+```bash
+cargo fmt
+cargo clippy --all-targets -- -D warnings
+uv run maturin develop --uv
+uv run --no-sync pytest
+```
+
+CI runs the same four, plus `ruff check .` and `ruff format --check .` for
+the Python files. `pre-commit run -a` covers the formatters and linters
+locally.
+
+## Docs
+
+Three pages: `index.md` (overview), `reference.md` (API and errors),
+`development.md`. Every example must match the behavior of a freshly
+built module; check them instead of writing them from memory. Keep the
+text short, in American English, with no performance claims that have not
+been measured.
+
+## Conventions
+
+- Commits follow [Conventional Commits](https://www.conventionalcommits.org/),
+  which release-please turns into versions and changelog entries.
+- Rust: `cargo fmt` defaults, no `unwrap()` on anything reachable from
+  Python input (a panic surfaces as `PanicException`).
+- Python: ruff with a 79-column limit.
+- Comments explain why, not what.
+
+## Release
+
+Version lives in `Cargo.toml` and is re-exported as
+`iterframes.__version__`; `pyproject.toml` takes it from there. Never bump
+it, write `CHANGELOG.md` entries, or push tags by hand: release-please
+does, from the Conventional Commits, in the `release-please` job of
+`.github/workflows/ci.yaml` (see "Releasing" in `docs/development.md`).
+Tags are `vX.Y.Z`; before 1.0 a breaking change bumps the minor version.
+
+Merging the release pull request creates the tag and a draft GitHub
+release; the same run attaches the wheels (`release` job), uploads them
+to PyPI (`publish`), and publishes the release (`publish-release`). The
+jobs share one workflow because a tag pushed with the default
+`GITHUB_TOKEN` starts no other workflow. The upload uses PyPI trusted
+publishing, bound to this workflow file and the `pypi` environment name:
+renaming either breaks publishing until the publisher is updated on
+PyPI.