Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan
SRMD super resolution plugin for VapourSynth implemented with ncnn library
https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan
Last synced: 2 months ago
JSON representation
SRMD super resolution plugin for VapourSynth implemented with ncnn library
- Host: GitHub
- URL: https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan
- Owner: Kiyamou
- License: mit
- Created: 2020-06-23T16:21:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-05T16:41:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T05:12:30.489Z (5 months ago)
- Language: C++
- Homepage:
- Size: 71.3 KB
- Stars: 22
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ncnn - VapourSynth-SRMD-ncnn-Vulkan
README
# VapourSynth-SRMD-ncnn-Vulkan
[](https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan/actions)
SRMD super resolution for VapourSynth, based on [srmd-ncnn-vulkan](https://github.com/nihui/srmd-ncnn-vulkan). Some code is from [vapoursynth-waifu2x-ncnn-vulkan](https://github.com/Nlzy/vapoursynth-waifu2x-ncnn-vulkan).
## Usage
```python
core.srmdnv.SRMD(clip clip, [int scale, int noise, int tilesize_x, int tilesize_y,
int gpu_id, int gpu_thread, bool tta])
```
Models should be located in folder `models`, and folder `models` should be located in the same folder as dynamic link library.
* ***clip***
* Required parameter.
* Clip to process.
* Only 32bit RGB is supported.
* ***scale***
* Optional parameter. Range: 2–4. *Default: 2*.
* ***noise***
* Optional parameter. Range: -1–10. *Default: 3*.
* The larger value, the stronger the effect of denoise.
* ***tilesize_x***
* Optional parameter. *Default: depands on video memory size*
* The tilesize for horizontal.
* Recommend to set a value that can divide the width.
* ***tilesize_y***
* Optional parameter. *Default: same as tilesize_x*.
* The tilesize for vertical.
* Recommend to set a value that can divide the height.
* ***gpu_id***
* Optional parameter. *Default: 0*.
* If you have more than one gpu devices, you can select gpu device by the parameter.
* ***tta***
* Optional parameter. *Default: False*.
* If true, quality will be improved, but speed will be significantly slower.
## Compilation
### Windows
1.Install Vulkan SDK.
2.If your VapourSynth is installed in `C:\Program Files\VapourSynth` , you can run the following command directly. Otherwise use `cmake -G "NMake Makefiles" -DVAPOURSYNTH_INCLUDE_DIR=Path/To/vapoursynth/sdk/include/vapoursynth ..` in the second-to-last step.
```bash
git clone --recursive https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan.git
cd VapourSynth-SRMD-ncnn-Vulkan
mkdir build && cd build
cmake -G "NMake Makefiles" ..
cmake --build .
```
### Linux
1.Install Vulkan SDK and add to path.
2.If your VapourSynth is installed in `usr/local` , you can run the following command directly. Otherwise use `cmake -DVAPOURSYNTH_INCLUDE_DIR=Path/To/vapoursynth ..` in the second-to-last step.
```bash
git clone --recursive https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan.git
cd VapourSynth-SRMD-ncnn-Vulkan
mkdir build && cd build
cmake ..
cmake --build .
```
### Windows and Linux using Github Actions
1.[Fork this repository](https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan/fork).
2.Enable Github Actions on your fork: **Settings** tab -> **Actions** -> **General** -> **Allow all actions and reusable workflows** -> **Save** button.
3.Edit (if necessary) the file `.github/workflows/CI.yml` on your fork modifying the environment variables Vulkan SDK and/or VapourSynth versions:
```
env:
VULKAN_SDK_VERSION:
VAPOURSYNTH_VERSION:
```
4.Go to the GitHub **Actions** tab on your fork, select **CI** workflow and press the **Run workflow** button (if you modified the `.github/workflows/CI.yml` file, a workflow will be already running and no need to run a new one).
When the workflow is completed you will be able to download the artifacts generated (Windows and Linux versions) from the run.
## Download Nightly Builds
**GitHub Actions Artifacts ONLY can be downloaded by GitHub logged users.**
Nightly builds are built automatically by GitHub Actions (GitHub's integrated CI/CD tool) every time a new commit is pushed to the _master_ branch or a pull request is created.
To download the latest nightly build, go to the GitHub [Actions](https://github.com/Kiyamou/VapourSynth-SRMD-ncnn-Vulkan/actions/workflows/CI.yml) tab, enter the last run of workflow **CI**, and download the artifacts generated (Windows and Linux versions) from the run.
## Reference Code
* srmd-ncnn-vulkan: https://github.com/nihui/srmd-ncnn-vulkan
* vapoursynth-waifu2x-ncnn-vulkan: https://github.com/Nlzy/vapoursynth-waifu2x-ncnn-vulkan