VapourSynth

https://vapoursynth.com/doc/
Admin
VapourSynth is a video manipulation application and library that provides multithreaded video...
Tokens:71,025
Snippets:714
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Upload Wheels with Twine

Source: https://vapoursynth.com/doc/packaging.html

Install the twine utility and upload your built distribution files to PyPI. You will be prompted for your PyPI credentials.

```bash
pip install twine
twine upload dist/*

```

--------------------------------

### Install VapourSynth via Pip

Source: https://vapoursynth.com/doc/installation.html

Direct installation of VapourSynth from the GitHub repository using pip.

```bash
pip install git+https://github.com/vapoursynth/vapoursynth.git
```

--------------------------------

### Verify VapourSynth Installation

Source: https://vapoursynth.com/doc/installation.html

Use this snippet in a Python command line to confirm the library is correctly installed and initialized.

```python
from vapoursynth import core
print(str(core))
```

--------------------------------

### Configure Clip Output Formats

Source: https://vapoursynth.com/doc/pythonreference.html

Examples for setting alternative output formats using alt_output parameters.

```python
some_clip = core.resize.Bicubic(clip, format=vs.YUV422P10)
some_clip.set_output(alt_output=1)
```

```python
some_clip = core.resize.Bicubic(clip, format=vs.YUV422P8)
some_clip.set_output(alt_output=2)
```

--------------------------------

### Install VapourSynth on macOS via Homebrew

Source: https://vapoursynth.com/doc/installation.html

Use Homebrew to install the VapourSynth package after installing Xcode and Homebrew.

```bash
brew install vapoursynth
```

--------------------------------

### Resize Error Example

Source: https://vapoursynth.com/doc/functions/video/resize.html

Example of an error message returned when colorspace conversion paths are invalid.

```text
Resize error 3074: no path between colorspaces (2/2/2 => 1/1/1).
May need to specify additional colorspace parameters.
```

--------------------------------

### Example Project Structure

Source: https://vapoursynth.com/doc/packaging.html

A typical project structure for a VapourSynth plugin using Hatchling and Meson. This structure helps organize source files, build configurations, and metadata for packaging.

```text
path/to/your/project
├── src
|  └── MyPlugin
|     ├── myplugin.cpp
|     └── myplugin.h
├── .gitattributes
├── .gitignore
├── LICENSE
├── hatch_build.py
├── meson.build
├── pyproject.toml
└── README.md

```

--------------------------------

### register_policy(policy)

Source: https://vapoursynth.com/doc/pythonreference.html

Installs a custom EnvironmentPolicy.

```APIDOC
## register_policy(policy)

### Description
Installs a custom EnvironmentPolicy for use by custom Script-Runners and Editors. This function only works if no other policy has been installed.

### Parameters
- **policy** (object) - Required - The policy object to register.
```

--------------------------------

### Expression examples and C equivalents

Source: https://vapoursynth.com/doc/functions/video/expr.html

Comparison of RPN expressions used in Expr and their equivalent C syntax.

```text
a b c ?

d e <

f abs
```

```text
a ? b : c

d < e

abs(f)
```

--------------------------------

### core()

Source: https://vapoursynth.com/doc/pythonreference.html

Gets the singleton Core object. If it is the first time the function is called, the Core will be instantiated with the default options.

```APIDOC
## core()

### Description
Gets the singleton Core object. If it is the first time the function is called, the Core will be instantiated with the default options.
```

--------------------------------

### Get Core Information

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Retrieves information about the VapourSynth core. Use VSCoreInfo or VSCoreInfo2 as appropriate.

```c
void getCoreInfo(VSCore *core, VSCoreInfo *info)
```

```c
void getCoreInfo(VSCore *core, VSCoreInfo2 *info)
```

--------------------------------

### FreezeFrames usage example

Source: https://vapoursynth.com/doc/functions/video/freezeframes.html

Demonstrates replacing multiple frame ranges with specific replacement frames. The ranges must not overlap.

```python
core.std.FreezeFrames(input, first=[0, 100, 231], last=[15, 112, 300], replacement=[8, 50, 2])
```

--------------------------------

### SelectEvery Usage Examples

Source: https://vapoursynth.com/doc/functions/video/selectevery.html

Common patterns for frame selection, decimation, and duplication using SelectEvery.

```python
SelectEvery(clip=clip, cycle=2, offsets=0)
```

```python
SelectEvery(clip=clip, cycle=2, offsets=1)
```

```python
SelectEvery(clip=clip, cycle=5, offsets=[1, 2, 3, 4])
```

```python
SelectEvery(clip=clip, cycle=4, offsets=[0, 1, 2, 3, 3])
```

--------------------------------

### VSLogHandle *addLogHandler(VSLogHandler handler, VSLogHandlerFree free, void *userData, VSCore *core)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Installs a custom handler for VapourSynth messages. This handler is specific to a VSCore instance and returns a unique handle. If no handler is installed, messages may be cached and delivered later.

