Skip to content

Jaded-Encoding-Thaumaturgy/vs-jetpack

Repository files navigation

vs-jetpack

Documentation Coverage Status PyPI Version

vs-jetpack provides a collection of Python modules for filtering video using VapourSynth. These include modules for scaling, masking, denoising, debanding, dehaloing, deinterlacing, and antialiasing, as well as general utility functions.

For support you can check out the JET Discord server.

Documentation

You can find the full API reference on the project's documentation site.

If you're looking for workflow recommendations, the JET Encoding Guide is available here.

Installation

vsjetpack relies on a number of VapourSynth plugins to function. Most of these plugins are now available as Python packages on PyPI and can be installed automatically using extras:

Breakdown

Most extras are hierarchical. For example, denoise includes all plugins from aa, which in turn includes mask, and so on.

Extra Purpose Included Plugins / Packages
source Clip Indexing bestsource, ffms2, lsmas, d2vsource, dvdsrc2
kernels Resizing resize2, descale, vs-placebo
rg Repair & Smoothing awarp, zsmooth (+ kernels, expr)
mask Masking adaptivegrain, edgemasks, hysteresis, subtext (+ source, rg)
aa Anti-aliasing bwdif, sangnom, znedi3 (+ mask)
denoise Denoising bm3d, dfttest2, deblock, mvutensils, nlm-ispc (+ aa)
deband Debanding vsnoise (+ denoise)
deinterlace Deinterlacing dmetrics, vivtc (+ denoise)
full All CPU-based extras All of the above
gpu Generic GPU ort
cl Open CL vszipcl
vulkan Vulkan Devices eedi3vk2, ncnn
nvidia NVIDIA GPU bm3dcuda, bilateralgpu, dfttest2-[nvrtc,cuda], ort-cuda, trt{-rtx} (+ cl, vulkan)
amd AMD GPU bm3dhip, dfttest2-[hiprtc,hipfft] (+ gpu, cl, vulkan)

Important

Some plugins distribute their wheels through our custom package index instead of PyPI.

Add --extra-index-url to ensure pip can locate all required packages:

pip install vsjetpack[full] --extra-index-url https://jaded-encoding-thaumaturgy.github.io/vs-wheels/simple

When downloading the nvidia extra, you can also add the NVIDIA index:

Bash

pip install vsjetpack[full,nvidia] \
  --extra-index-url https://pypi.nvidia.com/ \
  --extra-index-url https://jaded-encoding-thaumaturgy.github.io/vs-wheels/simple

Powershell

pip install vsjetpack[full,nvidia] `
  --extra-index-url https://pypi.nvidia.com/ `
  --extra-index-url https://jaded-encoding-thaumaturgy.github.io/vs-wheels/simple

For more information, click here.

Not all extras have prebuilt wheels on every platform:

Extra Windows x64 Linux (glibc 2.35+) Linux (musl 1.2+) macOS (x64/ARM) 15.0+
source
kernels
rg
mask
scale
aa
denoise
deband
deinterlace
full
gpu
cl
vulkan
nvidia ⚠️1
amd

Tip

If a plugin is unavailable for your platform, you may need to build it manually.

Refer to the plugin repository for platform-specific build instructions.

Footnotes

  1. bilateralgpu requires Glibc 2.39+.

About

Collection of JET's Vapoursynth packages for video filtering

Topics

Resources

License

Contributing

Stars

71 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors