generic ¶
Classes:
-
ChromaLocation
–Chroma sample position in YUV formats.
-
FieldBased
–Whether the frame is composed of two independent fields (interlaced) and their order if so.
Attributes:
-
ChromaLocationT
(TypeAlias
) –Type alias for values that can be used to initialize a :py:attr:
ChromaLocation
. -
FieldBasedT
(TypeAlias
) –Type alias for values that can be used to initialize a :py:attr:
FieldBased
.
ChromaLocationT module-attribute
¶
ChromaLocationT: TypeAlias = Union[int, ChromaLocation, ChromaLocation]
Type alias for values that can be used to initialize a :py:attr:ChromaLocation
.
FieldBasedT module-attribute
¶
FieldBasedT: TypeAlias = Union[int, FieldBased, FieldBased]
Type alias for values that can be used to initialize a :py:attr:FieldBased
.
ChromaLocation ¶
Bases: _ChromaLocationMeta
Chroma sample position in YUV formats.
Methods:
-
apply
–Applies the property to the VideoNode.
-
ensure_presence
–Ensure the presence of the property in the VideoNode.
-
ensure_presences
–Ensure the presence of multiple PropEnums at once.
-
from_param
–Determine the ChromaLocation through a parameter.
-
from_param_or_video
– -
from_res
–Guess the chroma location based on the clip's resolution.
-
from_video
–Obtain the chroma location of a clip from the frame properties.
-
get_offsets
–Get (left,top) shift for chroma relative to luma.
-
is_unknown
–Whether the value represents an unknown value.
-
is_valid
–Check if the given value is a valid int value of this enum.
-
prop_key
–The key used in props to store the enum.
Attributes:
-
BOTTOM
– -
BOTTOM_LEFT
– -
CENTER
– -
LEFT
– -
TOP
– -
TOP_LEFT
– -
pretty_string
(str
) –Get a pretty, displayable string of the enum member.
-
string
(str
) –Get the string representation used in resize plugin/encoders.
apply ¶
apply(clip: VideoNodeT) -> VideoNodeT
Applies the property to the VideoNode.
Source code
113 114 115 116 |
|
ensure_presence classmethod
¶
ensure_presence(
clip: VideoNodeT, value: int | Self | None, func: FuncExceptT | None = None
) -> VideoNodeT
Ensure the presence of the property in the VideoNode.
Source code
105 106 107 108 109 110 111 |
|
ensure_presences staticmethod
¶
ensure_presences(
clip: VideoNodeT,
prop_enums: Iterable[type[PropEnumT] | PropEnumT],
func: FuncExceptT | None = None,
) -> VideoNodeT
Ensure the presence of multiple PropEnums at once.
Source code
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|
from_param classmethod
¶
from_param(value: None, func_except: FuncExceptT | None = None) -> None
from_param(
value: int | ChromaLocation | ChromaLocationT,
func_except: FuncExceptT | None = None,
) -> Self
from_param(
value: int | ChromaLocation | ChromaLocationT | None,
func_except: FuncExceptT | None = None,
) -> Self | None
from_param(value: Any, func_except: Any = None) -> Self | None
Determine the ChromaLocation through a parameter.
Parameters:
-
value
¶Any
) –Value or ChromaLocation object.
-
func_except
¶Any
, default:None
) –Function returned for custom error handling. This should only be set by VS package developers.
Returns:
-
Self | None
–ChromaLocation object or None.
Source code
357 358 359 360 361 362 363 364 365 366 367 |
|
from_param_or_video classmethod
¶
from_param_or_video(
value: int | ChromaLocation | ChromaLocationT | None,
src: VideoNode | VideoFrame | FrameProps,
strict: bool = False,
func_except: FuncExceptT | None = None,
) -> ChromaLocation
Source code
369 370 371 372 373 374 375 376 |
|
from_res classmethod
¶
from_res(frame: VideoNode | VideoFrame) -> ChromaLocation
Guess the chroma location based on the clip's resolution.
Parameters:
-
frame
¶VideoNode | VideoFrame
) –Input clip or frame.
Returns:
-
ChromaLocation
–ChromaLocation object.
Source code
42 43 44 45 46 47 48 49 50 51 52 |
|
from_video classmethod
¶
from_video(
src: VideoNode | VideoFrame | FrameProps,
strict: bool = False,
func: FuncExceptT | None = None,
) -> ChromaLocation
Obtain the chroma location of a clip from the frame properties.
Parameters:
-
src
¶VideoNode | VideoFrame | FrameProps
) –Input clip, frame, or props.
-
strict
¶bool
, default:False
) –Be strict about the properties. The result may NOT be an unknown value.
Returns:
-
ChromaLocation
–ChromaLocation object.
Raises:
-
UndefinedChromaLocationError
–Chroma location is undefined.
-
UndefinedChromaLocationError
–Chroma location can not be determined from the frame properties.
Source code
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
get_offsets ¶
get_offsets(src: int | VideoFormatT | HoldsVideoFormatT) -> 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.
Source code
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
|
is_unknown classmethod
¶
Whether the value represents an unknown value.
Source code
26 27 28 29 30 |
|
is_valid classmethod
¶
Check if the given value is a valid int value of this enum.
Source code
148 149 150 151 |
|
FieldBased ¶
Bases: _FieldBasedMeta
Whether the frame is composed of two independent fields (interlaced) and their order if so.
Methods:
-
apply
–Applies the property to the VideoNode.
-
ensure_presence
– -
ensure_presences
–Ensure the presence of multiple PropEnums at once.
-
from_param
– -
from_param_or_video
–Get the enum member from a value that can be casted to this prop value
-
from_res
–Guess the Field order from the frame resolution.
-
from_video
–Obtain the Field order of a clip from the frame properties.
-
is_unknown
–Whether the value represents an unknown value.
-
is_valid
–Check if the given value is a valid int value of this enum.
-
prop_key
–The key used in props to store the enum.
Attributes:
-
BFF
–The frame is interlaced and the field order is bottom field first.
-
PROGRESSIVE
–The frame is progressive.
-
TFF
–The frame is interlaced and the field order is top field first.
-
field
(int
) –Check what field the enum signifies.
-
inverted_field
(FieldBased
) –Get the inverted field order.
-
is_inter
(bool
) –Check whether the value belongs to an interlaced value.
-
is_tff
(bool
) –Check whether the value is Top-Field-First.
-
pretty_string
(str
) – -
string
(str
) –Get the string representation used in resize plugin/encoders.
BFF class-attribute
instance-attribute
¶
BFF = 1
The frame is interlaced and the field order is bottom field first.
TFF class-attribute
instance-attribute
¶
TFF = 2
The frame is interlaced and the field order is top field first.
field property
¶
field: int
Check what field the enum signifies.
Raises:
-
UnsupportedFieldBasedError
–PROGRESSIVE value is passed.
inverted_field property
¶
inverted_field: FieldBased
Get the inverted field order.
Raises:
-
UnsupportedFieldBasedError
–PROGRESSIVE value is passed.
apply ¶
apply(clip: VideoNodeT) -> VideoNodeT
Applies the property to the VideoNode.
Source code
113 114 115 116 |
|
ensure_presence classmethod
¶
ensure_presence(
clip: VideoNodeT,
tff: int | FieldBasedT | bool | None,
func: FuncExceptT | None = None,
) -> VideoNodeT
Source code
425 426 427 428 429 430 431 |
|
ensure_presences staticmethod
¶
ensure_presences(
clip: VideoNodeT,
prop_enums: Iterable[type[PropEnumT] | PropEnumT],
func: FuncExceptT | None = None,
) -> VideoNodeT
Ensure the presence of multiple PropEnums at once.
Source code
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|
from_param classmethod
¶
from_param(value_or_tff: Any, func_except: Any = None) -> FieldBased | None
Source code
124 125 126 127 128 129 |
|
from_param_or_video classmethod
¶
from_param_or_video(
value: Any,
src: VideoNode | VideoFrame | FrameProps,
strict: bool = False,
func_except: FuncExceptT | None = None,
) -> Self
Get the enum member from a value that can be casted to this prop value or grab it from frame properties.
If strict=False
, gather the heuristics using the clip's size or format.
Parameters:
-
value
¶Any
) –Value to cast.
-
src
¶VideoNode | VideoFrame | FrameProps
) –Clip to get prop from.
-
strict
¶bool
, default:False
) –Be strict about the frame properties. Default: False.
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Source code
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
from_res classmethod
¶
from_res(frame: VideoNode | VideoFrame) -> FieldBased
Guess the Field order from the frame resolution.
Source code
131 132 133 134 135 |
|
from_video classmethod
¶
from_video(
src: VideoNode | VideoFrame | FrameProps,
strict: bool = False,
func: FuncExceptT | None = None,
) -> FieldBased
Obtain the Field order of a clip from the frame properties.
Parameters:
-
src
¶VideoNode | VideoFrame | FrameProps
) –Input clip, frame, or props.
-
strict
¶bool
, default:False
) –Be strict about the properties. Will ALWAYS error if the FieldBased is missing.
Returns:
-
FieldBased
–FieldBased object.
Raises:
-
UndefinedFieldBasedError
–Field order is undefined.
-
UndefinedFieldBasedError
–Field order can not be determined from the frame properties.
Source code
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
is_unknown classmethod
¶
Whether the value represents an unknown value.
Source code
26 27 28 29 30 |
|
is_valid classmethod
¶
Check if the given value is a valid int value of this enum.
Source code
148 149 150 151 |
|