```APIDOC
## VSLogHandle *addLogHandler(VSLogHandler handler, VSLogHandlerFree free, void *userData, VSCore *core)

### Description
Installs a custom handler for the various error messages VapourSynth emits. The message handler is per VSCore instance. Returns a unique handle. If no log handler is installed up to a few hundred messages are cached and will be delivered as soon as a log handler is attached. This behavior exists mostly so that warnings when auto-loading plugins (default behavior) won’t disappear-

### Parameters
#### Path Parameters
- **handler** (VSLogHandler) - Required - Custom message handler function pointer. If NULL, the default handler is restored.
- **free** (VSLogHandlerFree) - Required - Function pointer called when the handler is removed.
- **userData** (void *) - Required - Pointer passed to the message handler.
- **core** (VSCore *) - Required - Pointer to the VapourSynth core.
```

--------------------------------

### Load and Gain Audio Clip

Source: https://vapoursynth.com/doc/gettingstarted.html

This script loads an audio file using BestSource, applies a 2x gain to all channels, and sets it for output. Ensure BestSource is installed and auto-loaded.

```python
from vapoursynth import core                     # Get an instance of the core
clip = core.bs.AudioSource(source='filename.mkv')    # Load an audio track in mkv file
clip = core.std.AudioGain(clip,gain=2.0)         # Gain all channels 2x
clip.set_output()                                # Set the audio clip to be accessible for output

```

--------------------------------

### Merge Clips with Specific Weights

Source: https://vapoursynth.com/doc/functions/video/merge.html

Examples demonstrating how to merge clips by prioritizing luma or chroma planes using weight arrays.

```python
Merge(clipa=A, clipb=B, weight=[1, 0])
```

```python
Merge(clipa=A, clipb=B, weight=[0, 1])
```

--------------------------------

### Reconstructing frames with DoubleWeave

Source: https://vapoursynth.com/doc/functions/video/doubleweave.html

Example demonstrating the use of DoubleWeave to weave fields back together after using SeparateFields, followed by SelectEvery to finalize the frame rate.

```python
sep = core.std.SeparateFields(source)
...
woven = core.std.DoubleWeave(sep)
woven = core.std.SelectEvery(woven, 2, 0)
```

--------------------------------

### get_output(index)

Source: https://vapoursynth.com/doc/pythonreference.html

Get a previously set output node.

```APIDOC
## get_output(index)

### Description
Get a previously set output node. Throws an error if the index hasn’t been set.

### Parameters
#### Path Parameters
- **index** (int) - Optional - The index of the output node (default: 0).
```

--------------------------------

### Applying Blur Convolutions

Source: https://vapoursynth.com/doc/functions/video/convolution.html

Examples of using the Convolution function to achieve blur effects similar to Avisynth.

```python
Convolution(matrix=[1, 2, 1, 2, 4, 2, 1, 2, 1])
```

```python
Convolution(matrix=[1, 1, 1, 1, 1, 1, 1, 1, 1])
```

--------------------------------

### Convert limited range YUV to full range

Source: https://vapoursynth.com/doc/functions/video/levels.html

Example showing how to remap limited range YUV video to full range for both luma and chroma planes.

```python
clip = std.Levels(clip, min_in=16, max_in=235, min_out=0, max_out=255, planes=0)
clip = std.Levels(clip, min_in=16, max_in=240, min_out=0, max_out=255, planes=[1,2])
```

--------------------------------

### SetFieldBased Usage Example

Source: https://vapoursynth.com/doc/functions/video/setfieldbased.html

Demonstrates setting a clip to frame-based to improve resizing quality for progressive material incorrectly encoded as interlaced.

```python
clip = core.bs.VideoSource("rule6.mkv")
clip = core.std.SetFieldBased(clip, 0)
clip = clip.resize.Bilinear(clip, width=320, height=240)
```

--------------------------------

### Load and Flip Video Clip

Source: https://vapoursynth.com/doc/gettingstarted.html

This script loads a video file using BestSource, flips it horizontally, and sets it for output. Ensure BestSource is installed and auto-loaded.

```python
from vapoursynth import core                     # Get an instance of the core
clip = core.bs.VideoSource(source='filename.mkv')  # Load a video track in mkv file
clip = core.std.FlipHorizontal(clip)             # Flip the video clip in the horizontal direction
clip.set_output()                                # Set the video clip to be accessible for output

```

--------------------------------

### Argument Declaration Example 1

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Declares 'blah' as a vnode, 'moo' as an optional integer array, and 'asdf' as an optional float. This format is used for the 'args' parameter in registerFunction.

```text
blah:vnode;moo:int[]:opt;asdf:float:opt;
```

--------------------------------

### Initialize Local storage

Source: https://vapoursynth.com/doc/pythonreference.html

Demonstrates creating a Local instance to store variables tied to the currently active core.

```python
l = Local()
l.test = 1
```

--------------------------------

### Build Documentation

Source: https://vapoursynth.com/doc/installation.html

Command to generate the documentation using the provided Makefile.

```bash
$ make -C doc/ html
```

--------------------------------

### Prepare Windows Build Dependencies

Source: https://vapoursynth.com/doc/installation.html

Commands to manually clone required submodules into the VapourSynth directory.

```bash
git clone https://github.com/sekrit-twc/zimg --recurse-submodules
```

```bash
git clone https://github.com/sekrit-twc/libp2p
```

--------------------------------

### getPluginFunctionByName

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Get a function belonging to a plugin by its name.

```APIDOC
## getPluginFunctionByName

### Description
Get a function belonging to a plugin by its name.

### Parameters
- **name** (const char *) - The name of the function.
- **plugin** (VSPlugin *) - A pointer to the plugin.

### Returns
- (VSPluginFunction *) - A pointer to the VSPluginFunction, or NULL if not found.
```

--------------------------------

### VSInitPlugin (VapourSynthPluginInit2)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

The entry point for a VapourSynth plugin, responsible for initializing the plugin and registering its filters.

```APIDOC
## VSInitPlugin (VapourSynthPluginInit2)

### Description
A plugin's entry point. It must be called `VapourSynthPluginInit2`. This function is called after the core loads the shared library. Its purpose is to configure the plugin and to register the filters the plugin wants to export.

### Parameters
- **plugin** (VSPlugin *) - A pointer to the plugin object to be initialized.
- **vspapi** (const VSPLUGINAPI *) - A pointer to a VSPLUGINAPI struct with a subset of the VapourSynth API used for initializing plugins. The proper way to do things is to call configPlugin and then registerFunction for each function to export.

### Signature
typedef void (VS_CC *VSInitPlugin)(VSPlugin *plugin, const VSPLUGINAPI *vspapi)
```

--------------------------------

### void getCoreInfo(VSCore *core, VSCoreInfo *info)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Retrieves information about the VapourSynth core and populates the provided VSCoreInfo structure.

```APIDOC
## void getCoreInfo(VSCore *core, VSCoreInfo *info)

### Description
Returns information about the VapourSynth core.

### Parameters
#### Path Parameters
- **core** (VSCore *) - Required - Pointer to the VapourSynth core.
- **info** (VSCoreInfo *) - Required - Pointer to the VSCoreInfo structure to be populated.
```

--------------------------------

### Get API Version

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Returns the highest VAPOURSYNTH_API_VERSION supported by the library.

```c
int getAPIVersion()
```

--------------------------------

### std.LoadAllPlugins(path)

Source: https://vapoursynth.com/doc/functions/general/loadallplugins.html

Loads all native VapourSynth plugins found in the specified path. Plugins that fail to load are silently skipped.

```APIDOC
## std.LoadAllPlugins(path)

### Description
Loads all native VapourSynth plugins found in the specified path. Plugins that fail to load are silently skipped.

### Parameters
- **path** (string) - Required - The directory path containing the plugins to be loaded.
```

--------------------------------

### Convert to YV12

Source: https://vapoursynth.com/doc/functions/video/resize.html

Example of converting a clip to YV12 format using the Bicubic filter.

```python
Bicubic(clip=clip, format=vs.YUV420P8, matrix_s="709")
```

--------------------------------

### LoadAllPlugins Path Handling

Source: https://vapoursynth.com/doc/functions/general/loadallplugins.html

Demonstrates incorrect and correct ways to specify file paths for plugin loading to avoid Python escape character issues.

```python
LoadPlugin(path='c:\plugins')
```

```python
LoadPlugin(path='c:/plugins')
LoadPlugin(path=r'c:\plugins')
LoadPlugin(path='c:\\plugins\\')
```

--------------------------------

### void getCoreInfo(VSCore *core, VSCoreInfo2 *info)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Retrieves extended information about the VapourSynth core and populates the provided VSCoreInfo2 structure.

```APIDOC
## void getCoreInfo(VSCore *core, VSCoreInfo2 *info)

### Description
Returns information about the VapourSynth core.

### Parameters
#### Path Parameters
- **core** (VSCore *) - Required - Pointer to the VapourSynth core.
- **info** (VSCoreInfo2 *) - Required - Pointer to the VSCoreInfo2 structure to be populated.
```

--------------------------------

### Average Y planes with different formats

Source: https://vapoursynth.com/doc/functions/video/expr.html

Example of averaging Y planes across clips with different bit depths.

```python
std.Expr(clips=[clipa16bit, clipb10bit, clipa8bit],
   expr=["x y 64 * + z 256 * + 3 /", ""])
```

--------------------------------

### Combine Video and Audio Processing

Source: https://vapoursynth.com/doc/gettingstarted.html

This script demonstrates loading both video and audio, applying separate operations to each (flipping video, gaining audio), and setting them for output with specific indices.

```python
from vapoursynth import core
video = core.bs.VideoSource(source='filename.mkv')
audio = core.bs.AudioSource(source='filename.mkv')
video = core.std.FlipHorizontal(video)
audio = core.std.AudioGain(audio,gain=2.0)
video.set_output(index=0)
audio.set_output(index=1)

```

--------------------------------

### Create VapourSynth Core

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Creates a VapourSynth processing core. Use 0 for default flags. Multiple cores can be created but are rarely needed.

```c
VSCore *createCore(int flags)
```

--------------------------------

### Average Y planes of 3 YUV clips

Source: https://vapoursynth.com/doc/functions/video/expr.html

Example of averaging Y planes while passing through UV planes unchanged.

```python
std.Expr(clips=[clipa, clipb, clipc], expr=["x y + z + 3 /", "", ""])
```

--------------------------------

### Unsharp mask using MakeFullDiff

Source: https://vapoursynth.com/doc/functions/video/makefulldiff.html

Demonstrates using MakeFullDiff to calculate a difference clip for sharpening, followed by MergeFullDiff to apply it.

```python
blur_clip = core.std.Convolution(clip, matrix=[1, 2, 1, 2, 4, 2, 1, 2, 1])
diff_clip = core.std.MakeFullDiff(clip, blur_clip)
sharpened_clip = core.std.MergeFullDiff(clip, diff_clip)
```

--------------------------------

### Plugin Initialization Functions

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Functions for initializing and managing VapourSynth plugins.

```APIDOC
## Plugin Initialization Functions

### VSInitPlugin
This function is used to initialize a VapourSynth plugin.

### VSFilterGetFrame
This function is called by VapourSynth to get a frame from a filter.

### VSFilterFree
This function is called by VapourSynth to free resources associated with a filter.
```

--------------------------------

### Activate Virtual Environment (Windows)

Source: https://vapoursynth.com/doc/packaging.html

Activate the created virtual environment on Windows systems.

```bash
.venv\Scripts\activate
```

--------------------------------

### Set output format for Expr

Source: https://vapoursynth.com/doc/functions/video/expr.html

Example of overriding the output format when the result exceeds the range of the input clips.

```python
std.Expr(clips=[clipa10bit, clipb16bit, clipa8bit],
   expr=["x 64 * y + z 256 * + 3 /", ""], format=vs.YUV420P16)
```

--------------------------------

### Activate Virtual Environment (Linux/macOS)

Source: https://vapoursynth.com/doc/packaging.html

Activate the created virtual environment on Linux or macOS systems.

```bash
source .venv/bin/activate
```

--------------------------------

### Compile VapourSynth on Linux and macOS

Source: https://vapoursynth.com/doc/installation.html

Commands to build the VapourSynth wheel from the source directory.

```bash
python -m build --wheel
```

--------------------------------

### Set Frame Properties Example

Source: https://vapoursynth.com/doc/functions/video/setframeprops.html

Sets the _FieldBased property to 2 to indicate top field first order.

```python
clip = c.std.SetFrameProps(clip, _FieldBased=2)
```

--------------------------------

### SetFrameProp Usage

Source: https://vapoursynth.com/doc/functions/video/setframeprop.html

Example demonstrating how to set the _FieldBased property to 2 (top field first) for a given clip.

```python
clip = c.std.SetFrameProp(clip, prop="_FieldBased", intval=2)
```

--------------------------------

### Core Methods

Source: https://vapoursynth.com/doc/genindex.html

Methods for interacting with the VapourSynth core.

```APIDOC
## Core Methods

### get_video_format()

Retrieves the video format information.

### log_message()

Logs a message through the core.

### plugins()

Returns a list of loaded plugins.

### query_video_format()

Queries for a specific video format.

### remove_log_handler()

Removes a log handler.

### rule6()

Applies rule 6 processing.
```

--------------------------------

### output(fileobj, wav=False, w64=False, progress_update=None, prefetch=0, backlog=-1)

Source: https://vapoursynth.com/doc/pythonreference.html

Writes the whole audio to the specified file handle.

```APIDOC
## output(fileobj, wav=False, w64=False, progress_update=None, prefetch=0, backlog=-1)

### Description
Write the whole audio to the specified file handle. It is possible to pipe to stdout by specifying sys.stdout as the file.

### Parameters
- **fileobj** (file handle) - Required - The file handle to write to.
- **wav** (bool) - Optional - Write a WAV header.
- **w64** (bool) - Optional - Write a WAVE64 header.
- **progress_update** (function) - Optional - Callback function of the form func(current_frame, total_frames).
- **prefetch** (int) - Optional - Debugging purposes only.
- **backlog** (int) - Optional - Debugging purposes only.
```

--------------------------------

### Correct LoadPlugin path usage

Source: https://vapoursynth.com/doc/functions/general/loadplugin.html

Shows valid ways to specify file paths for LoadPlugin to avoid escape character issues.

```python
LoadPlugin(path='c:/plugins/filter.dll')
LoadPlugin(path=r'c:\plugins\filter.dll')
LoadPlugin(path='c:\\plugins\\filter.dll')
```

--------------------------------

### std.Trim

Source: https://vapoursynth.com/doc/functions/video/trim.html

Returns a clip containing only the frames between the specified first and last indices, or a clip of a specific length starting from the first index.

