rescale ¶

Bases: RescaleBase

Rescale wrapper supporting everything you need for (fractional) descaling, re-upscaling and masking-out details.

Examples usage:

• Basic 720p rescale:

  from vsscale import Rescale
  from vskernels import Bilinear
  
  rs = Rescale(clip, 720, Bilinear)
  final = rs.upscale
  

• Adding aa and dehalo on doubled clip:

  from vsaa import based_aa
  from vsdehalo import fine_dehalo
  
  aa = based_aa(rs.doubled, supersampler=False)
  dehalo = fine_dehalo(aa, ...)
  
  rs.doubled = dehalo
  

• Loading line_mask and credit_mask:

  from vsmasktools import diff_creditless_oped
  from vsexprtools import ExprOp
  
  rs.default_line_mask()
  
  oped_credit_mask = diff_creditless_oped(...)
  credit_mask = rs.default_credit_mask(thr=0.209, ranges=(200, 300), postfilter=4)
  rs.credit_mask = ExprOp.ADD.combine(oped_credit_mask, credit_mask)
  

• Fractional rescale:

  from vsscale import Rescale
  from vskernels import Bilinear
  
  # Forcing the height to a float will ensure a fractional descale
  rs = Rescale(clip, 800.0, Bilinear)
  >>> rs.descale_args
  ScalingArgs(
      width=1424, height=800, src_width=1422.2222222222222, src_height=800.0,
      src_top=0.0, src_left=0.8888888888889142, mode='hw'
  )
  
  # while doing this will not
  rs = Rescale(clip, 800, Bilinear)
  >>> rs.descale_args
  ScalingArgs(width=1422, height=800, src_width=1422, src_height=800, src_top=0, src_left=0, mode='hw')
  

• Cropping is also supported:

  from vsscale import Rescale
  from vskernels import Bilinear
  
  # Descaling while cropping the letterboxes at the top and bottom
  rs = Rescale(clip, 874, Bilinear, crop=(0, 0, 202, 202))
  >>> rs.descale_args
  ScalingArgs(
      width=1554, height=548, src_width=1554.0, src_height=547.0592592592592,
      src_top=0.4703703703703752, src_left=0.0, mode='hw'
  )
  
  # Same thing but ensuring the width is fractional descaled
  rs = Rescale(clip, 874.0, Bilinear, crop=(0, 0, 202, 202))
  >>> rs.descale_args
  ScalingArgs(
      width=1554, height=548, src_width=1553.7777777777778, src_height=547.0592592592592,
      src_top=0.4703703703703752, src_left=0.11111111111108585, mode='hw'
  )
  

Initialize the rescaling process.

Parameters:

• clip ¶

  (VideoNode) –

  Clip to be rescaled.

• height ¶

  (int | float) –

  Height to be descaled to. If passed as a float, a fractional descale is performed.

• kernel ¶

  (KernelLike) –

  Kernel used for descaling.

• upscaler ¶

  (ScalerLike, default: ArtCNN ) –

  Scaler that supports doubling. Defaults to ArtCNN.

• downscaler ¶

  (ScalerLike, default: Hermite(linear=True) ) –

  Scaler used to downscale the upscaled clip back to input resolution. Defaults to Hermite(linear=True).

• width ¶

  (int | float | None, default: None ) –

  Width to be descaled to. If None, it is automatically calculated from the height.

• base_height ¶

  (int | None, default: None ) –

  Integer height to contain the clip within. If None, it is automatically calculated from the height.

• base_width ¶

  (int | None, default: None ) –

  Integer width to contain the clip within. If None, it is automatically calculated from the width.

• crop ¶

  (tuple[LeftCrop, RightCrop, TopCrop, BottomCrop], default: CropRel() ) –

  Cropping values to apply before descale. The ratio descale_height / source_height is preserved even after descale. The cropped area is restored when calling the upscale property.

• shift ¶

  (tuple[TopShift, LeftShift], default: (0, 0) ) –

  Pixel shifts to apply during descale and upscale. Defaults to (0, 0).

• field_based ¶

  (FieldBasedT | bool | None, default: None ) –

  Whether the input is cross-converted or interlaced content.

• border_handling ¶

  (int | BorderHandling, default: MIRROR ) –

  Adjusts how the clip is padded internally during the scaling process. Accepted values are:

  • 0 (MIRROR): Assume the image was resized with mirror padding.
  • 1 (ZERO): Assume the image was resized with zero padding.
  • 2 (EXTEND): Assume the image was resized with extend padding, where the outermost row was extended infinitely far.

  Defaults to 0.

Methods:

• default_credit_mask –

  Load a credit mask by making a difference mask between src and rescaled clips

