NNEDI3: swap sneedif for nnedi3vk (#354)

Author: Ichunjo

pyproject.toml

@@ -113,7 +113,6 @@ aa = [
     "vsjetpack[scale]",
     "vapoursynth-bwdif>=5.0",
     "vapoursynth-sangnom>=43",
-    "vapoursynth-sneedif>=4.2",
     "vapoursynth-znedi3>=2.1",
 ]
 denoise = [
@@ -138,7 +137,11 @@ deinterlace = [
 deband = ["vsjetpack[denoise]", "vsnoise>=1.2"]
 gpu = ["vapoursynth-mlrt-ort>=15.16"]
 cl = ["vapoursynth-vszipcl>=1.2.0"]
-vulkan = ["vapoursynth-eedi3vk2>=1.0", "vapoursynth-mlrt-ncnn>=15.16"]
+vulkan = [
+    "vapoursynth-eedi3vk2>=1.0",
+    "vapoursynth-mlrt-ncnn>=15.16",
+    "vapoursynth-nnedi3vk>=1.0",
+]
 nvidia = [
     "vsjetpack[cl,vulkan]",
     "onnx>=1.21.0",

stubs/vapoursynth/__init__.pyi

@@ -1844,6 +1844,10 @@ class VideoNode(RawNode):
     nlm_ispc: Final[_nlm_ispc._VideoNode_bound.Plugin]
     """Non-local means denoise filter implemented in ISPC"""
 # </attribute/VideoNode_bound/nlm_ispc>
+# <attribute/VideoNode_bound/nnedi3vk>
+    nnedi3vk: Final[_nnedi3vk._VideoNode_bound.Plugin]
+    """Neural Network Edge Directed Interpolation 3, using Vulkan compute"""
+# </attribute/VideoNode_bound/nnedi3vk>
 # <attribute/VideoNode_bound/noise>
     noise: Final[_noise._VideoNode_bound.Plugin]
     """Noise generator"""
@@ -1872,10 +1876,6 @@ class VideoNode(RawNode):
     sangnom: Final[_sangnom._VideoNode_bound.Plugin]
     """VapourSynth Single Field Deinterlacer"""
 # </attribute/VideoNode_bound/sangnom>
-# <attribute/VideoNode_bound/sneedif>
-    sneedif: Final[_sneedif._VideoNode_bound.Plugin]
-    """Setsugen No Ensemble of Edge Directed Interpolation Functions"""
-# </attribute/VideoNode_bound/sneedif>
 # <attribute/VideoNode_bound/std>
     std: Final[_std._VideoNode_bound.Plugin]
     """VapourSynth Core Functions"""
@@ -2134,6 +2134,10 @@ class Core:
     nlm_ispc: Final[_nlm_ispc._Core_bound.Plugin]
     """Non-local means denoise filter implemented in ISPC"""
 # </attribute/Core_bound/nlm_ispc>
+# <attribute/Core_bound/nnedi3vk>
+    nnedi3vk: Final[_nnedi3vk._Core_bound.Plugin]
+    """Neural Network Edge Directed Interpolation 3, using Vulkan compute"""
+# </attribute/Core_bound/nnedi3vk>
 # <attribute/Core_bound/noise>
     noise: Final[_noise._Core_bound.Plugin]
     """Noise generator"""
@@ -2162,10 +2166,6 @@ class Core:
     sangnom: Final[_sangnom._Core_bound.Plugin]
     """VapourSynth Single Field Deinterlacer"""
 # </attribute/Core_bound/sangnom>
-# <attribute/Core_bound/sneedif>
-    sneedif: Final[_sneedif._Core_bound.Plugin]
-    """Setsugen No Ensemble of Edge Directed Interpolation Functions"""
-# </attribute/Core_bound/sneedif>
 # <attribute/Core_bound/std>
     std: Final[_std._Core_bound.Plugin]
     """VapourSynth Core Functions"""
@@ -3049,6 +3049,20 @@ class _nlm_ispc:
 
 # </implementation/nlm_ispc>
 
+# <implementation/nnedi3vk>
+class _nnedi3vk:
+    class _Core_bound:
+        class Plugin(_VSPlugin):
+            @_Wrapper.Function
+            def NNEDI3(self, /, clip: VideoNode, field: _IntLike, dh: _IntLike | None = None, planes: _IntLike | _SequenceLike[_IntLike] | None = None, nsize: _IntLike | None = None, nns: _IntLike | None = None, qual: _IntLike | None = None, etype: _IntLike | None = None, pscrn: _IntLike | None = None, coopvec: _IntLike | None = None, device_index: _IntLike | None = None, list_device: _IntLike | None = None, num_streams: _IntLike | None = None) -> VideoNode: ...
+
+    class _VideoNode_bound:
+        class Plugin(_VSPlugin):
+            @_Wrapper.Function
+            def NNEDI3(self, /, field: _IntLike, dh: _IntLike | None = None, planes: _IntLike | _SequenceLike[_IntLike] | None = None, nsize: _IntLike | None = None, nns: _IntLike | None = None, qual: _IntLike | None = None, etype: _IntLike | None = None, pscrn: _IntLike | None = None, coopvec: _IntLike | None = None, device_index: _IntLike | None = None, list_device: _IntLike | None = None, num_streams: _IntLike | None = None) -> VideoNode: ...
+
+# </implementation/nnedi3vk>
+
 # <implementation/noise>
 class _noise:
     class _Core_bound:
@@ -3225,30 +3239,6 @@ class _sangnom:
 
 # </implementation/sangnom>
 
-# <implementation/sneedif>
-_ReturnDict_sneedif_DeviceInfo = TypedDict("_ReturnDict_sneedif_DeviceInfo", {"name": _AnyStr, "vendor": _AnyStr, "profile": _AnyStr, "version": _AnyStr, "max_compute_units": int, "max_work_group_size": int, "max_work_item_sizes": _IntLike | list[_IntLike], "image2D_max_width": int, "image2D_max_height": int, "image_support": int, "global_memory_cache_type": _AnyStr, "global_memory_cache": int, "global_memory_size": int, "max_constant_buffer_size": int, "max_constant_arguments": int, "local_memory_type": _AnyStr, "local_memory_size": int, "available": int, "compiler_available": int, "linker_available": int, "opencl_c_version": _AnyStr, "image_max_buffer_size": int})
-_ReturnDict_sneedif_ListDevices = TypedDict("_ReturnDict_sneedif_ListDevices", {"numDevices": int, "deviceNames": _AnyStr | list[_AnyStr], "platformNames": _AnyStr | list[_AnyStr]})
-_ReturnDict_sneedif_PlatformInfo = TypedDict("_ReturnDict_sneedif_PlatformInfo", {"profile": _AnyStr, "version": _AnyStr, "name": _AnyStr, "vendor": _AnyStr})
-
-class _sneedif:
-    class _Core_bound:
-        class Plugin(_VSPlugin):
-            @_Wrapper.Function
-            def DeviceInfo(self, /, device: _IntLike | None = None) -> _ReturnDict_sneedif_DeviceInfo: ...
-            @_Wrapper.Function
-            def ListDevices(self, /) -> _ReturnDict_sneedif_ListDevices: ...
-            @_Wrapper.Function
-            def NNEDI3(self, /, clip: VideoNode, field: _IntLike, dh: _IntLike | None = None, dw: _IntLike | None = None, planes: _IntLike | _SequenceLike[_IntLike] | None = None, nsize: _IntLike | None = None, nns: _IntLike | None = None, qual: _IntLike | None = None, etype: _IntLike | None = None, pscrn: _IntLike | None = None, transpose_first: _IntLike | None = None, device: _IntLike | None = None) -> VideoNode: ...
-            @_Wrapper.Function
-            def PlatformInfo(self, /, device: _IntLike | None = None) -> _ReturnDict_sneedif_PlatformInfo: ...
-
-    class _VideoNode_bound:
-        class Plugin(_VSPlugin):
-            @_Wrapper.Function
-            def NNEDI3(self, /, field: _IntLike, dh: _IntLike | None = None, dw: _IntLike | None = None, planes: _IntLike | _SequenceLike[_IntLike] | None = None, nsize: _IntLike | None = None, nns: _IntLike | None = None, qual: _IntLike | None = None, etype: _IntLike | None = None, pscrn: _IntLike | None = None, transpose_first: _IntLike | None = None, device: _IntLike | None = None) -> VideoNode: ...
-
-# </implementation/sneedif>
-
 # <implementation/std>
 class _std:
     class _Core_bound:

uv.lock

@@ -383,7 +383,9 @@ class NNEDI3(SuperSampler):
     """
     Neural Network Edge Directed Interpolation (3rd gen.)
 
-    More information: https://github.com/sekrit-twc/znedi3
+    More information:
+        - https://github.com/sekrit-twc/znedi3
+        - https://github.com/HolyWu/VapourSynth-nnedi3vk
     """
 
     nsize: int = 0
@@ -430,7 +432,7 @@ class NNEDI3(SuperSampler):
     - 1: Weights trained to minimise squared error.
     """
 
-    pscrn: int | None = None
+    pscrn: int = 4
     """
     The prescreener used to decide which pixels should be processed by the predictor neural network,
     and which can be handled by simple cubic interpolation.
@@ -442,16 +444,19 @@ class NNEDI3(SuperSampler):
     - 3: New prescreener level 1.
     - 4: New prescreener level 2.
 
-    The new prescreener is not available with float input.
-
-    - Wrapper default is 4 for integer input and 1 for float input. When `opencl=True` it is always 1.
-    - Plugin default is 2 for integer input and 1 for float input.
+    Wrapper default is 4, plugin default is 2.
     """
 
-    opencl: bool = False
-    """
-    Enables the use of the OpenCL variant.
-    """
+    gpu: bool = False
+    """Enables the use of the Vulkan variant."""
+
+    opencl: Never = cast(Never, MISSING)
+    """Unused deprecated parameter."""
+
+    def __post_init__(self) -> None:
+        if self.opencl is not cast(Never, MISSING):
+            warnings.warn("The 'opencl' argument has been removed and is deprecated.", RuntimeWarning)
+        return super().__post_init__()
 
     @Scaler.cachedproperty
     def kernel_radius(self) -> int:
@@ -466,21 +471,17 @@ def kernel_radius(self) -> int:
                 return 32
 
     def get_deint_args(self, *, clip: vs.VideoNode | None = None, **kwargs: Any) -> dict[str, Any]:
-        pscrn = (
-            fallback(self.pscrn, 1 if self.opencl or clip.format.sample_type is vs.FLOAT else 4) if clip else self.pscrn
-        )
-
         return {
             "nsize": self.nsize,
             "nns": self.nns,
             "qual": self.qual,
             "etype": self.etype,
-            "pscrn": pscrn,
+            "pscrn": self.pscrn,
         } | kwargs
 
     @property
     def _deinterlacer_function(self) -> VSFunctionAllArgs:
-        return core.lazy.sneedif.NNEDI3 if self.opencl else core.lazy.znedi3.nnedi3
+        return core.lazy.nnedi3vk.NNEDI3 if self.gpu else core.lazy.znedi3.nnedi3
 
     def _interpolate(self, clip: vs.VideoNode, tff: bool, double_rate: bool, dh: bool, **kwargs: Any) -> vs.VideoNode:
         field = tff + double_rate * 2