cutcutcodec.core.analysis.video.properties.pxl_format.get_pxl_format

cutcutcodec.core.analysis.video.properties.pxl_format.get_pxl_format(filename: Path | str | bytes, index: int = 0, *, backend: str | None = None) → str[source]

Read in the metadata, the pixel format.

Parameters

filenamepathlike

The pathlike of the file containing a video stream.

indexint

The relative index of the video stream being considered, by default the first stream encountered is selected.

backendstr, optional

None (default) : Try to read the stream by trying differents backends.
‘ffmpeg’Uses the modules pip install ffmpeg-python
which are using the ffmpeg program in the background.
‘cv2’ : Uses the module pip install opencv-contrib-python-headless.

Returns

pxl_formatint: The name of the pixel format.

Raises

MissingStreamError: If the file does not contain a playable video stream.
MissingInformation: If the information is unavailable.

Examples

>>> from cutcutcodec.core.analysis.video.properties.pxl_format import get_pxl_format
>>> from cutcutcodec.utils import get_project_root
>>> media = get_project_root().parent / "media" / "video" / "intro.webm"
>>> get_pxl_format(media)
'yuv420p'
>>>