• default_line_mask –

  Load a default Kirsch line mask in the class instance. Additionally, it is returned.

Attributes:

• credit_mask (ConstantFormatVideoNode) –

  Gets the credit mask to be applied on the upscaled clip.

• descale (ConstantFormatVideoNode) –

  Gets the descaled clip.

• descale_args –
• doubled (ConstantFormatVideoNode) –

  Gets the doubled clip.

• ignore_mask (ConstantFormatVideoNode) –

  Gets the ignore mask to be applied on the descaled clip.

• line_mask (ConstantFormatVideoNode) –

  Gets the lineart mask to be applied on the upscaled clip.

• rescale (ConstantFormatVideoNode) –

  Gets the rescaled clip.

• upscale (ConstantFormatVideoNode) –

  Returns the upscaled clip

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
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
351

def __init__(
    self,
    clip: vs.VideoNode,
    /,
    height: int | float,
    kernel: KernelLike,
    upscaler: ScalerLike = ArtCNN,
    downscaler: ScalerLike = Hermite(linear=True),
    width: int | float | None = None,
    base_height: int | None = None,
    base_width: int | None = None,
    crop: tuple[LeftCrop, RightCrop, TopCrop, BottomCrop] = CropRel(),
    shift: tuple[TopShift, LeftShift] = (0, 0),
    field_based: FieldBasedT | bool | None = None,
    border_handling: int | BorderHandling = BorderHandling.MIRROR,
    **kwargs: Any,
) -> None:
    """
    Initialize the rescaling process.

    Args:
        clip: Clip to be rescaled.
        height: Height to be descaled to. If passed as a float, a fractional descale is performed.
        kernel: Kernel used for descaling.
        upscaler: Scaler that supports doubling. Defaults to ``ArtCNN``.
        downscaler: Scaler used to downscale the upscaled clip back to input resolution. Defaults to
            ``Hermite(linear=True)``.
        width: Width to be descaled to. If ``None``, it is automatically calculated from the height.
        base_height: Integer height to contain the clip within. If ``None``, it is automatically calculated from the
            height.
        base_width: Integer width to contain the clip within. If ``None``, it is automatically calculated from the
            width.
        crop: Cropping values to apply before descale. The ratio ``descale_height / source_height`` is preserved
            even after descale. The cropped area is restored when calling the ``upscale`` property.
        shift: Pixel shifts to apply during descale and upscale. Defaults to ``(0, 0)``.
        field_based: Whether the input is cross-converted or interlaced content.
        border_handling: Adjusts how the clip is padded internally during the scaling process.
            Accepted values are:

               - ``0`` (MIRROR): Assume the image was resized with mirror padding.
               - ``1`` (ZERO):   Assume the image was resized with zero padding.
               - ``2`` (EXTEND): Assume the image was resized with extend padding,
                 where the outermost row was extended infinitely far.

            Defaults to ``0``.
    """
    self._line_mask: ConstantFormatVideoNode | None = None
    self._credit_mask: ConstantFormatVideoNode | None = None
    self._ignore_mask: ConstantFormatVideoNode | None = None
    self._crop = crop
    self._pre = clip

    self.descale_args = ScalingArgs.from_args(
        clip, height, width, base_height, base_width, shift[0], shift[1], crop, mode="hw"
    )

    super().__init__(clip, kernel, upscaler, downscaler, field_based, border_handling, **kwargs)

    if self._crop > (0, 0, 0, 0):
        self._clipy = self._clipy.std.Crop(*self._crop)

credit_mask: ConstantFormatVideoNode

descale: ConstantFormatVideoNode

descale_args = from_args(
    clip,
    height,
    width,
    base_height,
    base_width,
    shift[0],
    shift[1],
    crop,
    mode="hw",
)

doubled: ConstantFormatVideoNode

ignore_mask: ConstantFormatVideoNode

line_mask: ConstantFormatVideoNode

rescale: ConstantFormatVideoNode

upscale: ConstantFormatVideoNode

default_credit_mask(
    rescale: VideoNode | None = None,
    src: VideoNode | None = None,
    thr: float = 0.216,
    expand: int = 4,
    ranges: FrameRangeN | FrameRangesN | None = None,
    stabilize: bool | tuple[Sequence[float], float] = False,
    **kwargs: Any
) -> ConstantFormatVideoNode

518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587

