Skip to content

normalize

Functions:

flatten

flatten(items: Iterable[Iterable[T]]) -> Iterator[T]
flatten(items: Iterable[Any]) -> Iterator[Any]
flatten(items: Any) -> Iterator[Any]
flatten(items: Any) -> Iterator[Any]

Flatten an array of values, clips and frames included.

Source code
124
125
126
127
128
129
130
def flatten(items: Any) -> Iterator[Any]:
    """Flatten an array of values, clips and frames included."""

    if isinstance(items, (vs.RawNode, vs.RawFrame)):
        yield items
    else:
        yield from jetp_flatten(items)

flatten_vnodes

flatten_vnodes(
    *clips: VideoNodeIterableT[VideoNodeT], split_planes: Literal[False] = ...
) -> Sequence[VideoNodeT]
flatten_vnodes(
    *clips: VideoNodeIterableT[VideoNodeT], split_planes: Literal[True] = ...
) -> Sequence[ConstantFormatVideoNode]
flatten_vnodes(
    *clips: VideoNodeIterableT[VideoNodeT], split_planes: bool = ...
) -> Sequence[VideoNodeT]
flatten_vnodes(
    *clips: VideoNodeIterableT[VideoNodeT], split_planes: bool = False
) -> Sequence[VideoNode]

Flatten an array of VideoNodes.

Parameters:

  • clips

    (VideoNodeIterableT[VideoNodeT], default: () ) –

    An array of clips to flatten into a list.

  • split_planes

    (bool, default: False ) –

    Optionally split the VideoNodes into their individual planes as well. Default: False.

Returns:

  • Sequence[VideoNode]

    Flattened list of VideoNodes.

Source code
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def flatten_vnodes(
    *clips: VideoNodeIterableT[VideoNodeT], split_planes: bool = False
) -> Sequence[vs.VideoNode]:
    """
    Flatten an array of VideoNodes.

    :param clips:           An array of clips to flatten into a list.
    :param split_planes:    Optionally split the VideoNodes into their individual planes as well.
                            Default: False.

    :return:                Flattened list of VideoNodes.
    """

    from .utils import split

    nodes = list[VideoNodeT](flatten(clips))

    if not split_planes:
        return nodes

    return sum(map(split, nodes), list[ConstantFormatVideoNode]())

invert_planes

invert_planes(clip: VideoNode, planes: PlanesT = None) -> list[int]

Invert a sequence of planes.

Parameters:

  • clip

    (VideoNode) –

    Input clip.

  • planes

    (PlanesT, default: None ) –

    Array of planes. If None, selects all planes of the input clip's format.

Returns:

  • list[int]

    Sorted inverted list of planes.

Source code
68
69
70
71
72
73
74
75
76
77
def invert_planes(clip: vs.VideoNode, planes: PlanesT = None) -> list[int]:
    """
    Invert a sequence of planes.

    :param clip:        Input clip.
    :param planes:      Array of planes. If None, selects all planes of the input clip's format.

    :return:            Sorted inverted list of planes.
    """
    return sorted(set(normalize_planes(clip, None)) - set(normalize_planes(clip, planes)))

invert_ranges

invert_ranges(
    clipa: VideoNode,
    clipb: VideoNode | None,
    ranges: FrameRangeN | FrameRangesN,
) -> list[tuple[int, int]]

Invert FrameRanges.

Example:

.. code-block:: python

>>> franges = [(100, 200), 600, (1200, 2400)]
>>> invert_ranges(core.std.BlankClip(length=10000), core.std.BlankClip(length=10000), franges)
[(0, 99), (201, 599), (601, 1199), (2401, 9999)]

Parameters:

  • clipa

    (VideoNode) –

    Original clip.

  • clipb

    (VideoNode | None) –

    Replacement clip.

  • ranges

    (FrameRangeN | FrameRangesN) –

    Ranges to replace clipa (original clip) with clipb (replacement clip). These ranges will be inverted. For more info, see replace_ranges.

Returns:

Source code
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
def invert_ranges(
    clipa: vs.VideoNode, clipb: vs.VideoNode | None, ranges: FrameRangeN | FrameRangesN
) -> list[tuple[int, int]]:
    """
    Invert FrameRanges.

    Example:

    .. code-block:: python

        >>> franges = [(100, 200), 600, (1200, 2400)]
        >>> invert_ranges(core.std.BlankClip(length=10000), core.std.BlankClip(length=10000), franges)
        [(0, 99), (201, 599), (601, 1199), (2401, 9999)]

    :param clipa:          Original clip.
    :param clipb:          Replacement clip.
    :param ranges:         Ranges to replace clipa (original clip) with clipb (replacement clip).
                           These ranges will be inverted. For more info, see `replace_ranges`.

    :return:                A list of inverted frame ranges.
    """

    return jetp_invert_ranges(ranges, clipa.num_frames, None if clipb is None else clipb.num_frames)

normalize_param_planes

