Crate vapoursynth4_sys

Raw bindings to VapourSynth.

Modules

helper

VSHelper4.h

Structs

VSAPI

This giant struct is the way to access VapourSynth’s public API.

VSAudioFormat

Describes the format of a clip.

VSAudioInfo

Contains information about a clip.

VSCore

The core represents one instance of VapourSynth. Every core individually loads plugins and keeps track of memory.

VSCoreInfo

Contains information about a VSCore instance.

VSFilterDependency

Specifies the dependency of a filter on other nodes.

VSFrame

A frame that can hold audio or video data.

VSFrameContext

Opaque type representing the current frame request in a filter.

VSFunction

Holds a reference to a function that may be called. This type primarily exists so functions can be shared between the scripting layer and plugins in the core.

VSLogHandle

Opaque type representing a registered logger.

VSMap

VSMap is a container that stores (key, value) pairs. The keys are strings and the values can be (arrays of) integers, floating point numbers, arrays of bytes, VSNode, VSFrame, or VSFunction.

VSNode

A reference to a node in the constructed filter graph. Its primary use is as an argument to other filter or to request frames from.

VSPLUGINAPI

This struct is used to access VapourSynth’s API when a plugin is initially loaded.

VSPlugin

A VapourSynth plugin. There are a few of these built into the core, and therefore available at all times: the basic filters (identifier com.vapoursynth.std, namespace std), the resizers (identifier com.vapoursynth.resize, namespace resize), and the Avisynth compatibility module, if running in Windows (identifier com.vapoursynth.avisynth, namespace avs).

VSPluginFunction

A function belonging to a Vapoursynth plugin. This object primarily exists so a plugin’s name, argument list and return type can be queried by editors.

VSSCRIPTAPI

This struct is the way to access VSScript’s public API.

VSScript

A script environment. All evaluation and communication with evaluated scripts happens through a VSScript object.

VSVideoFormat

Describes the format of a clip.

VSVideoInfo

Contains information about a clip.

Enums

VSActivationReason

See VSFilterGetFrame.

VSAudioChannels

Audio channel positions as an enum. Mirrors the FFmpeg audio channel constants in older api versions.

VSCacheMode

Describes how the output of a node is cached.

VSChromaLocation

VSColorFamily

VSColorPrimaries

VSColorRange

VSCoreCreationFlags

Options when creating a core.

VSDataTypeHint

Since the data type can contain both pure binary data and printable strings, the type also contains a hint for whether or not it is human readable. Generally the unknown type should be very rare and is almost only created as an artifact of API3 compatibility.

VSFieldBased

VSFilterMode

Controls how a filter will be multithreaded, if at all.

VSMapAppendMode

Controls the behaviour of mapSetInt() and friends.

VSMapPropertyError

When a mapGet* function fails, it returns one of these in the err parameter.

VSMatrixCoefficients

VSMediaType

Used to indicate the type of a VSFrame or VSNode object.

VSMessageType

See addLogHandler().

VSPluginConfigFlags

Options when loading a plugin.

VSPresetVideoFormat

The presets suffixed with H and S have floating point sample type. The H and S suffixes stand for half precision and single precision, respectively. All formats are planar.

VSPropertyType

Types of properties that can be stored in a VSMap.

VSRequestPattern

Describes the upstream frame request pattern of a filter.

VSSampleType

VSTransferCharacteristics

Constants

VAPOURSYNTH_API_MAJOR

Major API version.

VAPOURSYNTH_API_MINOR

Minor API version. It is bumped when new functions are added to VSAPI or core behavior is noticeably changed.

VAPOURSYNTH_API_VERSION

API version. The high 16 bits are VAPOURSYNTH_API_MAJOR, the low 16 bits are VAPOURSYNTH_API_MINOR.

VSSCRIPT_API_MAJOR

VSSCRIPT_API_MINOR

VSSCRIPT_API_VERSION

VS_AUDIO_FRAME_SAMPLES

The number of audio samples in an audio frame. It is a static number to make it possible to calculate which audio frames are needed to retrieve specific samples.

Functions

getVSScriptAPI^⚠

Returns a struct containing function pointer for the api. Will return NULL is the specified version isn’t supported.

getVapourSynthAPI^⚠

Returns a pointer to the global VSAPI instance.

vs_make_version

Used to create version numbers. The first argument is the major version and second is the minor.

Type Aliases

VSFilterFree

A filter’s “free” function.

VSFilterGetFrame

A filter’s “getFrame” function. It is called by the core when it needs the filter to generate a frame.

VSFrameDoneCallback

Function of the client application called by the core when a requested frame is ready, after a call to getFrameAsync().

VSFreeFunctionData

Free function type

VSGetVapourSynthAPI

Core entry point

VSInitPlugin

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.

VSLogHandler

Arguments

VSLogHandlerFree

VSPublicFunction

User-defined function called by the core to create an instance of the filter. This function is often named fooCreate.