Skip to main content

Pupil Labs Video

ci documentation uv ruff pre-commit pypi version python version

pl-video banner

A high-level wrapper of PyAV providing an easy to use interface to video data.

The goal of this library is to provide a simple interface while maintaining good computational performance. At current, only MP4 and MJPEG videos are officially compatible.

Features include:

  • Performant reading of video files (optionally including audio) utilizing multi-threading.
  • Ability to arbitrarily index frames by their index or timestamp.
  • Ability to slice the video by frame index or time. Large slices will be loaded lazily to avoidexcessive RAM consumption.
  • A frame buffer is maintained to cache frames close to the current decoding position, which avoids repetitive seeking when going back and forth between frames in the same neighborhood or iterating backwards.
  • Avoids demuxing and seeking operations as much as possible.
  • Reading multi-part video files (e.g. how they are generated by Neon or Pupil Invisible).

Installation

pip install pupil-labs-video

or

pip install -e git+https://github.com/pupil-labs/pl-video.git

Quick Start

You can open a video file and read frames like this:

import pupil_labs.video as plv

with plv.Reader(video_path) as video:
    # Iterate through video frames
    for frame in video:
        # Convert video frame to BGR array
        img = frame.bgr

    # Index individual frames or slices
    first_frame = video[0]
    last_frame = video[-1]
    frames = video[10:20]

    # Index frames by time
    ts = video[10].time
    frame = video.by_container_timestamps[ts]
    frames = video.by_container_timestamps[ts : ts + 10]

You can write video files like this:

import pupil_labs.video as plv

with (plv.Writer(out_path) as writer):
    for img in images:
        writer.write_image(img)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pupil_labs_video-1.0.14.tar.gz (323.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pupil_labs_video-1.0.14-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file pupil_labs_video-1.0.14.tar.gz.

File metadata

  • Download URL: pupil_labs_video-1.0.14.tar.gz
  • Upload date:
  • Size: 323.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pupil_labs_video-1.0.14.tar.gz
Algorithm Hash digest
SHA256 2de2b9d0ef8adfe7275fdd76280d6687d685b005ab666036f173b4209adab352
MD5 1c3160a0258c1c9b6c42df58dbb56b72
BLAKE2b-256 57e8fc7bb4ff5a56eb10b341648b1fa32d411560248639d03bfb2a597ab0492b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pupil_labs_video-1.0.14.tar.gz:

Publisher: on-release-main.yml on pupil-labs/pl-video

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pupil_labs_video-1.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for pupil_labs_video-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 b19924267d10b80187af8c74806ee6689357b78654aeabdb76acdda09e3d6409
MD5 b67766795fdedbe21cf70a963a4acfb7
BLAKE2b-256 a38aaf0420f6e4d8e01e183784a6b39f8a83c7e136150e5208626e592e13a99f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pupil_labs_video-1.0.14-py3-none-any.whl:

Publisher: on-release-main.yml on pupil-labs/pl-video

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page