Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

framepipe

Russian: README.ru.md · Русская документация

framepipe is a Python library for decoding and preparing video frames from files and network streams. It uses FFmpeg through a C++ binding and provides CPU arrays or supported GPU-backed frame objects.

Originally built for real-time ML/CV and edge inference, framepipe now also supports more general video pipelines. Its most developed usage pattern remains read-latest-drop: a background decoder publishes the newest frame without building up a queue for a slow consumer. For sequential file processing, use on_demand=True instead.

Documentation version: 0.4.2.dev4 (development). The Reader API and supported combinations may change. VAAPI has received the most attention in development and testing; D3D11VA is experimental and has barely been tested. Prebuilt wheels are currently planned for manylinux only.

What it provides

  • Decoding via HWAccel.SOFTWARE, CUDA, VAAPI, or experimental D3D11VA.
  • PostProcessor.CPU, CUDA, VAAPI, or OPENCL for supported conversion and resizing paths.
  • OutputFormat.BGR24, RGB24, GRAY8, or NATIVE, with MemoryType.CPU / GPU where supported.
  • NumPy arrays for packed CPU output; typed frame objects, DLPack, and native GPU handles on supported paths.
  • Latest-frame background reading and on-demand sequential file reading.

Support depends on the entire decoder → postprocessor → format → memory combination, not just on individual enum values. See the compatibility matrix before selecting a GPU path.

Quick start

Package is available via PyPi

uv add framepipe
# or
pip install framepipe
# or you can download .whl from Releases page 

Sequential processing of a file with the default CPU/BGR output:

from framepipe import Reader

with Reader("video.mp4", name="demo", on_demand=True) as reader:
    while (image := reader.next()) is not None:
        print(image.shape)  # NumPy H x W x 3

For live inference, read_latest() waits for the newest available frame and does not build up an output queue:

from framepipe import Reader

with Reader("rtsp://camera.example/live", name="camera") as reader:
    while reader.is_opened():
        image = reader.read_latest(timeout=1.0)
        if image is not None:
            print(image.shape)

For GPU or NATIVE output, prefer the methods ending in _frame, such as read_latest_frame() and next_frame(). Details: reading models and Reader API.

Documentation

Topic Page
Overview and pipeline Architecture
Supported combinations Compatibility matrix
Decoding HWAccel backends
Conversion and resizing Postprocessors
Frame storage and access Memory types and frames
Format and color handling Pixel formats and color
read / read_new / read_latest / on_demand Reading models
Reader methods and options Reader API
Maturity and known limitations Support status

This is a development snapshot, not a claim of universal hardware or codec compatibility. More formats, improved color handling, broader platform testing, and API refinements are planned.

License: MPL 2.0 (see LICENSE).

Metadata

Release files for framepipe 0.4.2.dev5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for framepipe 0.4.2.dev5
File Actions
framepipe-0.4.2.dev5-cp315-cp315-manylinux_2_34_x86_64.whl CPython 3.15 CPython 3.15 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp315-cp315-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev5-cp314-cp314-manylinux_2_34_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp314-cp314-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev5-cp313-cp313-manylinux_2_34_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp313-cp313-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev5-cp312-cp312-manylinux_2_34_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp312-cp312-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev5-cp311-cp311-manylinux_2_34_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp311-cp311-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev5-cp310-cp310-manylinux_2_34_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.34+ x86-64 Details for framepipe-0.4.2.dev5-cp310-cp310-manylinux_2_34_x86_64.whl

Total release size: 73.0 MB

Release files / framepipe-0.4.2.dev5-cp315-cp315-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp315-cp315-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.15 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
980594c47dae740cef5b8489160a7886ad2f4f179d2e1ccf40a1fdb8e68fef09
BLAKE2b-256 checksum
How to use checksums
775b5d014b7294659101954aac5df12d4b1386d474f25c210ac11298116aa26d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / framepipe-0.4.2.dev5-cp314-cp314-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp314-cp314-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.14 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
eac6ce26f3b7a37417a9a429a46bcde63895361b54885460e033160e220fd7dd
BLAKE2b-256 checksum
How to use checksums
3ad81d531306901c67786be9615cdca948d6f4c486ef7e561caf58eeeaa61416
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / framepipe-0.4.2.dev5-cp313-cp313-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp313-cp313-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.13 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
d99564cb21e6f00c7c0b5dbe7d1cf0cdffa7159bc3668116897165fb3e45dfb5
BLAKE2b-256 checksum
How to use checksums
8bfee199f758c5e22c50532dbf03ba000c23d608bacb90e53c13bd40c886ec0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / framepipe-0.4.2.dev5-cp312-cp312-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp312-cp312-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.12 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
97d124c3cc50fe3c1879158754caddda3b309088805f02a102a86127f505f85c
BLAKE2b-256 checksum
How to use checksums
09271d2339fdd3f597737db217082f06dd851c17fddbf7d1e1282c540cf35f2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / framepipe-0.4.2.dev5-cp311-cp311-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp311-cp311-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.11 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
a921e45a5cc610428684bd6927fa10e7197029061089371441be30fb49d68ff2
BLAKE2b-256 checksum
How to use checksums
4127ff210bd12bb63e489cc9490149c007a64f885560ab01bcb36b6864d6f18d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / framepipe-0.4.2.dev5-cp310-cp310-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev5-cp310-cp310-manylinux_2_34_x86_64.whl
Size 12.2 MB
Tags CPython 3.10 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
7556440b39e86971ab94a6221b61b0df4a9eaaa8954a8404542a498af8f97ba6
BLAKE2b-256 checksum
How to use checksums
54a1112b7c56076385466f21edf8f133f78fb73a588429fc392053c9186d6d89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for framepipe 0.4.2.dev5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page