cv-frames 0.0.5

Installation

Install via pip:

pip install cv-frames

If you install cv-frames standalone, you need to specify an OpenCV backend:

pip install cv-frames[opencv]

If cv-frames is part of a project that already depends on OpenCV (e.g. opencv-python or opencv-contrib-python is listed in your requirements.txt), no optional dependency is needed.

Command Line Usage

After installation, you can use the CLI:

cv-frames show path/to/video.mp4

Navigate through frames with any key. Press q to quit.

Python Usage

Example: Read and show frames programmatically

from pathlib import Path
from cvframes import iterate

for i, (_, frame) in enumerate(iterate(Path("video.mp4"))):
    print(f"Frame {i} shape:", frame.shape)

Example: Split side-by-side video into left/right frames

from cvframes import iterate_sbs

# Write the processed frames to disc
for capture, (left, right) in iterate_sbs("sbs_video.mp4", oname="processed.mp4"):
    processed = do_something(left)
    capture.write(processed)