clips ¶
Classes:
-
ProcessVariableClip
–A helper class for processing variable format/resolution clip.
-
ProcessVariableFormatClip
–A helper class for processing variable format clip.
-
ProcessVariableResClip
–A helper class for processing variable resolution clip.
-
ProcessVariableResFormatClip
–A helper class for processing variable format and resolution clip.
Functions:
-
finalize_clip
–Finalize a clip for output to the encoder.
-
finalize_output
–Decorator implementation of finalize_clip.
-
initialize_clip
–Initialize a clip with default props.
-
initialize_input
–Decorator implementation of initialize_clip
ProcessVariableClip ¶
ProcessVariableClip(
clip: VideoNodeT,
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
)
Bases: DynamicClipsCache[T, VideoNodeT]
A helper class for processing variable format/resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of items allowed in the cache. Defaults to 10.
Methods:
-
eval_clip
– -
from_clip
–Process a variable format/resolution clip.
-
from_func
–Process a variable format/resolution clip with a given function
-
get_clip
– -
get_key
–Generate a unique key based on the node or frame.
-
normalize
–Normalize the given node to the format/resolution specified by the unique key
cast_to
. -
process
–Process the given clip.
Attributes:
-
cache_size
– -
clip
– -
out
–
Source code
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|
eval_clip ¶
eval_clip() -> VideoNodeT
Source code
352 353 354 355 356 357 358 359 |
|
from_clip classmethod
¶
from_clip(clip: VideoNodeT) -> VideoNodeT
Process a variable format/resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
364 365 366 367 368 369 370 371 372 373 374 375 |
|
from_func classmethod
¶
from_func(
clip: VideoNodeT,
func: Callable[[VideoNodeT], VideoNodeT],
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
) -> VideoNodeT
Process a variable format/resolution clip with a given function
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
-
func
¶Callable[[VideoNodeT], VideoNodeT]
) –Function that takes and returns a single VideoNode.
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of VideoNode allowed in the cache. Defaults to 10.
Returns:
-
VideoNodeT
–Processed variable clip.
Source code
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
|
get_clip ¶
get_clip(key: T) -> VideoNodeT
Source code
361 362 |
|
get_key abstractmethod
¶
get_key(frame: VideoNode | VideoFrame) -> T
Generate a unique key based on the node or frame. This key will be used to temporarily assert a resolution and format for the clip to process.
Parameters:
-
frame
¶VideoNode | VideoFrame
) –Node or frame from which the unique key is generated.
Returns:
-
T
–Unique identifier.
Source code
408 409 410 411 412 413 414 415 416 417 418 419 |
|
normalize abstractmethod
¶
normalize(clip: VideoNodeT, cast_to: T) -> VideoNodeT
Normalize the given node to the format/resolution specified by the unique key cast_to
.
Parameters:
-
clip
¶VideoNodeT
) –Clip to normalize.
-
cast_to
¶T
) –The target resolution or format to which the clip should be cast or normalized.
Returns:
-
VideoNodeT
–Normalized clip.
Source code
421 422 423 424 425 426 427 428 429 430 431 432 |
|
process ¶
process(clip: VideoNodeT) -> VideoNodeT
Process the given clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
434 435 436 437 438 439 440 441 442 443 444 |
|
ProcessVariableFormatClip ¶
ProcessVariableFormatClip(
clip: VideoNodeT,
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
)
Bases: ProcessVariableClip[VideoFormat, VideoNode]
A helper class for processing variable format clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of items allowed in the cache. Defaults to 10.
Methods:
-
eval_clip
– -
from_clip
–Process a variable format/resolution clip.
-
from_func
–Process a variable format/resolution clip with a given function
-
get_clip
– -
get_key
– -
normalize
– -
process
–Process the given clip.
Attributes:
-
cache_size
– -
clip
– -
out
–
Source code
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|
eval_clip ¶
eval_clip() -> VideoNodeT
Source code
352 353 354 355 356 357 358 359 |
|
from_clip classmethod
¶
from_clip(clip: VideoNodeT) -> VideoNodeT
Process a variable format/resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
364 365 366 367 368 369 370 371 372 373 374 375 |
|
from_func classmethod
¶
from_func(
clip: VideoNodeT,
func: Callable[[VideoNodeT], VideoNodeT],
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
) -> VideoNodeT
Process a variable format/resolution clip with a given function
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
-
func
¶Callable[[VideoNodeT], VideoNodeT]
) –Function that takes and returns a single VideoNode.
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of VideoNode allowed in the cache. Defaults to 10.
Returns:
-
VideoNodeT
–Processed variable clip.
Source code
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
|
get_clip ¶
get_clip(key: T) -> VideoNodeT
Source code
361 362 |
|
get_key ¶
get_key(frame: VideoNode | VideoFrame) -> VideoFormat
Source code
465 466 467 |
|
normalize ¶
normalize(clip: VideoNode, cast_to: VideoFormat) -> ConstantFormatVideoNode
Source code
469 470 471 |
|
process ¶
process(clip: VideoNodeT) -> VideoNodeT
Process the given clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
434 435 436 437 438 439 440 441 442 443 444 |
|
ProcessVariableResClip ¶
ProcessVariableResClip(
clip: VideoNodeT,
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
)
Bases: ProcessVariableClip[tuple[int, int], VideoNodeT]
A helper class for processing variable resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of items allowed in the cache. Defaults to 10.
Methods:
-
eval_clip
– -
from_clip
–Process a variable format/resolution clip.
-
from_func
–Process a variable format/resolution clip with a given function
-
get_clip
– -
get_key
– -
normalize
– -
process
–Process the given clip.
Attributes:
-
cache_size
– -
clip
– -
out
–
Source code
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|
eval_clip ¶
eval_clip() -> VideoNodeT
Source code
352 353 354 355 356 357 358 359 |
|
from_clip classmethod
¶
from_clip(clip: VideoNodeT) -> VideoNodeT
Process a variable format/resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
364 365 366 367 368 369 370 371 372 373 374 375 |
|
from_func classmethod
¶
from_func(
clip: VideoNodeT,
func: Callable[[VideoNodeT], VideoNodeT],
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
) -> VideoNodeT
Process a variable format/resolution clip with a given function
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
-
func
¶Callable[[VideoNodeT], VideoNodeT]
) –Function that takes and returns a single VideoNode.
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of VideoNode allowed in the cache. Defaults to 10.
Returns:
-
VideoNodeT
–Processed variable clip.
Source code
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
|
get_clip ¶
get_clip(key: T) -> VideoNodeT
Source code
361 362 |
|
get_key ¶
Source code
452 453 |
|
normalize ¶
normalize(clip: VideoNodeT, cast_to: tuple[int, int]) -> VideoNodeT
Source code
455 456 457 |
|
process ¶
process(clip: VideoNodeT) -> VideoNodeT
Process the given clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
434 435 436 437 438 439 440 441 442 443 444 |
|
ProcessVariableResFormatClip ¶
ProcessVariableResFormatClip(
clip: VideoNodeT,
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
)
Bases: ProcessVariableClip[tuple[int, int, VideoFormat], VideoNode]
A helper class for processing variable format and resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of items allowed in the cache. Defaults to 10.
Methods:
-
eval_clip
– -
from_clip
–Process a variable format/resolution clip.
-
from_func
–Process a variable format/resolution clip with a given function
-
get_clip
– -
get_key
– -
normalize
– -
process
–Process the given clip.
Attributes:
-
cache_size
– -
clip
– -
out
–
Source code
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|
eval_clip ¶
eval_clip() -> VideoNodeT
Source code
352 353 354 355 356 357 358 359 |
|
from_clip classmethod
¶
from_clip(clip: VideoNodeT) -> VideoNodeT
Process a variable format/resolution clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
364 365 366 367 368 369 370 371 372 373 374 375 |
|
from_func classmethod
¶
from_func(
clip: VideoNodeT,
func: Callable[[VideoNodeT], VideoNodeT],
out_dim: tuple[int, int] | Literal[False] | None = None,
out_fmt: int | VideoFormat | Literal[False] | None = None,
cache_size: int = 10,
) -> VideoNodeT
Process a variable format/resolution clip with a given function
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
-
func
¶Callable[[VideoNodeT], VideoNodeT]
) –Function that takes and returns a single VideoNode.
-
out_dim
¶tuple[int, int] | Literal[False] | None
, default:None
) –Ouput dimension.
-
out_fmt
¶int | VideoFormat | Literal[False] | None
, default:None
) –Output format.
-
cache_size
¶int
, default:10
) –The maximum number of VideoNode allowed in the cache. Defaults to 10.
Returns:
-
VideoNodeT
–Processed variable clip.
Source code
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
|
get_clip ¶
get_clip(key: T) -> VideoNodeT
Source code
361 362 |
|
get_key ¶
Source code
479 480 481 |
|
normalize ¶
Source code
483 484 485 486 487 488 |
|
process ¶
process(clip: VideoNodeT) -> VideoNodeT
Process the given clip.
Parameters:
-
clip
¶VideoNodeT
) –Clip to process.
Returns:
-
VideoNodeT
–Processed clip.
Source code
434 435 436 437 438 439 440 441 442 443 444 |
|
finalize_clip ¶
finalize_clip(
clip: VideoNode,
bits: VideoFormatT | HoldsVideoFormatT | int | None = 10,
clamp_tv_range: bool = False,
dither_type: DitherType = AUTO,
*,
func: FuncExceptT | None = None
) -> ConstantFormatVideoNode
Finalize a clip for output to the encoder.
Parameters:
-
clip
¶VideoNode
) –Clip to output.
-
bits
¶VideoFormatT | HoldsVideoFormatT | int | None
, default:10
) –Bitdepth to output to.
-
clamp_tv_range
¶bool
, default:False
) –Whether to clamp to tv range.
-
dither_type
¶DitherType
, default:AUTO
) –Dithering used for the bitdepth conversion.
-
func
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling. This should only be set by VS package developers.
Returns:
-
ConstantFormatVideoNode
–Dithered down and optionally clamped clip.
Source code
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
|
finalize_output ¶
finalize_output(
function: Callable[P, VideoNode] | None = None,
/,
*,
bits: int | None = 10,
clamp_tv_range: bool = False,
dither_type: DitherType = AUTO,
func: FuncExceptT | None = None,
) -> Union[
Callable[P, VideoNode],
Callable[[Callable[P, VideoNode]], Callable[P, ConstantFormatVideoNode]],
]
Decorator implementation of finalize_clip.
Source code
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
initialize_clip ¶
initialize_clip(
clip: VideoNode,
bits: int | None = None,
matrix: MatrixT | None = None,
transfer: TransferT | None = None,
primaries: PrimariesT | None = None,
chroma_location: ChromaLocationT | None = None,
color_range: ColorRangeT | None = None,
field_based: FieldBasedT | None = None,
strict: bool = False,
dither_type: DitherType = AUTO,
*,
func: FuncExceptT | None = None
) -> ConstantFormatVideoNode
Initialize a clip with default props.
It is HIGHLY recommended to always use this function at the beginning of your scripts!
Parameters:
-
clip
¶VideoNode
) –Clip to initialize.
-
bits
¶int | None
, default:None
) –Bits to dither to.
- If 0, no dithering is applied.
- If None, 16 if bit depth is lower than it, else leave untouched.
- If positive integer, dither to that bitdepth.
-
matrix
¶MatrixT | None
, default:None
) –Matrix property to set. If None, tries to get the Matrix from existing props. If no props are set or Matrix=2, guess from the video resolution.
-
transfer
¶TransferT | None
, default:None
) –Transfer property to set. If None, tries to get the Transfer from existing props. If no props are set or Transfer=2, guess from the video resolution.
-
primaries
¶PrimariesT | None
, default:None
) –Primaries property to set. If None, tries to get the Primaries from existing props. If no props are set or Primaries=2, guess from the video resolution.
-
chroma_location
¶ChromaLocationT | None
, default:None
) –ChromaLocation prop to set. If None, tries to get the ChromaLocation from existing props. If no props are set, guess from the video resolution.
-
color_range
¶ColorRangeT | None
, default:None
) –ColorRange prop to set. If None, tries to get the ColorRange from existing props. If no props are set, assume Limited Range.
-
field_based
¶FieldBasedT | None
, default:None
) –FieldBased prop to set. If None, tries to get the FieldBased from existing props. If no props are set, assume PROGRESSIVE.
-
strict
¶bool
, default:False
) –Whether to be strict about existing properties. If True, throws an exception if certain frame properties are not found.
-
dither_type
¶DitherType
, default:AUTO
) –Dithering used for the bitdepth conversion.
-
func
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling. This should only be set by VS package developers.
Returns:
-
ConstantFormatVideoNode
–Clip with relevant frame properties set, and optionally dithered up to 16 bits by default.
Source code
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
|
initialize_input ¶
initialize_input(
function: Callable[P, VideoNodeT],
/,
*,
bits: int | None = 16,
matrix: MatrixT | None = None,
transfer: TransferT | None = None,
primaries: PrimariesT | None = None,
chroma_location: ChromaLocationT | None = None,
color_range: ColorRangeT | None = None,
field_based: FieldBasedT | None = None,
strict: bool = False,
dither_type: DitherType = AUTO,
func: FuncExceptT | None = None,
) -> Callable[P, VideoNodeT]
initialize_input(
*,
bits: int | None = 16,
matrix: MatrixT | None = None,
transfer: TransferT | None = None,
primaries: PrimariesT | None = None,
chroma_location: ChromaLocationT | None = None,
color_range: ColorRangeT | None = None,
field_based: FieldBasedT | None = None,
dither_type: DitherType = AUTO,
func: FuncExceptT | None = None
) -> Callable[[Callable[P, VideoNodeT]], Callable[P, VideoNodeT]]
initialize_input(
function: Callable[P, VideoNode] | None = None,
/,
*,
bits: int | None = 16,
matrix: MatrixT | None = None,
transfer: TransferT | None = None,
primaries: PrimariesT | None = None,
chroma_location: ChromaLocationT | None = None,
color_range: ColorRangeT | None = None,
field_based: FieldBasedT | None = None,
strict: bool = False,
dither_type: DitherType = AUTO,
func: FuncExceptT | None = None,
) -> Union[
Callable[P, VideoNodeT],
Callable[[Callable[P, VideoNodeT]], Callable[P, VideoNodeT]],
]
Decorator implementation of initialize_clip
Source code
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
|