Skip to content

types

Type Aliases:

  • BotFieldLeftShift –

    Type alias for the bottom field's horizontal shift in pixels.

  • BotFieldTopShift –

    Type alias for the bottom field's vertical shift in pixels.

  • Center –

    Type alias for the center point of the sigmoid curve, determining the midpoint of the transition.

  • FieldShift –

    Type alias for shifts in interlaced content.

  • LeftShift –

    Type alias for horizontal shift in pixels (left).

  • ShiftT –

    Deprecated type alias for shift in both horizontal and vertical directions.

  • Slope –

    Type alias for the slope of the sigmoid curve, controlling the steepness of the transition.

  • TopFieldLeftShift –

    Type alias for the top field's horizontal shift in pixels.

  • TopFieldTopShift –

    Type alias for the top field's vertical shift in pixels.

  • TopShift –

    Type alias for vertical shift in pixels (top).

Classes:

BotFieldLeftShift 

BotFieldLeftShift = float

Type alias for the bottom field's horizontal shift in pixels.

Used when processing interlaced video to describe the horizontal shift of the bottom field.

BotFieldTopShift 

BotFieldTopShift = float

Type alias for the bottom field's vertical shift in pixels.

Used when processing interlaced video to describe the vertical shift of the bottom field.

Center 

Center = float

Type alias for the center point of the sigmoid curve, determining the midpoint of the transition.

FieldShift 

FieldShift = tuple[
    TopShift | tuple[TopFieldTopShift, BotFieldTopShift],
    LeftShift | tuple[TopFieldLeftShift, BotFieldLeftShift],
]

Type alias for shifts in interlaced content.

Represents separate shifts for top and bottom fields.

LeftShift 

LeftShift = float

Type alias for horizontal shift in pixels (left).

Represents the amount of horizontal offset when scaling a video.

ShiftT 

ShiftT = (
    tuple[TopShift, LeftShift]
    | tuple[
        TopShift | tuple[TopFieldTopShift, BotFieldTopShift],
        LeftShift | tuple[TopFieldLeftShift, BotFieldLeftShift],
    ]
)

Deprecated type alias for shift in both horizontal and vertical directions.

Can either represent a single shift (for progressive video) or separate shifts for top and bottom fields (for interlaced video).

The first value in the tuple represents vertical shift, and the second represents horizontal shift.

Slope 

Slope = float

Type alias for the slope of the sigmoid curve, controlling the steepness of the transition.

TopFieldLeftShift 

TopFieldLeftShift = float

Type alias for the top field's horizontal shift in pixels.

Used when processing interlaced video to describe the horizontal shift of the top field.

TopFieldTopShift 

TopFieldTopShift = float

Type alias for the top field's vertical shift in pixels.

Used when processing interlaced video to describe the vertical shift of the top field.

TopShift 

TopShift = float

Type alias for vertical shift in pixels (top).

Represents the amount of vertical offset when scaling a video.

BorderHandling

Bases: CustomIntEnum

Methods:

Attributes:

MIRROR class-attribute instance-attribute 

MIRROR = 0

REPEAT class-attribute instance-attribute 

REPEAT = 2

ZERO class-attribute instance-attribute 

ZERO = 1

pad_amount cached 

pad_amount(size: int, min_amount: int = 2) -> int
Source code in vskernels/types.py 
51
52
53
54
55
56
@cache
def pad_amount(self, size: int, min_amount: int = 2) -> int:
    if self is BorderHandling.MIRROR:
        return 0

    return (((size + min_amount) + 7) & -8) - size

prepare_clip 

prepare_clip(
    clip: VideoNode,
    min_pad: int = 2,
    shift: tuple[TopShift, LeftShift] = (0, 0),
) -> tuple[VideoNode, tuple[TopShift, LeftShift]]
Source code in vskernels/types.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def prepare_clip(
    self, clip: vs.VideoNode, min_pad: int = 2, shift: tuple[TopShift, LeftShift] = (0, 0)
) -> tuple[vs.VideoNode, tuple[TopShift, LeftShift]]:
    pad_w, pad_h = (self.pad_amount(size, min_pad) for size in (clip.width, clip.height))

    if pad_w == pad_h == 0:
        return clip, shift

    match self:
        case BorderHandling.ZERO:
            padded = padder.COLOR(clip, pad_w, pad_w, pad_h, pad_h)
        case BorderHandling.REPEAT:
            padded = padder.REPEAT(clip, pad_w, pad_w, pad_h, pad_h)
        case _:
            raise CustomNotImplementedError

    shift = tuple(s + ((p - c) // 2) for s, c, p in zip(shift, *((x.height, x.width) for x in (clip, padded))))

    return padded, shift

SampleGridModel

Bases: CustomIntEnum

Methods:

Attributes:

MATCH_CENTERS class-attribute instance-attribute 

MATCH_CENTERS = 1

MATCH_EDGES class-attribute instance-attribute 

MATCH_EDGES = 0

__call__ 

__call__(
    width: int,
    height: int,
    src_width: float,
    src_height: float,
    shift: tuple[float, float],
    kwargs: dict[str, Any],
) -> tuple[dict[str, Any], tuple[float, float]]
Source code in vskernels/types.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def __call__(
    self,
    width: int,
    height: int,
    src_width: float,
    src_height: float,
    shift: tuple[float, float],
    kwargs: dict[str, Any],
) -> tuple[dict[str, Any], tuple[float, float]]:
    if self is SampleGridModel.MATCH_CENTERS:
        src_width = src_width * (width - 1) / (src_width - 1)
        src_height = src_height * (height - 1) / (src_height - 1)

        kwargs |= {"src_width": src_width, "src_height": src_height}
        shift_x, shift_y, *_ = tuple(
            (x / 2 + y for x, y in zip(((height - src_height), (width - src_width)), shift))
        )
        shift = shift_x, shift_y

    return kwargs, shift

for_dst 

for_dst(
    clip: VideoNode,
    width: int,
    height: int,
    shift: tuple[float, float],
    **kwargs: Any
) -> tuple[dict[str, Any], tuple[float, float]]
Source code in vskernels/types.py 
84
85
86
87
88
89
90
def for_dst(
    self, clip: vs.VideoNode, width: int, height: int, shift: tuple[float, float], **kwargs: Any
) -> tuple[dict[str, Any], tuple[float, float]]:
    src_width = kwargs.get("src_width", width)
    src_height = kwargs.get("src_height", height)

    return self(src_width, src_height, width, height, shift, kwargs)

for_src 

for_src(
    clip: VideoNode,
    width: int,
    height: int,
    shift: tuple[float, float],
    **kwargs: Any
) -> tuple[dict[str, Any], tuple[float, float]]
Source code in vskernels/types.py 
92
93
94
95
96
97
98
def for_src(
    self, clip: vs.VideoNode, width: int, height: int, shift: tuple[float, float], **kwargs: Any
) -> tuple[dict[str, Any], tuple[float, float]]:
    src_width = kwargs.get("src_width", clip.width)
    src_height = kwargs.get("src_height", clip.height)

    return self(width, height, src_width, src_height, shift, kwargs)