upsies.utils.mediainfo.video

Module Attributes

upsies.utils.mediainfo.video.known_hdr_formats = {'DV', 'HDR', 'HDR10', 'HDR10+'}

Set of valid HDR format names

Functions

upsies.utils.mediainfo.video.get_bit_depth(path, default=<object object>)

Return bit depth of default video track (e.g. 8 or 10)

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if anything goes wrong

upsies.utils.mediainfo.video.get_frame_rate(path, default=<object object>)

Return frames per second of default video track as float

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if anything goes wrong

upsies.utils.mediainfo.video.get_hdr_formats(path, default=<object object>)

Return sequence of HDR formats e.g. ("HDR10",), ("DV", "HDR10")

The sequence may be empty.

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if anything goes wrong

upsies.utils.mediainfo.video.get_height(path, *, dar=True, default=<object object>)

Return displayed height of video file path

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• dar (bool) – Return display aspect ratio instead of storage aspect ratio

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if height can’t be determined

upsies.utils.mediainfo.video.get_resolution(path, default=<object object>)

Return resolution and scan type of video file path as str (e.g. “1080p”)

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if resolution can’t be determined

upsies.utils.mediainfo.video.get_resolution_int(path, default=<object object>)

Return resolution of video file path as int (e.g. 1080)

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if resolution can’t be determined

upsies.utils.mediainfo.video.get_scan_type(path)

Return scan type of video file path (“i” for interlaced, “p” for progressive)

This always defaults to “p” if it cannot be determined.

Parameters:

path (str) –

Path to video file

For directories, the return value of find_main_video() is used.

Raises:

ContentError – if scan type can’t be determined

upsies.utils.mediainfo.video.get_video_format(path, default=<object object>)

Return video format of default video track

Return x264, x265 or XviD if either one is detected.

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist or video format cannot be determined, raise ContentError if not provided

Raises:

ContentError – if anything goes wrong

upsies.utils.mediainfo.video.get_width(path, *, dar=True, default=<object object>)

Return displayed width of video file path

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• dar (bool) – Return display aspect ratio instead of storage aspect ratio

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if width can’t be determined

upsies.utils.mediainfo.video.is_bt2020(path, default=<object object>)

Whether path is BT.2020 (~UHD) video

See is_bt601().

upsies.utils.mediainfo.video.is_bt601(path, default=<object object>)

Whether path is BT.601 (~SD) video

Parameters:

• path (str) –

  Path to video file

  For directories, the return value of find_main_video() is used.

• default – Return value if path doesn’t exist, raise ContentError if not provided

Raises:

ContentError – if anything goes wrong

upsies.utils.mediainfo.video.is_bt709(path, default=<object object>)

Whether path is BT.709 (~UHD) video

See is_bt601().