```APIDOC
## std.Trim(clip, first=0, last, length)

### Description
Trim returns a clip with only the frames between the arguments first and last, or a clip of length frames, starting at first. Trim is inclusive, meaning Trim(clip, first=3, last=3) will return one frame.

### Parameters
- **clip** (vnode) - Required - The input video clip.
- **first** (int) - Optional - The index of the first frame to include (default: 0).
- **last** (int) - Optional - The index of the last frame to include.
- **length** (int) - Optional - The number of frames to include starting from first.

### Notes
- Specifying both last and length is an error.
- Calling Trim in a way that returns no frames is an error, as 0-frame clips are not allowed.
- In Python, this can also be invoked by slicing a clip.
```

--------------------------------

### Argument Declaration Example 2

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Declares 'blah' as a vnode and accepts all remaining arguments of any type. This format is used for the 'args' parameter in registerFunction.

```text
blah:vnode;any
```

--------------------------------

### Add Log Handler

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Installs a custom handler for VapourSynth messages. The handler is specific to a VSCore instance. Cached messages are delivered upon attachment.

```c
VSLogHandle *addLogHandler(VSLogHandler handler, VSLogHandlerFree free, void *userData, VSCore *core)
```

--------------------------------

### Resize and Convert to Planar RGB with Properties

Source: https://vapoursynth.com/doc/functions/video/resize.html

Resize a clip to 1080p and convert to planar RGB when color information is already present in frame properties.

```python
Bicubic(clip=clip, width=1920, height=1080, format=vs.RGB24)
```

--------------------------------

### Resize and Convert to Planar RGB without Properties

Source: https://vapoursynth.com/doc/functions/video/resize.html

Resize a clip to 1080p and convert to planar RGB, manually specifying the input matrix since frame properties are missing.

```python
Bicubic(clip=clip, width=1920, height=1080, format=vs.RGB24, matrix_in_s="709")
```

--------------------------------

### get_include()

Source: https://vapoursynth.com/doc/pythonreference.html

Returns the full path to the VapourSynth headers.

```APIDOC
## get_include()

### Description
Returns the full path to the VapourSynth headers.
```

--------------------------------

### std.LoadPlugin(path, altsearchpath=False)

Source: https://vapoursynth.com/doc/functions/general/loadplugin.html

Loads a native VapourSynth plugin. If successful, the plugin's functions are registered in their own namespace. It returns an error if a plugin with the same identifier or namespace is already loaded.

```APIDOC
## std.LoadPlugin(path, altsearchpath=False)

### Description
Loads a native VapourSynth plugin. If successful, the loaded plugin's functions will end up in their own namespace. Returns an error if a plugin with the same identifier or namespace already has been loaded.

### Parameters
- **path** (string) - Required - The file path to the plugin DLL.
- **altsearchpath** (bint) - Optional - Defaults to False. If set to True, modifies the search behavior to also include DLLs in the PATH.

### Usage Example
```python
import vapoursynth as vs
core = vs.core
core.std.LoadPlugin(path=r'c:\plugins\filter.dll')
```
```

--------------------------------

### createScript

Source: https://vapoursynth.com/doc/api/vsscript4.h.html

Creates an empty script environment that can be used to evaluate scripts. Passing a pre-created core can be useful to have custom core creation flags, log callbacks or plugins pre-loaded. Passing NULL will automatically create a new core with default settings. The function takes over ownership of the core regardless of success or failure and returns NULL on error.

```APIDOC
## createScript

### Description
Creates an empty script environment that can be used to evaluate scripts. Passing a pre-created _core_ can be usful to have custom core creation flags, log callbacks or plugins pre-loaded. Passing NULL will automatically create a new core with default settings.
Takes over ownership of the _core_ regardless of success or failure. Returns NULL on error.

### Signature

```c
VSScript *createScript(VSCore *core)
```
```

--------------------------------

### enum VSCoreCreationFlags

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Options for creating a VapourSynth core.

```APIDOC
## enum VSCoreCreationFlags
> Options when creating a core.
>   * ccfEnableGraphInspection
>> Required to use the graph inspection api functions. Increases memory usage due to the extra information stored.
>   * ccfDisableAutoLoading
>> Don’t autoload any user plugins. Core plugins are always loaded.
>   * ccfDisableLibraryUnloading
>> Don’t unload plugin libraries when the core is destroyed. Due to a small amount of memory leaking every load and unload (windows feature, not my fault) of a library this may help in applications with extreme amount of script reloading.
>   * ccfEnableFrameRefDebug
>> Logs information when frames are allocated and freed and by which filter (if any). The messages are information level. Useful to help debug frame reference leaks.
```

--------------------------------

### pyproject.toml Configuration

Source: https://vapoursynth.com/doc/packaging.html

Defines build system requirements, project metadata, and build targets for Hatch.

```toml
[build-system]
requires = ["hatchling", "packaging", "meson"]
build-backend = "hatchling.build"

[project]
name = "MyPlugin"
version = "1.0"
description = "MyPlugin description"
requires-python = ">=3.12"
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
authors = [{ name = "Name", email = "name@email.com" }]
maintainers = [{ name = "YourName", email = "name@email.com" }]

dependencies = ["vapoursynth>=74"]

[tool.hatch.build.targets.wheel]
include = ["vapoursynth/plugins"]
artifacts = [
    "vapoursynth/plugins/*.dylib",
    "vapoursynth/plugins/*.so",
    "vapoursynth/plugins/*.dll",
]

[tool.hatch.build.targets.wheel.hooks.custom]
path = "hatch_build.py"

```

