Internal filters

From Avisynth wiki
Jump to: navigation, search

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.

An alphabetical listing of the internal filters can be found here.

Contents

Source filters

These filters can read media files and return an AviSynth clip. See debug filters for non-file source filters.

Filter Description Color format
AviSource / AviFileSource / OpenDMLSource Opens an AVI file. All
DirectShowSource Opens a filename using DirectShow. All
ImageReader / ImageSource / ImageSourceAnim Reads in still or animated images. See ImageWriter. All
Import Imports an AviSynth script into the current script. All
SegmentedAviSource / SegmentedDirectShowSource Loads up to 100 avi files per argument. All
WavSource Opens a WAV file or the audio of an AVI file. All

Color conversion and adjustment filters

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

Filter Description Color format
ColorYUV Adjusts colors and luma independently. YUV [8-16bit]
ConvertBackToYUY2 Converts a RGB clip back to YUY2. RGB
ConvertToRGB Converts to RGB32 unless clip is RGB24. All [8bit]
ConvertToRGB24 / ConvertToRGB32 Converts to 8-bit Interleaved RGB24 / RGB32. All [8bit]
ConvertToRGB48 / ConvertToRGB64 AVS+ Converts to 16-bit, Interleaved RGB48 / RGB64 All [16bit]
ConvertToPlanarRGB /
ConvertToPlanarRGBA
AVS+ Converts to Planar RGB(A) at all bit depths All
ConvertToYUY2 Converts to 8-bit Interleaved YUY2. RGB24/32, YUV [8bit]
ConvertToYV24 / ConvertToYV16 /

ConvertToYV12 / ConvertToY8

Converts to 8-bit Planar YV24, YV16, YV12, Y-only. All
ConvertToYUV444 / ConvertToYUV422 /
ConvertToYUV420 /

ConvertToYUVA444 / ConvertToYUVA422 /
ConvertToYUVA420

AVS+ Converts to Planar YUV(A) at all bit depths All
ConvertToYUV411 AVS+ Converts to 8-bit Planar YV411 All
FixLuminance Correct shifting vertical luma offset. YUY2
Greyscale/Grayscale Converts a video to greyscale (no color) All
Invert Inverts selected color channels of a video. All
Levels Scales and clamps the black and white levels, and adjusts the gamma. All [8-16bit]
Limiter Clips levels to within CCIR-601 range, and optionally highlights pixels outside that range. YUV [8-16bit]
MergeRGB / MergeARGB Select and combine a color channel from each of the input video clips. All
MergeLuma / MergeChroma Merge (blend) chroma or luma from one video clip into another. There is an optional weighting, so a percentage between the two clips can be specified. YUV
RGBAdjust Adjusts each color channel separately. RGB [8-16bit]
ShowAlpha / ShowRed / ShowGreen / ShowBlue Shows the selected channel of an (A)RGB clip. RGB
SwapUV Swaps chroma channels. YUV
Tweak Adjusts the hue, saturation, brightness, and contrast. YUV
UToY / UToY8 / VToY / VToY8 Copies U or V chroma plane to the Y luma plane. YUV, except Y8
YToUV Puts the luma channels of two clips as U and V channels. Luma is now 50% grey. YUV

Overlay and Mask filters

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

Filter Description Color format
ColorKeyMask Sets the alpha-channel (similar as Mask does) but generates it by comparing the color. RGB32; RGB64 [+],
All Planar RGB [+]
Layer Puts one clip on top of another using different layer (blend) modes and variable opacity. Supports alpha-channel transparency. YUY2, RGB32;

RGB64 [+]

Mask Applies an alpha-mask to a clip. RGB32; RGB64 [+],
All Planar RGB [+]
MaskHS This filter returns a mask (as Y8) of clip using a given hue and saturation range. YUV
Merge Merge (blend) one video clip into another. There is an optional weighting, so a percentage between the two clips can be specified. All
Overlay Puts one clip on top of another with optional XY displacement of the overlaying image, using different overlay (blend) modes and variable opacity. Uses a separate mask clip for transparency information. All except YV411
ResetMask Applies an "all-opaque" alpha-mask to clip. RGB32; RGB64 [+],

All Planar RGB [+]

Subtract Shows the difference between the corresponding pixels of two clips. All

Geometric deformation filters

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

