vs-colorfix 2.1.0__tar.gz

vs_colorfix-2.1.0/.github/workflows/publish.yml

@@ -0,0 +1,76 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    if: ${{ !github.event.release.prerelease }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out released tag
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Check tag matches package version
+        shell: bash
+        run: |
+          VERSION="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          TAG="${{ github.event.release.tag_name }}"
+          TAG_VERSION="${TAG#v}"
+
+          if [ "$TAG_VERSION" != "$VERSION" ]; then
+            echo "Release tag $TAG does not match pyproject.toml version $VERSION"
+            exit 1
+          fi
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build twine
+
+      - name: Build wheel and source distribution
+        run: python -m build
+
+      - name: Validate distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish distributions to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/vs_colorfix
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

vs_colorfix-2.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 pifroggi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vs_colorfix-2.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: vs_colorfix
+Version: 2.1.0
+Summary: Color Fix, Color Transfer, or Color Match for VapourSynth.
+Project-URL: Homepage, https://github.com/pifroggi/vs_colorfix
+Project-URL: Repository, https://github.com/pifroggi/vs_colorfix
+Project-URL: Issues, https://github.com/pifroggi/vs_colorfix/issues
+Author: pifroggi
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: color fix,color matching,color transfer,filtering,vapoursynth,video
+Classifier: Environment :: GPU
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.12
+Requires-Dist: vapoursynth-mlrt-ncnn
+Requires-Dist: vapoursynth-mlrt-ort; sys_platform == 'win32'
+Requires-Dist: vapoursynth-vszip
+Requires-Dist: vapoursynth>=74
+Provides-Extra: tensorrt
+Requires-Dist: cuda-python; (sys_platform == 'win32' or sys_platform == 'linux') and extra == 'tensorrt'
+Requires-Dist: tensorrt-cu13>=11.1.0.106; (sys_platform == 'win32' or sys_platform == 'linux') and extra == 'tensorrt'
+Requires-Dist: vapoursynth-mlrt-trt>=16.0; (sys_platform == 'win32' or sys_platform == 'linux') and extra == 'tensorrt'
+Description-Content-Type: text/markdown
+
+# Color Fix for VapourSynth
+
+For example for fixing color shift from AI upscaling/restoration models, or transfering color grading from an old release to a remaster. Also known as Color Transfer or Color Matching. See this collection of [Comparisons](https://slow.pics/c/abXjnKn3).
+
+<br />
+
+<p align="center">
+  <a href="https://slow.pics/c/abXjnKn3">
+    <img src="https://raw.githubusercontent.com/pifroggi/vs_colorfix/refs/heads/main/README_img.png" width="600" />
+  </a>
+</p>
+
+## Installation
+
+### Nvidia
+```
+pip install -U vs_colorfix[tensorrt] --extra-index-url https://pypi.nvidia.com/
+```
+To enable the Wavelet Color Fix CPU backend, install the plugin [Vapoursynth-ATWT](https://github.com/yuygfgg/Vapoursynth-ATWT). *(optional)*  
+### Others
+```
+pip install -U vs_colorfix
+```
+To enable the Wavelet Color Fix CPU backend, install the plugin [Vapoursynth-ATWT](https://github.com/yuygfgg/Vapoursynth-ATWT). *(optional)*  
+
+<br />
+
+> [!TIP]
+> For VapourSynth R73 and older, follow the [manual installation steps](https://github.com/pifroggi/vs_colorfix/wiki/Manual-Installation).
+
+<br />
+
+
+## Average Color Fix
+Fixes color shift by matching the average color of a clip to a reference clip. A very fast way to transfer colors from one clip to another. For large color differences, the Wavelet Color Fix is more accurate. 
+
+```python
+import vs_colorfix
+clip = vs_colorfix.average(clip, ref, radius=10, planes=[0, 1, 2], fast=False)
+```
+
+__*`clip`*__  
+Base clip where the colors will be applied to.  
+Recommended higher than 8-bit to avoid banding.
+
+__*`ref`*__  
+Reference clip where the colors are taken from.  
+Check the [comparisons](https://slow.pics/c/abXjnKn3) to get an idea how close it should match the base clip.
+
+__*`radius`*__  
+Higher means a more global color match and wider bloom/bleed.  
+Lower means a more local color match and smaller bloom/bleed. Too low and the reference clip will become visible.  
+Test values 5 and 30 and this will become more clear.
+
+__*`planes`* (optional)__  
+Which planes to color fix. Any unmentioned planes will simply be copied.  
+If not set, all planes will be color-fixed.
+
+ __*`fast`* (optional)__  
+Does the averaging via a downscale instead of a blur, which is much faster, but will produce faint blocky artifacts.  
+I found it useful for radius > 60 where artifacts are no longer noticable, or to fix something like a prefilter clip.
+
+> [!TIP]
+> * If your clips are not sufficiently aligned or synchronized, use [vs_align](https://github.com/pifroggi/vs_align) to align them first.
+> * To replicate chaiNNers Average Color Fix, you can convert % to radius: `radius = (100/percentage-1)/2`  
+>   ChaiNNer works like fast=True does here, but it is recommended to leave it off for better results.
+
+<br />
+
+## Wavelet Color Fix
+Fixes color shift by first converting into wavelets, then matching the average color of a clip to a reference clip. Works similarly to the Average Color Fix, but more accurate when the color differences are large, at the cost of more computation.
+
+```python
+import vs_colorfix
+clip = vs_colorfix.wavelet(clip, ref, wavelets=4, planes=[0, 1, 2], backend="ncnn", num_streams=2, gpu_id=0, engine_folder=None)
+```
+
+__*`clip`*__  
+Base clip where the colors will be applied to.  
+Recommended higher than 8-bit to avoid banding.
+
+__*`ref`*__  
+Reference clip where the colors are taken from.  
+Check the [comparisons](https://slow.pics/c/abXjnKn3) to get an idea how close it should match the base clip.
+
+__*`wavelets`*__  
+Number of wavelets in the 1-10 range. Around 4 seems to work best in most cases.  
+Higher means a more global color match and wider bloom/bleed.  
+Lower means a more local color match and smaller bloom/bleed. Too low and the reference clip will become visible.  
+Test values 3 and 8 and this will become more clear.
+
+__*`planes`* (optional)__  
+Which planes to color fix. Any unmentioned planes will simply be copied.  
+If not set, all planes will be color-fixed.
+
+__*`backend`* (optional)__  
+The used backend. **16-bit float input is always much faster on GPU, but not supported by older GPUs.**
+* `cpu` CPU mode using the vapoursynth-ATWT plugin *(slow)*.
+* `ncnn` GPU mode using vs-mlrt with NCNN support. Works on almost any GPU, even Mac *(fast)*.
+* `directml` GPU mode using vs-mlrt with DirectML support. Works on most GPUs, Windows only *(fast)*.
+* `tensorrt` GPU mode using vs-mlrt with TensorRT support. Requires an Nvidia RTX GPU. On the first run, this mode will automatically build an engine, which may take a few minutes. Changing wavelets or input dimensions will trigger rebuilding, but build engines are stored *(very fast)*.
+
+__*`num_streams`* (optional)__  
+Number of parallel GPU streams. Higher can be faster, but requires more VRAM. Does not affect the CPU backend.
+
+__*`gpu_id`* (optional)__  
+Which GPU to use starting from 0. Can be used to switch between iGPU/dGPU. Does not affect the CPU backend.
+
+__*`engine_folder`* (optional)__  
+Optional path to the TensorRT engine storage location. By default engines are stored in `vs_colorfix/engines`. Only affects the TensorRT backend.
+
+> [!TIP]
+> * On low end GPUs, the NCNN backend can be faster than TensorRT and DirectML.
+> * If your clips are not sufficiently aligned or synchronized, use [vs_align](https://github.com/pifroggi/vs_align) to align them first.
+
+<br />
+
+## Benchmarks
+Benchmarks were done on a RTX 4090 GPU and a Ryzen 5900X CPU with 16-bit input clips.
+
+<table>
+  <tr>
+    <td valign="top">
+
+<table>
+  <thead>
+    <tr align="center">
+      <th colspan="5">Wavelet Color Fix</th>
+    </tr>
+    <tr align="center">
+      <th>Resolution</th>
+      <th>TensorRT</th>
+      <th>DirectML</th>
+      <th>NCNN</th>
+      <th>CPU</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr align="center">
+      <td>1440x1080</td>
+      <td>~360 fps</td>
+      <td>~250 fps</td>
+      <td>~250 fps</td>
+      <td>~20 fps</td>
+    </tr>
+    <tr align="center">
+      <td>2880x2160</td>
+      <td>~80 fps</td>
+      <td>~60 fps</td>
+      <td>~60 fps</td>
+      <td>~5 fps</td>
+    </tr>
+  </tbody>
+</table>
+
+</td>
+<td valign="top">
+
+<table>
+  <thead>
+    <tr align="center">
+      <th colspan="3">Average Color Fix</th>
+    </tr>
+    <tr align="center">
+      <th>Resolution</th>
+      <th>fast=False</th>
+      <th>fast=True</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr align="center">
+      <td>1440x1080</td>
+      <td>~250 fps</td>
+      <td>~850 fps</td>
+    </tr>
+    <tr align="center">
+      <td>2880x2160</td>
+      <td>~60 fps</td>
+      <td>~150 fps</td>
+    </tr>
+  </tbody>
+</table>
+
+</td>
+  </tr>
+</table>
+
+<br />
+
+## Acknowledgements
+Average Color Fix idea from [chaiNNer](https://github.com/chaiNNer-org/chaiNNer).  
+Wavelet Color Fix idea from [sd-webui-stablesr](https://github.com/pkuliyi2015/sd-webui-stablesr/blob/master/srmodule/colorfix.py).

vs_colorfix-2.1.0/README.md

@@ -0,0 +1,192 @@
+# Color Fix for VapourSynth
+
+For example for fixing color shift from AI upscaling/restoration models, or transfering color grading from an old release to a remaster. Also known as Color Transfer or Color Matching. See this collection of [Comparisons](https://slow.pics/c/abXjnKn3).
+
+<br />
+
+<p align="center">
+  <a href="https://slow.pics/c/abXjnKn3">
+    <img src="https://raw.githubusercontent.com/pifroggi/vs_colorfix/refs/heads/main/README_img.png" width="600" />
+  </a>
+</p>
+
+## Installation
+
+### Nvidia
+```
+pip install -U vs_colorfix[tensorrt] --extra-index-url https://pypi.nvidia.com/
+```
+To enable the Wavelet Color Fix CPU backend, install the plugin [Vapoursynth-ATWT](https://github.com/yuygfgg/Vapoursynth-ATWT). *(optional)*  
+### Others
+```
+pip install -U vs_colorfix
+```
+To enable the Wavelet Color Fix CPU backend, install the plugin [Vapoursynth-ATWT](https://github.com/yuygfgg/Vapoursynth-ATWT). *(optional)*  
+
+<br />
+
+> [!TIP]
+> For VapourSynth R73 and older, follow the [manual installation steps](https://github.com/pifroggi/vs_colorfix/wiki/Manual-Installation).
+
+<br />
+
+
+## Average Color Fix
+Fixes color shift by matching the average color of a clip to a reference clip. A very fast way to transfer colors from one clip to another. For large color differences, the Wavelet Color Fix is more accurate. 
+
+```python
+import vs_colorfix
+clip = vs_colorfix.average(clip, ref, radius=10, planes=[0, 1, 2], fast=False)
+```
+
+__*`clip`*__  
+Base clip where the colors will be applied to.  
+Recommended higher than 8-bit to avoid banding.
+
+__*`ref`*__  
+Reference clip where the colors are taken from.  
+Check the [comparisons](https://slow.pics/c/abXjnKn3) to get an idea how close it should match the base clip.
+
+__*`radius`*__  
+Higher means a more global color match and wider bloom/bleed.  
+Lower means a more local color match and smaller bloom/bleed. Too low and the reference clip will become visible.  
+Test values 5 and 30 and this will become more clear.
+
+__*`planes`* (optional)__  
+Which planes to color fix. Any unmentioned planes will simply be copied.  
+If not set, all planes will be color-fixed.
+
+ __*`fast`* (optional)__  
+Does the averaging via a downscale instead of a blur, which is much faster, but will produce faint blocky artifacts.  
+I found it useful for radius > 60 where artifacts are no longer noticable, or to fix something like a prefilter clip.
+
+> [!TIP]
+> * If your clips are not sufficiently aligned or synchronized, use [vs_align](https://github.com/pifroggi/vs_align) to align them first.
+> * To replicate chaiNNers Average Color Fix, you can convert % to radius: `radius = (100/percentage-1)/2`  
+>   ChaiNNer works like fast=True does here, but it is recommended to leave it off for better results.
+
+<br />
+
+## Wavelet Color Fix
+Fixes color shift by first converting into wavelets, then matching the average color of a clip to a reference clip. Works similarly to the Average Color Fix, but more accurate when the color differences are large, at the cost of more computation.
+
+```python
+import vs_colorfix
+clip = vs_colorfix.wavelet(clip, ref, wavelets=4, planes=[0, 1, 2], backend="ncnn", num_streams=2, gpu_id=0, engine_folder=None)
+```
+
+__*`clip`*__  
+Base clip where the colors will be applied to.  
+Recommended higher than 8-bit to avoid banding.
+
+__*`ref`*__  
+Reference clip where the colors are taken from.  
+Check the [comparisons](https://slow.pics/c/abXjnKn3) to get an idea how close it should match the base clip.
+
+__*`wavelets`*__  
+Number of wavelets in the 1-10 range. Around 4 seems to work best in most cases.  
+Higher means a more global color match and wider bloom/bleed.  
+Lower means a more local color match and smaller bloom/bleed. Too low and the reference clip will become visible.  
+Test values 3 and 8 and this will become more clear.
+
+__*`planes`* (optional)__  
+Which planes to color fix. Any unmentioned planes will simply be copied.  
+If not set, all planes will be color-fixed.
+
+__*`backend`* (optional)__  
+The used backend. **16-bit float input is always much faster on GPU, but not supported by older GPUs.**
+* `cpu` CPU mode using the vapoursynth-ATWT plugin *(slow)*.
+* `ncnn` GPU mode using vs-mlrt with NCNN support. Works on almost any GPU, even Mac *(fast)*.
+* `directml` GPU mode using vs-mlrt with DirectML support. Works on most GPUs, Windows only *(fast)*.
+* `tensorrt` GPU mode using vs-mlrt with TensorRT support. Requires an Nvidia RTX GPU. On the first run, this mode will automatically build an engine, which may take a few minutes. Changing wavelets or input dimensions will trigger rebuilding, but build engines are stored *(very fast)*.
+
+__*`num_streams`* (optional)__  
+Number of parallel GPU streams. Higher can be faster, but requires more VRAM. Does not affect the CPU backend.
+
+__*`gpu_id`* (optional)__  
+Which GPU to use starting from 0. Can be used to switch between iGPU/dGPU. Does not affect the CPU backend.
+
+__*`engine_folder`* (optional)__  
+Optional path to the TensorRT engine storage location. By default engines are stored in `vs_colorfix/engines`. Only affects the TensorRT backend.
+
+> [!TIP]
+> * On low end GPUs, the NCNN backend can be faster than TensorRT and DirectML.
+> * If your clips are not sufficiently aligned or synchronized, use [vs_align](https://github.com/pifroggi/vs_align) to align them first.
+
+<br />
+
+## Benchmarks
+Benchmarks were done on a RTX 4090 GPU and a Ryzen 5900X CPU with 16-bit input clips.
+
+<table>
+  <tr>
+    <td valign="top">
+
+<table>
+  <thead>
+    <tr align="center">
+      <th colspan="5">Wavelet Color Fix</th>
+    </tr>
+    <tr align="center">
+      <th>Resolution</th>
+      <th>TensorRT</th>
+      <th>DirectML</th>
+      <th>NCNN</th>
+      <th>CPU</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr align="center">
+      <td>1440x1080</td>
+      <td>~360 fps</td>
+      <td>~250 fps</td>
+      <td>~250 fps</td>
+      <td>~20 fps</td>
+    </tr>
+    <tr align="center">
+      <td>2880x2160</td>
+      <td>~80 fps</td>
+      <td>~60 fps</td>
+      <td>~60 fps</td>
+      <td>~5 fps</td>
+    </tr>
+  </tbody>
+</table>
+
+</td>
+<td valign="top">
+
+<table>
+  <thead>
+    <tr align="center">
+      <th colspan="3">Average Color Fix</th>
+    </tr>
+    <tr align="center">
+      <th>Resolution</th>
+      <th>fast=False</th>
+      <th>fast=True</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr align="center">
+      <td>1440x1080</td>
+      <td>~250 fps</td>
+      <td>~850 fps</td>
+    </tr>
+    <tr align="center">
+      <td>2880x2160</td>
+      <td>~60 fps</td>
+      <td>~150 fps</td>
+    </tr>
+  </tbody>
+</table>
+
+</td>
+  </tr>
+</table>
+
+<br />
+
+## Acknowledgements
+Average Color Fix idea from [chaiNNer](https://github.com/chaiNNer-org/chaiNNer).  
+Wavelet Color Fix idea from [sd-webui-stablesr](https://github.com/pkuliyi2015/sd-webui-stablesr/blob/master/srmodule/colorfix.py).