[quote=stargaze][size=5][color=#007dc6][b]1. Introduction to Vapoursynth[/b][/color][/size]

[size=3][color=#007dc6][b]1.1 What is Vapoursynth?[/b][/color][/size]

[url=http://www.vapoursynth.com/]VapourSynth[/url] (VS) is an application for video manipulation, just like Avisynth. It has a core library written in C++ and a Python module to allow video scripts to be created.

[url=https://bitbucket.org/mystery_keeper/vapoursynth-editor]VapourSynth Editor[/url] (VSE) is the script editor which is commonly used, with syntax completion and fast preview support.

Vapoursynth scripts are written in python. The main difference compared to Avisynth is the assignment of variables. You have to specify the variable names each time you’re doing something:
[pre]variable = doSomething()
 [/pre]You will have more things to write but it will be clearer to which variable you're assigning the operation.

[size=3][color=#007dc6][b]1.2 Installation of VapourSynth[/b][/color][/size]

The prefered way to install VS is to get the needed packages from the repositories of your distribution, for its simplicity. However, I will here detail how to compile them if you want to have the latest versions which may not be available from your package manager. The initial instructions are taken from [url=http://www.l33tmeatwad.com/vapoursynth101/software-setup]here[/url]. For Arch-based system users, you should be able to compile everything from AUR.
[spoiler]
[color=#007dc6]1.2.1 Preparation[/color]

In the following, we will make the installation in ~/apps. Make sure this directory exists or change it if you like.

[*]Ubuntu:
Check to see if the "site-packages" directory exists:
[pre]if test -d /usr/local/lib/python3.6/site-packages; then echo "exists"; else echo "doesn't exist"; fi
 [/pre]If it does, moving all the files to dist-packages and deleting the directory is recommended.
Create a link to the "dist-packages" directory:
[pre]sudo ln -s /usr/local/lib/python3.6/dist-packages /usr/local/lib/python3.6/site-packages
 [/pre][*]Fedora:
Create now a link for the plugins install directory to the VS one:
[pre]sudo ln -s /usr/lib64/vapoursynth /usr/local/lib/vapoursynth
 [/pre][color=#994d00]For Fedora users, in the following when running ./configure for ffmpeg, l-smash, vapoursynth, x264 and zimg, add --prefix=/usr.[/color]

[color=#007dc6]1.2.2 Dependencies for VS and its plugins[/color]

> [b]Required packages from the repositories of your distribution:[/b]

[*]Ubuntu:
[pre]sudo apt-get install build-essential git yasm libass-dev python3-pip python3-dev cython3 autoconf libtool libmagick++-dev qt5-default libfftw3-dev
 [/pre][*]Fedora:
[pre]sudo dnf install automake gcc gcc-c++ yasm libass-devel python3-devel libtool ImageMagick-c++-devel qt-devel fftw-devel redhat-rpm-config qt5-qtbase-devel
sudo pip3 install cython
 [/pre]> [b]L-SMASH[/b]
[pre]cd ~/apps
git clone https://github.com/l-smash/l-smash.git
./configure --enable-shared
make lib
sudo make install-lib
 [/pre]> [b]x264[/b]
[pre]cd ~/apps
git clone git://git.videolan.org/x264.git
cd x264
./configure --enable-shared
make
sudo make install
 [/pre]> [b]ffmpeg[/b]
[pre]cd ~/apps
git clone https://github.com/ffmpeg/ffmpeg.git
cd ffmpeg
./configure --enable-gpl --enable-libx264 --enable-avresample --enable-shared
make
sudo make install
 [/pre]> [b]zimg[/b]
[pre]cd ~/apps
git clone https://github.com/sekrit-twc/zimg.git
cd zimg
./autogen.sh
./configure
make
sudo make install
 [/pre]
[color=#007dc6]1.2.3 VapourSynth[/color]

> [b]Installation[/b]
[pre]cd ~/apps
git clone https://github.com/vapoursynth/vapoursynth.git
./autogen.sh
./configure
make
sudo make install[/pre]
> [b]Now try it out:[/b]
[pre]vspipe --version
 [/pre]Possible errors:

[*]"vspipe: error while loading shared libraries: libvapoursynth-script.so.0: cannot open shared object file: No such file or directory”.
This is caused by the non-standard location of libvapoursynth-script.so.0. Your dynamic loader is not configured to look in /usr/local/lib. One way to work around this error is to set the LD_LIBRARY_PATH environment variable. Open ~/.bashrc and add:
[pre]export LD_LIBRARY_PATH=/usr/local/lib
 [/pre]Then reload ~/.bashrc with:
[pre]. ~/.bashrc
 [/pre][*]“Failed to initialize VapourSynth environment”.
This is caused by the non-standard location of the Python module, vapoursynth.so. Your Python is not configured to look in /usr/local/lib/python3.x/site-packages. One way to work around this error is to set the PYTHONPATH environment variable. Open ~/.bashrc and add (replace “x” with the correct number, you probably have python 3.6):
[pre]export PYTHONPATH=/usr/local/lib/python3.x/site-packages
 [/pre]Then reload ~/.bashrc with:
[pre]. ~/.bashrc
 [/pre][color=#007dc6]1.2.4 VapourSynth Editor[/color]

> [b]Installation[/b]
[pre]cd ~/apps
git clone https://bitbucket.org/mystery_keeper/vapoursynth-editor.git
cd vapoursynth-editor/pro
qmake pro.pro #NOTE: Fedora uses qmake-qt5.
make
sudo ln -s ~/apps/vapoursynth-editor/build/release-64bit-gcc/vsedit /usr/bin/vsedit
 [/pre]> [b]Add VapourSynth-Editor to application menu[/b] (Optional, for gnome):
[pre]sudo ln -s $HOME/apps/VapourSynth-Editor/vsedit.ico /usr/share/icons/vsedit.ico
sudo gedit ~/.local/share/applications/vsedit.desktop
 [/pre]Enter the following, save, then close gedit:
[pre][Desktop Entry]
Type=Application
Name=VapourSynth-Editor
Comment=
Icon=/usr/share/icons/vsedit.ico
Exec=/usr/bin/vsedit
Terminal=false
Categories=VapourSynth;
 [/pre][/spoiler]
[size=3][color=#007dc6][b]1.3 Installation of plugins[/b][/color][/size]
[spoiler]
Let's take FFMS2, that you will need, as example.

> [b]Download the source[/b]:[pre]git clone https://github.com/FFMS/ffms2.git
 [/pre]> [b]Browse to the source directory:[/b][pre]cd ffms2
 [/pre]> [b]Next you need to find what files were included to assist with compiling the source:[/b][pre]ls
 [/pre]You will be looking for one or more of the following files: autogen.sh, configure, CMakeLists.txt, or waf.

> [b]FFMS2 has autogen.sh so you would compile and install by doing the following:[/b][pre]./autogen.sh
./configure
make
sudo make install
 [/pre]> [b]Pay attention to where the install places the file, most plugins will install to /usr/local/lib instead of the VS plugins directory. If this is the case you will need to create a symbolic link in the VS plugins folder by doing the following:[/b]

[*]Ubuntu:
[pre]sudo ln -s /usr/local/lib/ffms2.so /usr/local/lib/vapoursynth/libffms2.so
 [/pre][*]Fedora:
[pre]sudo ln -s /usr/lib64/libffms2.so /usr/lib64/vapoursynth/libffms2.so
 [/pre]Follow the same procedure for each plugin you want to install.
[/spoiler]
[size=3][color=#007dc6][b]1.4 Scripts[/b][/color][/size]

Most Avisynth functions have been ported by a couple of developers/contributers. Their scripts usually rely on each other’s. Here are the scripts you can have a look at and their respective functions:

[url=https://github.com/HomeOfVapourSynthEvolution/havsfunc]havsfunc[/url]
[spoiler]
Main functions:
[quote]daa
santiag
FixChromaBleedingMod
Deblock_QED
DeHalo_alpha
YAHR
HQDering mod
QTGMC
srestore
ivtc_txt60mc
logoNR
Vinverse
Vinverse2
LUTDeCrawl
LUTDeRainbow
Stab
GrainStabilizeMC
MCTemporalDenoise
SMDegrain
STPresso
SigmoidInverse, SigmoidDirect
GrainFactory3
InterFrame
SmoothLevels
FastLineDarken 1.4x MT MOD
Toon
LSFmod
TemporalDegrain
aaf[/quote]
Utility functions:
[quote]AverageFrames
Bob
ChangeFPS
Clamp
KNLMeansCL
Overlay
Padding
Resize
SCDetect
Weave
ContraSharpening
MinBlur
sbr
DitherLumaRebuild
mt_expand_multi
mt_inpand_multi
mt_inflate_multi
mt_deflate_multi[/quote][/spoiler]
[url=https://github.com/WolframRhodium/muvsfunc]muvsfunc[/url]
[spoiler]
[quote]LDMerge
Compare (2)
ExInpand
InDeflate
MultiRemoveGrain
GradFun3
AnimeMask (2)
PolygonExInpand
Luma
ediaa
nnedi3aa
maa
SharpAAMcmod
TEdge
Sort
Soothe_mod
TemporalSoften
FixTelecinedFades
TCannyHelper
MergeChroma
firniture
BoxFilter
SmoothGrad
DeFilter
scale (using the old expression in havsfunc)
ColorBarsHD
SeeSaw
abcxyz
Sharpen
Blur
BlindDeHalo3
dfttestMC
TurnLeft
TurnRight
BalanceBorders
DisplayHistogram
GuidedFilter (Color)
GMSD
SSIM
SSIM_downsample
LocalStatisticsMatching
LocalStatistics
TextSub16
TMinBlur
mdering
BMAFilter[/quote][/spoiler]
[url=https://github.com/HomeOfVapourSynthEvolution/mvsfunc]mvsfunc[/url]
[spoiler]
Main functions:
[quote]Depth
ToRGB
ToYUV
BM3D
VFRSplice[/quote]
Runtime functions:
[quote]PlaneStatistics
PlaneCompare
ShowAverage
FilterIf
FilterCombed[/quote]
Utility functions:
[quote]Min
Max
Avg
MinFilter
MaxFilter
LimitFilter
PointPower
CheckMatrix
postfix2infix[/quote]
Frame property functions:
[quote]SetColorSpace
AssumeFrame
AssumeTFF
AssumeBFF
AssumeField
AssumeCombed[/quote]
Helper functions:
[quote]CheckVersion
GetMatrix
zDepth
PlaneAverage
GetPlane
GrayScale
Preview[/quote][/spoiler]
[url=https://github.com/Irrational-Encoding-Wizardry/fvsfunc]fvsfunc[/url]
[spoiler][quote]GradFun3mod
DescaleM (DebilinearM, DebicubicM etc.)
Downscale444
JIVTC
OverlayInter
AutoDeblock
ReplaceFrames (ReplaceFramesSimple)
maa
TemporalDegrain
DescaleAA
InsertSign[/quote][/spoiler]
[url=https://gist.github.com/kageru/d71e44d9a83376d6b35a85122d427eb5]kagefunc[/url]
[spoiler][quote]inverse_scale
inverse_scale_clip_array
clip_to_plane_array
plane_array_to_clip
generate_mask
apply_mask
apply_mask_to_area
getY
generate_keyframes
adaptive_grain
conditional_resize
retinex_edgemask
kirsch
fast_sobel
get_descale_filter
hardsubmask
hardsubmask_fades
crossfade
hybriddenoise
insert_clip
get_subsampling
iterate
is16bit
getw
shiftl
fit_subsampling
mask_detail[/quote][/spoiler]
[url=https://gist.github.com/4re/bba3f65469acfe0ec08a]vshelpers of 4re[/url]
[spoiler][quote]clamp
m4
build_mask
mt_lut
mt_lutxy
logic
get_luma
merge_chroma
rsoften
fit
move
get_decoder
subtract
starmask[/quote][/spoiler]
I additionally created avisynth's ports of functions you will probably need and other utility functions in my [url=https://awesome-hd.me/forums.php?action=viewthread&threadid=23395&post=1#post183689]sgvsfunc script[/url].
[spoiler]
Filtering functions:
[quote]FixRowBrightness
FixColumnBrightness
FixRowBrightnessProtect2
FixColumnBrightnessProtect2
FixBrightnessProtect2
bbmod
BlackBorders
CropResize
CropResizeReader
DebandReader
LumaMaskMerge
RGBMaskMerge[/quote]
Utility functions:
[quote]SelectRangeEvery
FrameInfo
DelFrameProp
InterleaveDir
ExtractFramesReader
ReplaceFrames
Overlay
mt_lut
GetPlane
scale[/quote][/spoiler]
You can install the aforementioned scripts. You will also need to install [url=https://github.com/dubhater/vapoursynth-adjust]Adjust[/url] which is a requirement for havsfunc.

To install a python script for VS, just download the .py file from github and copy it into your python packages directory:

[*]Ubuntu: /usr/local/lib/python3.6/dist-packages
[*]Fedora & Arch: /usr/lib64/python3.6/site-packages

[size=3][color=#007dc6][b]1.5 Initialisation of a script[/b][/color][/size]

[color=#007dc6]1.5.1 Basics[/color]

Open VSE. The first step when creating a script is to initialise VS. Write the following always in the first line:
[pre]import vapoursynth as vs
from vapoursynth import core
 [/pre]The second line can alternatively be:
[pre]core = vs.get_core()
 [/pre]And the following always in the last line of your script:
[pre]last.set_output()
 [/pre]where “last” should contain the clip you want to encode.

[color=#007dc6]1.5.2 Loading plugins[/color]

Plugins will be automatically loaded once installed. You can rely on “core” to call them:
[pre]variable = core.pluginname.function(clip)
 [/pre]For example:
[pre]src = core.ffms2.Source('/path/to/source.mkv')
 [/pre][color=#007dc6]1.5.3 Loading scripts[/color]

Scripts are loaded manually. Import them at the beginning of your script. You may give them names. For example:
[pre]import fvsfunc as fvf
import mvsfunc as mvf
import kagefunc as kgf
import havsfunc as haf
import muvsfunc as muvf
import sgvsfunc as sgf
 [/pre]You can finally call them in your script:
[pre]variable = scriptname.function(clip)
 [/pre]For example to call QTGMC:
[pre]out = haf.QTGMC(src)
 [/pre][/quote]