--------------------------------

### VSPLUGINAPI::configPlugin

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Provides essential information about a plugin to VapourSynth during its loading process.

```APIDOC
## configPlugin(const char *identifier, const char *pluginNamespace, const char *name, int pluginVersion, int apiVersion, int flags, VSPlugin *plugin)

### Description
Used to provide information about a plugin when loaded. Must be called exactly once from the _VapourSynthPluginInit2_ entry point. It is recommended to use the VS_MAKE_VERSION macro when providing the _pluginVersion_. If you don’t know the specific _apiVersion_ you actually require simply pass VAPOURSYNTH_API_VERSION to match the header version you’re compiling against. The _flags_ consist of values from VSPluginConfigFlags ORed together but should for most plugins typically be 0.

Returns non-zero on success.

### Method
`int`

### Parameters
- **identifier** (const char *) - Unique identifier for the plugin.
- **pluginNamespace** (const char *) - The namespace for the plugin.
- **name** (const char *) - The human-readable name of the plugin.
- **pluginVersion** (int) - The version of the plugin.
- **apiVersion** (int) - The VapourSynth API version the plugin requires.
- **flags** (int) - Flags for plugin configuration.
- **plugin** (VSPlugin *) - Pointer to the VSPlugin structure.
```

--------------------------------

### text.CoreInfo

Source: https://vapoursynth.com/doc/functions/video/text/coreinfo.html

Prints information about the VapourSynth core, such as version and memory use. If no clip is supplied, a default blank one is used. This is a convenience function for Text.

```APIDOC
## text.CoreInfo

### Description
Prints information about the VapourSynth core, such as version and memory use. If no clip is supplied, a default blank one is used. This is a convenience function for Text.

### Signature
text.CoreInfo([_vnode clip=std.BlankClip()_, _int alignment=7_, _int scale=1_])

### Parameters
#### clip
- **clip** (_vnode_) - Optional - The clip to use. Defaults to a blank clip.
#### alignment
- **alignment** (_int_) - Optional - Alignment setting. Defaults to 7.
#### scale
- **scale** (_int_) - Optional - Scale setting. Defaults to 1.
```

--------------------------------

### getCore

Source: https://vapoursynth.com/doc/api/vsscript4.h.html

Retrieves the VapourSynth core that was created in the script environment. If a VapourSynth core has not been created yet, it will be created now with default options. The VSScript retains ownership of the returned core object. Returns NULL on error.

```APIDOC
## getCore

### Description
Retrieves the VapourSynth core that was created in the script environment. If a VapourSynth core has not been created yet, it will be created now, with the default options (see the Python Reference).
VSScript retains ownership of the returned core object.
Returns NULL on error.

### Signature

```c
VSCore *getCore(VSScript *handle)
```
```

--------------------------------

### Unsharp masking using MakeDiff

Source: https://vapoursynth.com/doc/functions/video/makediff.html

Demonstrates how to perform unsharp masking on the luma plane by calculating the difference between a clip and its blurred version, then merging that difference back.

```python
blur_clip = core.std.Convolution(clip, matrix=[1, 2, 1, 2, 4, 2, 1, 2, 1], planes=[0])
diff_clip = core.std.MakeDiff(clip, blur_clip, planes=[0])
sharpened_clip = core.std.MergeDiff(clip, diff_clip, planes=[0])
```

--------------------------------

### Chain VapourSynth Filters

Source: https://vapoursynth.com/doc/pythonreference.html

Demonstrates chaining filters using dot notation compared to nested function calls.

```python
clip = clip.std.Trim(first=100, last=2000).std.FlipVertical()
```

```python
clip = core.std.FlipVertical(core.std.Trim(clip, first=100, last=2000))
```

--------------------------------

### Create New Video Frame

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Creates a new video frame with uninitialized memory. Optionally copies properties from another frame. Invalid arguments result in a fatal error.

```c
VSFrame *newVideoFrame(const VSVideoFormat *format, int width, int height, const VSFrame *propSrc, VSCore *core)
```

--------------------------------

### std.BlankAudio

Source: https://vapoursynth.com/doc/functions/audio/blankaudio.html

Generates a new empty audio clip with specified properties.

