README.md
1Description
2===========
3
4waifu2x filter for VapourSynth, based on the w2xc library.
5
6
7Note
8====
9
10The folder `models` must be located in the same folder as `Waifu2x-w2xc.dll`.
11
12The filter will generate .bin files at the same location of the model files for the first time it runs. Make sure that your executable has write permission to the folder of the model files. The filter still can run even without the .bin files being generated, but the performance will degrade. When you update the model files in the future, remember to delete the .bin files as well.
13
14
15Usage
16=====
17
18 w2xc.Waifu2x(clip clip[, int noise=0, int scale=2, int block=512, bint photo=False, int gpu=1, int processor=-1, bint list_proc=False, bint log=False])
19
20* clip: Clip to process. Only planar RGB format with float sample type of 32 bit depth is supported.
21
22* noise: Noise reduction level.
23 * -1 = none
24 * 0 = low
25 * 1 = medium
26 * 2 = high
27 * 3 = highest
28
29* scale: Upscaling factor. Must be a power of 2. Set to 1 for no upscaling.
30
31* block: The block size for dividing the image during processing. Smaller value results in lower VRAM usage, while larger value may give faster speed. The optimal value may vary according to different graphics card and image size.
32
33* photo: When set to false, it uses the anime-style model. When set to true, the photo model will be used instead.
34
35* gpu: Controls the environment to use.
36 * 0 = disable GPU
37 * 1 = auto detect. It will run on the first available environment in the following order:
38 * CUDA
39 * AMD OpenCL
40 * FMA
41 * AVX
42 * Intel OpenCL
43 * SSE3
44 * OpenCV filter2D
45 * 2 = force to use OpenCL
46
47* processor: Sets target processor. Any non-negative value supersedes the choice from `gpu`. Use `list_proc` to get the index of the available processors.
48
49* list_proc: Whether to draw the processors list on the frame.
50
51* log: Whether to write the internal processing stats to stdout.
52
53
54Compilation
55===========
56
57Requires [w2xc](https://github.com/DeadSix27/waifu2x-converter-cpp).
58
59```
60meson build
61ninja -C build
62ninja -C build install
63```
64