video_utils

sleap.sleap_io_adaptors.video_utils

Video utilities for sleap-io integration.

Functions:

Name	Description
available_video_exts	Return tuple of supported video extensions.
can_use_ffmpeg	Check if ffmpeg is available for writing videos.
get_last_frame_idx	Get the last frame index for a specific video.
video_get_channels	Get video channels for backward compatibility.
video_get_frame	Get frame by index for backward compatibility.
video_get_frames	Get frame count for backward compatibility.
video_get_height	Get video height for backward compatibility.
video_get_width	Get video width for backward compatibility.
video_util_reset	Reloads the video.

available_video_exts()

Return tuple of supported video extensions.

Returns:

Type	Description
Tuple[str]	Tuple of supported video extensions.

Source code in sleap/sleap_io_adaptors/video_utils.py

def available_video_exts() -> Tuple[str]:
    """Return tuple of supported video extensions.

    Returns:
        Tuple of supported video extensions.
    """
    return MediaVideo.EXTS + HDF5Video.EXTS + ImageVideo.EXTS + TiffVideo.EXTS

can_use_ffmpeg()

Check if ffmpeg is available for writing videos.

Source code in sleap/sleap_io_adaptors/video_utils.py

def can_use_ffmpeg():
    """Check if ffmpeg is available for writing videos."""
    try:
        import imageio_ffmpeg as ffmpeg
    except ImportError:
        return False

    try:
        # Try to get the version of the ffmpeg plugin
        ffmpeg_version = ffmpeg.get_ffmpeg_version()
        if ffmpeg_version:
            return True
    except Exception:
        return False

    return False

get_last_frame_idx(video=None)

Get the last frame index for a specific video. This function recreates the functionality of labels.get_last_frame_idx(video) from the original SLEAP codebase.

Source code in sleap/sleap_io_adaptors/video_utils.py

def get_last_frame_idx(video=None):
    """Get the last frame index for a specific video.
    This function recreates the functionality of labels.get_last_frame_idx(video)
    from the original SLEAP codebase.
    """
    if video is None:
        return None
    if hasattr(video.backend, "source_inds"):
        source_inds = video.backend.source_inds
        return max(source_inds)
    else:
        return len(video) - 1

video_get_channels(video)

Get video channels for backward compatibility.

Parameters:

Name	Type	Description	Default
video	Video	Video object to get channels from.	required

Returns:

Type	Description
int	Number of channels in video frames.

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_get_channels(video: Video) -> int:
    """Get video channels for backward compatibility.

    Args:
        video: Video object to get channels from.

    Returns:
        Number of channels in video frames.
    """
    return video.shape[3] if len(video.shape) > 3 else 3

video_get_frame(video, idx)

Get frame by index for backward compatibility.

Parameters:

Name	Type	Description	Default
video	Video	Video object to get frame from.	required
idx	int	Frame index to retrieve.	required

Returns:

Type	Description
	Frame data as numpy array.

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_get_frame(video: Video, idx: int):
    """Get frame by index for backward compatibility.

    Args:
        video: Video object to get frame from.
        idx: Frame index to retrieve.

    Returns:
        Frame data as numpy array.
    """
    return video[idx]

video_get_frames(video)

Get frame count for backward compatibility.

Parameters:

Name	Type	Description	Default
video	Video	Video object to get frame count from.	required

Returns:

Type	Description
int	Number of frames in the video.

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_get_frames(video: Video) -> int:
    """Get frame count for backward compatibility.

    Args:
        video: Video object to get frame count from.

    Returns:
        Number of frames in the video.
    """
    return len(video)

video_get_height(video)

Get video height for backward compatibility.

Parameters:

Name	Type	Description	Default
video	Video	Video object to get height from.	required

Returns:

Type	Description
int	Height of video frames in pixels.

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_get_height(video: Video) -> int:
    """Get video height for backward compatibility.

    Args:
        video: Video object to get height from.

    Returns:
        Height of video frames in pixels.
    """
    return video.shape[1] if len(video.shape) > 1 else None

video_get_width(video)

Get video width for backward compatibility.

Parameters:

Name	Type	Description	Default
video	Video	Video object to get width from.	required

Returns:

Type	Description
int	Width of video frames in pixels.

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_get_width(video: Video) -> int:
    """Get video width for backward compatibility.

    Args:
        video: Video object to get width from.

    Returns:
        Width of video frames in pixels.
    """
    return video.shape[2] if len(video.shape) > 2 else None

video_util_reset(video, filename=None, grayscale=None)

Reloads the video.

Returns:

Type	Description
	None

Source code in sleap/sleap_io_adaptors/video_utils.py

def video_util_reset(video: Video, filename: str = None, grayscale: bool = None):
    """Reloads the video.

    Returns:
        None
    """
    if filename is not None:
        video.replace_filename(filename, open=False)
        # No apparent 'test frame'.

    # If none, auto-detects based on first frame load.
    video.grayscale = grayscale

    # no apparent 'bgr' attribute (removed in sleap-io?)

    # potential breaking change
    if (filename is not None) or (grayscale is not None):
        # In sleap-io, keep_open is a backend attribute, not a video attribute
        if hasattr(video, "backend") and hasattr(video.backend, "keep_open"):
            video.backend.keep_open = (
                False  # Reader depends on both filename and grayscale
            )