```APIDOC
## std.BlankAudio

### Description
Generates a new empty clip. This can be useful to have when editing audio or for testing. The default is a 10 second long 44.1kHz 16 bit stereo clip.

### Signature
`std.BlankAudio([clip, channels=[FRONT_LEFT, FRONT_RIGHT], bits=16, sampletype=INTEGER, samplerate=44100, length=(10*samplerate), bint keep=0])`

### Parameters
- **clip** (anode) - Optional - A clip to copy properties from.
- **channels** (int[]) - Optional - A list of channel constants. Default is [FRONT_LEFT, FRONT_RIGHT].
- **bits** (int) - Optional - Bit depth. Default is 16.
- **sampletype** (int) - Optional - INTEGER (0) or FLOAT (1). Default is INTEGER.
- **samplerate** (int) - Optional - Sample rate in Hz. Default is 44100.
- **length** (int) - Optional - Length of the clip in samples. Default is 10 * samplerate.
- **keep** (bint) - Optional - If set, a reference to the same frame is returned on every request. Default is 0.
```

--------------------------------

### VSFrame *newVideoFrame(const VSVideoFormat *format, int width, int height, const VSFrame *propSrc, VSCore *core)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Creates a new video frame with specified format, dimensions, and optionally copies properties from another frame. The new frame's memory is uninitialized. Ownership of the new frame is transferred to the caller.

```APIDOC
## VSFrame *newVideoFrame(const VSVideoFormat *format, int width, int height, const VSFrame *propSrc, VSCore *core)

### Description
Creates a new video frame, optionally copying the properties attached to another frame. It is a fatal error to pass invalid arguments to this function. The new frame contains uninitialised memory.

### Parameters
#### Path Parameters
- **format** (const VSVideoFormat *) - Required - The desired colorspace format. Must not be NULL.
- **width** (int) - Required - The desired width of the frame in pixels. Must be greater than 0 and have a suitable multiple for the subsampling in format.
- **height** (int) - Required - The desired height of the frame in pixels. Must be greater than 0 and have a suitable multiple for the subsampling in format.
- **propSrc** (const VSFrame *) - Optional - A frame from which properties will be copied. Can be NULL.
- **core** (VSCore *) - Required - Pointer to the VapourSynth core.
```

--------------------------------

### VSCoreInfo

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Contains information about a VSCore instance.

```APIDOC
## struct VSCoreInfo

### Description
Contains information about a VSCore instance.

### Members
- **versionString** (const char *) - Printable string containing the name of the library, copyright notice, core and API versions.
- **core** (int) - Version of the core.
- **api** (int) - Version of the API.
- **numThreads** (int) - Number of worker threads.
- **maxFramebufferSize** (int64_t) - The framebuffer cache will be allowed to grow up to this size (bytes) before memory is aggressively reclaimed.
- **usedFramebufferSize** (int64_t) - Current size of the framebuffer cache, in bytes.
```

--------------------------------

### avs.LoadPlugin(path)

Source: https://vapoursynth.com/doc/functions/general/loadpluginavs.html

Loads an Avisynth plugin from the specified file path.

```APIDOC
## avs.LoadPlugin(path)

### Description
Loads an Avisynth 2.5, 2.6, or Avisynth+ plugin. Loaded functions are accessible via the avs namespace.

### Parameters
- **path** (string) - Required - The file system path to the Avisynth plugin (.dll).

### Usage Example
```python
import vapoursynth as vs
avs = vs.get_avs_core()
avs.LoadPlugin(path=r'c:\plugins\filter.dll')
```
```

--------------------------------

### VSFrame *newVideoFrame2(const VSVideoFormat *format, int width, int height, const VSFrame **planeSrc, const int *planes, const VSFrame *propSrc, VSCore *core)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Creates a new video frame, copying planes from specified source frames and optionally copying properties from another frame. The new frame's memory is uninitialized where source planes are NULL. Ownership of the new frame is transferred to the caller.

```APIDOC
## VSFrame *newVideoFrame2(const VSVideoFormat *format, int width, int height, const VSFrame **planeSrc, const int *planes, const VSFrame *propSrc, VSCore *core)

### Description
Creates a new video frame from the planes of existing frames, optionally copying the properties attached to another frame. It is a fatal error to pass invalid arguments to this function.

### Parameters
#### Path Parameters
- **format** (const VSVideoFormat *) - Required - The desired colorspace format. Must not be NULL.
- **width** (int) - Required - The desired width of the frame in pixels. Must be greater than 0 and have a suitable multiple for the subsampling in format.
- **height** (int) - Required - The desired height of the frame in pixels. Must be greater than 0 and have a suitable multiple for the subsampling in format.
- **planeSrc** (const VSFrame **) - Required - Array of frames from which planes will be copied. If any elements are NULL, the corresponding planes will be uninitialized.
- **planes** (const int *) - Required - Array of plane numbers indicating which plane to copy from the corresponding source frame.
- **propSrc** (const VSFrame *) - Optional - A frame from which properties will be copied. Can be NULL.
- **core** (VSCore *) - Required - Pointer to the VapourSynth core.

### Request Example
```c
const VSFrame * frames[3] = { frameA, frameB, frameC };
const int planes[3] = { 1, 0, 2 };
VSFrame * newFrame = vsapi->newVideoFrame2(f, w, h, frames, planes, frameB, core);
```
```

--------------------------------

### AudioNode and VideoNode Methods

Source: https://vapoursynth.com/doc/genindex.html

Methods for interacting with audio and video nodes.

