pixano.features.schemas.views.video

Video(created_at=None, updated_at=None, **data)

Bases: View

Video view.

Attributes:

Name	Type	Description
url	str	The video URL.
num_frames	int	The number of frames in the video.
fps	float	The frames per second of the video.
width	int	The video width.
height	int	The video height.
format	str	The video format.
duration	float	The video duration.

Source code in pixano/features/schemas/base_schema.py

def __init__(self, /, created_at: datetime | None = None, updated_at: datetime | None = None, **data: Any):
    """Create a new model by parsing and validating input data from keyword arguments.

    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
    validated to form a valid model.

    `self` is explicitly positional-only to allow `self` as a field name.

    Args:
        created_at: The creation date of the object.
        updated_at: The last modification date of the object.
        data: The data of the object validated by Pydantic.
    """
    created_at, updated_at = validate_and_init_create_at_and_update_at(created_at, updated_at)
    data.update({"created_at": created_at, "updated_at": updated_at})
    super().__init__(**data)

create_video(url, id='', item_ref=ItemRef.none(), parent_ref=ViewRef.none(), num_frames=None, fps=None, width=None, height=None, format=None, duration=None, url_relative_path=None)

Create a Video instance.

Parameters:

Name	Type	Description	Default
url	Path	The image URL. If not relative, the URL is converted to a relative path using other_path.	required
id	str	Point cloud ID.	''
item_ref	ItemRef	Item reference.	none()
parent_ref	ViewRef	Parent view reference.	none()
num_frames	int | None	The number of frames in the video. If None, the number of frames is extracted from the video file.	None
fps	float | None	The frames per second of the video. If None, the fps is extracted from the video file.	None
width	int | None	The video width. If None, the width is extracted from the video file.	None
height	int | None	The video height. If None, the height is extracted from the video file.	None
format	str | None	The video format. If None, the format is extracted from the video file.	None
duration	float | None	The video duration. If None, the duration is extracted from the video file.	None
url_relative_path	Path | None	The path to convert the URL to a relative path.	None

Returns:

Type	Description
Video	The created Video instance.

Source code in pixano/features/schemas/views/video.py

def create_video(
    url: Path,
    id: str = "",
    item_ref: ItemRef = ItemRef.none(),
    parent_ref: ViewRef = ViewRef.none(),
    num_frames: int | None = None,
    fps: float | None = None,
    width: int | None = None,
    height: int | None = None,
    format: str | None = None,
    duration: float | None = None,
    url_relative_path: Path | None = None,
) -> Video:
    """Create a `Video` instance.

    Args:
        url: The image URL. If not relative, the URL is converted to a relative path using `other_path`.
        id: Point cloud ID.
        item_ref: Item reference.
        parent_ref: Parent view reference.
        num_frames: The number of frames in the video. If None, the number of frames is
            extracted from the video file.
        fps: The frames per second of the video. If None, the fps is extracted from the video
            file.
        width: The video width. If None, the width is extracted from the video file.
        height: The video height. If None, the height is extracted from the video file.
        format: The video format. If None, the format is extracted from the video file.
        duration: The video duration. If None, the duration is extracted from the video file.
        url_relative_path: The path to convert the URL to a relative path.

    Returns:
        The created `Video` instance.
    """
    none_conditions = [
        num_frames is None,
        fps is None,
        width is None,
        height is None,
        format is None,
        duration is None,
    ]
    not_none_conditions = [
        num_frames is not None,
        fps is not None,
        width is not None,
        height is not None,
        format is not None,
        duration is not None,
    ]
    if not all(none_conditions) and not all(not_none_conditions):
        raise ValueError(
            "All or none of the following arguments must be provided: width, height, format, num_frames, fps, duration"
        )

    url = Path(url)
    if id is None:
        id = shortuuid.uuid()

    if width is None:
        try:
            import ffmpeg
        except ImportError:
            raise ImportError("To load video files metadata, install ffmpeg")
        try:
            metadata = ffmpeg.probe(str(url.resolve()), cmd="ffprobe")["streams"][0]
        except FileNotFoundError:
            raise FileNotFoundError("File not found or ffprobe is not installed.")
        r_frame_rate = metadata["r_frame_rate"].split("/")
        fps = float(r_frame_rate[0]) / float(r_frame_rate[1])
        num_frames = int(metadata["nb_frames"])
        width = int(metadata["width"])
        height = int(metadata["height"])
        format = url.suffix[1:]
        duration = float(metadata["duration"])

    if url_relative_path is not None:
        url_relative_path = Path(url_relative_path)
        url = url.relative_to(url_relative_path)

    return Video(
        id=id,
        item_ref=item_ref,
        parent_ref=parent_ref,
        url=url.as_posix(),
        num_frames=num_frames,
        fps=fps,
        width=width,
        height=height,
        format=format,
        duration=duration,
    )

is_video(cls, strict=False)

Check if the given class is a Video or a subclass of Video.

Source code in pixano/features/schemas/views/video.py

def is_video(cls: type, strict: bool = False) -> bool:
    """Check if the given class is a `Video` or a subclass of `Video`."""
    return issubclass_strict(cls, Video, strict)