Core Filters

Introduction

The available (internal) filters are listed here and divided into categories. A short description is added, including the supported color formats (and sample types for the audio filters). There are some functions which combine two or more clips in different ways. How the video content is calculated is described for each function, but here is a summary which explains which properties that the resulting clip will have.

Media file filters

These filters can be used to read or write media files. Usually they produce source clips for processing. See debug filters for non-file source filters.

Color conversion and adjustment filters

These filters can be used to change the color format or adjust the colors of a clip.

Overlay and Mask filters

These filters can be used to layer clips with or without using masks and to create masks.

  • ColorKeyMask Sets the alpha-channel (similar as Mask does) but generates it by comparing the color.

  • Layer Layering two videos.

  • Mask Applies an alpha-mask to a clip.

  • MaskHS Returns a mask (as Y8) of clip using a given hue and saturation range.

  • Overlay Overlay puts two clips on top of each other with an optional displacement of the overlaying image, and using different overlay methods. Furthermore opacity can be adjusted for the overlay clip.

  • ResetMask Applies an "all-opaque" alpha-mask to clip.

Geometric deformation filters

These filters can be used to change image size, process borders or make other deformations of a clip.

Pixel restoration filters

These filters can be used for image detail (pixel) restoration (like denoising, sharpening) of a clip.

  • Blur / Sharpen These are simple 3x3-kernel blurring and sharpening filters.

  • GeneralConvolution General 3x3 or 5x5 convolution matrix.

  • SpatialSoften / TemporalSoften The SpatialSoften and TemporalSoften filters remove noise from a video clip by selectively blending pixels.

  • FixBrokenChromaUpsampling I noticed that the MS DV codec upsamples the chroma channels incorrectly, and I added a FixBrokenChromaUpsampling filter to compensate for it.

Timeline editing filters

These filters can be used to arrange frames in time (clip cutting, splicing and other editing).

Interlace filters

These filters can be used for creating and processing field-based material (which is frame-based material separated into fields). AviSynth is capable of dealing with both progressive and interlaced material. The main problem is, that it often doesn't know what it receives from source filters. This is the reason that the field-based flag exists and can be used when dealing with interlaced material. More information about field-based video can be found here.

  • AssumeFrameBased / AssumeFieldBased Forces frame-based or field-based material.

  • AssumeTFF / AssumeBFF Forces field order.

  • Bob Bob takes a clip and bob-deinterlaces it

  • ComplementParity Changes top fields to bottom fields and vice-versa.

  • DoubleWeave The DoubleWeave filter operates like Weave, except that it produces double the number of frames by combining both the odd and even pairs of fields.

  • PeculiarBlend This filter blends each frame with the following frame in a peculiar way.

  • Pulldown The Pulldown filter simply selects two out of every five frames of the source video.

  • SeparateColumns / SeparateRows Takes a clip and separates the columns or rows of each frame into new frames.

  • SeparateFields SeparateFields takes a frame-based clip and splits each frame into its component top and bottom fields.

  • SwapFields The SwapFields filter swaps the two fields in an interlaced frame

  • Weave Weave takes even pairs of fields from a Fields Separated input video clip and combines them together to produce interlaced frames.

  • WeaveColumns / WeaveRows Takes a clip and weaves sets of columns or rows together to produce a composite frames.

Audio processing filters

These filters can be used to process audio. Audio samples from a clip will be automatically converted if any filters requires a special type of sample. This means that if a filter doesn't support the type of sample it is given, it will automatically convert the samples to something it supports. The internal formats supported in each filter is listed in the sample type column. A specific sample type can be forced by using the ConvertAudio functions.

If the sample type is float, when AviSynth has to output the data, it will be converted to 16 bit, since float cannot be passed as valid AVI data.

Meta filters

These special filters can be used to control other filters execution.

  • Animate / ApplyRange Animate (ApplyRange) is a meta-filter which evaluates its parameter filter with continuously varying (the same) arguments.

  • TCPDeliver This filter will enable you to send clips over your network. You can connect several clients to the same machine.

Conditional filters

The basic characteristic of conditional filters is that 'their scripts' are evaluated (executed) at every frame instead of the whole clip. This allows for complex video processing that would be difficult or impossible to be performed by a normal AviSynth script.

Debug filters

  • BlankClip / Blackness The BlankClip filter produces a solid color, silent video clip of the specified length (in frames).

  • ColorBars / ColorBarsHD The ColorBars filters produce a video clip containing SMPTE color bars scaled to any image size.

  • Compare Compares two clips and prints out information about the differences.

  • Echo Forces getframe calls to all input clips. Returns only first clip result.

  • Histogram Adds a Histogram.

  • Info Prints out image and sound information.

  • Preroll Preroll the audio or video on non linear access.

  • MessageClip MessageClip produces a clip containing a text message

  • ShowFiveVersions ShowFiveVersions takes five video streams and combines them in a staggered arrangement from left to right.

  • ShowFrameNumber / ShowSMPTE / ShowTime ShowFrameNumber draws text on every frame indicating what number Avisynth thinks it is. ShowSMPTE displays the SMPTE timecode. hh:mm:ss:ff ShowTime displays the duration with millisecond resolution. hh:mm:ss.sss

  • StackHorizontal / StackVertical StackHorizontal takes two or more video clips and displays them together in left-to-right order.

  • Subtitle The Subtitle filter adds a single line of anti-aliased text to a range of frames.

  • Tone This will generate sound.

  • Version The Version filter generates a video clip with a short version and copyright statement

$Date: 2013/01/06 13:38:34 $