```APIDOC
## AudioNode and VideoNode Methods

### get_frame()

Retrieves a frame from the node.

### get_frame_async()

Retrieves a frame asynchronously from the node.

### is_inspectable()

Checks if the node can be inspected.

### output()

Outputs the node's data.
```

--------------------------------

### Environment.use()

Source: https://vapoursynth.com/doc/pythonreference.html

Returns a context-manager that enables the given environment in the block enclosed in the with-statement.

```APIDOC
## Environment.use()

### Description
Returns a context-manager that enables the given environment in the block enclosed in the with-statement and restores the environment to the one defined before the with-block has been encountered.
```

--------------------------------

### VSCore createCore(int flags)

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Creates a VapourSynth processing core. Multiple cores can be created but are generally not needed. The flags parameter allows for customization of core creation.

```APIDOC
## VSCore createCore(int flags)

### Description
Creates a VapourSynth processing core and returns a pointer to it. It is possible to create multiple cores but in most cases it shouldn’t be needed.

### Parameters
#### Path Parameters
- **flags** (int) - Required - VSCoreCreationFlags ORed together if desired. Pass 0 for sane defaults that should suit most uses.
```

--------------------------------

### getNextPlugin

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Used to enumerate over all currently loaded plugins. The order is fixed but provides no other guarantees.

```APIDOC
## getNextPlugin

### Description
Used to enumerate over all currently loaded plugins. Pass NULL to get the first plugin.

### Parameters
- **plugin** (VSPlugin *) - Current plugin. Pass NULL to get the first plugin.
- **core** (VSCore *) - Pointer to the VSCore instance.

### Returns
- (VSPlugin *) - A pointer to the next plugin in order or NULL if the final plugin has been reached.
```

--------------------------------

### Copy stereo to 5.1

Source: https://vapoursynth.com/doc/functions/audio/audiomix.html

Maps stereo input to 5.1 output channels while zeroing out the remaining surround channels.

```python
AudioMix(clips=c, matrix=[1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0], channels_out=[vs.FRONT_LEFT, vs.FRONT_RIGHT, vs.FRONT_CENTER, vs.LOW_FREQUENCY, vs.BACK_LEFT, vs.BACK_RIGHT])
```

--------------------------------

### Compare Video Preset Format

Source: https://vapoursynth.com/doc/api/vshelper4.h.html

Compares a video clip's format against a predefined preset format. Requires VSCore and VSAPI instances.

```cpp
static inline bool vsh::isSameVideoPresetFormat(unsigned presetFormat, const VSVideoFormat *v, VSCore *core, const VSAPI *vsapi)
{
    return v && v->format == presetFormat;
}
```

--------------------------------

### enum VSPluginConfigFlags

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Options for loading a plugin.

```APIDOC
## enum VSPluginConfigFlags
> Options when loading a plugin.
>   * pcModifiable
>> Allow functions to be added to the plugin object after the plugin loading phase. Mostly useful for Avisynth compatibility and other foreign plugin loaders.
```

--------------------------------

### VSCoreInfo2

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Contains information about a VSCore instance (version 2).

```APIDOC
## struct VSCoreInfo2

### Description
Contains information about a VSCore instance.

### Members
- **versionString** (const char *) - Printable string containing the name of the library, copyright notice, core and API versions.
- **coreVersion** (int) - Version of the core.
- **apiVersion** (int) - Version of the API.
- **creationFlags** (int) - The flags that were passed when creation the core.
- **numThreads** (int) - Number of worker threads.
- **maxFramebufferSize** (int64_t) - The framebuffer cache will be allowed to grow up to this size (bytes) before memory is aggressively reclaimed.
- **usedFramebufferSize** (int64_t) - Current size of the framebuffer cache, in bytes.
```

--------------------------------

### create_environment(flags=0)

Source: https://vapoursynth.com/doc/pythonreference.html

Returns an Environment object used for context-sensitive data.

```APIDOC
## create_environment(flags=0)

### Description
Returns an Environment that is used by the wrapper for context-sensitive data used by VapourSynth, such as the active core object and registered outputs.

### Parameters
- **flags** (int) - Optional - Configuration flags for the environment.
```

--------------------------------

### VSAudioFormat

Source: https://vapoursynth.com/doc/api/vapoursynth4.h.html

Describes the format of an audio clip. Use queryAudioFormat() for proper initialization.

```APIDOC
## struct VSAudioFormat

### Description
Describes the format of a clip. Use queryAudioFormat() to fill it in with proper error checking. Manually filling out the struct is allowed but discouraged since illegal combinations of values will cause undefined behavior.

### Members
- **sampleType** (int) - See VSSampleType.
- **bitsPerSample** (int) - Number of significant bits.
- **bytesPerSample** (int) - Number of bytes needed for a sample. This is always a power of 2 and the smallest possible that can fit the number of bits used per sample.
- **numChannels** (int) - Number of audio channels.
- **channelLayout** (uint64_t) - A bitmask representing the channels present using the constants in 1 left shifted by the constants in VSAudioChannels.
```
Tokens:
Raw