normalize_param_planes(
    clip: VideoNode,
    param: T | Sequence[T],
    planes: PlanesT,
    null: T,
    func: FuncExceptT | None = None,
) -> list[T]

Normalize a value or sequence to a list mapped to the clip's planes.

For any plane not included in planes, the corresponding output value is set to null.

Parameters:

  • clip

    (VideoNode) –

    The input clip whose format and number of planes will be used to determine mapping.

  • param

    (T | Sequence[T]) –

    A single value or a sequence of values to normalize across the clip's planes.

  • planes

    (PlanesT) –

    The planes to apply the values to. Other planes will receive null.

  • null

    (T) –

    The default value to use for planes that are not included in planes.

  • func

    (FuncExceptT | None, default: None ) –

    Function returned for custom error handling.

Returns:

  • list[T]

    A list of length equal to the number of planes in the clip, with param values or null.

Source code
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def normalize_param_planes(
    clip: vs.VideoNode, param: T | Sequence[T], planes: PlanesT, null: T, func: FuncExceptT | None = None
) -> list[T]:
    """
    Normalize a value or sequence to a list mapped to the clip's planes.

    For any plane not included in `planes`, the corresponding output value is set to `null`.

    :param clip:    The input clip whose format and number of planes will be used to determine mapping.
    :param param:   A single value or a sequence of values to normalize across the clip's planes.
    :param planes:  The planes to apply the values to. Other planes will receive `null`.
    :param null:    The default value to use for planes that are not included in `planes`.
    :param func:    Function returned for custom error handling.

    :return:        A list of length equal to the number of planes in the clip, with `param` values or `null`.
    """
    func = func or normalize_param_planes

    from .check import check_variable_format

    assert check_variable_format(clip, func)

    planes = normalize_planes(clip, planes)

    return [
        p if i in planes else null for i, p in enumerate(normalize_seq(param, clip.format.num_planes))
    ]

normalize_planes

normalize_planes(clip: VideoNode, planes: PlanesT = None) -> list[int]

Normalize a sequence of planes.

Parameters:

  • clip

    (VideoNode) –

    Input clip.

  • planes

    (PlanesT, default: None ) –

    Array of planes. If None, returns all planes of the input clip's format. Default: None.

Returns:

  • list[int]

    Sorted list of planes.

Source code
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def normalize_planes(clip: vs.VideoNode, planes: PlanesT = None) -> list[int]:
    """
    Normalize a sequence of planes.

    :param clip:        Input clip.
    :param planes:      Array of planes. If None, returns all planes of the input clip's format.
                        Default: None.

    :return:            Sorted list of planes.
    """

    assert clip.format

    if planes is None or planes == 4:
        planes = list(range(clip.format.num_planes))
    else:
        planes = to_arr(planes)

    return list(sorted(set(planes).intersection(range(clip.format.num_planes))))

normalize_ranges

normalize_ranges(
    clip: VideoNode, ranges: FrameRangeN | FrameRangesN
) -> list[tuple[int, int]]

Normalize ranges to a list of positive ranges.

Frame ranges can include None and negative values. None will be converted to either 0 if it's the first value in a FrameRange, or the clip's length if it's the second item. Negative values will be subtracted from the clip's length.

Examples:

.. code-block:: python

>>> clip.num_frames
1000
>>> normalize_ranges(clip, (None, None))
[(0, 999)]
>>> normalize_ranges(clip, (24, -24))
[(24, 975)]
>>> normalize_ranges(clip, [(24, 100), (80, 150)])
[(24, 150)]

Parameters:

Returns:

Source code
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def normalize_ranges(clip: vs.VideoNode, ranges: FrameRangeN | FrameRangesN) -> list[tuple[int, int]]:
    """
    Normalize ranges to a list of positive ranges.

    Frame ranges can include `None` and negative values.
    None will be converted to either 0 if it's the first value in a FrameRange,
    or the clip's length if it's the second item.
    Negative values will be subtracted from the clip's length.

    Examples:

    .. code-block:: python

        >>> clip.num_frames
        1000
        >>> normalize_ranges(clip, (None, None))
        [(0, 999)]
        >>> normalize_ranges(clip, (24, -24))
        [(24, 975)]
        >>> normalize_ranges(clip, [(24, 100), (80, 150)])
        [(24, 150)]


    :param clip:        Input clip.
    :param ranges:      Frame range or list of frame ranges.

    :return:            List of positive frame ranges.
    """

    return jetp_normalize_ranges(ranges, clip.num_frames)

normalize_seq

normalize_seq(val: T | Sequence[T], length: int = 3) -> list[T]
normalize_seq(val: Any, length: int = 3) -> list[Any]
normalize_seq(val: T | Sequence[T], length: int = 3) -> list[T]

Normalize a sequence to the given length.

Source code
41
42
43
44
def normalize_seq(val: T | Sequence[T], length: int = 3) -> list[T]:
    """Normalize a sequence to the given length."""

    return jetp_normalize_seq(val, length)