Filter Description Color format
AddBorders Adds black or colored borders around the image. All
Crop Crops excess pixels from each frame. All
CropBottom Crops excess pixels from the bottom of each frame. All
FlipHorizontal / FlipVertical Flips the video from left to right/upside-down. All
Letterbox Blackens out (or colors out) the top and bottom (and optionally left and right) of each frame. All
HorizontalReduceBy2 / VerticalReduceBy2 / ReduceBy2 Reduces the size of each frame by half horizontally, vertically or in both directions. All
BicubicResize / BilinearResize / BlackmanResize / GaussResize / LanczosResize / Lanczos4Resize / PointResize / SincResize / Spline16Resize / Spline36Resize / Spline64Resize Rescale the input video frames to an arbitrary new resolution, using different sampling algorithms. All
SkewRows Skews (or deskews) the rows of a clip. RGB24, RGB32,
YUY2, Y8
TurnLeft / TurnRight / Turn180 Rotates the clip 90 degrees counter-clockwise / 90 degrees clockwise. All

Pixel restoration filters

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

Filter Description Color format
Blur / Sharpen Simple 3x3-kernel blurring/sharpening filter. All
GeneralConvolution General 3x3 or 5x5 convolution matrix. RGB32
SpatialSoften Removes noise from a video clip by selectively blending pixels spatially. YUY2
TemporalSoften Removes noise from a video clip by selectively blending pixels temporally. All except RGB24
and RGB48 [+]
FixBrokenChromaUpsampling The free Canopus DV Codec v1.00 upsamples the chroma channels incorrectly (although newer non-free versions appear to work fine). This filter compensates for it. YUY2

Timeline editing filters

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

Filter Description Color format
AlignedSplice / UnalignedSplice Joins two or more video clips end to end. All
AssumeFPS / AssumeScaledFPS / ChangeFPS / ConvertFPS Changes framerate and/or video speed in different ways. All
DeleteFrame Deletes a single frame, given as an argument. All
Dissolve Like AlignedSplice, except that the clips are combined with some overlap. All
DuplicateFrame Duplicates a single frame given as an argument. All
FadeIn0 / FadeIn / FadeIn2 / FadeOut0 / FadeOut / FadeOut2 / FadeIO0 / FadeIO / FadeIO2 Causes the video stream to fade linearly to black at the start or end. All
FreezeFrame Replaces all the frames between first-frame and last-frame with a selected frame. All
Interleave Interleaves frames from several clips on a frame-by-frame basis. All
Loop Loops the segment from start_frame to end_frame a given number of times. All
Reverse Makes a clip play in reverse. All
SelectEven / SelectOdd Makes an output video stream using only the even- or odd-numbered frames. All
SelectEvery Selects frames with a fixed period; a generalization of SelectEven and SelectOdd. All
SelectRangeEvery Selects a range of frames with a fixed period. All
Trim Trims a video clip so that it includes only the frames first_frame through last_frame. All

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.

Filter Description Color format
AssumeFrameBased / AssumeFieldBased Forces frame-based or field-based material. All
AssumeBFF / AssumeTFF Forces field order. All
Bob Takes a clip and bob-deinterlaces it. All
ComplementParity Changes top fields to bottom fields and vice-versa. All
DoubleWeave Operates like Weave, except that it produces double the number of frames by combining both the odd and even pairs of fields. All
PeculiarBlend Blends each frame with the following frame in a peculiar way. YUY2
Pulldown Selects two out of every five frames of the source video. All
SeparateColumns / SeparateRows Separates the columns or rows of each frame into new frames. All
SeparateFields Splits each frame into its component top and bottom fields. All
SwapFields Swaps the two fields in an interlaced frame. All
Weave Combines fields together to produce interlaced frames. All
WeaveColumns / WeaveRows Takes a clip and weaves sets of columns or rows together to produce composite frames. All

Audio processing filters

These filters process audio. Audio samples 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.

AVS+ automatic conversion is not performed. The new behavior is to raise an error when a sample type is not compatible. It is your responsibility to use ConvertAudio where needed.

Float audio is converted to 16 bit when frameserving through ACM, unless OPT_AllowFloatAudio is set to true. In that case the audio is kept as it is. When accessing AviSynth directly (like MeGUI, BeHappy or ffmpeg do for example), there is no automatic conversion.