def default_credit_mask(
    self,
    rescale: vs.VideoNode | None = None,
    src: vs.VideoNode | None = None,
    thr: float = 0.216,
    expand: int = 4,
    ranges: FrameRangeN | FrameRangesN | None = None,
    stabilize: bool | tuple[Sequence[float], float] = False,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Load a credit mask by making a difference mask between src and rescaled clips

    Args:
        rescale: Rescaled clip, defaults to rescaled instance clip.
        src: Source clip, defaults to source instance clip.
        thr: Threshold of the amplification expr, defaults to 0.216.
        expand: Additional expand radius applied to the mask, defaults to 4.
        ranges: If specified, ranges to apply the credit clip to.
        stabilize: Try to stabilize the mask by applying a temporal convolution and then binarized by a threshold.
            Only works when there are ranges specified.

    Returns:
        Generated mask.
    """
    if not src:
        src = self._clipy
    if not rescale:
        rescale = self.rescale

    src, rescale = get_y(src), get_y(rescale)

    credit_mask = based_diff_mask(src, rescale, thr=thr, expand=expand, func=self.default_credit_mask, **kwargs)

    if ranges is not None:
        if stabilize:
            ranges = normalize_ranges(credit_mask, ranges)

            scprev = [x for s, e in ranges for x in (s, e + int(not replace_ranges.exclusive))]
            scnext = [x - 1 for x in scprev]

            def set_credit_ranges(n: int, f: vs.VideoFrame) -> vs.VideoFrame:
                f = f.copy()
                f.props.update(_SceneChangePrev=False, _SceneChangeNext=False)

                if n in scprev:
                    f.props["_SceneChangePrev"] = True
                    return f

                if n in scnext:
                    f.props["_SceneChangeNext"] = True

                return f

            credit_mask = core.std.ModifyFrame(credit_mask, credit_mask, set_credit_ranges)

            if isinstance(stabilize, tuple):
                weights, thr = stabilize
            else:
                weights, thr = [1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1], 0.24

            credit_mask = BlurMatrix.custom(weights, ConvMode.T)(credit_mask, scenechange=True).std.Binarize(
                scale_mask(thr, 32, credit_mask)
            )

        credit_mask = replace_ranges(credit_mask.std.BlankClip(keep=True), credit_mask, ranges)

    self.credit_mask = credit_mask

    return self.credit_mask

default_line_mask(
    clip: VideoNode | None = None, scaler: ScalerLike = Bilinear, **kwargs: Any
) -> ConstantFormatVideoNode

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516

def default_line_mask(
    self, clip: vs.VideoNode | None = None, scaler: ScalerLike = Bilinear, **kwargs: Any
) -> ConstantFormatVideoNode:
    """
    Load a default Kirsch line mask in the class instance. Additionally, it is returned.

    Args:
        clip: Reference clip, defaults to doubled clip if None.
        scaler: Scaled used for matching the source clip format, defaults to Bilinear.

    Returns:
        Generated mask.
    """
    scaler = Scaler.ensure_obj(scaler)
    scale_kwargs = scaler.kwargs if clip else self.descale_args.kwargs(self.doubled) | scaler.kwargs

    clip = clip if clip else self.doubled

    line_mask = KirschTCanny.edgemask(clip, **kwargs).std.Maximum().std.Minimum()
    line_mask = scaler.scale(
        line_mask, self._clipy.width, self._clipy.height, format=self._clipy.format, **scale_kwargs
    )

    self.line_mask = line_mask

    return self.line_mask

Bases: vs_object

Base class for Rescale wrapper

Attributes:

• descale (ConstantFormatVideoNode) –

  Gets the descaled clip.

• descale_args (ScalingArgs) –

  Descale arguments. See ScalingArgs

• doubled (ConstantFormatVideoNode) –

  Gets the doubled clip.

• rescale (ConstantFormatVideoNode) –

  Gets the rescaled clip.

• upscale (ConstantFormatVideoNode) –

  Returns the upscaled clip

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

def __init__(
    self,
    clip: vs.VideoNode,
    /,
    kernel: KernelLike,
    upscaler: ScalerLike = ArtCNN,
    downscaler: ScalerLike = Hermite(linear=True),
    field_based: FieldBasedT | bool | None = None,
    border_handling: int | BorderHandling = BorderHandling.MIRROR,
    **kwargs: Any,
) -> None:
    assert check_variable(clip, self.__class__)

    self._clipy, *chroma = split(clip)
    self._chroma = chroma

    self._kernel = Kernel.ensure_obj(kernel)
    self._upscaler = Scaler.ensure_obj(upscaler)

    self._downscaler = Scaler.ensure_obj(downscaler)

    self._field_based = FieldBased.from_param(field_based)

    self._border_handling = BorderHandling(int(border_handling))

    self.__add_props = kwargs.get("_add_props")

descale: ConstantFormatVideoNode

descale_args: ScalingArgs

doubled: ConstantFormatVideoNode

rescale: ConstantFormatVideoNode

upscale: ConstantFormatVideoNode