ProPainter Vapoursynth filter - Printable Version

def propainter_inpaint(

        clip: vs.VideoNode,

        length: int = 100,

        clip_mask: vs.VideoNode = None,

        img_mask_path: str = None,

        mask_dilation: int = 8,

        neighbor_length: int = 10,

        ref_stride: int = 10,

        raft_iter: int = 20,

        mask_region: tuple[int, int, int, int] = None,

        sc_threshold: float = 0.1,

        sc_min_freq: int = 0,

        weights_dir: str = model_dir,

        enable_fp16: bool = True,

        device_index: int = 0,

        inference_mode: bool = False

) -> vs.VideoNode:

    """ProPainter: Improving Propagation and Transformer for Video Inpainting



    :param clip:            Clip to process. Only RGB24 "full range" format is supported.

    :param length:          Sequence length that the model processes (min. 12 frames). High values will

                            increase the inference speed but will increase also the memory usage. Default: 100

    :param clip_mask:       Clip mask, must be of the same size and length of input clip. Default: None

    :param img_mask_path:   Path of the mask image, must be of the same size of input clip: Default: None

    :param mask_dilation:   Mask dilation for video and flow masking. Default: 8

    :param neighbor_length: Length of local neighboring frames. Low values decrease the memory usage.

                            High values could help to improve the quality on fast moving sequences.

                            Default: 10

    :param ref_stride:      Stride of global reference frames. High values will allow to

                            reduce the memory usage and increase the inference speed, but could

                            affect the inference quality. Default: 10

    :param raft_iter:       Iterations for RAFT inference. Low values will increase the inference

                            speed but could affect the output quality. Default: 20

    :param mask_region:     Allow to restrict the region of the mask, format: (width, height, left, top).

                            The region must be big enough to allow the inference. Default: None

    :param weights_dir:     Path string of location of model weights.

    :param sc_threshold:    If > 0 represent the scene change threshold used to generate the reference frames for

                            ProPainter, range [0,1]. Default = 0.1

    :param sc_min_freq:     Minimum number of frames that must elapse between two accepted scene changes.

                            If > 0, it is clamped to a minimum of 5 frames. Default is 0 (no spacing enforced).

    :param enable_fp16:     If True use fp16 (half precision) during inference. Default: fp16 (for RTX30 or above)

    :param device_index:    Device ordinal of the GPU (if = -1 CPU mode is enabled). Default: 0

    :param inference_mode:  Enable/Disable torch inference mode. Default: False

    """