Skip to content

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
basic Essential plugins akarin, fmtconv, vszip, scxvid, scipy, rich, psutil
source Clip Indexing bestsource, ffms2, 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, eedi3, sangnom, sneedif, znedi3 (+ mask)
denoise Denoising bm3d, dctfilter, dfttest2, deblock, mvtools, nlm-ispc, wnnm (+ aa)
deband Debanding vsnoise (+ denoise)
deinterlace Deinterlacing dmetrics, vivtc (+ denoise)
full All CPU-based extras All of the above
cl Open CL knlmeanscl,
nvidia NVIDIA GPU bm3dcuda, bilateralgpu, nlm-cuda, dfttest2-[nvrtc,cuda]
amd AMD GPU bm3dhip, dfttest2-[hiprtc,hipfft] (+ cl)

[!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,nvidia] --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 (Intel/ARM) 15.0+
basic ✅ ✅ ✅ ✅
source ✅ ✅ ❌1 ⚠️1
kernels ✅ ✅ ✅ ✅
rg ✅ ✅ ✅ ✅
mask ✅ ✅ ❌1 ✅
aa ✅ ✅ ❌1 ✅
denoise ✅ ✅ ❌ ⚠️2
deband ✅ ✅ ❌ ✅
deinterlace ✅ ✅ ❌ ✅
full ✅ ✅ ❌ ⚠️
cl ✅ ✅ ❌ ✅
nvidia ✅ ⚠️3 ❌ ❌
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.

  1. dvdsrc2 isn't available on musl and macOS. ↩↩↩↩

  2. wnnm isn't available on macOS. ↩

  3. Requires Glibc 2.39+ for bilateralgpu. ↩