base ¶
This module defines the base abstract interfaces for general scaling operations.
Classes:
-
Descaler
–Abstract descaling interface.
-
Kernel
–Abstract kernel interface combining scaling, descaling, resampling, and shifting functionality.
-
Resampler
–Abstract resampling interface.
-
Scaler
–Abstract scaling interface.
Attributes:
-
DescalerLike
–Type alias for anything that can resolve to a Descaler.
-
KernelLike
–Type alias for anything that can resolve to a Kernel.
-
ResamplerLike
–Type alias for anything that can resolve to a Resampler.
-
ScalerLike
–Type alias for anything that can resolve to a Scaler.
DescalerLike module-attribute
¶
Type alias for anything that can resolve to a Descaler.
This includes
- A string identifier.
- A class type subclassing
Descaler
. - An instance of a
Descaler
.
KernelLike module-attribute
¶
Type alias for anything that can resolve to a Kernel.
This includes
- A string identifier.
- A class type subclassing
Kernel
. - An instance of a
Kernel
.
ResamplerLike module-attribute
¶
Type alias for anything that can resolve to a Resampler.
This includes
- A string identifier.
- A class type subclassing
Resampler
. - An instance of a
Resampler
.
ScalerLike module-attribute
¶
Type alias for anything that can resolve to a Scaler.
This includes
- A string identifier.
- A class type subclassing
Scaler
. - An instance of a
Scaler
.
abstract_kernels module-attribute
¶
abstract_kernels: list[BaseScalerMeta] = []
List of fully abstract kernel classes.
Used internally to track kernel base classes that should not be used directly.
partial_abstract_kernels module-attribute
¶
partial_abstract_kernels: list[BaseScalerMeta] = []
List of partially abstract kernel classes.
These may implement some but not all kernel functionality.
BaseScaler ¶
Base abstract scaling interface for VapourSynth scalers.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
pretty_string
–Cached property returning a user-friendly string representation.
Attributes:
Source code
310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
BaseScalerMeta ¶
Bases: ABCMeta
Metaclass for scaler classes.
This metaclass can be used to enforce abstraction rules by specifying abstract
or partial_abstract
as keyword arguments in the class definition.
- If
abstract=True
: The class is marked as fully abstract and added to theabstract_kernels
registry. It should not be instantiated. - If
partial_abstract=True
: The class is considered partially abstract, meaning it may lack certain implementations (e.g., kernel radius) but is still allowed to be instantiated. It is added topartial_abstract_kernels
.
Descaler ¶
Bases: BaseScaler
Abstract descaling interface.
Subclasses must define the descale_function
used to perform the descaling.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
descale
–Descale a clip to the given resolution.
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_descale_args
–Construct the argument dictionary used for descaling.
-
get_rescale_args
–Construct the argument dictionary used for upscaling.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip.
Attributes:
-
descale_function
(Callable[..., ConstantFormatVideoNode]
) –Descale function called internally when performing descaling operations.
-
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
rescale_function
(Callable[..., ConstantFormatVideoNode]
) –Rescale function called internally when performing upscaling operations.
Source code
310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
descale_function instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode]
Descale function called internally when performing descaling operations.
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
rescale_function instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode]
Rescale function called internally when performing upscaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None,
height: int | None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Descale a clip to the given resolution.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
) –Target descaled width (defaults to clip width if None).
-
height
¶int | None
) –Target descaled height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
Returns:
-
ConstantFormatVideoNode
–The descaled clip.
Source code
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_descale_args ¶
get_descale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Construct the argument dictionary used for descaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width for descaling.
-
height
¶int | None
, default:None
) –Target height for descaling.
-
**kwargs
¶Any
, default:{}
) –Extra keyword arguments to merge.
Returns:
Source code
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
|
get_rescale_args ¶
get_rescale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Construct the argument dictionary used for upscaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width for upscaling.
-
height
¶int | None
, default:None
) –Target height for upscaling.
-
**kwargs
¶Any
, default:{}
) –Extra keyword arguments to merge.
Returns:
Source code
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None,
height: int | None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
) –Target scaled height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 |
|
Kernel ¶
Bases: Scaler
, Descaler
, Resampler
Abstract kernel interface combining scaling, descaling, resampling, and shifting functionality.
Subclasses are expected to implement the actual transformation logic by overriding the methods or providing the respective *_function
callables (scale_function
, descale_function
, resample_function
).
This class is abstract and should not be used directly.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
descale
–Descale a clip to the given resolution.
-
ensure_obj
–Ensure that the given kernel input is returned as a kernel instance.
-
from_param
–Resolve and return a kernel class from a string name, class type, or instance.
-
get_descale_args
–Generate and normalize argument dictionary for a descale operation.
-
get_params_args
–Generate a base set of parameters to pass for scaling, descaling, or resampling.
-
get_resample_args
–Generate and normalize argument dictionary for a resample operation.
-
get_rescale_args
–Generate and normalize argument dictionary for a rescale operation.
-
get_scale_args
–Generate and normalize argument dictionary for a scale operation.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
pretty_string
–Cached property returning a user-friendly string representation.
-
resample
–Resample a video clip to the given format.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip.
-
scale
–Scale a clip to a specified resolution.
-
shift
–Apply a subpixel shift to the clip using the kernel's scaling logic.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
descale_function
(Callable[..., ConstantFormatVideoNode]
) –Descale function called internally when performing descaling operations.
-
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) –Resample function called internally when performing resampling operations.
-
rescale_function
(Callable[..., ConstantFormatVideoNode]
) –Rescale function called internally when performing upscaling operations.
-
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
Source code
310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
descale_function instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode]
Descale function called internally when performing descaling operations.
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode]
Resample function called internally when performing resampling operations.
rescale_function instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode]
Rescale function called internally when performing upscaling operations.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None,
height: int | None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Descale a clip to the given resolution.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
) –Target descaled width (defaults to clip width if None).
-
height
¶int | None
) –Target descaled height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
Returns:
-
ConstantFormatVideoNode
–The descaled clip.
Source code
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
|
ensure_obj classmethod
¶
ensure_obj(
kernel: KernelLike | None = None, /, func_except: FuncExceptT | None = None
) -> Self
Ensure that the given kernel input is returned as a kernel instance.
Parameters:
-
kernel
¶KernelLike | None
, default:None
) –Kernel name, class, or instance. Defaults to current class if None.
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–The resolved and instantiated kernel.
Source code
906 907 908 909 910 911 912 913 914 915 916 917 918 |
|
from_param classmethod
¶
from_param(
kernel: KernelLike | None = None, /, func_except: FuncExceptT | None = None
) -> type[Self]
Resolve and return a kernel class from a string name, class type, or instance.
Parameters:
-
kernel
¶KernelLike | None
, default:None
) –Kernel identifier as a string, class type, or instance. If None, defaults to the current class.
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–The resolved kernel class.
Raises:
-
UnknownKernelError
–If the kernel could not be identified.
Source code
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 |
|
get_descale_args ¶
get_descale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a descale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the descale function.
Returns:
Source code
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 |
|
get_params_args ¶
get_params_args(
is_descale: bool,
clip: VideoNode,
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate a base set of parameters to pass for scaling, descaling, or resampling.
Parameters:
-
is_descale
¶bool
) –Whether this is for a descale operation.
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Additional keyword arguments to include.
Returns:
Source code
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 |
|
get_resample_args ¶
get_resample_args(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None,
matrix_in: MatrixT | None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a resample operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –The target video format, which can either be:
- an integer format ID,
- a
vs.PresetVideoFormat
orvs.VideoFormat
, - or a source from which a valid
VideoFormat
can be extracted.
-
matrix
¶MatrixT | None
) –Target color matrix.
-
matrix_in
¶MatrixT | None
) –Source color matrix.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the resample function.
Returns:
Source code
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 |
|
get_rescale_args ¶
get_rescale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a rescale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the rescale function.
Returns:
Source code
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a scale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the scale function.
Returns:
Source code
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
resample ¶
resample(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None = None,
matrix_in: MatrixT | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Resample a video clip to the given format.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –The target video format, which can either be:
- an integer format ID,
- a
vs.PresetVideoFormat
orvs.VideoFormat
, - or a source from which a valid
VideoFormat
can be extracted.
-
matrix
¶MatrixT | None
, default:None
) –An optional color transformation matrix to apply.
-
matrix_in
¶MatrixT | None
, default:None
) –An optional input matrix for color transformations.
-
**kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the
resample_function
.
Returns:
-
ConstantFormatVideoNode
–The resampled clip.
Source code
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None,
height: int | None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
) –Target scaled height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNode | ConstantFormatVideoNode
Scale a clip to a specified resolution.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
, default:None
) –Target width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNode | ConstantFormatVideoNode
–The scaled clip.
Source code
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
shift ¶
shift(
clip: VideoNode,
shifts_or_top: float | tuple[float, float] | list[float],
shift_left: float | list[float] | None = None,
/,
**kwargs: Any,
) -> ConstantFormatVideoNode
Apply a subpixel shift to the clip using the kernel's scaling logic.
If a single float or tuple is provided, it is used uniformly. If a list is given, the shift is applied per plane.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shifts_or_top
¶float | tuple[float, float] | list[float]
) –Either a single vertical shift, a (top, left) tuple, or a list of vertical shifts.
-
shift_left
¶float | list[float] | None
, default:None
) –Horizontal shift or list of horizontal shifts. Ignored if
shifts_or_top
is a tuple. -
**kwargs
¶Any
, default:{}
) –Additional arguments passed to the internal
scale
call.
Returns:
-
ConstantFormatVideoNode
–A new clip with the applied shift.
Raises:
-
VariableFormatError
–If the input clip has variable format.
-
CustomValueError
–If the input clip is GRAY but lists of shift has been passed.
Source code
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
Resampler ¶
Bases: BaseScaler
Abstract resampling interface.
Subclasses must define the resample_function
used to perform the resampling.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_resample_args
–Construct the argument dictionary used for resampling.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
resample
–Resample a video clip to the given format.
Attributes:
-
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) –Resample function called internally when performing resampling operations.
Source code
310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode]
Resample function called internally when performing resampling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_resample_args ¶
get_resample_args(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None,
matrix_in: MatrixT | None,
**kwargs: Any
) -> dict[str, Any]
Construct the argument dictionary used for resampling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –The target video format, which can either be:
- an integer format ID,
- a
vs.PresetVideoFormat
orvs.VideoFormat
, - or a source from which a valid
VideoFormat
can be extracted.
-
matrix
¶MatrixT | None
) –The matrix for color transformation.
-
matrix_in
¶MatrixT | None
) –The input matrix for color transformation.
-
**kwargs
¶Any
, default:{}
) –Additional keyword arguments for resampling.
Returns:
Source code
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
resample ¶
resample(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None = None,
matrix_in: MatrixT | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Resample a video clip to the given format.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –The target video format, which can either be:
- an integer format ID,
- a
vs.PresetVideoFormat
orvs.VideoFormat
, - or a source from which a valid
VideoFormat
can be extracted.
-
matrix
¶MatrixT | None
, default:None
) –An optional color transformation matrix to apply.
-
matrix_in
¶MatrixT | None
, default:None
) –An optional input matrix for color transformations.
-
**kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the
resample_function
.
Returns:
-
ConstantFormatVideoNode
–The resampled clip.
Source code
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
|
Scaler ¶
Bases: BaseScaler
Abstract scaling interface.
Subclasses should define a scale_function
to perform the actual scaling logic.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale a clip to a specified resolution.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
Source code
310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNode | ConstantFormatVideoNode
Scale a clip to a specified resolution.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
, default:None
) –Target width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNode | ConstantFormatVideoNode
–The scaled clip.
Source code
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|