Metadata-Version: 2.4
Name: vsdirty
Version: 0.5.0
Summary: VapourSynth wrappers for denoising, masking and edge fixing
Author: PingWer, Mhanz3500
Project-URL: Homepage, https://github.com/PingWer/vs-dirty
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: vsjetpack
Requires-Dist: vapoursynth-cas
Requires-Dist: vapoursynth-edgemasks
Requires-Dist: vapoursynth-bm3d>=10.0
Requires-Dist: vapoursynth-bm3dcpu>=2.16.4; (platform_machine == "x86_64" or platform_machine == "AMD64") and (platform_system == "Linux" or platform_system == "Windows")
Requires-Dist: vapoursynth-bm3dmetal>=4.0.0; platform_system == "Darwin"
Requires-Dist: dfttest2[gcc]>=10; platform_machine != "x86_64" and platform_machine != "AMD64"
Requires-Dist: dfttest2[cpu]>=10; platform_machine == "x86_64" or platform_machine == "AMD64"
Requires-Dist: vapoursynth-mvtools>=26
Requires-Dist: vapoursynth-nlm-ispc>=3
Requires-Dist: vapoursynth-deblock>=8.0
Provides-Extra: cl
Requires-Dist: vsjetpack[cl]; extra == "cl"
Provides-Extra: nvidia
Requires-Dist: vsjetpack[nvidia]; extra == "nvidia"
Provides-Extra: amd
Requires-Dist: vsjetpack[amd]; extra == "amd"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: vsnoise; extra == "test"
Dynamic: license-file

# vs-dirty

A collection of VapourSynth wrappers and utility functions focused on advanced denoising, masking, and edge fixing.

Follow the docstring for more information about the parameters.

## Installation

You can install `vsdirty` via pip:

```bash
pip install vsdirty
```

If you want to enable GPU acceleration for neural networks, install the package with the appropriate extra based on your hardware:

* **NVIDIA (TensorRT):**
  ```bash
  pip install vsdirty[nvidia]
  ```
* **AMD (DirectML / ORT):**
  ```bash
  pip install vsdirty[amd]
  ```
* **OpenCL (Generic):**
  ```bash
  pip install vsdirty[cl]
  ```

Or build from source:

```bash
git clone https://github.com/PingWer/vs-dirty
cd vs-dirty
pip install .[nvidia] # or .[amd], .[cl]
```

## Dependencies

This package relies on several external VapourSynth plugins. Most of them are automatically downloaded via pip, but ensure they are available in your VapourSynth environment:

| Plugin | Used For |
| :--- | :--- |
| **vapoursynth-edgemasks** | High-performance convolution masks (`Kroon`, `Sobel`, `Kirsch`, `Prewitt`) |
| **vapoursynth-cas** | Contrast Adaptive Sharpening |
| **vapoursynth-bm3d** | High-quality block-matching denoising |
| **vapoursynth-mvtools** | Motion interpolation and analysis |
| **vapoursynth-nlm-ispc** | Non-local means denoising |
| **vapoursynth-akarin** | Fast mathematical expression evaluation (`Expr`) |
| **libbore** | Enhancing edge contours (`dirtyfixer.bore`) |

> **Note:** Currently, **libbore** is not available via pip. You will need to download and install it manually from its [GitHub repository](https://github.com/OpusGang/bore).

## License

MIT License
