generic ¶

def apply(self, clip: vs.VideoNode) -> vs.VideoNode:
    """
    Applies the property to the VideoNode.
    """

    return vs.core.std.SetFrameProp(clip, self.prop_key, self.value)

@classmethod
def ensure_presence(
    cls, clip: vs.VideoNode, value: int | Self | None, /, func: FuncExcept | None = None
) -> vs.VideoNode:
    """
    Ensure the presence of the property in the VideoNode.
    """

    enum_value = cls.from_param_or_video(value, clip, True, func)

    return vs.core.std.SetFrameProp(clip, enum_value.prop_key, enum_value.value)

@staticmethod
def ensure_presences(
    clip: vs.VideoNode, prop_enums: Iterable[type[PropEnum] | PropEnum], func: FuncExcept | None = None
) -> vs.VideoNode:
    """
    Ensure the presence of multiple PropEnums at once.
    """

    return vs.core.std.SetFrameProps(
        clip,
        **{
            value.prop_key: value.value
            for value in (
                prop_enum if isinstance(prop_enum, PropEnum) else prop_enum.from_video(clip, True, func)
                for prop_enum in prop_enums
            )
        },
    )

@classmethod
def from_param(cls, value: Any, func_except: Any = None) -> Self | None:
    """
    Determine the ChromaLocation through a parameter.

    Args:
        value: Value or ChromaLocation object.
        func_except: Function returned for custom error handling. This should only be set by VS package
            developers.

    Returns:
        ChromaLocation object or None.
    """

@classmethod
def from_param_or_video(
    cls,
    value: ChromaLocation | None,
    src: vs.VideoNode | vs.VideoFrame | Mapping[str, Any],
    strict: bool = False,
    func_except: FuncExcept | None = None,
) -> ChromaLocation: ...

@classmethod
def from_res(cls, frame: vs.VideoNode | vs.VideoFrame) -> ChromaLocation:
    """
    Guess the chroma location based on the clip's resolution.

    Args:
        frame: Input clip or frame.

    Returns:
        ChromaLocation object.
    """

    return ChromaLocation.LEFT

@classmethod
def from_video(
    cls, src: vs.VideoNode | vs.VideoFrame | Mapping[str, Any], strict: bool = False, func: FuncExcept | None = None
) -> ChromaLocation:
    """
    Obtain the chroma location of a clip from the frame properties.

    Args:
        src: Input clip, frame, or props.
        strict: Be strict about the properties. The result may NOT be an unknown value.

    Returns:
        ChromaLocation object.

    Raises:
        UndefinedChromaLocationError: Chroma location is undefined.
        UndefinedChromaLocationError: Chroma location can not be determined from the frame properties.
    """

    return _base_from_video(cls, src, UndefinedChromaLocationError, strict, func)

def get_offsets(self, src: int | VideoFormatLike | HoldsVideoFormat) -> tuple[float, float]:
    """
    Get (left,top) shift for chroma relative to luma.

    This is only useful if you MUST use a pre-specified chroma location and shift the chroma yourself.
    """
    from ..utils import get_video_format

    fmt = get_video_format(src)

    off_left = off_top = 0.0

    if self in {ChromaLocation.LEFT, ChromaLocation.TOP_LEFT, ChromaLocation.BOTTOM_LEFT}:
        off_left = 0.5 - 2 ** (fmt.subsampling_w - 1)

    if self in {ChromaLocation.TOP, ChromaLocation.TOP_LEFT}:
        off_top = 0.5 - 2 ** (fmt.subsampling_h - 1)
    elif self in {ChromaLocation.BOTTOM, ChromaLocation.BOTTOM_LEFT}:
        off_top = 2 ** (fmt.subsampling_h - 1) - 0.5

    return off_left, off_top

@classmethod
def is_unknown(cls, value: int | Self) -> bool:
    """
    Whether the value represents an unknown value.
    """

    return False

@classmethod
def is_valid(cls, value: int) -> bool:
    """
    Check if the given value is a valid int value of this enum.
    """
    return int(value) in map(int, cls.__members__.values())

@classproperty
@classmethod
def prop_key(cls) -> str:
    """
    The key used in props to store the enum.
    """

    return f"_{cls.__name__}"

def apply(self, clip: vs.VideoNode) -> vs.VideoNode:
    """
    Applies the property to the VideoNode.
    """

    return vs.core.std.SetFrameProp(clip, self.prop_key, self.value)

@classmethod
def ensure_presence(
    cls, clip: vs.VideoNode, tff: FieldBasedLike | bool | None, func: FuncExcept | None = None
) -> vs.VideoNode:
    field_based = cls.from_param_or_video(tff, clip, True, func)

    return vs.core.std.SetFieldBased(clip, field_based.value)

@staticmethod
def ensure_presences(
    clip: vs.VideoNode, prop_enums: Iterable[type[PropEnum] | PropEnum], func: FuncExcept | None = None
) -> vs.VideoNode:
    """
    Ensure the presence of multiple PropEnums at once.
    """

    return vs.core.std.SetFrameProps(
        clip,
        **{
            value.prop_key: value.value
            for value in (
                prop_enum if isinstance(prop_enum, PropEnum) else prop_enum.from_video(clip, True, func)
                for prop_enum in prop_enums
            )
        },
    )

@classmethod
def from_param(cls, value: FieldBasedLike | bool | None, func_except: FuncExcept | None = None) -> Self | None:
    """
    Determine the type of field through a parameter.

    Args:
        value: Value or FieldBased object. If it's bool, it specifies whether it's TFF or BFF.
        func_except: Function returned for custom error handling. This should only be set by VS package
            developers.

    Returns:
        FieldBased object or None.
    """
    if isinstance(value, bool):
        return cls(1 + value)

    return super().from_param(value)

@classmethod
def from_param_or_video(
    cls,
    value: FieldBasedLike | bool | None,
    src: vs.VideoNode | vs.VideoFrame | Mapping[str, Any],
    strict: bool = False,
    func_except: FuncExcept | None = None,
) -> FieldBased: ...

@classmethod
def from_res(cls, frame: vs.VideoNode | vs.VideoFrame) -> FieldBased:
    """
    Guess the Field order from the frame resolution.
    """

    return cls.PROGRESSIVE

@classmethod
def from_video(
    cls, src: vs.VideoNode | vs.VideoFrame | Mapping[str, Any], strict: bool = False, func: FuncExcept | None = None
) -> FieldBased:
    """
    Obtain the Field order of a clip from the frame properties.

    Args:
        src: Input clip, frame, or props.
        strict: Be strict about the properties. Will ALWAYS error if the FieldBased is missing.

    Returns:
        FieldBased object.

    Raises:
        UndefinedFieldBasedError: Field order is undefined.
        UndefinedFieldBasedError: Field order can not be determined from the frame properties.
    """

    return _base_from_video(cls, src, UndefinedFieldBasedError, strict, func)

@classmethod
def is_unknown(cls, value: int | Self) -> bool:
    """
    Whether the value represents an unknown value.
    """

    return False

@classmethod
def is_valid(cls, value: int) -> bool:
    """
    Check if the given value is a valid int value of this enum.
    """
    return int(value) in map(int, cls.__members__.values())

@classproperty
@classmethod
def prop_key(cls) -> str:
    """
    The key used in props to store the enum.
    """

    return f"_{cls.__name__}"