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

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.dev4

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.dev4
File Actions
framepipe-0.4.2.dev4-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.dev4-cp315-cp315-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev4-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.dev4-cp314-cp314-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev4-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.dev4-cp313-cp313-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev4-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.dev4-cp312-cp312-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev4-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.dev4-cp311-cp311-manylinux_2_34_x86_64.whl
framepipe-0.4.2.dev4-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.dev4-cp310-cp310-manylinux_2_34_x86_64.whl

Total release size: 73.0 MB

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

Download URL framepipe-0.4.2.dev4-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
3b345d3b3633c28d10317991b13010b3f83bfb2e82b9d5f131037330049cfb87
BLAKE2b-256 checksum
How to use checksums
cf1b82338a31645f65680de3bd45ce4a71ae8220b3fbe0347f2bf3a3d17c32af
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.dev4-cp314-cp314-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev4-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
0091fe5f0e151c45c7f76a13258f6dbe26bd521817a37d7ad2b2e1907b2691e3
BLAKE2b-256 checksum
How to use checksums
9b477a2c303a59d0b5144a68d8466ba8cbe48c7323cc50633d69769b99600f0a
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.dev4-cp313-cp313-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev4-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
da3c5e3a75063748413d9c58b8490f2061f398451b4c5418b43e00ae620c8e19
BLAKE2b-256 checksum
How to use checksums
885b4cb5a636f15fecfb5fbb50f930bc86dd2a06c25497e2214b45f58071bf75
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.dev4-cp312-cp312-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev4-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
73a08014b67e3c8a3af5b48d855d070cced1fe8de1bb3c8b1ab9b95ba64d8af0
BLAKE2b-256 checksum
How to use checksums
d2192673012265ae03c7bb61c12f2b0eaa27fcd63cf2b55fba13285889820ddb
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.dev4-cp311-cp311-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev4-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
25de6497e18d8c0e21445b605396e02a55b4994596c10b388217e2a2869487d4
BLAKE2b-256 checksum
How to use checksums
7ae95446484c94e621ec6e18dafc85940e2b6f15b4b11e5eb87f6ef050bbdb91
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.dev4-cp310-cp310-manylinux_2_34_x86_64.whl

Download URL framepipe-0.4.2.dev4-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
ac11d452f9e5981fd9053265294babe3e37908a3d50015114f78eaa3ae9f57ae
BLAKE2b-256 checksum
How to use checksums
8ea5e14ef142e2a6443fe7b9e14c42ceb3114e1281a7ec90e2ce18bc2322ea3a
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.dev4

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