The automatic conversion is done for clients that cannot handle Float audio (in the old days most of them couldn't). Note conversion takes place after the script processing is finished. Float audio is always allowed within the script.

Filter Description Sample type
Amplify / AmplifydB Amplify multiply audio samples by amount. 16 bit, Float
AssumeSampleRate Adjusts the playback speed of the audio. All
AudioDub / AudioDubEx AudioDub takes the video stream from the first argument and the audio stream from the second argument and combines them. AudioDubEx is similar, but it doesn't throw an exception if both clips don't have a video or audio stream. All
AudioTrim Trims an audio clip so that it includes only the start_time through end_time. All
ConvertAudioTo8bit / ConvertAudioTo16bit / ConvertAudioTo24bit / ConvertAudioTo32bit / ConvertAudioToFloat Converts audio samples to 8/16/24/32/Float bits. All
ConvertToMono Merges all audio channels. 16 bit, Float
DelayAudio Delays the audio track by second seconds. All
EnsureVBRMP3Sync Corrects out-of-sync MP3-AVI's, when seeking or trimming. All
GetChannel / GetLeftChannel / GetRightChannel Returns an audio channel from a clip. All
KillAudio / KillVideo Removes the audio or video from a clip completely. All
MergeChannels Merges channels of two audio clips. All
MixAudio Mixes audio from two clips. 16 bit, Float
MonoToStereo Converts two mono signals to one stereo signal. 16 bit, Float
Normalize Amplifies the entire waveform as much as possible, without clipping. 16 bit, Float
ResampleAudio Performs a high-quality change of audio sample rate. 16 bit, Float
SuperEQ High quality 18 band sound equalizer. Float
SSRC Very high quality sample rate conversion. Float
TimeStretch Change speed of a sound without changing the pitch, and change pitch without changing duration. Float

Conditional and other meta filters

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

Filter Description Color format
ConditionalFilter / FrameEvaluate / ScriptClip / ConditionalSelect ConditionalFilter returns source1 if some condition is met, otherwise it returns source2. ScriptClip/FrameEvaluate returns the clip which is returned by the function evaluated on every frame. ConditionalSelect returns one frame from several sources based on an integer evaluator. All
ConditionalReader Import information from a text file, with different values for each frame - or a range of frames. All
WriteFile / WriteFileIf / WriteFileStart / WriteFileEnd These filters evaluate expressions and output the results to a text-file. All
Animate / ApplyRange Animate is a meta-filter which evaluates another filter with continuously varying arguments.

ApplyRange 'is a special case of Animate where start_args = end_args.

All
TCPServer / TCPSource Send clips over your network. You can connect several clients to the same machine. All

Export filters

These filters can write directly to media files.

Filter Description Color format
ImageWriter Writes frames as images to your hard disk. See ImageReader. All

Debug filters

Filter Description Color format
BlankClip / Blackness Produces a solid color, silent video clip of the specified length (in frames). All
ColorBars / ColorBarsHD Produce a video clip containing SMPTE colorbars scaled to any image size. RGB32, YUY2,
YV12, YV24
Compare Compares two clips and prints out information about the differences. All
Echo Forces internal GetFrame calls to all input clips. Returns only first clip result. All
Histogram A multipurpose audio/video analysis tool. All
Info Prints out image and sound information. All
MessageClip Produces a clip containing a text message. RGB32
Preroll Preroll the audio or video on non-linear access. All
ShowFiveVersions Takes five video clips and combines them in a staggered arrangement from left to right. All
ShowFrameNumber / ShowSMPTE / ShowTime Draws text on every frame indicating what number AviSynth thinks it is. All
StackHorizontal / StackVertical Takes two or more video clips and displays them together in left-to-right/up-to-down order. All
Subtitle Adds anti-aliased text to a range of frames. All
Tone Generates a sound. Float
Version Generates a video clip with a short AviSynth version and copyright statement. RGB24

Footnotes

The above filters work with the following named color formats.

Name Formats
All RGB, YUV (detailed below)
RGB Interleaved  RGB24, RGB32 [8bit]
RGB48, RGB64 [16bit] [+]
RGB Planar RGBP8, RGBAP8, RGBP10, RGBAP10 etc [+]  
YUV YUY2 Interleaved, YUV Planar,
YUVA Planar [+]
YUV Planar  YV12, YV24‡, YV16‡, YV411‡, Y8‡ 
YUV444P8, YUV444P10, YUV444P12 etc [+]
YUVA Planar  YUVA444P8, YUVA444P10, YUVA444P12 etc [+]
Notes and exceptions.
Not supported in AviSynth version 2.58 or below
[+] AviSynth+ color space only (Deep Color, Planar RGB, YUVA).
[8bit]   8-bit only [+]
[16bit] 16-bit only [+]
[8-16bit] 8, 10, 12, 14, 16 bit (excludes 32-bit floating-point) [+]
AVS+ AviSynth+ filter only.
Personal tools