Avisynth wiki - User contributions [en]

Filter SDK/avs2yuv

2014-01-05T08:47:59Z

Unreal666: Added 'FilterSDK' Category

avs2yuv reads a script and outputs raw video (YUV or RGB). It's a stripped down version of the famous avs2yuv.

Here's avs2yuv.cpp:

#include <stdio.h>
#include <Windows.h>
#include "avisynth.h"

#define MY_VERSION "Avs2YUV 0.24"

const AVS_Linkage *AVS_linkage = 0;

int __cdecl main(int argc, const char* argv[])
{
const char* infile = NULL;
const char* outfile = NULL;
FILE* out_fh;

if (!strcmp(argv[1], "-h")) {
fprintf(stderr, MY_VERSION "\n"
"Usage: avs2yuv.exe in.avs out.raw\n");
return 2;
} else {
infile = argv[1];
outfile = argv[2];
}

try {
char* colorformat;
typedef IScriptEnvironment* (__stdcall *DLLFUNC)(int);
IScriptEnvironment* env;
HMODULE avsdll = LoadLibrary("avisynth.dll");
if (!avsdll) {
fprintf(stderr, "failed to load avisynth.dll\n");
return 2;
}

DLLFUNC CreateEnv = (DLLFUNC)GetProcAddress(avsdll, "CreateScriptEnvironment");
if (!CreateEnv) {
fprintf(stderr, "failed to load CreateScriptEnvironment()\n");
FreeLibrary(avsdll);
return 1;
}

env = CreateEnv(AVISYNTH_INTERFACE_VERSION);
env->CheckVersion(5); // todo - only useful for plugins - find another way to check AviSynth version
AVS_linkage = env->GetAVSLinkage();
AVSValue arg(infile);
AVSValue res = env->Invoke("Import", AVSValue(&arg, 1));
if (!res.IsClip()) {
fprintf(stderr, "Error: '%s' didn't return a video clip.\n", infile);
FreeLibrary(avsdll);
return 1;
}

PClip clip = res.AsClip();
VideoInfo vi = clip->GetVideoInfo();

fprintf(stderr, " %s:\n", infile);
fprintf(stderr, " %dx%d,\n", vi.width, vi.height);
fprintf(stderr, " %d/%d fps,\n", vi.fps_numerator, vi.fps_denominator);
fprintf(stderr, " %d frames,\n", vi.num_frames);
if (vi.IsYUV()) {
colorformat = "YUV";
} else {
colorformat = "RGB";
}
fprintf(stderr, " %s color format", colorformat);

out_fh = fopen(outfile, "wb");
if (!out_fh) {
fprintf(stderr, "fopen(\"%s\") failed", outfile);
FreeLibrary(avsdll);
return 1;
}

static const int planes[] = {PLANAR_Y, PLANAR_U, PLANAR_V};

for (int frm = 0; frm < vi.num_frames; ++frm) {
PVideoFrame f = clip->GetFrame(frm, env);

int wrote = 0;

for (int p=0; p<3; p++) { // for interleaved formats only the first plane (being the whole frame) is written
int height = f->GetHeight(planes[p]);
int rowsize = f->GetRowSize(planes[p]);
int pitch = f->GetPitch(planes[p]);
const BYTE* data = f->GetReadPtr(planes[p]);
for (int y=0; y<height; y++) {
wrote += fwrite(data, 1, rowsize, out_fh);
data += pitch;
}
}
}

env->DeleteScriptEnvironment();
FreeLibrary(avsdll);

} catch(AvisynthError err) {
fprintf(stderr, "\nAvisynth error:\n%s\n", err.msg);
return 1;
}

AVS_linkage = 0;
fclose(out_fh);
return 0;
}

Compile this file into an EXE named avs2yuv.exe. See [[Filter_SDK/Compiling_instructions|compiling instructions]]. Now open the command line and go to the folder where avs2yuv.exe and your script (called example.avs here) are located. Our script:

ColorBars()
ConvertToYV12()
Trim(0,4)
Showframenumber()

Type the following on the command line (the name of the output clip can be arbitrary in our application):

avs2yuv.exe example.avs output.raw

So the output file will contain five frames of YV12 data (640x480). The raw stream can be played with [http://www.yuvtoolkit.com/ YUVtoolkit] for example. You can also import it in AviSynth using the plugin RawSource.

=== Line by line breakdown ===

Here's a line-by-line breakdown of avs2yuv.cpp.

#include <stdio.h>

The header stdio.h contains objects like [http://www.cplusplus.com/reference/cstdio/stderr/ stderr] (a pointer to a FILE object) and functions like [http://www.cplusplus.com/reference/cstdio/fprintf/ fprintf] and [http://www.cplusplus.com/reference/cstdio/fopen/ fopen]. Those will be used later on.

The standard error stream (''stderr'') is the default destination for error messages and other diagnostic warnings. Like stdout, it is usually also directed by default to the text console (generally, on the screen).

''fprintf'' writes formatted data to stream.

''fopen'' opens the file whose name is specified in the parameter filename and associates it with a stream that can be identified in future operations by the FILE pointer returned.

#include <Windows.h>

#include "avisynth.h"

This header declares all the classes and miscellaneous constants that you might need when accessing avisynth.dll.

#define MY_VERSION "Avs2YUV 0.24"

Defines the version number which will be printed (using the "-h" option) later on.

const AVS_Linkage *AVS_linkage = 0;

This declares and initializes the server pointers static storage [[Filter_SDK/AVS_Linkage|AVS_Linkage]].

int __cdecl main(int argc, const char* argv[])

argv and argc are how command line arguments are passed to main() in C and C++ (you can name them the way you want to). argc will be the number of strings pointed to by the array argv. This will be one plus the number of arguments, with the first one being the name of the application. Thus when using the command line "avs2yuv.exe in.avs out.raw" we have argv[0]="avs2yuv.exe", argv[1]="in.avs", argv[2]="out.raw" and argc=2.

const char* infile = NULL;
const char* outfile = NULL;

initialize infile and outfile as null pointers by setting them to [http://www.cplusplus.com/reference/cstddef/NULL/ NULL]. We could have set them to 0 too since that's the same in C/C++.

FILE* out_fh;

out_fh is declared as a pointer to a [http://www.cplusplus.com/reference/cstdio/FILE/ FILE object].

if (!strcmp(argv[1], "-h")) {
fprintf(stderr, MY_VERSION "\n"
"Usage: avs2yuv.exe in.avs out.raw\n");
return 2;

When using the command line "avs2yuv.exe -h" it will print to the console how the application should be used ('h' from help). The [http://www.cplusplus.com/doc/tutorial/functions/ return] terminates the function main() (and thus the application). returning 0 means that your program executed without errors and returning a different int means it executed with errors.

"Avs2YUV 0.24" (followed by an enter)
"Usage: avs2yuv.exe in.avs out.raw" (followed by an enter)

} else {
infile = argv[1];
outfile = argv[2];
}

When the second argument (argv[1]) is not '-h' it will set infile to the name of the input file (being argv[1]) and outfile to the name of the output file (being argv[2]).

try {
char* colorformat;
IScriptEnvironment* env;

env returns a pointer to the [[Cplusplus_API#IScriptEnvironment|IScriptEnvironment]] interface.

HMODULE avsdll = LoadLibrary("avisynth.dll");

[http://msdn.microsoft.com/en-us/library/windows/desktop/ms684175%28v=vs.85%29.aspx LoadLibrary] loads the specified module (which is avisynth.dll here) into the address space of the process (the process being avs2yuv.exe here). When successful avsdll will be the handle to the module, else it will be NULL.

if (!avsdll) {
fprintf(stderr, "failed to load avisynth.dll\n");
return 2;
}

When avsdll is NULL (thus 0), !avsdll evaluates to one, and the error "failed to load avisynth.dll" is printed to the console.

typedef IScriptEnvironment* (__stdcall *DLLFUNC)(int);
DLLFUNC CreateEnv = (DLLFUNC)GetProcAddress(avsdll, "CreateScriptEnvironment");

[[Cplusplus_API#CreateScriptEnvironment|CreateScriptEnvironment]] is exported by avisynth.dll and it is a pointer to the [[Cplusplus_API#IScriptEnvironment|IScriptEnvironment]] interface. [http://msdn.microsoft.com/en-us/library/windows/desktop/ms683212%28v=vs.85%29.aspx GetProcAddress] will retrieve the address of the exported function (when failing it will return NULL).

In order to do so you must declare a function pointer (called 'DLLFUNC' here) with *exactly* the same prototype as the function it is supposed to represent. This is done in the first line (note that [[Cplusplus_API#CreateScriptEnvironment|CreateScriptEnvironment]] has one parameter of type 'int')

typedef IScriptEnvironment* (__stdcall *DLLFUNC)(int);

The [http://www.cplusplus.com/doc/tutorial/other_data_types/ typedef declaration] is used to construct shorter or more meaningful names (like 'DLLFUNC' here) for types that are already defined (like 'IScriptEnvironment*' here).

In the second line the value of GetProcAddress is cast to the correct function pointer type.

... = (DLLFUNC)GetProcAddress(...);

We could also have used

IScriptEnvironment* (__stdcall *CreateEnv)(int) = NULL;
CreateEnv = (IScriptEnvironment* (__stdcall *)(int))GetProcAddress(avsdll, "CreateScriptEnvironment");

or shorter and less readable

IScriptEnvironment* (__stdcall *CreateEnv)(int) = (IScriptEnvironment* (__stdcall *)(int))GetProcAddress(avsdll, "CreateScriptEnvironment");

if (!CreateEnv) {
fprintf(stderr, "failed to load CreateScriptEnvironment()\n");
FreeLibrary(avsdll);
return 1;
}

When CreateEnv is NULL (so GetProcAddress failed to retrieve the exported function) an error is written to the console. [http://msdn.microsoft.com/en-us/library/windows/desktop/ms683152%28v=vs.85%29.aspx FreeLibrary] frees the module from your memory.

env = CreateEnv(AVISYNTH_INTERFACE_VERSION);

This creates the script environment. Its members can be accessed by [[Cplusplus_API#IScriptEnvironment|env->...]].

env->CheckVersion(5);

// todo - only useful for plugins - find another way to check AviSynth version (it now simply quits when an old avisynth.dll is loaded)

AVS_linkage = env->GetAVSLinkage();

This gets the server pointers static storage [[Filter_SDK/AVS_Linkage|AVS_Linkage]].

AVSValue arg(infile);
AVSValue res = env->Invoke("Import", AVSValue(&arg, 1));

This calls the [[Import]] function on the input file infile. So the script is loaded.

if (!res.IsClip()) {
fprintf(stderr, "Error: '%s' didn't return a video clip.\n", infile);
FreeLibrary(avsdll);
return 1;
}

If the return value of the script is not a clip an error is written to the console.

PClip clip = res.AsClip();

todo - check whether it has video (it can be an audio only clip) - clip.HasVideo() ???

VideoInfo vi = clip->GetVideoInfo();

[[Cplusplus_API#GetVideoInfo|GetVideoInfo]] returns a [[Cplusplus_API/VideoInfo|VideoInfo]] structure of the clip.

fprintf(stderr, " %s:\n", infile);
fprintf(stderr, " %dx%d,\n", vi.width, vi.height);
fprintf(stderr, " %d/%d fps,\n", vi.fps_numerator, vi.fps_denominator);
fprintf(stderr, " %d frames,\n", vi.num_frames);
if (vi.IsYUV()) {
colorformat = "YUV";
} else {
colorformat = "RGB";
}
fprintf(stderr, " %s color format", colorformat);

Some information about the clip is written to the console.

out_fh = fopen(outfile, "wb");

Creates an empty binary file and opens it for writing.

if (!out_fh) {
fprintf(stderr, "fopen(\"%s\") failed", outfile);
FreeLibrary(avsdll);
return 1;
}

When failing (thus when out_fh is NULL) an error is written to the console.

static const int planes[] = {PLANAR_Y, PLANAR_U, PLANAR_V};

x

for (int frm = 0; frm < vi.num_frames; ++frm) {

Start with frame zero (and run through all of them).

PVideoFrame f = clip->GetFrame(frm, env);

int wrote = 0;

for (int p=0; p<3; p++) { // for interleaved formats only the first plane (being the whole frame) is written
int height = f->GetHeight(planes[p]);
int rowsize = f->GetRowSize(planes[p]);
int pitch = f->GetPitch(planes[p]);
const BYTE* data = f->GetReadPtr(planes[p]);
for (int y=0; y<height; y++) {
wrote += fwrite(data, 1, rowsize, out_fh);
data += pitch;
}
}
}

env->DeleteScriptEnvironment();
FreeLibrary(avsdll);

} catch(AvisynthError err) {
fprintf(stderr, "\nAvisynth error:\n%s\n", err.msg);
return 1;
}

AVS_linkage = 0;
fclose(out_fh);
return 0;
}

todo - static and dynamic linking (see above) - http://msdn.microsoft.com/en-us/library/windows/desktop/ms685090%28v=vs.85%29.aspx
http://msdn.microsoft.com/en-us/library/d14wsce5.aspx

[[Category:FilterSDK]]

Internal functions/Numeric functions

2014-01-05T02:10:53Z

Unreal666: /* Numeric functions */

== Numeric functions ==

They provide common mathematical operations on numeric variables.

* {{ScriptFunction|Max|v2.58|Max(float, float [, ...])}}
: Returns the maximum value of a set of numbers.
: If all the values are of type Int, the result is an Int. If any of the values are of type Float, the result is a Float.
: This may cause an unexpected result when an Int value greater than 16777216 is mixed with Float values.
: ''Examples:''
Max (1, 2) = 2
Max (5, 3.0, 2) = 5.0

* {{ScriptFunction|Min|v2.58|Min(float, float [, ...])}}
: Returns the minimum value of a set of numbers.
: ''Examples:''
Min (1, 2) = 1
Min (5, 3.0, 2) = 2.0

* {{ScriptFunction|MulDiv|v2.56|MulDiv(int, int, int)}}
: Multiplies two ints (m, n) and divides the product by a third (d) in a single operation, with 64 bit intermediate result. The actual equation used is <tt> (m * n + d / 2) / d </tt>.
: ''Examples:''
MulDiv (1, 1, 2) = 1
MulDiv (2, 3, 2) = 3

* {{ScriptFunction|Floor||Floor(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round down on any fractional amount).
: ''Examples:''
Floor(1.2) = 1
Floor(1.6) = 1
Floor(-1.2) = -2
Floor(-1.6) = -2

* {{ScriptFunction|Ceil||Ceil(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round up on any fractional amount).
: ''Examples:''
Ceil(1.2) = 2
Ceil(1.6) = 2
Ceil(-1.2) = -1
Ceil(-1.6) = -1

* {{ScriptFunction|Round||Round(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round off to nearest integer).
: ''Examples:''
Round(1.2) = 1
Round(1.6) = 2
Round(-1.2) = -1
Round(-1.6) = -2

* {{ScriptFunction|Int|v2.07|Int(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round towards zero).
: ''Examples:''
Int(1.2) = 1
Int(1.6) = 1
Int(-1.2) = -1
Int(-1.6) = -1

* {{ScriptFunction|Float|v2.07|Float(int)}}
: Converts int to single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value. Integer values that require more than 24-bits to be represented will have their lower 8-bits truncated yielding unexpected values.
: ''Examples:''
Float(4) = 4.0
Float(4) / 3 = 1.333 (while 4 / 3 = 1 , due to integer division)

* {{ScriptFunction|Sin|v2|Sin(float)}}
: Returns the sine of the argument (assumes it is radians).
: ''Examples:''
Sin(Pi()/4) = 0.707
Sin(Pi()/2) = 1.0

* {{ScriptFunction|Cos|v2|Cos(float)}}
: Returns the cosine of the argument (assumes it is radians).
: ''Examples:''
Cos(Pi()/4) = 0.707
Cos(Pi()/2) = 0.0

* {{ScriptFunction|Tan|v2.60|Tan(float)}}
: Returns the tangent of the argument (assumes it is radians).
: ''Examples:''
Tan(Pi()/4) = 1.0
Tan(Pi()/2) = not defined
: 32 bit ieee floats do not have sufficient resolution to exactly represent
: pi/2 so AviSynth returns a large positive number for the value slightly less
: than pi/2 and a large negative value for the next possible value which is
: slightly greater than pi/2.

* {{ScriptFunction|Asin|v2.60|Asin(float)}}
: Returns the inverse of the sine of the argument (output is radians).
: ''Examples:''
Asin(0.707) = 0.7852471634 (~ Pi/4)
Asin(1.0) = 1.570796327 (~ Pi/2)

* {{ScriptFunction|Acos|v2.60|Acos(float)}}
: Returns the inverse of the cosine of the argument (output is in radians).
: ''Examples:''
Acos(0.707) = 0.7852471634 (~ Pi/4)
Acos(0.0) = 1.570796327 (~ Pi/2)

* {{ScriptFunction|Atan|v2.60|Atan(float)}}
: Returns the inverse of the tangent of the argument (output is in radians).
: ''Examples:''
Atan(0.707) = 0.6154085176
Atan(1.0) = 0.7853981634 (~ Pi/4)

* {{ScriptFunction|Atan2|v2.60|Atan2(float, float)}}
: Returns the angle between the positive x-axis of a plane and the point given by the coordinates (x, y) on it (output is in radians). See [http://en.wikipedia.org/wiki/Atan2 wikipedia] for more information.
: y is the first argument and x is the second argument.
: ''Examples:''
Atan2(1.0, 0) = 1.570796327 (~ Pi/2)
Atan2(1.0, 1.0) = 0.7852471634 (~ Pi/4)
Atan2(−1.0, −1.0) = -2.356194490 (~ −3Pi/4)

* {{ScriptFunction|Sinh|v2.60|Sinh(float)}}
: Returns the hyperbolic sine of the argument. See [http://en.wikipedia.org/wiki/Hyperbolic_function wikipedia] for more information.
: ''Examples:''
Sinh(2.0) = 3.626860408

* {{ScriptFunction|Cosh|v2.60|Cosh(float)}}
: Returns the hyperbolic cosine of the argument.
: ''Examples:''
Cosh(2.0) = 3.762195691

* {{ScriptFunction|Tanh|v2.60|Tanh(float)}}
: Returns the hyperbolic tangent of the argument.
: ''Examples:''
Tanh(2.0) = 0.9640275801

* {{ScriptFunction|Fmod|v2.60|Fmod(float, float)}}
: Returns the modulo of the argument. Output is float.
: ''Examples:''
Fmod(3.5, 0.5) = 0 (since 3.5 - 7*0.5 = 0)
Fmod(3.5, 1.0) = 0.5 (since 3.5 - 3*1.0 = 0.5)

* {{ScriptFunction|Pi|v2|Pi()}}
: Returns the value of the "pi" constant (the ratio of a circle's circumference to its diameter).
: ''Examples:''
d = Pi() # d == 3.141592653

* {{ScriptFunction|Tau|v2.60|Tau()}}
: Returns the value of the "tau" constant (the ratio of a circle's circumference to its radius). See [http://en.wikipedia.org/wiki/Tau_(2π) Tau_(2Π)] for more information.
: ''Examples:''
d = Tau() # d == 6.283186

* {{ScriptFunction|Exp|v2|Exp(float)}}
: Returns the natural (base-e) exponent of the argument.
: ''Examples:''
Exp(1) = 2.7182818
Exp(0) = 1.0

* {{ScriptFunction|Log|v2|Log(float)}}
: Returns the natural (base-e) logarithm of the argument.
: ''Examples:''
Log(1) = 0.0
Log(10) = 2.30259
Log(Exp(1)) = 1.0

* {{ScriptFunction|Log10|v2.60|Log10(float)}}
: Returns the common logarithm of the argument.
: ''Examples:''
Log10(1.0) = 0
Log10(10.0) = 1.0
Log10(2.0) = 0.3010299957

* {{ScriptFunction|Pow|v2|Pow(float base, float power)}}
: Returns "base" raised to the power indicated by the second argument.
: ''Examples:''
Pow(2, 3) = 8
Pow(3, 2) = 9
Pow(3.45, 1.75) = 8.7334

* {{ScriptFunction|Sqrt|v2|Sqrt(float)}}
: Returns the square root of the argument.
: ''Examples:''
Sqrt(1) = 1.0
Sqrt(2) = 1.4142

* {{ScriptFunction|Abs|v2.07|Abs(float or int)}}
: Returns the absolute value of its argument (returns float for float, integer for integer).
: ''Examples:''
Abs(-3.8) = 3.8
Abs(-4) = 4

* {{ScriptFunction|Sign|v2.07|Sign(float)}}
: Returns the sign of the value passed as argument (1, 0 or -1).
: ''Examples:''
Sign(-3.5) = -1
Sign(3.5) = 1
Sign(0) = 0

* {{ScriptFunction|Frac|v2.07|Frac(float)}}
: Returns the fractional portion of the value provided.
: ''Examples:''
Frac(3.7) = 0.7
Frac(-1.8) = -0.8

* {{ScriptFunction|Rand|v2.07|Rand([int max] [, bool scale] [, bool seed])}}
: Returns a random integer value. All parameters are optional.
:* ''max'' sets the maximum value+1 (default 32768) and can be set negative for negative results. It operates either in scaled or modulus mode (default ''scale''=true only if abs(max) > 32768, false otherwise).
:* Scaled mode (''scale''=true) scales the internal random number generator value to the maximum value, while modulus mode (''scale''=false) uses the remainder from an integer divide of the random generator value by the maximum. I found modulus mode is best for smaller maximums.
:* Using ''seed=true'' seeds the random number generator with the current time. ''seed'' defaults to false and probably isn't necessary, although it's there just in case.
: Typically, this function would be used with the Select function for random clips.
: ''Examples:''
Select(Rand(5), clip1, clip2, clip3, clip4, clip5)

* {{ScriptFunction|Spline|v2.51|Spline(float X, x1, y1, x2, y2, .... [, bool cubic])}}
: Interpolates the Y value at point X using the control points x1/y1, ... There have to be at least 2 x/y-pairs. The interpolation can be cubic (the result is a spline) or linear (the result is a polygon). Default is cubic.
: ''Examples:''
Spline(5, 0, 0, 10, 10, 20, 0, false) = 5
Spline(5, 0, 0, 10, 10, 20, 0, true) = 7

* {{ScriptFunction|ContinuedNumerator|v2.60|ContinuedNumerator(float, int limit)}}
* {{ScriptFunction|ContinuedNumerator|v2.60|ContinuedNumerator(int, int, int limit)}}
* {{ScriptFunction|ContinuedDenominator|v2.60|ContinuedDenominator(float, int limit)}}
* {{ScriptFunction|ContinuedDenominator|v2.60|ContinuedDenominator(int, int, int limit)}}
: The rational pair (ContinuedNumerator,ContinuedDenominator) returned has the smallest possible denominator such that the absolute error is less than 1/limit. More information can be found on [http://en.wikipedia.org/wiki/Continued_fraction wikipedia].
: If ''limit'' is not specified in the Float case the rational pair returned is to the limit of the single precision floating point value. Thus (float)((double)Num/(double)Den) == V.
: In the Int case if ''limit'' is not specified then the normalized original values will be returned, i.e. reduced by the GCD.
: ''Examples:''
ContinuedNumerator(PI(), limit=5000]) = 355
ContinuedDenominator(PI(), limit=5000) = 113

ContinuedNumerator(PI(), limit=50]) = 22
ContinuedDenominator(PI(), limit=50) = 7

ContinuedNumerator(355, 113, limit=50]) = 22
ContinuedDenominator(355, 113, limit=50) = 7

* {{ScriptFunction|BitAnd|v2.60|BitAnd(int, int)}}
: The functions: BitAnd, BitNot, BitOr and BitXor, etc, are bitwise operators. This means that their arguments (being integers) are converted to binary numbers, the operation is performed on their bits, and the resulting binary number is converted back again.
: BitAnd returns the bitwise AND (sets bit to 1 if both bits are 1 and sets bit to 0 otherwise).
: ''Examples:''
BitAnd(5, 6) = 4 # since 5 = 101, 6 = 110, and 101&110 = 100

* {{ScriptFunction|BitNot|v2.60|BitNot(int)}}
: Returns the bit-inversion (sets bit to 1 if bit is 0 and vice-versa).
: ''Examples:''
BitNOT(5) = -6 # since 5 = 101, and ~101 = 1111 1111 1111 1111 1111 1111 1111 1010 = -6
: Note: 1111 1111 1111 1111 1111 1111 1111 1010 = (2^32-1)-2^0-2^2 = 2^32-(1+2^0+2^2) =(signed) -(1+2^0+2^2) = -6

* {{ScriptFunction|BitOr|v2.60|BitOr(int, int)}}
: Returns the bitwise inclusive OR (sets bit to 1 if one of the bits (or both) is 1 and sets bit to 0 otherwise).
: ''Examples:''
BitOr(5, 6) = 7 # since 5 = 101, 6 = 110, and 101|110 = 111
BitOr(4, 2) = 6 # since 4 = 100, 2 = 010, and 100|010 = 110

* {{ScriptFunction|BitXor|v2.60|BitXor(int, int)}}
: Returns the bitwise exclusive OR (sets bit to 1 if exactly one of the bits is 1 and sets bit to 0 otherwise).
: ''Examples:''
BitXor(5, 6) = 3 # since 5 = 101, 6 = 110, and 101^110 = 011
BitXor(4, 2) = 6 # since 4 = 100, 2 = 010, and 100^010 = 110

* {{ScriptFunction|BitLShift|v2.60|BitLShift(int, int)}}
* {{ScriptFunction|BitShl|v2.60|BitShl(int, int)}}
* {{ScriptFunction|BitSal|v2.60|BitSal(int, int)}}
: Shift the bits of a number to the left.
: ''Examples:''
Shifts the bits of the number 5 two bits to the left:
BitLShift(5, 2) = 20 (since 101 << 2 = 10100)

* {{ScriptFunction|BitRShiftL|v2.60|BitRShiftL(int, int)}}
* {{ScriptFunction|BitRShiftU|v2.60|BitRShiftU(int, int)}}
* {{ScriptFunction|BitShr|v2.60|BitShr(int, int)}}
: Shift the bits of an unsigned integer to the right. (Logical, zero fill, Right Shift)
: ''Examples:''
Shifts the bits of the number -42 one bit to the right, treating it as unsigned:
BitRShiftL(-42, 1) = 2147483627 (since 1111 1111 1111 1111 1111 1111 1101 0110 >> 1 = 0111 1111 1111 1111 1111 1111 1110 1011)
: Note: -42 = -(1+2^0+2^3+2^5) = (unsigned) (2^32-1)-(2^0+2^3+2^5) = 1111 1111 1111 1111 1111 1111 1101 0110

* {{ScriptFunction|BitRShiftA|v2.60|BitRShiftA(int, int)}}
* {{ScriptFunction|BitRShiftS|v2.60|BitRShiftS(int, int)}}
* {{ScriptFunction|BitSar|v2.60|BitSar(int, int)}}
: Shift the bits of an integer to the right. (Arithmetic, Sign bit fill, Right Shift)
: Examples:
Shifts the bits of the number -42 one bit to the right, treating it as signed:
BitRShiftA(-42, 1) = -21 (since 1111 1111 1111 1111 1111 1111 1101 0110 >> 1 = 1111 1111 1111 1111 1111 1111 1110 1011)

* {{ScriptFunction|BitLRotate|v2.60|BitLRotate(int, int)}}
* {{ScriptFunction|BitRol|v2.60|BitRol(int, int)}}
: Rotates the bits of an integer to the left by the number of bits specified in the second operand. For each rotation specified, the high order bit that exits from the left of the operand returns at the right to become the new low order bit.
: Examples:
Rotates the bits of the number -2147483642 one bit to the left:
BitLRotate(-2147483642, 1) = 13 (since 10000000000000000000000000000110 ROL 1 = 00000000000000000000000000001101)

* {{ScriptFunction|BitRRotate|v2.60|BitRRotateL(int, int)}}
* {{ScriptFunction|BitRor|v2.60|BitRor(int, int)}}
: Rotates the bits of an integer to the right by the number of bits specified in the second operand. For each rotation specified, the low order bit that exits from the right of the operand returns at the left to become the new high order bit.
: Examples:
Rotates the bits of the number 13 one bit to the right:
BitRRotate(13, 1) = -2147483642 (since 00000000000000000000000000001101 ROR 1 = 10000000000000000000000000000110)

* {{ScriptFunction|BitTest|v2.60|BitTest(int, int)}}
* {{ScriptFunction|BitTst|v2.60|BitTst(int, int)}}
: Tests a single bit (that is, it returns true if its state is one, else it returns false). The second operand denotes the location of the bit which is specified as an offset from the low order end of the operand (starting at zero).
: Examples:
Check the state of the fourth bit:
BitTest(3, 4) = False
BitTest(19, 4) = True

Check the state of the sign bit:
BitTest(-1, 31) = True
BitTest(2147483647, 31) = False

* {{ScriptFunction|BitSet|v2.60|BitSet(int, int)}}
: Sets a single bit to one (so it sets its state to one). The second operand denotes the location of the bit which is specified as an offset from the low order end of the operand (starting at zero).
: Examples:
Set the state of the fourth bit to one:
BitSet(3, 4) = 19
BitSet(19, 4) = 19

Set the state of the sign bit to one:
BitSet(-1, 31) = -1
BitSet(2147483647, 31) = -1

* {{ScriptFunction|BitClear|v2.60|BitClear(int, int)}}
* {{ScriptFunction|BitClr|v2.60|BitClr(int, int)}}
: Sets a single bit to zero (so it sets its state to zero). The second operand denotes the location of the bit which is specified as an offset from the low order end of the operand (starting at zero).
: Examples:
Clear the bits of the number 5
BitClear(5, 0) = 4 (first bit is set to zero)
BitClear(5, 1) = 5 (second bit is already zero)
BitClear(5, 2) = 1 (third bit is set to zero)
BitClear(5, 3) = 5 (fourth bit is already zero)

Clear the state of the sign bit:
BitClear(-1, 31) = 2147483647

* {{ScriptFunction|BitChange|v2.60|BitChange(int, int)}}
* {{ScriptFunction|BitChg|v2.60|BitChg(int, int)}}
: Sets a single bit to its complement (so it changes the state of a single bit; 1 becomes 0 and vice versa). The second operand denotes the location of the bit which is specified as an offset from the low order end of the operand (starting at zero). The sign bit is bit 31.
: Examples:
Change the state of the a bit of the number 5:
BitChange(5, 0) = 4 (first bit is set to zero)
BitChange(5, 1) = 7 (second bit is set to one)
BitChange(5, 2) = 1 (third bit is set to zero)
BitChange(5, 3) = 13 (fourth bit is set to one)

Change the state of the sign bit:
BitChange(-1, 31) = 2147483647

----
Back to [[Internal functions]].

[[Category:AviSynth_Syntax]]
[[Category:Scripting_Basics]]

Changelist 26

2014-01-04T17:58:03Z

Unreal666: /* Changes */

== Changes from 2.6.0 Alpha 2 to 2.6.0 CVS ==

=== Additions ===
* Added Eval(clip, string name, string) alias for oop processing of argument.
* DirectShowSource support non-standard pixel types "YV24" and "YV16".
* Info: Audio only clip now creates its own canvas video.
* AviSource: Include packed/padded processing and -ve biHeight logic for compressed input.
* Add Script Functions :- BitLRotate, BitRRotate, BitChange, BitClear, BitSet, BitTest and their asm aliases.
* Add WeaveRows (blit cost) and WeaveColumns (slow) frame combining filters.
* Add AudioDuration() [as float seconds], IsY8(), IsYV411() & PixelType() [as a string] script functions.
* Add Echo and Preroll filters.
* Add IScriptEnvironment::GetAVSLinkage() and DLLExport AVS_linkage for host usage of avisynth.dll.
* DirectShowSource, 2.6 plugin, support pixel types "AYUV" as YV24, "Y41P" and "Y411" as YV411.
* AviSource: Add Full and Auto pseudo pixel_types. Full is all supported. Auto is YV12, YUY2, RGB32, RGB24 & Y8.
* Add "AudioLengthS", "Ord" & "FillStr" script functions.
* Add AudioTrim(clip, float, float) audio priority trimming, args in fractional seconds.
* Add Trim(M, Length=N[, Pad=False]) and Trim(M, End=N[, Pad=False]) function overloads for explicit Trimming. Length=0 means zero frame clip. End=0 means end at frame 0.
* Add SeparateRows (zero cost) and SeparateColumns (slow) frame slashing filters.
* Add Script Functions :- Acos, Asin, Atan, Atan2, Cosh, Sinh, Tanh, Fmod, Log10, BitLShift, BitRShiftS, BitRShiftU and Hex.
* Add "ConditionalSelect","csc+[show]b" runtime filter.
* Add dither option to Levels, RGBAdjust & Tweak.
* Add BitAnd(), BitNot(), BitOr() & BitXor() script functions.
* Add StrCmp() & StrCmpI() script functions.
* Add YV24 support for Limiter show option.
* Add "Global OPT_dwChannelMask={int}"
* Add 0x0063F speaker mask for 7.1 WAVE_FORMAT_EXTENSIBLE.
* Add .dll DelayLoad exception texts to crash message formatter.
* ImageWriter, add support for printf formating of filename string, default is ("%06d.%s", n, ext);
* Add avs_get_error(AVS_ScriptEnvironment*); to avisynth_c interface.
* Catch and save AvisynthError text in more avisynth_c entry points, for kemuri-_9.
* Add ScriptName(), ScriptFile(), ScriptDir() functions (WarpEnterprises).
* Add SkewRows filter.
* Histogram, Levels mode, Improve colour of chroma legends.
* ConditionalFilter, teach about string results.
* Add some more "Add/Remove Software" registry keys to the Installer (XhmikosR).
* AviSource: Support both packed and DWORD padded raw planar input like with DSS.
* Add IScriptEnvironment::ApplyMessage()
* Add ImageSourceAnim (Wilbert)
* Support user upgrade to 178 DevIL.dll (They need to manage CRT dependancies).
* ImageSource: palette and compressed bmp images load correctly now (issue 894702) [need 178 DevIL.dll]
* ImageSource: support for other formats like: gif, exr, jp2, psd, hdr [need 178 DevIL.dll]
* Add YV24 mode to ColorBars.
* Add ColorBarsHD based on arib_std_b28.
* C-api usability enhancements from kemuri9 [Work in progress!]
* Add Undefined(), AudioLengthLo(), AudioLengthHi(), IsYV16() & IsYV24() script functions
* Allow newlines (and hence comments) before '{' -- Gavino
* Added IScriptEnvironment::DeleteScriptEnvironment()
* Added Histogram, population clamp % factor for "Levels" mode,
* Histogram, revert "Stereo" mode to YV12, Add "StereoY8" mode,
* AviSource: Support fourcc "GREY" as Y8
* Add "Global OPT_AVIPadScanlines=True" option for DWORD aligned planar padding

=== Bugfixes ===
* Fixed frame range clamping in ComparePlane (ultim).
* Fixed posible leak with realloc in ConditionalReader (ultim).
* Fixed posible double free in text-overlay (ultim).
* Fixed RGB32 to Y8 pixel right shift from 4th pixel on (Robert Martens).
* Fixed Overlay YV24 Image444 leak.
* Fixed AVISource "AUTO" and "FULL" handling.
* Fixed ImageSource handling of missing ebmp files.
* Fixed DirectShowSource incorrect byte order for unpacking of pixel type "AYUV".
* Fixed HexValue parsing values greater than 7FFFFFFF, now as unsigned hex.
* Fixed ConditionalReader memory overrun parsing bools.
* Fixed ResampleAudio NOP test to compare vi.num_audio_samples, not sample rate.
* Fixed YV24 -> RGB24 overrun cleanup for widths%16 == 5.
* Fixed RGB24 AddBorders with right=0.
* Fixed conditional_functions error message names (Wilbert).
* Fixed Audio cache ac_expected_next regression.
* Fixed ImageSource deal with add 1 to IL_NUM_IMAGES bug (Wilbert)
* Fixed Overlay YV24 V plane conversion.
* Fixed Overlay YV24 mode with shared input clip, needed a MakeWritable.
* Fixed ImageReader upside down TIFF in 178 DevIL. (Wilbert)
* Fixed SaveString 'string+string' bug when total length is 4096*K-1, K is +int.
* Fixed SincResize misuse of "int abs(int)" (Gavino). Fix Lanczos and Blackman sinc use of float == 0.0, use small limit "> 0.000001".
* Fixed Classic mode legend drawing for planar right limit and yuy2 centre line.
* Fixed possible MT race. Use "env->ManageCache(MC_IncVFBRefcount, ...)" in ProtectVFB.
* Fixed SwapYToUV output image size bug for 3 clip case.
* Fixed Crop limit tests for RGB.
* Fixed Overlay yellow tint on rec601 RGB import conversion.
* Fixed YtoUV() output image size bug for 3 clip case.
* Fixed ConvertToPlanar chroma alignment.
* Fixed Levels (RGB) change use of PixelClip(x) to min(max(x, 0), 255).
* Fixed SwapYtoUV yuy2 crash (StainlessS).
* Fixed Overlay saturate UV in add and subtract mode.
* Fixed Info.h range protect display characters (StainlessS).
* Fixed AviSource packed planar import chroma offsets.
* Fixed AviSource NULL GetWritePtr() failure due to premature setting of last_frame.
* Fixed Mask rounding in greyscale calcs (Wilbert), minor refactor.
* Fixed SelectRangeEvery audio snafu (Gavino).
* Fixed LoadPlugin, SaveString of result string.
* Fixed LoadPlugin, use _vsnprintf.
* Fixed LoadVirtualdubPlugin, don't add vdub filter to chain on load failure.
* Fixed rounding in RGB HResize (JoshyD) (affects all resizers)
* Fixed error message name in the filter VerticalReduceBy2
* Fixed SeparateFields() with variable parity input clip (Wilbert)
* Fixed AviSource, cannot cast__int64* to long*, it does not work!
* Fixed ConditionalReader: Don't allow out of range "Range" to overwrite edge values

=== Optimizations ===
* Cache auto increase span on sparse misses.
* Cache prevent inactive instances returning VFB early and spoiling active instances hit rate (LaTo).
* ConvertToPlanarGeneric explicit add Cache before chroma rescaler.
* Overlay minor refactor YV12 -> 444 chroma
* Speedup ConvertToMono(), minor refactor MixAudio().
* Change StackVertical/Horizontal to interative instead of recursive, 2^N performace increase for 3 and more clips, i.e. 1 blit total instead of blit(blit(blit(...
* RGBtoY8 Dynamic ASM code, suport for RGB24.
* YV24backtoYUY2 Dynamic ASM code.
* UtoY8, VtoY8 abuse subframe, zero cost.
* YV24<->RGB Add SSE2 and SSSE3 code paths, get rid of wide_enough.
* ConvertToYUY2 Add SSE2, MMX restore full speed on platforms with poor ooox.
* ConvertAudio, manage tempbuffer and floatbuffer independently.
* ConvertAudio, prefer SSE2 over 3DNow for super AMD cores.
* Info.h, full refactor, a good example of "Never look down", thx StainlessS
* DoubleWeaveFrames, If A not writable, try to write to B, else make new frame
* Histogram, fix GetFrame/NewVideoFrame call order
* HResizer, interleave code +4% faster
* YtoUV() Abuse Subframe to snatch the Y plane / UV planes, Derestrict destination colorformat autogeneration.
* ImageSource: Improve thread interlock code
* ConditionalReader/WriteFile: Full refactor.
* Replace _strdup with SaveString in AddFunction (Thanks Gavino)

=== Changes ===
* Import: Increase full path buffer to MAX_PATH*4 for multi char code pages like CP932 (Chikuzen).
* Throw error when output number of frames will exceed MAXINT.
* BlankClip: Supply useful defaults for new Audio/Video when using a Video/Audio only template clip.
* BlankClip: Use duration from Audio only template as default length for new clip.
* Define new IClip::SetCacheHints cachehint constants.
* Force int call arguments to user script function float params to be explicit floats.
* Splice pass CacheHints through to both children in + and ++ mode.
* WriteFileStart/End save current_frame and set Last.
* ConditionalReader do not ignore syntax errors in input file.
* ImageSourceAnim Pad/Crop images to match first frame (Wilbert)
* ImageSource Add version to messages (Wilbert)
* Initial 2.6 API entry point linkage.
* Use Invoke for graph tail, enhance non-clip output error reporting.
* PopContext when inner block Asserts/throws (maxxon).
* Remove duplicate definitions (Wilbert)
* Enhance non-clip output error reporting.
* Explicitly specify calling sequence as __cdecl for Avisynth softwire routines, (was the compiler default)
* Use env->Invoke("Cache", ...) everywhere instead of Cache::Create_Cache(), allows for Cache to be overloaded by a plugin.
* ConvertToYUY2 Change from 0-1-1 kernel to 1-2-1 kernel.
* Tweak make Interp same units as minSat and maxSat.
* Check HKEY_CURRENT_USER for PluginDir first. (henktiggelaar)
* Make forced, -ve, planar alignment of chroma planes match subsampling.
* Enforce planar alignment restrictions.
* C-api: Remove func sub-struct from AVS_Library struct
* Add error code to plugin load failure message
* Make default planar AVI output packed.
* WriteFile() now supports unlimited number of unlimited strings. (was 16 by 254 byte strings).
* ConvertToRGB*, make C++ code sample chroma the same as the MMX code i.e. use both pixels.
* ConvertToRGB*, use YV24 path for planar, complain when options are present for YUY2.
* ConvertToYUY2, use YV16 path for planar, complain when options are present for RGB
** see: http://forum.doom9.org/showthread.php?p=1378381#post1378381
* Thread safe code, part 2.
* Correct IClip baked documentation
* Fix at_exit executon order
* Passify compilation error/warnings (XhmikosR)
* for, const, extern and ansi patches for VC2008 (SEt)
* Disable OPT_RELS_LOGGING option
* Change implicit Last parsing for argless, bracketless calls to match bracketed cases. (Gavino) [not documented yet ???]
* DirectShowSource: Support last minute format renegotiation thru IPin::QueryAccept() & Validate the size of the provided directshow buffer.
* Remove non ascii chars from comments.
* Add core stubs for DirectShowSource, TCPServer & TCPSource, report when plugins are missing.
* Add note for original source downloads - SoundTouch
* Add more lineage history to Info()
* Move convertaudio, alignplanar, fillborder & MIN/MAX_INT definitions.
* Run AtExit before dismantling world.
* Change setcachehints definition from void to int. Test IClip version >= 5.
* Move PixelClip definition to avisynth.cpp
* SubTitle, etc, make X & Y options float (0.125 pixel granularity).
* ShowSMPTE() supports all integer FPS and multiplies of drop frame FPS.
* SubTitle, stop overwriting string constants (Gavino).
* SubTitle, improve pixel registration (Gavino).
* Make Info() CPU display hierarchical.
* Thread safe code, part 1.

== Changes from 2.5 series to 2.6.0 Alpha 2 ==

=== Additions ===
* Added support for argument passing and EAX return value to SoftwireHelper.
* Added "Global OPT_VDubPlanarHack=True" to flip YV24 and YV16 chroma planes for old VDub's.
* Added ContinuedDenominator/ContinuedNumerator(f[]i[limit]i) script functions.
* Tweak: fix MaskPointResizing + put back Dividee ISSE code (use sse=true, can't use all settings in that case).
* Added ChromaInPlacement, ChromaOutPlacement and ChromaResample options to planar colour conversions.
* Added MaskHS.
* Minor tweaks to get ready for VC8.
* Add Y8 for DevIL, planarize EBMP.
* Planar support for many filters.
* Added Info() time indicator on audio length and video (current frame & total). (2.5.8)
* Added UtoY8 and VtoY8.
* Added more info to Info(). (2.5.8)
* ColorYUV: Added all adjustment parameters as conditional variables "coloryuv_SETTING". Enable by setting conditional=true.
* ConditionalReader: Added support for type String.
* ConditionalReader: Added offset keyword to offset all frame numbers after the keyword.
* Added SincResize() with optional taps parameter (default is 4).
* Added Custom band setting to SuperEQ to allow all 16 bands to be set from script. Usage: SuperEQ(clip,band1, band2, band3....) values are dB in float.
* Added fast 0-1-0 kernel for YV24 to ConvertBacktoYUY2().
* Added formats: YV24, YV16, Y8, YV411.

=== Bugfixes ===
* Fixed MonoToStereo with stereo sources.
* Fixed MergeChannels with only 1 input clip.
* Fixed support for negative height DIB format AVI's. (Oops still not quite right yet)
* Fixed Audio cache crashes.
* Fixed resize with YV411 missing code.
* Fixed ConditionalReader rounding with integer Interpolation.
* Fixed Softwire SSE2 bugs.
* Fixed SSSE3 CPU detection.
* Fixed SSSE3, SSE4.1 & SSE4.2 detection.
* Fixed Fastwire encoding of instructions that are >2 opcodes (SSSE3+4).
* Fixed _RPT5() macro for debug builds

=== Optimizations ===
* SuperEQ: Improve channel unpacking/packing code.
* H-Resize: Use SSE4.1 (movntdqa) loads for use once memory access.
* H-Resize: Added SSE2 horizontal unpacker.
* Resize: Use SSE3 (lddqu) loads for unaligned memory access.
* Added ultra fast vertical PointResizer (64 pixel/cycle).
* Added dynamic SSSE3 vertical resizer (16 pixel/cycle) ~ twice as fast as old MMX.
* Added dynamic SSE2 vertical resizer (16 pixel/cycle).
* Added dynamic MMX vertical resizer (8 pixel/cycle).
* Added SSSE3 version for RGB<->YV24 conversions.
* Added dynamic compiled MMX/iSSE for RGB<->YV24 conversions. Speed is approx 200% of C-code.

=== Changes ===
* ConditionalReader/WriteFile: Full refactor.
* SoftwireHelper: explicit hardware exception handling.
* Resize: Moved GetResampleFunction into Resamplefunction, to allow overrides.
* Resampler: Removed dead stlf code.
* Updated Soundtouch to 1.31 (2.5.8)
* Put dynamic matrix conversion into separate file.
* Moved chroma subsampling to image_type section.
* Added specific error reporting when requesting chromasubsampling with Y8.
* Split up merge and plane Swappers.
* Split up Plane transfers into separate classes.
* Added automatic destination colorspace detection on planar YtoUV.
* Took out greyscale and RGB32<->RGB24 from convert.cpp and placed them in separate files.
* All code assuming UVwidth = Ywidth/2 and similar should be gone.

[[Category:Changelist]]

Changelist 26

2014-01-04T17:57:36Z

Unreal666: /* Optimizations */

== Changes from 2.6.0 Alpha 2 to 2.6.0 CVS ==

=== Additions ===
* Added Eval(clip, string name, string) alias for oop processing of argument.
* DirectShowSource support non-standard pixel types "YV24" and "YV16".
* Info: Audio only clip now creates its own canvas video.
* AviSource: Include packed/padded processing and -ve biHeight logic for compressed input.
* Add Script Functions :- BitLRotate, BitRRotate, BitChange, BitClear, BitSet, BitTest and their asm aliases.
* Add WeaveRows (blit cost) and WeaveColumns (slow) frame combining filters.
* Add AudioDuration() [as float seconds], IsY8(), IsYV411() & PixelType() [as a string] script functions.
* Add Echo and Preroll filters.
* Add IScriptEnvironment::GetAVSLinkage() and DLLExport AVS_linkage for host usage of avisynth.dll.
* DirectShowSource, 2.6 plugin, support pixel types "AYUV" as YV24, "Y41P" and "Y411" as YV411.
* AviSource: Add Full and Auto pseudo pixel_types. Full is all supported. Auto is YV12, YUY2, RGB32, RGB24 & Y8.
* Add "AudioLengthS", "Ord" & "FillStr" script functions.
* Add AudioTrim(clip, float, float) audio priority trimming, args in fractional seconds.
* Add Trim(M, Length=N[, Pad=False]) and Trim(M, End=N[, Pad=False]) function overloads for explicit Trimming. Length=0 means zero frame clip. End=0 means end at frame 0.
* Add SeparateRows (zero cost) and SeparateColumns (slow) frame slashing filters.
* Add Script Functions :- Acos, Asin, Atan, Atan2, Cosh, Sinh, Tanh, Fmod, Log10, BitLShift, BitRShiftS, BitRShiftU and Hex.
* Add "ConditionalSelect","csc+[show]b" runtime filter.
* Add dither option to Levels, RGBAdjust & Tweak.
* Add BitAnd(), BitNot(), BitOr() & BitXor() script functions.
* Add StrCmp() & StrCmpI() script functions.
* Add YV24 support for Limiter show option.
* Add "Global OPT_dwChannelMask={int}"
* Add 0x0063F speaker mask for 7.1 WAVE_FORMAT_EXTENSIBLE.
* Add .dll DelayLoad exception texts to crash message formatter.
* ImageWriter, add support for printf formating of filename string, default is ("%06d.%s", n, ext);
* Add avs_get_error(AVS_ScriptEnvironment*); to avisynth_c interface.
* Catch and save AvisynthError text in more avisynth_c entry points, for kemuri-_9.
* Add ScriptName(), ScriptFile(), ScriptDir() functions (WarpEnterprises).
* Add SkewRows filter.
* Histogram, Levels mode, Improve colour of chroma legends.
* ConditionalFilter, teach about string results.
* Add some more "Add/Remove Software" registry keys to the Installer (XhmikosR).
* AviSource: Support both packed and DWORD padded raw planar input like with DSS.
* Add IScriptEnvironment::ApplyMessage()
* Add ImageSourceAnim (Wilbert)
* Support user upgrade to 178 DevIL.dll (They need to manage CRT dependancies).
* ImageSource: palette and compressed bmp images load correctly now (issue 894702) [need 178 DevIL.dll]
* ImageSource: support for other formats like: gif, exr, jp2, psd, hdr [need 178 DevIL.dll]
* Add YV24 mode to ColorBars.
* Add ColorBarsHD based on arib_std_b28.
* C-api usability enhancements from kemuri9 [Work in progress!]
* Add Undefined(), AudioLengthLo(), AudioLengthHi(), IsYV16() & IsYV24() script functions
* Allow newlines (and hence comments) before '{' -- Gavino
* Added IScriptEnvironment::DeleteScriptEnvironment()
* Added Histogram, population clamp % factor for "Levels" mode,
* Histogram, revert "Stereo" mode to YV12, Add "StereoY8" mode,
* AviSource: Support fourcc "GREY" as Y8
* Add "Global OPT_AVIPadScanlines=True" option for DWORD aligned planar padding

=== Bugfixes ===
* Fixed frame range clamping in ComparePlane (ultim).
* Fixed posible leak with realloc in ConditionalReader (ultim).
* Fixed posible double free in text-overlay (ultim).
* Fixed RGB32 to Y8 pixel right shift from 4th pixel on (Robert Martens).
* Fixed Overlay YV24 Image444 leak.
* Fixed AVISource "AUTO" and "FULL" handling.
* Fixed ImageSource handling of missing ebmp files.
* Fixed DirectShowSource incorrect byte order for unpacking of pixel type "AYUV".
* Fixed HexValue parsing values greater than 7FFFFFFF, now as unsigned hex.
* Fixed ConditionalReader memory overrun parsing bools.
* Fixed ResampleAudio NOP test to compare vi.num_audio_samples, not sample rate.
* Fixed YV24 -> RGB24 overrun cleanup for widths%16 == 5.
* Fixed RGB24 AddBorders with right=0.
* Fixed conditional_functions error message names (Wilbert).
* Fixed Audio cache ac_expected_next regression.
* Fixed ImageSource deal with add 1 to IL_NUM_IMAGES bug (Wilbert)
* Fixed Overlay YV24 V plane conversion.
* Fixed Overlay YV24 mode with shared input clip, needed a MakeWritable.
* Fixed ImageReader upside down TIFF in 178 DevIL. (Wilbert)
* Fixed SaveString 'string+string' bug when total length is 4096*K-1, K is +int.
* Fixed SincResize misuse of "int abs(int)" (Gavino). Fix Lanczos and Blackman sinc use of float == 0.0, use small limit "> 0.000001".
* Fixed Classic mode legend drawing for planar right limit and yuy2 centre line.
* Fixed possible MT race. Use "env->ManageCache(MC_IncVFBRefcount, ...)" in ProtectVFB.
* Fixed SwapYToUV output image size bug for 3 clip case.
* Fixed Crop limit tests for RGB.
* Fixed Overlay yellow tint on rec601 RGB import conversion.
* Fixed YtoUV() output image size bug for 3 clip case.
* Fixed ConvertToPlanar chroma alignment.
* Fixed Levels (RGB) change use of PixelClip(x) to min(max(x, 0), 255).
* Fixed SwapYtoUV yuy2 crash (StainlessS).
* Fixed Overlay saturate UV in add and subtract mode.
* Fixed Info.h range protect display characters (StainlessS).
* Fixed AviSource packed planar import chroma offsets.
* Fixed AviSource NULL GetWritePtr() failure due to premature setting of last_frame.
* Fixed Mask rounding in greyscale calcs (Wilbert), minor refactor.
* Fixed SelectRangeEvery audio snafu (Gavino).
* Fixed LoadPlugin, SaveString of result string.
* Fixed LoadPlugin, use _vsnprintf.
* Fixed LoadVirtualdubPlugin, don't add vdub filter to chain on load failure.
* Fixed rounding in RGB HResize (JoshyD) (affects all resizers)
* Fixed error message name in the filter VerticalReduceBy2
* Fixed SeparateFields() with variable parity input clip (Wilbert)
* Fixed AviSource, cannot cast__int64* to long*, it does not work!
* Fixed ConditionalReader: Don't allow out of range "Range" to overwrite edge values

=== Optimizations ===
* Cache auto increase span on sparse misses.
* Cache prevent inactive instances returning VFB early and spoiling active instances hit rate (LaTo).
* ConvertToPlanarGeneric explicit add Cache before chroma rescaler.
* Overlay minor refactor YV12 -> 444 chroma
* Speedup ConvertToMono(), minor refactor MixAudio().
* Change StackVertical/Horizontal to interative instead of recursive, 2^N performace increase for 3 and more clips, i.e. 1 blit total instead of blit(blit(blit(...
* RGBtoY8 Dynamic ASM code, suport for RGB24.
* YV24backtoYUY2 Dynamic ASM code.
* UtoY8, VtoY8 abuse subframe, zero cost.
* YV24<->RGB Add SSE2 and SSSE3 code paths, get rid of wide_enough.
* ConvertToYUY2 Add SSE2, MMX restore full speed on platforms with poor ooox.
* ConvertAudio, manage tempbuffer and floatbuffer independently.
* ConvertAudio, prefer SSE2 over 3DNow for super AMD cores.
* Info.h, full refactor, a good example of "Never look down", thx StainlessS
* DoubleWeaveFrames, If A not writable, try to write to B, else make new frame
* Histogram, fix GetFrame/NewVideoFrame call order
* HResizer, interleave code +4% faster
* YtoUV() Abuse Subframe to snatch the Y plane / UV planes, Derestrict destination colorformat autogeneration.
* ImageSource: Improve thread interlock code
* ConditionalReader/WriteFile: Full refactor.
* Replace _strdup with SaveString in AddFunction (Thanks Gavino)

=== Changes ===
* BlankClip: Supply useful defaults for new Audio/Video when using a Video/Audio only template clip.
* BlankClip: Use duration from Audio only template as default length for new clip.
* Define new IClip::SetCacheHints cachehint constants.
* Force int call arguments to user script function float params to be explicit floats.
* Splice pass CacheHints through to both children in + and ++ mode.
* WriteFileStart/End save current_frame and set Last.
* ConditionalReader do not ignore syntax errors in input file.
* ImageSourceAnim Pad/Crop images to match first frame (Wilbert)
* ImageSource Add version to messages (Wilbert)
* Initial 2.6 API entry point linkage.
* Use Invoke for graph tail, enhance non-clip output error reporting.
* PopContext when inner block Asserts/throws (maxxon).
* Remove duplicate definitions (Wilbert)
* Enhance non-clip output error reporting.
* Explicitly specify calling sequence as __cdecl for Avisynth softwire routines, (was the compiler default)
* Use env->Invoke("Cache", ...) everywhere instead of Cache::Create_Cache(), allows for Cache to be overloaded by a plugin.
* ConvertToYUY2 Change from 0-1-1 kernel to 1-2-1 kernel.
* Tweak make Interp same units as minSat and maxSat.
* Check HKEY_CURRENT_USER for PluginDir first. (henktiggelaar)
* Make forced, -ve, planar alignment of chroma planes match subsampling.
* Enforce planar alignment restrictions.
* C-api: Remove func sub-struct from AVS_Library struct
* Add error code to plugin load failure message
* Make default planar AVI output packed.
* WriteFile() now supports unlimited number of unlimited strings. (was 16 by 254 byte strings).
* ConvertToRGB*, make C++ code sample chroma the same as the MMX code i.e. use both pixels.
* ConvertToRGB*, use YV24 path for planar, complain when options are present for YUY2.
* ConvertToYUY2, use YV16 path for planar, complain when options are present for RGB
** see: http://forum.doom9.org/showthread.php?p=1378381#post1378381
* Thread safe code, part 2.
* Correct IClip baked documentation
* Fix at_exit executon order
* Passify compilation error/warnings (XhmikosR)
* for, const, extern and ansi patches for VC2008 (SEt)
* Disable OPT_RELS_LOGGING option
* Change implicit Last parsing for argless, bracketless calls to match bracketed cases. (Gavino) [not documented yet ???]
* DirectShowSource: Support last minute format renegotiation thru IPin::QueryAccept() & Validate the size of the provided directshow buffer.
* Remove non ascii chars from comments.
* Add core stubs for DirectShowSource, TCPServer & TCPSource, report when plugins are missing.
* Add note for original source downloads - SoundTouch
* Add more lineage history to Info()
* Move convertaudio, alignplanar, fillborder & MIN/MAX_INT definitions.
* Run AtExit before dismantling world.
* Change setcachehints definition from void to int. Test IClip version >= 5.
* Move PixelClip definition to avisynth.cpp
* SubTitle, etc, make X & Y options float (0.125 pixel granularity).
* ShowSMPTE() supports all integer FPS and multiplies of drop frame FPS.
* SubTitle, stop overwriting string constants (Gavino).
* SubTitle, improve pixel registration (Gavino).
* Make Info() CPU display hierarchical.
* Thread safe code, part 1.

== Changes from 2.5 series to 2.6.0 Alpha 2 ==

=== Additions ===
* Added support for argument passing and EAX return value to SoftwireHelper.
* Added "Global OPT_VDubPlanarHack=True" to flip YV24 and YV16 chroma planes for old VDub's.
* Added ContinuedDenominator/ContinuedNumerator(f[]i[limit]i) script functions.
* Tweak: fix MaskPointResizing + put back Dividee ISSE code (use sse=true, can't use all settings in that case).
* Added ChromaInPlacement, ChromaOutPlacement and ChromaResample options to planar colour conversions.
* Added MaskHS.
* Minor tweaks to get ready for VC8.
* Add Y8 for DevIL, planarize EBMP.
* Planar support for many filters.
* Added Info() time indicator on audio length and video (current frame & total). (2.5.8)
* Added UtoY8 and VtoY8.
* Added more info to Info(). (2.5.8)
* ColorYUV: Added all adjustment parameters as conditional variables "coloryuv_SETTING". Enable by setting conditional=true.
* ConditionalReader: Added support for type String.
* ConditionalReader: Added offset keyword to offset all frame numbers after the keyword.
* Added SincResize() with optional taps parameter (default is 4).
* Added Custom band setting to SuperEQ to allow all 16 bands to be set from script. Usage: SuperEQ(clip,band1, band2, band3....) values are dB in float.
* Added fast 0-1-0 kernel for YV24 to ConvertBacktoYUY2().
* Added formats: YV24, YV16, Y8, YV411.

=== Bugfixes ===
* Fixed MonoToStereo with stereo sources.
* Fixed MergeChannels with only 1 input clip.
* Fixed support for negative height DIB format AVI's. (Oops still not quite right yet)
* Fixed Audio cache crashes.
* Fixed resize with YV411 missing code.
* Fixed ConditionalReader rounding with integer Interpolation.
* Fixed Softwire SSE2 bugs.
* Fixed SSSE3 CPU detection.
* Fixed SSSE3, SSE4.1 & SSE4.2 detection.
* Fixed Fastwire encoding of instructions that are >2 opcodes (SSSE3+4).
* Fixed _RPT5() macro for debug builds

=== Optimizations ===
* SuperEQ: Improve channel unpacking/packing code.
* H-Resize: Use SSE4.1 (movntdqa) loads for use once memory access.
* H-Resize: Added SSE2 horizontal unpacker.
* Resize: Use SSE3 (lddqu) loads for unaligned memory access.
* Added ultra fast vertical PointResizer (64 pixel/cycle).
* Added dynamic SSSE3 vertical resizer (16 pixel/cycle) ~ twice as fast as old MMX.
* Added dynamic SSE2 vertical resizer (16 pixel/cycle).
* Added dynamic MMX vertical resizer (8 pixel/cycle).
* Added SSSE3 version for RGB<->YV24 conversions.
* Added dynamic compiled MMX/iSSE for RGB<->YV24 conversions. Speed is approx 200% of C-code.

=== Changes ===
* ConditionalReader/WriteFile: Full refactor.
* SoftwireHelper: explicit hardware exception handling.
* Resize: Moved GetResampleFunction into Resamplefunction, to allow overrides.
* Resampler: Removed dead stlf code.
* Updated Soundtouch to 1.31 (2.5.8)
* Put dynamic matrix conversion into separate file.
* Moved chroma subsampling to image_type section.
* Added specific error reporting when requesting chromasubsampling with Y8.
* Split up merge and plane Swappers.
* Split up Plane transfers into separate classes.
* Added automatic destination colorspace detection on planar YtoUV.
* Took out greyscale and RGB32<->RGB24 from convert.cpp and placed them in separate files.
* All code assuming UVwidth = Ywidth/2 and similar should be gone.

[[Category:Changelist]]

Changelist 26

2014-01-04T17:54:46Z

Unreal666: /* Additions */

== Changes from 2.6.0 Alpha 2 to 2.6.0 CVS ==

=== Additions ===
* Added Eval(clip, string name, string) alias for oop processing of argument.
* DirectShowSource support non-standard pixel types "YV24" and "YV16".
* Info: Audio only clip now creates its own canvas video.
* AviSource: Include packed/padded processing and -ve biHeight logic for compressed input.
* Add Script Functions :- BitLRotate, BitRRotate, BitChange, BitClear, BitSet, BitTest and their asm aliases.
* Add WeaveRows (blit cost) and WeaveColumns (slow) frame combining filters.
* Add AudioDuration() [as float seconds], IsY8(), IsYV411() & PixelType() [as a string] script functions.
* Add Echo and Preroll filters.
* Add IScriptEnvironment::GetAVSLinkage() and DLLExport AVS_linkage for host usage of avisynth.dll.
* DirectShowSource, 2.6 plugin, support pixel types "AYUV" as YV24, "Y41P" and "Y411" as YV411.
* AviSource: Add Full and Auto pseudo pixel_types. Full is all supported. Auto is YV12, YUY2, RGB32, RGB24 & Y8.
* Add "AudioLengthS", "Ord" & "FillStr" script functions.
* Add AudioTrim(clip, float, float) audio priority trimming, args in fractional seconds.
* Add Trim(M, Length=N[, Pad=False]) and Trim(M, End=N[, Pad=False]) function overloads for explicit Trimming. Length=0 means zero frame clip. End=0 means end at frame 0.
* Add SeparateRows (zero cost) and SeparateColumns (slow) frame slashing filters.
* Add Script Functions :- Acos, Asin, Atan, Atan2, Cosh, Sinh, Tanh, Fmod, Log10, BitLShift, BitRShiftS, BitRShiftU and Hex.
* Add "ConditionalSelect","csc+[show]b" runtime filter.
* Add dither option to Levels, RGBAdjust & Tweak.
* Add BitAnd(), BitNot(), BitOr() & BitXor() script functions.
* Add StrCmp() & StrCmpI() script functions.
* Add YV24 support for Limiter show option.
* Add "Global OPT_dwChannelMask={int}"
* Add 0x0063F speaker mask for 7.1 WAVE_FORMAT_EXTENSIBLE.
* Add .dll DelayLoad exception texts to crash message formatter.
* ImageWriter, add support for printf formating of filename string, default is ("%06d.%s", n, ext);
* Add avs_get_error(AVS_ScriptEnvironment*); to avisynth_c interface.
* Catch and save AvisynthError text in more avisynth_c entry points, for kemuri-_9.
* Add ScriptName(), ScriptFile(), ScriptDir() functions (WarpEnterprises).
* Add SkewRows filter.
* Histogram, Levels mode, Improve colour of chroma legends.
* ConditionalFilter, teach about string results.
* Add some more "Add/Remove Software" registry keys to the Installer (XhmikosR).
* AviSource: Support both packed and DWORD padded raw planar input like with DSS.
* Add IScriptEnvironment::ApplyMessage()
* Add ImageSourceAnim (Wilbert)
* Support user upgrade to 178 DevIL.dll (They need to manage CRT dependancies).
* ImageSource: palette and compressed bmp images load correctly now (issue 894702) [need 178 DevIL.dll]
* ImageSource: support for other formats like: gif, exr, jp2, psd, hdr [need 178 DevIL.dll]
* Add YV24 mode to ColorBars.
* Add ColorBarsHD based on arib_std_b28.
* C-api usability enhancements from kemuri9 [Work in progress!]
* Add Undefined(), AudioLengthLo(), AudioLengthHi(), IsYV16() & IsYV24() script functions
* Allow newlines (and hence comments) before '{' -- Gavino
* Added IScriptEnvironment::DeleteScriptEnvironment()
* Added Histogram, population clamp % factor for "Levels" mode,
* Histogram, revert "Stereo" mode to YV12, Add "StereoY8" mode,
* AviSource: Support fourcc "GREY" as Y8
* Add "Global OPT_AVIPadScanlines=True" option for DWORD aligned planar padding

=== Bugfixes ===
* Fixed frame range clamping in ComparePlane (ultim).
* Fixed posible leak with realloc in ConditionalReader (ultim).
* Fixed posible double free in text-overlay (ultim).
* Fixed RGB32 to Y8 pixel right shift from 4th pixel on (Robert Martens).
* Fixed Overlay YV24 Image444 leak.
* Fixed AVISource "AUTO" and "FULL" handling.
* Fixed ImageSource handling of missing ebmp files.
* Fixed DirectShowSource incorrect byte order for unpacking of pixel type "AYUV".
* Fixed HexValue parsing values greater than 7FFFFFFF, now as unsigned hex.
* Fixed ConditionalReader memory overrun parsing bools.
* Fixed ResampleAudio NOP test to compare vi.num_audio_samples, not sample rate.
* Fixed YV24 -> RGB24 overrun cleanup for widths%16 == 5.
* Fixed RGB24 AddBorders with right=0.
* Fixed conditional_functions error message names (Wilbert).
* Fixed Audio cache ac_expected_next regression.
* Fixed ImageSource deal with add 1 to IL_NUM_IMAGES bug (Wilbert)
* Fixed Overlay YV24 V plane conversion.
* Fixed Overlay YV24 mode with shared input clip, needed a MakeWritable.
* Fixed ImageReader upside down TIFF in 178 DevIL. (Wilbert)
* Fixed SaveString 'string+string' bug when total length is 4096*K-1, K is +int.
* Fixed SincResize misuse of "int abs(int)" (Gavino). Fix Lanczos and Blackman sinc use of float == 0.0, use small limit "> 0.000001".
* Fixed Classic mode legend drawing for planar right limit and yuy2 centre line.
* Fixed possible MT race. Use "env->ManageCache(MC_IncVFBRefcount, ...)" in ProtectVFB.
* Fixed SwapYToUV output image size bug for 3 clip case.
* Fixed Crop limit tests for RGB.
* Fixed Overlay yellow tint on rec601 RGB import conversion.
* Fixed YtoUV() output image size bug for 3 clip case.
* Fixed ConvertToPlanar chroma alignment.
* Fixed Levels (RGB) change use of PixelClip(x) to min(max(x, 0), 255).
* Fixed SwapYtoUV yuy2 crash (StainlessS).
* Fixed Overlay saturate UV in add and subtract mode.
* Fixed Info.h range protect display characters (StainlessS).
* Fixed AviSource packed planar import chroma offsets.
* Fixed AviSource NULL GetWritePtr() failure due to premature setting of last_frame.
* Fixed Mask rounding in greyscale calcs (Wilbert), minor refactor.
* Fixed SelectRangeEvery audio snafu (Gavino).
* Fixed LoadPlugin, SaveString of result string.
* Fixed LoadPlugin, use _vsnprintf.
* Fixed LoadVirtualdubPlugin, don't add vdub filter to chain on load failure.
* Fixed rounding in RGB HResize (JoshyD) (affects all resizers)
* Fixed error message name in the filter VerticalReduceBy2
* Fixed SeparateFields() with variable parity input clip (Wilbert)
* Fixed AviSource, cannot cast__int64* to long*, it does not work!
* Fixed ConditionalReader: Don't allow out of range "Range" to overwrite edge values

=== Optimizations ===
* ConvertToPlanarGeneric explicit add Cache before chroma rescaler.
* Overlay minor refactor YV12 -> 444 chroma
* Speedup ConvertToMono(), minor refactor MixAudio().
* Change StackVertical/Horizontal to interative instead of recursive, 2^N performace increase for 3 and more clips, i.e. 1 blit total instead of blit(blit(blit(...
* RGBtoY8 Dynamic ASM code, suport for RGB24.
* YV24backtoYUY2 Dynamic ASM code.
* UtoY8, VtoY8 abuse subframe, zero cost.
* YV24<->RGB Add SSE2 and SSSE3 code paths, get rid of wide_enough.
* ConvertToYUY2 Add SSE2, MMX restore full speed on platforms with poor ooox.
* ConvertAudio, manage tempbuffer and floatbuffer independently.
* ConvertAudio, prefer SSE2 over 3DNow for super AMD cores.
* Info.h, full refactor, a good example of "Never look down", thx StainlessS
* DoubleWeaveFrames, If A not writable, try to write to B, else make new frame
* Histogram, fix GetFrame/NewVideoFrame call order
* HResizer, interleave code +4% faster
* YtoUV() Abuse Subframe to snatch the Y plane / UV planes, Derestrict destination colorformat autogeneration.
* ImageSource: Improve thread interlock code
* ConditionalReader/WriteFile: Full refactor.
* Replace _strdup with SaveString in AddFunction (Thanks Gavino)

=== Changes ===
* BlankClip: Supply useful defaults for new Audio/Video when using a Video/Audio only template clip.
* BlankClip: Use duration from Audio only template as default length for new clip.
* Define new IClip::SetCacheHints cachehint constants.
* Force int call arguments to user script function float params to be explicit floats.
* Splice pass CacheHints through to both children in + and ++ mode.
* WriteFileStart/End save current_frame and set Last.
* ConditionalReader do not ignore syntax errors in input file.
* ImageSourceAnim Pad/Crop images to match first frame (Wilbert)
* ImageSource Add version to messages (Wilbert)
* Initial 2.6 API entry point linkage.
* Use Invoke for graph tail, enhance non-clip output error reporting.
* PopContext when inner block Asserts/throws (maxxon).
* Remove duplicate definitions (Wilbert)
* Enhance non-clip output error reporting.
* Explicitly specify calling sequence as __cdecl for Avisynth softwire routines, (was the compiler default)
* Use env->Invoke("Cache", ...) everywhere instead of Cache::Create_Cache(), allows for Cache to be overloaded by a plugin.
* ConvertToYUY2 Change from 0-1-1 kernel to 1-2-1 kernel.
* Tweak make Interp same units as minSat and maxSat.
* Check HKEY_CURRENT_USER for PluginDir first. (henktiggelaar)
* Make forced, -ve, planar alignment of chroma planes match subsampling.
* Enforce planar alignment restrictions.
* C-api: Remove func sub-struct from AVS_Library struct
* Add error code to plugin load failure message
* Make default planar AVI output packed.
* WriteFile() now supports unlimited number of unlimited strings. (was 16 by 254 byte strings).
* ConvertToRGB*, make C++ code sample chroma the same as the MMX code i.e. use both pixels.
* ConvertToRGB*, use YV24 path for planar, complain when options are present for YUY2.
* ConvertToYUY2, use YV16 path for planar, complain when options are present for RGB
** see: http://forum.doom9.org/showthread.php?p=1378381#post1378381
* Thread safe code, part 2.
* Correct IClip baked documentation
* Fix at_exit executon order
* Passify compilation error/warnings (XhmikosR)
* for, const, extern and ansi patches for VC2008 (SEt)
* Disable OPT_RELS_LOGGING option
* Change implicit Last parsing for argless, bracketless calls to match bracketed cases. (Gavino) [not documented yet ???]
* DirectShowSource: Support last minute format renegotiation thru IPin::QueryAccept() & Validate the size of the provided directshow buffer.
* Remove non ascii chars from comments.
* Add core stubs for DirectShowSource, TCPServer & TCPSource, report when plugins are missing.
* Add note for original source downloads - SoundTouch
* Add more lineage history to Info()
* Move convertaudio, alignplanar, fillborder & MIN/MAX_INT definitions.
* Run AtExit before dismantling world.
* Change setcachehints definition from void to int. Test IClip version >= 5.
* Move PixelClip definition to avisynth.cpp
* SubTitle, etc, make X & Y options float (0.125 pixel granularity).
* ShowSMPTE() supports all integer FPS and multiplies of drop frame FPS.
* SubTitle, stop overwriting string constants (Gavino).
* SubTitle, improve pixel registration (Gavino).
* Make Info() CPU display hierarchical.
* Thread safe code, part 1.

== Changes from 2.5 series to 2.6.0 Alpha 2 ==

=== Additions ===
* Added support for argument passing and EAX return value to SoftwireHelper.
* Added "Global OPT_VDubPlanarHack=True" to flip YV24 and YV16 chroma planes for old VDub's.
* Added ContinuedDenominator/ContinuedNumerator(f[]i[limit]i) script functions.
* Tweak: fix MaskPointResizing + put back Dividee ISSE code (use sse=true, can't use all settings in that case).
* Added ChromaInPlacement, ChromaOutPlacement and ChromaResample options to planar colour conversions.
* Added MaskHS.
* Minor tweaks to get ready for VC8.
* Add Y8 for DevIL, planarize EBMP.
* Planar support for many filters.
* Added Info() time indicator on audio length and video (current frame & total). (2.5.8)
* Added UtoY8 and VtoY8.
* Added more info to Info(). (2.5.8)
* ColorYUV: Added all adjustment parameters as conditional variables "coloryuv_SETTING". Enable by setting conditional=true.
* ConditionalReader: Added support for type String.
* ConditionalReader: Added offset keyword to offset all frame numbers after the keyword.
* Added SincResize() with optional taps parameter (default is 4).
* Added Custom band setting to SuperEQ to allow all 16 bands to be set from script. Usage: SuperEQ(clip,band1, band2, band3....) values are dB in float.
* Added fast 0-1-0 kernel for YV24 to ConvertBacktoYUY2().
* Added formats: YV24, YV16, Y8, YV411.

=== Bugfixes ===
* Fixed MonoToStereo with stereo sources.
* Fixed MergeChannels with only 1 input clip.
* Fixed support for negative height DIB format AVI's. (Oops still not quite right yet)
* Fixed Audio cache crashes.
* Fixed resize with YV411 missing code.
* Fixed ConditionalReader rounding with integer Interpolation.
* Fixed Softwire SSE2 bugs.
* Fixed SSSE3 CPU detection.
* Fixed SSSE3, SSE4.1 & SSE4.2 detection.
* Fixed Fastwire encoding of instructions that are >2 opcodes (SSSE3+4).
* Fixed _RPT5() macro for debug builds

=== Optimizations ===
* SuperEQ: Improve channel unpacking/packing code.
* H-Resize: Use SSE4.1 (movntdqa) loads for use once memory access.
* H-Resize: Added SSE2 horizontal unpacker.
* Resize: Use SSE3 (lddqu) loads for unaligned memory access.
* Added ultra fast vertical PointResizer (64 pixel/cycle).
* Added dynamic SSSE3 vertical resizer (16 pixel/cycle) ~ twice as fast as old MMX.
* Added dynamic SSE2 vertical resizer (16 pixel/cycle).
* Added dynamic MMX vertical resizer (8 pixel/cycle).
* Added SSSE3 version for RGB<->YV24 conversions.
* Added dynamic compiled MMX/iSSE for RGB<->YV24 conversions. Speed is approx 200% of C-code.

=== Changes ===
* ConditionalReader/WriteFile: Full refactor.
* SoftwireHelper: explicit hardware exception handling.
* Resize: Moved GetResampleFunction into Resamplefunction, to allow overrides.
* Resampler: Removed dead stlf code.
* Updated Soundtouch to 1.31 (2.5.8)
* Put dynamic matrix conversion into separate file.
* Moved chroma subsampling to image_type section.
* Added specific error reporting when requesting chromasubsampling with Y8.
* Split up merge and plane Swappers.
* Split up Plane transfers into separate classes.
* Added automatic destination colorspace detection on planar YtoUV.
* Took out greyscale and RGB32<->RGB24 from convert.cpp and placed them in separate files.
* All code assuming UVwidth = Ywidth/2 and similar should be gone.

[[Category:Changelist]]

Changelist 26

2014-01-04T17:53:55Z

Unreal666: /* Bugfixes */

== Changes from 2.6.0 Alpha 2 to 2.6.0 CVS ==

=== Additions ===
* DirectShowSource support non-standard pixel types "YV24" and "YV16".
* Info: Audio only clip now creates its own canvas video.
* AviSource: Include packed/padded processing and -ve biHeight logic for compressed input.
* Add Script Functions :- BitLRotate, BitRRotate, BitChange, BitClear, BitSet, BitTest and their asm aliases.
* Add WeaveRows (blit cost) and WeaveColumns (slow) frame combining filters.
* Add AudioDuration() [as float seconds], IsY8(), IsYV411() & PixelType() [as a string] script functions.
* Add Echo and Preroll filters.
* Add IScriptEnvironment::GetAVSLinkage() and DLLExport AVS_linkage for host usage of avisynth.dll.
* DirectShowSource, 2.6 plugin, support pixel types "AYUV" as YV24, "Y41P" and "Y411" as YV411.
* AviSource: Add Full and Auto pseudo pixel_types. Full is all supported. Auto is YV12, YUY2, RGB32, RGB24 & Y8.
* Add "AudioLengthS", "Ord" & "FillStr" script functions.
* Add AudioTrim(clip, float, float) audio priority trimming, args in fractional seconds.
* Add Trim(M, Length=N[, Pad=False]) and Trim(M, End=N[, Pad=False]) function overloads for explicit Trimming. Length=0 means zero frame clip. End=0 means end at frame 0.
* Add SeparateRows (zero cost) and SeparateColumns (slow) frame slashing filters.
* Add Script Functions :- Acos, Asin, Atan, Atan2, Cosh, Sinh, Tanh, Fmod, Log10, BitLShift, BitRShiftS, BitRShiftU and Hex.
* Add "ConditionalSelect","csc+[show]b" runtime filter.
* Add dither option to Levels, RGBAdjust & Tweak.
* Add BitAnd(), BitNot(), BitOr() & BitXor() script functions.
* Add StrCmp() & StrCmpI() script functions.
* Add YV24 support for Limiter show option.
* Add "Global OPT_dwChannelMask={int}"
* Add 0x0063F speaker mask for 7.1 WAVE_FORMAT_EXTENSIBLE.
* Add .dll DelayLoad exception texts to crash message formatter.
* ImageWriter, add support for printf formating of filename string, default is ("%06d.%s", n, ext);
* Add avs_get_error(AVS_ScriptEnvironment*); to avisynth_c interface.
* Catch and save AvisynthError text in more avisynth_c entry points, for kemuri-_9.
* Add ScriptName(), ScriptFile(), ScriptDir() functions (WarpEnterprises).
* Add SkewRows filter.
* Histogram, Levels mode, Improve colour of chroma legends.
* ConditionalFilter, teach about string results.
* Add some more "Add/Remove Software" registry keys to the Installer (XhmikosR).
* AviSource: Support both packed and DWORD padded raw planar input like with DSS.
* Add IScriptEnvironment::ApplyMessage()
* Add ImageSourceAnim (Wilbert)
* Support user upgrade to 178 DevIL.dll (They need to manage CRT dependancies).
* ImageSource: palette and compressed bmp images load correctly now (issue 894702) [need 178 DevIL.dll]
* ImageSource: support for other formats like: gif, exr, jp2, psd, hdr [need 178 DevIL.dll]
* Add YV24 mode to ColorBars.
* Add ColorBarsHD based on arib_std_b28.
* C-api usability enhancements from kemuri9 [Work in progress!]
* Add Undefined(), AudioLengthLo(), AudioLengthHi(), IsYV16() & IsYV24() script functions
* Allow newlines (and hence comments) before '{' -- Gavino
* Added IScriptEnvironment::DeleteScriptEnvironment()
* Added Histogram, population clamp % factor for "Levels" mode,
* Histogram, revert "Stereo" mode to YV12, Add "StereoY8" mode,
* AviSource: Support fourcc "GREY" as Y8
* Add "Global OPT_AVIPadScanlines=True" option for DWORD aligned planar padding

=== Bugfixes ===
* Fixed frame range clamping in ComparePlane (ultim).
* Fixed posible leak with realloc in ConditionalReader (ultim).
* Fixed posible double free in text-overlay (ultim).
* Fixed RGB32 to Y8 pixel right shift from 4th pixel on (Robert Martens).
* Fixed Overlay YV24 Image444 leak.
* Fixed AVISource "AUTO" and "FULL" handling.
* Fixed ImageSource handling of missing ebmp files.
* Fixed DirectShowSource incorrect byte order for unpacking of pixel type "AYUV".
* Fixed HexValue parsing values greater than 7FFFFFFF, now as unsigned hex.
* Fixed ConditionalReader memory overrun parsing bools.
* Fixed ResampleAudio NOP test to compare vi.num_audio_samples, not sample rate.
* Fixed YV24 -> RGB24 overrun cleanup for widths%16 == 5.
* Fixed RGB24 AddBorders with right=0.
* Fixed conditional_functions error message names (Wilbert).
* Fixed Audio cache ac_expected_next regression.
* Fixed ImageSource deal with add 1 to IL_NUM_IMAGES bug (Wilbert)
* Fixed Overlay YV24 V plane conversion.
* Fixed Overlay YV24 mode with shared input clip, needed a MakeWritable.
* Fixed ImageReader upside down TIFF in 178 DevIL. (Wilbert)
* Fixed SaveString 'string+string' bug when total length is 4096*K-1, K is +int.
* Fixed SincResize misuse of "int abs(int)" (Gavino). Fix Lanczos and Blackman sinc use of float == 0.0, use small limit "> 0.000001".
* Fixed Classic mode legend drawing for planar right limit and yuy2 centre line.
* Fixed possible MT race. Use "env->ManageCache(MC_IncVFBRefcount, ...)" in ProtectVFB.
* Fixed SwapYToUV output image size bug for 3 clip case.
* Fixed Crop limit tests for RGB.
* Fixed Overlay yellow tint on rec601 RGB import conversion.
* Fixed YtoUV() output image size bug for 3 clip case.
* Fixed ConvertToPlanar chroma alignment.
* Fixed Levels (RGB) change use of PixelClip(x) to min(max(x, 0), 255).
* Fixed SwapYtoUV yuy2 crash (StainlessS).
* Fixed Overlay saturate UV in add and subtract mode.
* Fixed Info.h range protect display characters (StainlessS).
* Fixed AviSource packed planar import chroma offsets.
* Fixed AviSource NULL GetWritePtr() failure due to premature setting of last_frame.
* Fixed Mask rounding in greyscale calcs (Wilbert), minor refactor.
* Fixed SelectRangeEvery audio snafu (Gavino).
* Fixed LoadPlugin, SaveString of result string.
* Fixed LoadPlugin, use _vsnprintf.
* Fixed LoadVirtualdubPlugin, don't add vdub filter to chain on load failure.
* Fixed rounding in RGB HResize (JoshyD) (affects all resizers)
* Fixed error message name in the filter VerticalReduceBy2
* Fixed SeparateFields() with variable parity input clip (Wilbert)
* Fixed AviSource, cannot cast__int64* to long*, it does not work!
* Fixed ConditionalReader: Don't allow out of range "Range" to overwrite edge values

=== Optimizations ===
* ConvertToPlanarGeneric explicit add Cache before chroma rescaler.
* Overlay minor refactor YV12 -> 444 chroma
* Speedup ConvertToMono(), minor refactor MixAudio().
* Change StackVertical/Horizontal to interative instead of recursive, 2^N performace increase for 3 and more clips, i.e. 1 blit total instead of blit(blit(blit(...
* RGBtoY8 Dynamic ASM code, suport for RGB24.
* YV24backtoYUY2 Dynamic ASM code.
* UtoY8, VtoY8 abuse subframe, zero cost.
* YV24<->RGB Add SSE2 and SSSE3 code paths, get rid of wide_enough.
* ConvertToYUY2 Add SSE2, MMX restore full speed on platforms with poor ooox.
* ConvertAudio, manage tempbuffer and floatbuffer independently.
* ConvertAudio, prefer SSE2 over 3DNow for super AMD cores.
* Info.h, full refactor, a good example of "Never look down", thx StainlessS
* DoubleWeaveFrames, If A not writable, try to write to B, else make new frame
* Histogram, fix GetFrame/NewVideoFrame call order
* HResizer, interleave code +4% faster
* YtoUV() Abuse Subframe to snatch the Y plane / UV planes, Derestrict destination colorformat autogeneration.
* ImageSource: Improve thread interlock code
* ConditionalReader/WriteFile: Full refactor.
* Replace _strdup with SaveString in AddFunction (Thanks Gavino)

=== Changes ===
* BlankClip: Supply useful defaults for new Audio/Video when using a Video/Audio only template clip.
* BlankClip: Use duration from Audio only template as default length for new clip.
* Define new IClip::SetCacheHints cachehint constants.
* Force int call arguments to user script function float params to be explicit floats.
* Splice pass CacheHints through to both children in + and ++ mode.
* WriteFileStart/End save current_frame and set Last.
* ConditionalReader do not ignore syntax errors in input file.
* ImageSourceAnim Pad/Crop images to match first frame (Wilbert)
* ImageSource Add version to messages (Wilbert)
* Initial 2.6 API entry point linkage.
* Use Invoke for graph tail, enhance non-clip output error reporting.
* PopContext when inner block Asserts/throws (maxxon).
* Remove duplicate definitions (Wilbert)
* Enhance non-clip output error reporting.
* Explicitly specify calling sequence as __cdecl for Avisynth softwire routines, (was the compiler default)
* Use env->Invoke("Cache", ...) everywhere instead of Cache::Create_Cache(), allows for Cache to be overloaded by a plugin.
* ConvertToYUY2 Change from 0-1-1 kernel to 1-2-1 kernel.
* Tweak make Interp same units as minSat and maxSat.
* Check HKEY_CURRENT_USER for PluginDir first. (henktiggelaar)
* Make forced, -ve, planar alignment of chroma planes match subsampling.
* Enforce planar alignment restrictions.
* C-api: Remove func sub-struct from AVS_Library struct
* Add error code to plugin load failure message
* Make default planar AVI output packed.
* WriteFile() now supports unlimited number of unlimited strings. (was 16 by 254 byte strings).
* ConvertToRGB*, make C++ code sample chroma the same as the MMX code i.e. use both pixels.
* ConvertToRGB*, use YV24 path for planar, complain when options are present for YUY2.
* ConvertToYUY2, use YV16 path for planar, complain when options are present for RGB
** see: http://forum.doom9.org/showthread.php?p=1378381#post1378381
* Thread safe code, part 2.
* Correct IClip baked documentation
* Fix at_exit executon order
* Passify compilation error/warnings (XhmikosR)
* for, const, extern and ansi patches for VC2008 (SEt)
* Disable OPT_RELS_LOGGING option
* Change implicit Last parsing for argless, bracketless calls to match bracketed cases. (Gavino) [not documented yet ???]
* DirectShowSource: Support last minute format renegotiation thru IPin::QueryAccept() & Validate the size of the provided directshow buffer.
* Remove non ascii chars from comments.
* Add core stubs for DirectShowSource, TCPServer & TCPSource, report when plugins are missing.
* Add note for original source downloads - SoundTouch
* Add more lineage history to Info()
* Move convertaudio, alignplanar, fillborder & MIN/MAX_INT definitions.
* Run AtExit before dismantling world.
* Change setcachehints definition from void to int. Test IClip version >= 5.
* Move PixelClip definition to avisynth.cpp
* SubTitle, etc, make X & Y options float (0.125 pixel granularity).
* ShowSMPTE() supports all integer FPS and multiplies of drop frame FPS.
* SubTitle, stop overwriting string constants (Gavino).
* SubTitle, improve pixel registration (Gavino).
* Make Info() CPU display hierarchical.
* Thread safe code, part 1.

== Changes from 2.5 series to 2.6.0 Alpha 2 ==

=== Additions ===
* Added support for argument passing and EAX return value to SoftwireHelper.
* Added "Global OPT_VDubPlanarHack=True" to flip YV24 and YV16 chroma planes for old VDub's.
* Added ContinuedDenominator/ContinuedNumerator(f[]i[limit]i) script functions.
* Tweak: fix MaskPointResizing + put back Dividee ISSE code (use sse=true, can't use all settings in that case).
* Added ChromaInPlacement, ChromaOutPlacement and ChromaResample options to planar colour conversions.
* Added MaskHS.
* Minor tweaks to get ready for VC8.
* Add Y8 for DevIL, planarize EBMP.
* Planar support for many filters.
* Added Info() time indicator on audio length and video (current frame & total). (2.5.8)
* Added UtoY8 and VtoY8.
* Added more info to Info(). (2.5.8)
* ColorYUV: Added all adjustment parameters as conditional variables "coloryuv_SETTING". Enable by setting conditional=true.
* ConditionalReader: Added support for type String.
* ConditionalReader: Added offset keyword to offset all frame numbers after the keyword.
* Added SincResize() with optional taps parameter (default is 4).
* Added Custom band setting to SuperEQ to allow all 16 bands to be set from script. Usage: SuperEQ(clip,band1, band2, band3....) values are dB in float.
* Added fast 0-1-0 kernel for YV24 to ConvertBacktoYUY2().
* Added formats: YV24, YV16, Y8, YV411.

=== Bugfixes ===
* Fixed MonoToStereo with stereo sources.
* Fixed MergeChannels with only 1 input clip.
* Fixed support for negative height DIB format AVI's. (Oops still not quite right yet)
* Fixed Audio cache crashes.
* Fixed resize with YV411 missing code.
* Fixed ConditionalReader rounding with integer Interpolation.
* Fixed Softwire SSE2 bugs.
* Fixed SSSE3 CPU detection.
* Fixed SSSE3, SSE4.1 & SSE4.2 detection.
* Fixed Fastwire encoding of instructions that are >2 opcodes (SSSE3+4).
* Fixed _RPT5() macro for debug builds

=== Optimizations ===
* SuperEQ: Improve channel unpacking/packing code.
* H-Resize: Use SSE4.1 (movntdqa) loads for use once memory access.
* H-Resize: Added SSE2 horizontal unpacker.
* Resize: Use SSE3 (lddqu) loads for unaligned memory access.
* Added ultra fast vertical PointResizer (64 pixel/cycle).
* Added dynamic SSSE3 vertical resizer (16 pixel/cycle) ~ twice as fast as old MMX.
* Added dynamic SSE2 vertical resizer (16 pixel/cycle).
* Added dynamic MMX vertical resizer (8 pixel/cycle).
* Added SSSE3 version for RGB<->YV24 conversions.
* Added dynamic compiled MMX/iSSE for RGB<->YV24 conversions. Speed is approx 200% of C-code.

=== Changes ===
* ConditionalReader/WriteFile: Full refactor.
* SoftwireHelper: explicit hardware exception handling.
* Resize: Moved GetResampleFunction into Resamplefunction, to allow overrides.
* Resampler: Removed dead stlf code.
* Updated Soundtouch to 1.31 (2.5.8)
* Put dynamic matrix conversion into separate file.
* Moved chroma subsampling to image_type section.
* Added specific error reporting when requesting chromasubsampling with Y8.
* Split up merge and plane Swappers.
* Split up Plane transfers into separate classes.
* Added automatic destination colorspace detection on planar YtoUV.
* Took out greyscale and RGB32<->RGB24 from convert.cpp and placed them in separate files.
* All code assuming UVwidth = Ywidth/2 and similar should be gone.

[[Category:Changelist]]

External filters

2013-08-06T03:22:48Z

Unreal666: Add ExInpaint plugin

Rough classification of filters (in progress).

To make it easier for people to to find what they need here, the list includes both script function filters (see [[Import]]) and plugin filters (see [[Plugins]]).

A list of older plugins (for AviSynth v1.0x/v2.0x) which are still sometimes used can be found [[External_plugins_old|here]].

A large list of filters can be downloaded [http://www.64k.it/andres/dettaglio.php?sez=avisynth here] and [http://www.avisynth.nl/users/warpenterprises/ Warp Enterprises Avisynth Filter Collection]

A list of 64bit compiles can be found [http://yo4kazu.110mb.com/ here] and [http://code.google.com/p/avisynth64/wiki/PluginLinks here].

Most scripts will apply filters in the following order:

# Create an AviSynth clip from a video file.
# Correct or remove any unwanted features in the video (e.g. dot crawl, field blending or telecine).
# Denoise the video (optional).
# Manipulate the video into the desired format (by e.g. changing the size and frame rate).

AviSynth filters have been classified under these four basic tasks, with a fifth category for filters that fall outside this scheme, and a sixth category for filters that process audio only.

== Source Filters ==

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?t=135855 BassAudio]
| [http://un4seen.com/bass.html Bass Audio] decoder. Supports wav, aiff, mp3, mp2, mp1, ogg. Support for aac, ac3, alac, ape, cd, flac, midi, mpc, ofr, spx, tta, wma, wv with additional included dll's. The filter is included in the Behappy package.
| N/A
| [http://behappy.codeplex.com/ Plugin] [http://yo4kazu.110mb.com/ x64]
|-
| [http://www.gyroshot.com/cmvsource.htm CMVSource]
| Load [http://www.bay12games.com/dwarves/ Dwarf Fortress] CMV and CCMV movies.
| [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=162850 Plugin]
| {{Author/Robert Martens}}
|-
| [http://forum.doom9.org/showthread.php?t=122598 DGAVCDecode]
| AVC/H.264 decoder plug-in.
| [[YV12]]
| [http://www.videohelp.com/tools/DGAVCDec Plugin]
| {{Author/Donald Graft}}
|-
| [[DGDecode]]
| Decode MPEG1/MPEG2 streams from: DVD VOBs, captured transport streams, *.mpg/*.m2v/*.pva files, etc. Use this instead of MPEGDecoder/MPEG2Dec3.
| [[YV12]], [[YUY2]], [[RGB24]], [[I420]]
| [http://neuron2.net/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
| [http://forum.doom9.org/showthread.php?t=134275 DirectShowSource2]
| Uses the installed Haali Media Splitter along with its ''avss.dll'' AviSynth plugin. Converts vfr files to cfr in order to support frame-accurate seeking.
|
| [http://haali.cs.msu.ru/mkv/ Plugin]
|-
| [[DVInfo]]
| Grabs the timestamp and recording date info from a DV-AVI. See [http://forum.doom9.org/showthread.php?t=61688 discussion].
| N/A
| [http://www.avisynth.nl/users/warpenterprises/files/#dvinfo Plugin]
| {{Author/WarpEnterprises}}
|-
| [[DVTimeStampEx]]
| Shows DV timestamp information over a DV clip.
| N/A
| [http://www.avisynth.nl/users/warpenterprises/files/#dvtimestampex Plugin]
|-
| [[FFmpegSource]]
| Decodes all ffmpeg ([http://en.wikipedia.org/wiki/Libavcodec libavcodec]) supported A/V formats with frame accurate seeking in AVI, MKV and MP4. See [http://forum.doom9.org/showthread.php?t=127037 discussion].
| [[RGB]], [[YUY2]], [[YV12]], [[I420]]
| [http://code.google.com/p/ffmpegsource Plugin]
| {{Author/Myrsloik}}, TheFluff, Plorkyeran, others
|-
| [http://forum.doom9.org/showthread.php?t=110021 HDVInfo]
| Grabs the timestamp and recording date info out of a M2T-D2V file
| N/A
| [http://strony.aster.pl/paviko/hdvinfo0.93.zip Plugin]
|-
| [http://forum.doom9.org/showthread.php?t=109997 ImageSequence]
| Load png, jpg, bmp, pcx, tga and gif image sequences using the [http://corona.sourceforge.net/ Corona Image I/O Library]. CoronaSequence/RawSequence.
| [[RGB32]]
| [http://www.avisynth.nl/users/warpenterprises/#imagesequence Plugin]
|-
| [http://forum.doom9.org/showthread.php?t=135928 Immaavs]
| ImmaRead uses the ImageMagick libraries to read images. Many formats are supported including animations, multipage files, image sequences and images with different sizes.
|
| [http://www.wilbertdijkhof.com/ Plugin]
| {{Author/Wilbert Dijkhof}}
|-
| [[IUF]]
| Import Uncompressed File. Must be uncompressed! Supported uncompressed Formats: avi, omf(avid), pxr(pixar), mov(24/32bit quicktime), cineon. Can export as well. See [http://forum.doom9.org/showthread.php?t=51227 discussion].
| [[RGB]]
| [http://web.archive.org/web/20091016215740/http://geocities.com/hanfrunz/iuf_v1.5.zip Plugin]
|-
| [[MPASource]]
| A mp1/mp2/mp3 audio decoder plugin. See [http://forum.doom9.org/showthread.php?t=41435 discussion]
| N/A
| [http://www.avisynth.nl/users/warpenterprises/#mpasource Plugin]
| {{Author/WarpEnterprises}}
|-
| [[MPEGDecoder]]
| Load VOB/MPEG-2 ES,PS,TS/MPEG-1 files directly. (deprecated)
| [[YV12]]
| Plugin
|-
| [[MPEG2Dec]]
| Mpeg2dec is a plugin which lets AviSynth import MPEG2 files. (deprecated)
| [[RGB]], [[YUY2]]
| [http://www.avisynth.nl/users/warpenterprises/ Plugin]
| {{Author/Dividee}} and others
|-
| [[MPEG2Dec3]]
| A MPEG2Dec2.dll modification with deblocking and deringing. Note that the colorspace information of dvd2avi is ignored when using mpeg2dec. See [http://forum.doom9.org/showthread.php?s=&threadid=53164 discussion]. (deprecated)
| [[RGB]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/ Plugin]
| {{Author/Marc FD}}, {{Author/Nic}}, {{Author/Tom Barry}}, {{Author/Sh0dan}} and others
|-
| [http://www.codeplex.com/NicAudio NicAudio]
| Audio Plugins for Audio: MPEGAudio/AC3/DTS/LPCM and other uncompressed formats. Formerly known As EvilMPASource. See [http://forum.doom9.org/showthread.php?s=&threadid=89629 discussion].
| N/A
| [http://www.codeplex.com/NicAudio/Release/ProjectReleases.aspx Plugin]
| {{Author/Nic}}
|-
| [http://forum.doom9.org/showthread.php?t=103931 OmfSource]
| Opens the AVID OMF file format (video only, and only works with captured files). See [http://forum.doom9.org/showthread.php?t=103931 discussion].
| [[YUY2]], [[YV12]]
| [http://www.tateu.net/software/ Plugin]
| {{Author/tateu}}
|-
| [[QTSource]]
| Quicktime Import/Export Filter using an existing installation of Quicktime 6/7. See [http://forum.doom9.org/showthread.php?t=104293 discussion].
| [[RGB32]], [[RGB24]], [[YUY2]]
| [http://www.tateu.net/software/ Plugin]
| {{Author/tateu}}
|-
| [http://web.archive.org/web/20120124010957/http://arenafilm.hu/alsog/avisynthr3d/ R3DSource]
| Redcode RAW source plugin to load R3D clips. See [http://reduser.net/forum/showthread.php?25398 discussion].
| [[RGB32]]
| [http://arenafilm.hu/alsog/avisynthr3d/ Plugin]
| {{Author/Kertai Gábor}}
|-
| [[RawSource]]
| Loads raw video data directly from files. See the initial [http://forum.doom9.org/showthread.php?t=39798 discussion] and its [http://forum.doom9.org/showthread.php?t=103509 continuation].
| [[RGB]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/#rawsource Plugin] [https://sites.google.com/site/csghone/audio-video-tools/rawsource_25_dll_20122327.zip Updated with NV12 Support]
| {{Author/WarpEnterprises}}, {{Author/Wilbert Dijkhof}} and {{Author/Sh0dan}}
|-
| [[RawSourceMod]]
| Loads raw video data directly from files. Further modifications (most raw formats, YUV4MPEG2 compatible with latest spec) [http://forum.doom9.org/showthread.php?t=39798 discussion].
| [[RGB]], [[YUY2]], [[YV12]] (for 2.5/2.6), [[YV24]], [[YV16]], [[YV411]], [[Y8]] (for 2.6)
| [http://www.mediafire.com/?3bmwyi1lztt4h1j 2.5 plugin] [http://www.mediafire.com/?a6e6bqxbmrt9uge 2.6 plugin]
[http://www.microsoft.com/download/en/details.aspx?id=8328 msvcr100.dll]
| Chikuzen
|-
| [http://forum.doom9.org/showthread.php?p=1403600 Sashimi]
(function "RawReader")
| Loads raw video data directly from files, similarly to RawSource, but also allows for skipping headers, and extra formats (long list to help anyone doing a search): GREY, Y8, interleaved RGB, BGR (which is RGB24), BGRA (which is RGB32), ARBG, ABGR, RGBA, interleaved YUV (which is YCbCr), YUY2, UYVY, AYUV, planar YUV formats YUV444, YUV422, YUV420 (as YV12), YUV420 (as IMC2), and some raw ImageMagick formats. Some supports for different bit-depths. Includes YUVInterleaved.avsi, InterleavedConversions.avsi, and PlanarConversions.avsi. [http://forum.doom9.org/showthread.php?p=1403600 Discussion].
| [[RGB]], [[YUY2]], and [[YV12]].
| [http://sites.google.com/site/ourenthusiasmsasham/soft Plugin with scripts]
| [http://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|}

== Restoration Filters ==

These remove effects or artefacts introduced (deliberately or accidentally) into the source video. Denoisers are classified separately.

=== Anti-[[aliasing]] ===

{{FilterTable}}
| [[AAA]]
| Anti-aliasing filter designed for anime. See [http://forum.doom9.org/showthread.php?t=83396 discussion].
| [[YV12]]
| Script
| {{Author/Soulhunter}}
|-
| [[AntiAliasing]]
| Anti-aliasing script for, well, anti-aliasing. See [http://forum.doom9.org/showthread.php?t=83396 discussion].
| [[YV12]]
| Script
| {{Author/SpikeSpiegel}}, {{Author/Didée}}, {{Author/mf}}, {{Author/scharfis brain}} and {{Author/Soulhunter}}
|-
| [[AntiAliasRG]]
| An anti-aliasing script that uses RemoveGrain(SSE3).dll. See [http://forum.doom9.org/showthread.php?t=83396&page=4 discussion].
| [[YV12]]
| Script
| Bloax
|-
| [[DAA]]
| Anti-aliasing with contra-sharpening. Included in [[AnimeIVTC]].
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| [[FAA]]
| Faster Anti-aliasing. See [http://forum.doom9.org/showthread.php?t=83396&page=4].
| [[YV12]]
| Script
| list
|-
| [[MAA]]
| Anti-aliasing with edge masking. Included in [[AnimeIVTC]].
| [[YV12]]
| Script
| martino, Kintaro, thetoof
|-
| [[SangNom]]
| A single field deinterlacer, can also be used for anti-aliasing. See [http://forum.doom9.org/showthread.php?t=69052 discussion].
| [[YV12]]
| [http://manao4.free.fr/SangNom.zip Plugin]
| {{Author/Marc FD}}
|-
| [[SAA]]
| A simple anti-aliasing script. See [http://forum.doom9.org/showthread.php?t=83396 discussion].
| [[YV12]]
| Script
| {{Author/Soulhunter}}
|-
| SharpAAMCmod
| High quality MoComped AntiAliasing script, also a line darkener since it uses edge masking to apply tweakable warp sharpening, "normal" sharpening and line darkening with optional temporal stabilization of these edges. Part of [[AnimeIVTC]]. See [http://forum.doom9.org/showthread.php?t=138305] and [http://forum.doom9.org/showthread.php?t=140031]
|
| Script
| thetoof
|-
| [[TIsophote]]
| A level-set (isophote) smoothing filter, see [http://web.missouri.edu/~kes25c/]
| YV12
| Plugin
| {{Author/tritical}}
|}

=== Chroma correction ===

{{FilterTable}}
| [[BT709ToBT601]]
| Convert from BT.709 (HDTV) to BT.601 (SDTV) colorimetry.
| [[YV12]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [[ChromaShift]]
| This filter will shift the chrominance information by an even number of pixels, in either horizontal direction. It can also apply an overall vertical shift of the total chrominance information, up or down. It is primarily intended to correct improper colour registration.
| [[YV12]], [[YUY2]], [[RGB]]
| [http://www.geocities.com/siwalters_uk/chromashift27.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChromaShiftSP]]
| This script can shift chroma in all directions with subpixel accuracy.
|
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
|-
| [[ColorMatrix]]
| ColorMatrix corrects the colors of MPEG-2 streams. More correctly, many MPEG-2 streams use slightly different coefficients (called Rec.709) for storing the color information than AviSynth's color conversion routines or the XviD/DivX decoders (called Rec.601) do, with the result that DivX/XviD clips or MPEG-2 clips encoded by TMPGEnc/QuEnc are displayed with slighty off colors. This can be checked by opening the MPEG-2 stream directly in VDubMod. See [http://forum.doom9.org/showthread.php?t=82217 discussion].
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/ColorMatrixv25.zip Plugin]
| {{Author/Wilbert Dijkhof}}
{{Author/tritical}} (v2.0+)
|-
| [[FixChromaBleeding]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas.
| [[YV12]]
| [http://web.archive.org/web/20091026141730/http://www.geocities.com/alex_j_jordan/chroma.txt Script]
| {{Author/Alex Jordan}}
|-
| [[ReInterpolate411]]
| This is a fast simple filter to correct the improper 4:1:1 => 4:2:2 conversion that seems to occur with some DV/4:1:1 codes when used with Avisynth. It assumes the odd chroma pixels are duplicates and discards them replacing them with the average of the two horizontally adjacent even chroma pixels. It doesn't matter whether the clip is interlaced though it must be in YUY2 format for Avisynth 2.5. There are no parameters, and currently no readme file.
| [[YUY2]]
| Plugin
| {{Author/Tom Barry}}
|-
| [[ReInterpolate420]]
| Usually, DV decoders upsample PAL DV (which is YV12) to YUY2 using point sampling. This plugin reinterpolates the original chroma samples.
| [[YUY2]]
| [http://avisynth.org.ru/reinterpolate420/reinterpolate420_v3.zip Plugin]
| {{Author/Wilbert Dijkhof}}
{{Author/Fizick}} (v3)
|-
| [[MoveChroma]]
| MoveChroma is a simple filter combination that helps in moving chroma back, if it has been displaced.
|
| Script
|
|-
| [[FixChromaticAberration]]
| FixChromaticAberration resizes (and crops) the red/green/blue channels of the image separately. This helps to minimize the colored edges next to the image corners that result from lenses with chromatic aberration.
|
| Script
|
|}

=== Debanding ===

{{FilterTable}}
| AdaptDBMC
| Luma / Fade / Blue adaptive debanding script.
| [[YV12]]
| [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=512 Script]
| {{Author/06_taro}}
|-
| [http://forum.doom9.org/showthread.php?t=108681 GradFun2DB]
| DeBanding Filter. See [http://en.wikipedia.org/wiki/Color_banding wikipedia:Color Banding]
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://web.archive.org/web/20080905123941/http://soulhunter.chronocrossdev.com/data/gradfun2db.zip Plugin]
| Prunedtree
|-
| GradFunkMirror
| Script that fixes GradFun2DB's bug that leaves the first 16 pixels on every border unprocessed. Needs [http://forum.doom9.org/showthread.php?t=108681 GradFun2DB] !
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://avisynth.nl/images/GradFunkMirror.avsi Script]
| Alain2, MugFunky
|-
| [[GradFun2DBmod]]
| An advanced debanding script based on GradFun2DB.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144537 Script]
| {{Author/LaTo}}
|-
| GradFun3
| This debanding script, part of the [[External_filters#Deepcolor_Filters|Dither]] package, has several gradient smoothing algorithms, including a bilateral filter. It uses an ordered dithering, which has a good resilience to lossy compression.
| [[YV12]], [[YV16]], [[YV24]], [[Y8]], [[YV411]]
| [http://forum.doom9.org/showthread.php?p=1386559 Script]
| {{Author/cretindesalpes}}
|-
| flash3kyuu_deband
| Fast debanding plugin ported from AviUtl.
| [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[Y8]], [[YV411]]
| [http://forum.doom9.org/showthread.php?t=161411 Plugin]
| SAPikachu
|-
| LumaDB
| Fast debanding filter with luma-adaptive grain and mask. Used to process luma only. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=668 discussion.]
| [[YV12]]
| [http://www.nmm-hd.org/upload/get~3YK_B5TfcyI/LumaDB-0.7.rar Script]
| {{Author/06_taro}}
|-
| LumaDBL
| Fast debanding filter with luma-adaptive grain and mask. Used to process luma only. Works in 16-bit internally and can also input/output 16-bit. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=668 discussion.]
| [[YV12]]
| [http://www.nmm-hd.org/upload/get~mQYIS9H6Qas/LumaDBL-0.7.rar Script]
| {{Author/06_taro}}
|}

=== Deblocking ===

{{FilterTable}}
| [[BlockKiller]]
| Deblocking filter, see [http://forum.doom9.org/showthread.php?t=153589].
| [[YV12]], [[YUY2]]
| Script
| Jawed
|-
| [[BlockTerminator]]
| Deblocking filter, see [http://forum.doom9.org/showthread.php?t=111483&page=2].
| [[YV12]], [[YUY2]]
| Script
| {{Author/foxyshadis}}
|-
| [[DeBlock]]
| Deblocking filter, see [http://avisynth.org.ru/mvtools/deblock.html], [http://neuron2.net/dgmpgdec/DGDecodeManual.html#DeBlock]
| [[YV12]], [[YUY2]]
| Plugin
| {{Author/Fizick}} / {{Author/Manao}}
|-
| [[Deblock_QED]]
| "A postprocessed Deblock(): Uses full frequencies of Deblock's changes on block borders, but DCT-lowpassed changes on block interiours." Didée See [http://forum.doom9.org/showthread.php?p=944459]
| [[YV12]]
| [http://avisynth.nl/images/Deblock_QED_MT2.avs Script]
| {{Author/Didée}}
|-
| [[FunkyDeBlock]]
| Deblocking script based on [[DGDecode/BlindPP|BlindPP]] and high/lowpass separation. See [http://forum.doom9.org/showthread.php?t=72431 discussion].
| [[YV12]]
| Script
| Mug Funky
|-
| [[MDeblock]]
| Plugin for removing block artifacts, see [http://home.arcor.de/kassandro/MDeblock/MDeblock.htm homepage.]
| [[YV12]]
| [http://home.arcor.de/kassandro/MDeblock/MDeblock.zip Plugin]
| {{Author/kassandro}}
|-
| [[SmoothD]]
| Filter to deblock frames while keeping high frequency detail. See [http://forum.doom9.org/showthread.php?s=&postid=566064 discussion].
| [[YV12]]
| [http://www.funknmary.de/bergdichter/projekte/video/SmoothD Plugin]
| Tobias Bergmann
|-
| [[SmoothD2]]
| Deblocking filter. Rewrite of SmoothD. Faster, better detail preservation, optional chroma deblocking. See [http://forum.doom9.org/showthread.php?t=164800 discussion].
| [[YV12]]
| [https://sites.google.com/site/jconklin754smoothd2/home Plugin]
| Jim Conklin
|-
| [[SmoothDeblock3]]
| Slow and complex, but produces very good results - especially on severely blocky sources - in a similar manner to TempGaussMC and QTGMC. See [http://forum.doom9.org/showthread.php?t=111526 discussion] and an [http://forum.doom9.org/showthread.php?p=945261#post945261 overall comment].
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1553458#post1553458 Script]
| redfordxx
|}

=== Dehaloing ===

{{FilterTable}}
| [[abcxyz]]
| Filter to remove halos. See [http://forum.doom9.org/showthread.php?t=144982 discussion].
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| [[BlindDeHalo]]
| Filter to remove edge enhancement artefacts. See [http://forum.doom9.org/showthread.php?threadid=74003 discussion].
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| [[BlindDeHalo2]]
| Filter to remove edge enhancement artefacts. See [http://forum.doom9.org/showthread.php?p=579853#post579853 discussion].
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| [[BlindDeHalo3]]
| Filter to remove edge enhancement artefacts. See [http://forum.doom9.org/showthread.php?p=622289#post622289 discussion].
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| [[DeHalo_alpha]]
| Very powerful filter to remove edge enhancement artefacts. See [http://forum.doom9.org/showthread.php?p=777956#post777956 discussion].
| [[YV12]]
| [http://avisynth.nl/images/DeHalo_alpha.avsi Script]
| {{Author/Didée}}
|-
| Mask_DHA
| A combination of the best of DeHalo_alpha and BlindDeHalo3, plus a few minor tweaks to the masking. See [http://forum.doom9.org/showthread.php?t=148498 discussion].
| [[YV12]]
| Script
| 'Orum
|-
| [[YAHR]]
| Basic filter with no variables to remove edge enhancement artefacts. See [http://forum.doom9.org/showthread.php?p=1205653#post1205653]
| [[YV12]]
| [http://avisynth.nl/images/YAHR.avsi Script]
| {{Author/Didée}}
|}

=== Deringing & Mosquito Noise ===

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?p=636297#post636297 BlindDeRing]
| Deringing filter.
| [[YV12]]
| [http://chaosking.de/wp-content/uploads/avsfilters/Restoration_Filters/Deringing/BlindDeRing___(2005).7z Plugin]
| krieger2005
|-
| [[HQDering]]
| Applies deringing by using a smart smoother near edges (where ringing occurs) only. See [http://forum.doom9.org/showthread.php?p=1043583#post1043583 here] and [http://forum.doom9.org/showthread.php?s=&threadid=67532 here] for details.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=793930#post793930 Script]
| {{Author/mf}}
|-
| [http://forum.doom9.org/showthread.php?t=167582 MosquitoNR]
| A noise reduction filter designed for mosquito noise, which is often caused by lossy compression.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]], [[YUY2]]
| [http://www.geocities.jp/w_bean17/index.html Plugin]
| {{Author/b_inary}}
|}

=== Deinterlacing ===

{{FilterTable}}
| [[Area]]
| A port of Gunnar Thalin's VirtualDub filter "Deinterlace - area based" to AviSynth.
| [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/ Plugin]
| {{Author/Donald Graft}} // {{Author/Gunnar Thalin}}
|-
| [[BlendBob]]
| Filter designed for use after a smart bob; blends every other frame with the closest matching neighbouring frame. See [http://forum.doom9.org/showthread.php?threadid=80289 discussion].
| [[YV12]]
| [http://leak.no-ip.org/AviSynth/BlendBob/ Plugin]
| {{Author/Leak}}
|-
| [[DGBob]]
| This filter splits each field of the source into its own frame and then adaptively creates the missing lines either by interpolating the current field or by using the previous field's data. See [http://forum.doom9.org/showthread.php?s=&threadid=55598 discussion].
| [[RGB]], [[YV12]], [[YUY2]]
| [http://neuron2.net/dgbob/dgbob.html Plugin]
| {{Author/Donald Graft}}
|-
| [[Decomb]]
| The [[Decomb/FieldDeinterlace|FieldDeinterlace]] filter provides functionality similar to the postprocessing function of [[Decomb/Telecide|Telecide]]. You can use it for pure interlaced streams (that is, those not containing telecined progressive frames). The name refers to the fact that field mode differencing is used.
| [[YV12]], [[YUY2]]
| [http://neuron2.net/decomb/decombnew.html Plugin]
| {{Author/Donald Graft}}
|-
| [[GreedyHMA]]
| GreedyHMA is an Avisynth filter that executes DScaler's Greedy/HM algorithm code to perform pulldown matching, filtering, and video deinterlace. It has pretty much been superceded by Donald Graft's [[Decomb]] package. However there may be occasions where it sometimes gives preferable results, especially with some bad [[PAL]] clips.
| [[YUY2]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [[IBob]]
| Interpolating Bob works identically to the Avisynth built-in [[Bob]] filter except that it uses linear interpolation instead of bicubic resizing. See [http://forum.doom9.org/showthread.php?s=&threadid=62142 discussion].
| [[YV12]], [[YUY2]]
| [http://kevin.atkinson.dhs.org/ibob/ Plugin]
| {{Author/Kevin Atkinson}}
|-
| [[KernelDeint]]
| This filter deinterlaces using a kernel approach. It gives greatly improved vertical resolution in deinterlaced areas compared to simple field discarding. Superceded by [[LeakKernelDeint]], see the description below in this table.
| [[RGB]], [[YV12]], [[YUY2]]
| [http://neuron2.net/kerneldeint/kerneldeint.html Plugin]
| {{Author/Donald Graft}}
|-
| [[LeakKernelBob]]
| This filter does a full framerate deinterlacing, i.e. it turn 50 fields per second into 50 frames per second. Adapted from Scharfis_brain's script of the same name.
| [[RGB32]], [[YV12]], [[YUY2]]
| [http://leak.no-ip.org/AviSynth/LeakKernelDeint/ Plugin]
| {{Author/Leak}}
|-
| [[LeakKernelDeint]]
| This filter deinterlaces using a kernel approach. It gives greatly improved vertical resolution in deinterlaced areas compared to simple field discarding. Compared to [[KernelDeint]], it is low-level optimized (for speed) and provides some useful new functionality. As the original author of KernelDeint() states, LeakKernelDeint() is the preferred version to use.
| [[RGB32]], [[YV12]], [[YUY2]]
| [http://leak.no-ip.org/AviSynth/LeakKernelDeint/ Plugin]
| {{Author/Leak}}
|-
| [[MCBob]]
| Another approach to motion compensated bobbing. No residual combing, Motion Masking adaptive to local complexity, self adaptive error correction for temporal interpolation, Motion Search between fields of same parity, and spatial Interpolation overweights spatio-temporal interpolation. Is SLOW.

* MCBob + EEDI2 [http://forum.doom9.org/showthread.php?t=124676#post988224]
* MCBob + NNEDI [http://forum.doom9.org/showthread.php?t=129953#post1055263]
|
| Script
| {{Author/Didée}}
|-
| [[MVBob]]
| by scharfis_brain [http://forum.doom9.org/showthread.php?t=84725]
|
| Script
| scharfis_brain
|-
| [[QTGMC]]
| by -Vit- [http://forum.doom9.org/showthread.php?t=156028] A new deinterlacer based on TempGaussMC_beta2. It's faster and has a presets system for speed/quality selection. There are also several new features including progressive support and noise/grain processing. The script also contains extensive comments to better describe the settings and the workings of the TGMC algorithm.
|
| [http://www.mediafire.com/download.php?vx4my32a9fqz8q9 Script]
| -Vit-
|-
| Securebob
| type=2 or type=3. (part of MVbob) [http://web.archive.org/web/20080924163957/http://home.arcor.de/scharfis_brain/mvbob/]
|
| Script
| scharfis_brain
|-
| SecureDeint
| (part of MVbob) [http://web.archive.org/web/20080924163957/http://home.arcor.de/scharfis_brain/mvbob/]
|
| Script (?)
| scharfis_brain
|-
| SmoothDeinterlace
| by Gunnar Thalin [http://www.guthspot.se/video/AVSPorts/SmoothDeinterlacer/]
|
| Plugin
| {{Author/Gunnar Thalin}}
|-
| [[TDeint]]
| TDeint is a bi-directionally, motion adaptive (sharp) deinterlacer. It can also adaptively choose between using per-field and per-pixel motion adaptivity. It can use cubic interpolation, kernel interpolation (with temporal direction switching), or one of two forms of modified ELA interpolation which help to reduce "jaggy" edges in moving areas where interpolation must be used. TDeint also supports user overrides through an input file, and can act as a smart bobber or same frame rate deinterlacer, as well as an IVTC post-processor. See [http://forum.doom9.org/showthread.php?s=&threadid=82264 discussion].
| [[YUY2]], [[YV12]]
| [http://bengal.missouri.edu/~kes25c/TDeintv11.zip Plugin]
| {{Author/tritical}}
|-
| [[Telecide Hints]]
| The filter process the stats file to get the usual progressive matches and identify VFR sections.
|
| Plugin
|
|-
| [[TempGaussMC]]
| Motion-compensated bob deinterlacer, based on temporal gaussian blurring. reduces noise/grain of the source and does NOT leave the original fields unchanged. Output is rich with details and very stable. Is SLOW
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20100903072408/http://home.arcor.de/dhanselmann/_stuff/ Script]
| {{Author/Didée}}
|-
| [[TomsMoComp]]
| This filter uses motion compensation and adaptive processing to deinterlace video source (not for NTSC film). See [http://forum.doom9.org/showthread.php?s=&threadid=37915 discussion].
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [[Yadif]]
| Port of YADIF (Yet Another DeInterlacing Filter) from MPlayer by Michael Niedermayer (http://www.mplayerhq.hu). It check pixels of previous, current and next frames to re-create the missed field by some local adaptive method (edge-directed interpolation) and uses spatial check to prevent most artifacts.
| [[YUY2]], [[YV12]]
| [http://avisynth.org.ru/yadif/yadif.html Plugin]
| {{Author/Fizick}}
|-
| [[Yadifmod]]
| Modified version of Fizick's avisynth filter port of yadif from mplayer. This version doesn't internally generate spatial predictions, but takes them from an external clip. It also is not an Avisynth_C plugin (just a normal one).
| [[YUY2]], [[YV12]]
| [http://bengal.missouri.edu/~kes25c/yadifmod_v1.zip Plugin]
| {{Author/tritical}}
|-
| [[TomsBob]]
| We've asked Tom to include a proper 60fps deinterlacer in his wonderful TomsMoComp, but until then you'll have to make do with TomsBob.
|
| Script
|
|}

=== Fieldblending and Frameblending removal ===

{{FilterTable}}
| [[c_deblend]] superseded by [[srestore]]
| Cdeblend is a simple blend replacing function like unblend or removeblend.
|
| Script
| MOmonster
|-
| [[Deblend]]
| See [http://forum.doom9.org/showthread.php?p=760375#post760375 discussion].
|
| Script
| actionman133
|-
| [http://forum.doom9.org/showthread.php?t=157337 ExBlend]
| ExBlend is a plugin to repair damage caused by blend deinterlacing of telecined clips, which results in a double blend, every five frames, GGGBBGGGBBGGGBB etc where 'G' is good and 'B' is blend. See [http://forum.doom9.org/showthread.php?t=157337 discussion]
| [[YV12]], [[YUY2]]
| [http://www.mediafire.com/download/0rxe3675sfr4w9l/ExBlend_25_dll_20100226.zip Plugin]
| StainlessS
|-
| [[mrestore]] superseded by [[srestore]]
| Uses conditional frame evaluation to undo standard conversions with blends.
| [[YV12]]
| Script
| MOmonster
|-
| [http://bossanovaguitar.com/video/RemoveBlend-0.3.html RemoveBlend]
| This filter is used to remove blended fields/frames. See [http://forum.doom9.org/showthread.php?t=75772 discussion.]
| [[YV12]]
| [http://bossanovaguitar.com/video/removeblend-0.3.zip Plugin]
| {{Author/violao}}
|-
| [[Restore24]]
| Restore24 is an AviSynth filter that is able to do the nearly impossible: Restore 24fps FILM out of a fieldblended FILM -> Telecine -> NTSC -> Blendconversion -> PAL - Video. See [http://forum.doom9.org/showthread.php?s=&threadid=75432 discussion].
|
| Script
| scharfis_brain
|-
| [[RestoreFPS]]
| RestoreFPS reverses the kind of blending generated by [[ConvertFPS]], restoring original framerate. It will work perfectly well on any regular blend pattern.
| [[YV12]]
| Plugin
| {{Author/mg262}}
|-
| Specials
| Helps restore video with blended fields/frames using a reference source. See [http://forum.doom9.org/showthread.php?t=165030 discussion]
| [[YV12]]
| [http://horman.net/specials.zip Plugin]
| {{Author/David Horman}}
|-
| [[Unblend]]
| Unblend is based on warpenterprise's deblend algorithm and neuron2's decimate code, with YV12 support only. The aim is the same of deblend. See [http://forum.doom9.org/showthread.php?t=55019 discussion].
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/unblend_5F25_dll_2003.zip Plugin]
| Bach
|-
| [[FixBlendIVTC]] superseded by [[srestore]]
| A blend replacing/frame restoring function for doubleblends caused by blend-deinterlacing of telecined sources.
| ?
| Script
| MOmonster
|-
| [[Cdeint]]
| Restores 24fps FILM out of a fieldblended FILM -> Telecine -> NTSC -> Blendconversion -> PAL - Video (alternative for Restore24).
|
| Script
|
|}

=== Film Damage correction ===

{{FilterTable}}
| [[DeScratch]]
| DeScratch removes vertical scratches from films. Also it can be used for removing of horizontal noise lines such as drop-outs from analog VHS captures (after image rotation).
| [[YV12]]
| [http://avisynth.org.ru/descratch/descratch.html Plugin]
| {{Author/Fizick}}
|-
| [[DeSpot]]
| This filter is designed to remove temporal noise in the form of dots (spots) and streaks found in some videos. The filter is also useful for restoration (cleaning) of old telecined 8mm (and other) films from spots (from dust) and some stripes (scratches).
| [[YV12]]
| [http://avisynth.org.ru/despot/despot.html Plugin]
| {{Author/Fizick}}
|-
| [[deVCR]]
| deVCR elliminates (to a certain degree) the annoying horizontal lines that keep crawling around your VHS or Beta recorded video.
|
| Script
| Ricardo Garcia
|-
| Film_Restoring_Frame_Blending
|
|
| Script
| videoFred
|-
| Film_Restoring_Frame_Interpolation
|
|
| Script
| videoFred
|-
| [[RemoveDirt]]
| RemoveDirt is a temporal cleaner for Avisynth 2.5x. It has now become an AVS script function, which involves RestoreMotionBlocks and various filters from the [[RemoveGrain]] package.
| [[YV12]], [[YUY2]]
| Script
| {{Author/kassandro}}
|-
| [[UnDot]]
| UnDot is a simple median filter for removing dots, that is stray orphan pixels and mosquito noise. It clips each pixel value to stay within min and max of its eight surrounding neigbors. See [http://forum.doom9.org/showthread.php?s=&postid=205442#post205442 discussion].
| [[YUY2]], [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/undot_5F25_dll_20030118.zip Plugin]
| {{Author/Tom Barry}}
|}

=== Frequency Interference removal ===

{{FilterTable}}
| DeFreq
| Defreq uses Fast Fourier Transform method for frequency selecting an removing. See [http://forum.doom9.org/showthread.php?t=82978 discussion].
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/defreq/defreq.html Plugin]
| {{Author/Fizick}}
|-
| FanFilter
| Regular vertical frequency interference is filtered in spatial domain.
| [[YV12]], [[YUY2]], [[RGB32]], [[RGB24]]
| [http://avisynth.nl/users/vcmohan/FanFilter/FanFilter.html Plugin]
| {{Author/vcmohan}}
|}

=== IVTC & Decimation ===

{{FilterTable}}
| [[AnimeIVTC]]
| What it does:
* High quality adaptative field matching for hard telecine
* Bob, remove the blends and decimate back to the desired framerate for DHT/field-blended
* Creating a VFR clip for hybrid sources
* Bob the interlaced credits, blend-deinterlacing the background while doing minimal damage on the progressive credits, convert their framerate to match the episode's and splice them with it OR leave them @ 30p to create a VFR clip
* Very good combing removal and anti-aliasing functions
See [http://forum.doom9.org/showthread.php?t=138305]

|
| Script
| thetoof
|-
| BruteIVTC
|
|
| [http://mf.creations.nl/avs/filters/ Plugin]
| MarcFD
|-
| [http://forum.doom9.org/showthread.php?t=158230 DOCI]
| Destruction of Chroma Interlacing fixes a problem where you captured pulleddown video in YV12. In the combed frames, the chroma from two frames has been blended, leading to a ghosting effect when IVTC'd. This filter reconstructs the chroma exactly and fixes the problem.
|
| [http://forum.doom9.org/showthread.php?t=158230 Script]
| jmac698
|-
| [[FDecimate]]
| The FDecimate() filter provides extended decimation capabilities not available from [[Decomb/Decimate|Decimate()]]. It can remove frames from a clip to achieve the desired frame rate, while retaining audio/video synchronization. It preferentially removes duplicate frames where possible. ("FDecimate" stands for "Free Decimate", which implies that the output frame rate may be freely chosen, and is not limited to 1-in-N decimation).
| [[YUY2]], [[YV12]]
| [http://neuron2.net/fdecimate/fdecimate.html Plugin]
| {{Author/Donald Graft}}
|-
| [[GreedyHMA]]
| GreedyHMA is an Avisynth filter that executes DScaler's Greedy/HM algorithm code to perform pulldown matching, filtering, and video deinterlace. It has pretty much been superseded by Donald Graft's [[DeComb]] package. However there may be occasions where it sometimes gives preferable results, especially with some bad [[PAL]] clips.
| [[YUY2]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| IT
| Inverse Telecine
| [[YUY2]], [[YV12]]
| [http://avisynth.nl/users/warpenterprises/ Plugin]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| ivtc_txt60mc
| Deinterlaces telecined footage with that has been overlayed scrolling text at 60i.
|
| [http://doom10.org/index.php?topic=292.msg5499#msg5499 Script]
| {{Author/cretindesalpes}} aka Firesledge
|-
| [[MultiDecimate]]
| Removes N out of every M frames, taking the frames most similar to their predecessors. See [http://forum.doom9.org/showthread.php?s=&threadid=51901&perpage=20&pagenumber=2 discussion].
| [[YUY2]]
| [http://neuron2.net/multidecimate/multidecimate.html Plugin]
| {{Author/Donald Graft}}
|-
| [[PFR]]
| PFR (Progressive Frame Restorer) is an Avisynth filter that attempts to produce progressive frames from a mixed progressive/interlaced/IVTCed source.
| [[YUY2]]
| [http://siwalters.net/ Plugin]
| {{Author/Simon Walters}}
|-
| ReMatch
|
|
|
| Plugin
|-
| RePal
|
|
|
| Plugin
|-
| [[SmartDecimate]]
| Smart Decimate removes telecine by combining telecine fields and decimating at the same time, which is different from the traditional approach of matching telecine frames and then removing duplicates. See [http://forum.doom9.org/showthread.php?s=&threadid=60031 discussion].
| [[YUY2]], [[YV12]]
| [http://kevin.atkinson.dhs.org/tel/ Plugin]
| {{Author/Kevin Atkinson}}
|-
| [[Decomb]]
| The [[Decomb/Telecide|Telecide]] and [[Decomb/Decimate|Decimate]] filters can be combined to implement IVTC.
| [[YUY2]], [[YV12]]
| [http://neuron2.net/decomb/decombnew.html Plugin]
| {{Author/Donald Graft}}
|-
| [[TIVTC]]
| A package containing these 7 filters: TFM, TDecimate, MergeHints, FrameDiff, FieldDiff, ShowCombedTIVTC, and RequestLinear. Also contains these 3 conditional functions: IsCombedTIVTC, CFieldDiff, and CFrameDiff. Designed primarily for IVTC operations. [http://forum.doom9.org/showthread.php?t=82264 Discussion]
| [[YUY2]], [[YV12]]
| Plugin
| {{Author/tritical}}
|-
| TPRIVTC
|
|
| Plugin
|-
| [[UnComb]]
| Filter for matching up even and odd fields of properly telecined NTSC or PAL film source video. See [http://forum.doom9.org/showthread.php?s=&threadid=52333 discussion].
| [[YV12]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [[IvtcBlend]]
| Waka demonstrated an IvtcBlend function that uses the information in the "extra" fields of a telecined source to help combat temporal noise.
|
| Script
|
|}

=== Ghost Removal ===

{{FilterTable}}
| FixVHSOversharp
|
|
| [http://web.archive.org/web/20091026142456/http://www.geocities.com/mrtibsvideo/fixvhsoversharp.html Plugin]
|-
| GhostBuster
|
|
| [http://kvcd.net/sansgrip/avisynth/Ghostbuster-0.1.zip Plugin]
| SansGrip
|}

=== Logo Removal ===

{{FilterTable}}
| [[Shared_functions/DeKafka|DeKafka]]
| This fairly simple filter washes away those annoying bugs from broadcast clips.
|
| Script
|-
| DeLogo
| DeLogo Filter for VirtualDub. Removes static elements, e.g. logos or watermarks, from the video stream. It can remove either opaque elements or alpha blended, the latter even without destroying the picture beneath.
|
| [http://neuron2.net/delogo132/delogo.html Plugin] & [http://forum.doom9.org/showthread.php?t=119447 Script]
| Karel Suhajda
|-
| [[InpaintFunc]]
| Script for logo removal using inpainting. Can remove alpha blended or opaque logos with a basic postprocessing to hide artifacts.
|
| Script
| Reuf Toc
|-
| [[rm_logo]]
| Combination of deblending and inpainting to remove logos with adjustable postprocessing to further hide artifacts. See [http://forum.doom9.org/showthread.php?t=134919]
|
| Script
| Spuds
|-
| X-Logo
| X-Logo Avisynth plugin and Virtualdub filter. Removes opaque logos.
|
| [http://www.marzocchi.net/Olafsen/pmwiki/pmwiki.php/Software/X-Logo Plugin]
| Leuf
|}

=== Luma Equalisation ===

{{FilterTable}}
| [[Antiflicker]]
| "A quick-and-dirty port of my VirtualDub filter (which sucks, by the way; it was one of my first filters)."
See [http://forum.doom9.org/showthread.php?p=224573#post224573 discussion.]
| [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/antiflicker_25_dll_20030304.zip Plugin]
| {{Author/Donald Graft}}
|-
| [http://avisynth.org.ru/deflicker/deflicker.html DeFlicker]
| Can remove old film intensity flicker by temporal mean luma smoothing. Can also correct blinding of automatic gain control after flashes.
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/deflicker/deflicker04.zip Plugin]
| Fizick (Alexander G. Balakhnin)
|-
| [http://forum.doom9.org/showthread.php?p=1326599#post1326599 Dumb Deflicker]
| Gathers average luma of frames, smoothens that with temporalsoften, and applies the obtained difference to the original input. It is pretty simple, read "dumb". See [http://forum.doom9.org/showthread.php?p=1326599#post1326599 discussion]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1326599#post1326599 Script]
| {{Author/Didée}}
|-
| [http://avisynth.org.ru/equlines/equlines.html EquLines]
| Equalizes total luminosity in pairs of even and odd lines. Useful for removing inter-line differences from telecined films.
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/equlines/equlines03.zip Plugin]
| {{Author/Fizick}}
|-
| [http://akuvian.org/src/avisynth/flicker/lmflicker.txt LMFlicker]
| LMFlicker is intended to reduce flickering in some film/vhs transfers. FieldFade is a similar concept, but applied on a per-field basis, to reduce combing in a video where fades were applied after telecine.
| [[YV12]]
| [http://akuvian.org/src/avisynth/flicker/ Plugin]
| {{Author/akupenguin}}
|-
| [http://forum.doom9.org/showthread.php?t=159493 Local Deflicker]
| Deflickers only part of a frame. See [http://forum.doom9.org/showthread.php?t=159493 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=159493 Script]
| prokhozhijj
|-
| [http://home.arcor.de/kassandro/ReduceFlicker/ReduceFlicker.htm ReduceFlicker]
| Reduces temporal oscillations in clips; should be applied before deinterlacing. Contains ReduceFlicker, ReduceFluctuations, and LockClense. See [http://videoprocessing.11.forumer.com/viewtopic.php?t=24 discussion.]
| [[YV12]], [[YUY2]]
| [http://home.arcor.de/kassandro/ReduceFlicker/ReduceFlicker.zip Plugin]
| {{Author/kassandro}}
|-
| [http://www.zhitenev.com/avisynth/TimeLapseDF/ TimeLapseDF]
| Designed to remove luminosity flicker in time lapse photography. Unlike most other flicker removal filters, utilizes cumulative distribution function in addition to average frame luminosity. See [http://timescapes.org/phpBB3/viewtopic.php?f=8&t=2410 discussion.]
| [[YV12]], [[YUY2]]
| [http://www.zhitenev.com/avisynth/TimeLapseDF/TimeLapseDF.dll 32-Bit Plugin]
[http://www.zhitenev.com/avisynth/TimeLapseDF/x64/TimeLapseDF64.dll 64-Bit Plugin]
| {{Author/Denis Zhitenev}}
|-
| [http://forum.doom9.org/showthread.php?t=106898 wdeflicker]
| Modifies luma of a source clip by refering to a temporally super-smoothed clip. Heights of source and reference clips must match.
| [[YV12]], [[YUY2]]
| [http://forum.doom9.org/attachment.php?attachmentid=5417&d=1139174468 Plugin]
| Osmiridium
|}

=== Rainbow & Dot Crawl removal ===

{{FilterTable}}
| BiFrost
| Bifrost uses temporal blending to remove or at least reduce the effect of rainbows. See [http://forum.doom9.org/showthread.php?t=74397 discussion.]
| [[YV12]]
| [http://ivtc.org/avisynth/bifrost-1.1.zip Plugin]
| {{Author/Myrsloik}}
|-
| CC
| Dot crawl and rainbow removal.
| [[YV12]], [[YUY2]]
| [http://www.chiyoclone.net/dl/cc_20040522.lzh Plugin]
| {{Author/chiyo-clone}}
|-
| [http://forum.doom9.org/showpost.php?p=1571520&postcount=20 Checkmate]
| Spatial and temporal dot crawl removal.
| [[YV12]]
| [http://web.archive.org/web/20090218093135/http://mf.creations.nl/avs/filters/checkmate.dll Plugin]
| {{Author/mf}} / prunedtree
|-
| DeCrawl
| Spatial and temporal dot crawl removal, particularly for animated material.
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/decrawl_20060924.zip Plugin]
| Dan Donovan
|-
| DeCross
| Cross Color Reduction. Also known as rainbows.
| [[YV12]], [[YUY2]]
| [http://nullinfo.s21.xrea.com/cgi/counter/count.xcg?down=DeCross0002.zip Plugin]
| {{Author/minamina}}
|-
| DeDot
| Removes dot crawl and may also be useful for rainbows. See [http://forum.doom9.org/showthread.php?t=98219 discussion]
| [[YV12]], [[YUY2]]
| [http://nullinfo.s21.xrea.com/cgi/counter/count.xcg?down=DeDot_YV12_0002.zip Plugin]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| DeRainbow
| It removes rainbows on the clip, without any visible quality loss. See [http://forum.doom9.org/showthread.php?p=398106#post398106 discussion.]
| [[YV12]], [[YUY2]]
| [http://forum.doom9.org/showthread.php?p=398106#post398106 Script]
| sh0dan
|-
| DFMDeRainbow
| Creates mask to process only edges; rainbows are removed by hitting chroma planes with two passes of FluxSmooth (hence "Double-Flux-Mask").
| [[YV12]], [[YUY2]]
| [http://www.aquilinestudios.org/scripts/DFMDeRainbow-20050128.avsi Script]
| {{Author/Scintilla}}
|-
| [http://avisynth.org.ru/docs/english/externalfilters/guavacomb.htm GuavaComb]
| Removes dot crawl, rainbows, and some kinds of shimmering. See [http://forum.doom9.org/showthread.php?t=37456 discussion]
| [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/guavacomb_5F25_dll_20030801.zip Plugin]
| {{Author/Lindsey Dubb}}
|-
| LUTDeCrawl
| Purely temporal; only targets pixels for dot crawl removal if luma is fluctuating and (optionally) chroma is not.
| [[YV12]]
| [http://www.aquilinestudios.org/scripts/LUTDeCrawl-20081003.avsi Script]
| {{Author/Scintilla}}
|-
| LUTDeRainbow
| Purely temporal; only targets pixels for derainbowing if chroma is fluctuating and (optionally) luma is not.
| [[YV12]]
| [http://www.aquilinestudios.org/scripts/LUTDeRainbow-20081003.avsi Script]
| {{Author/Scintilla}}
|-
| mfRainbow
| Derainbows in areas of high Y, U and V frequencies, which fluctuate heavily. See discussion [http://forum.doom9.org/showthread.php?t=67578 here] and [http://forum.doom9.org/showthread.php?s=&postid=321859#post321859 here.]
| [[YV12]]
| [http://web.archive.org/web/20090212071718/http://mf.creations.nl/avs/functions/mfRainbow-v0.31.avs Script]
| {{Author/mf}}
|-
| Rainbow_Smooth
| A small spatial derainbow function. It uses [http://web.archive.org/web/20031009215231/http://kurosu.inforezo.org/avs/Smooth/index.html SmoothUV] to smooth out chroma and edge masking to prevent color bleeding.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1025503#post1025503 Script]
| MOmonster
|-
| SmartSSIQ
| SSIQ can alter the color on the entire picture. So this script first applies SSIQ to the entire picture. Then it locates the edges. Finally, it layers ONLY the de-rainbowed edges onto the original video. See discussion [http://forum.doom9.org/showthread.php?t=98267 here] and [http://forum.doom9.org/showthread.php?p=748304#post748304 here.]
| [[YV12]], [[RGB32]]
| Script
| LB
|-
| SSIQ
| Rainbow remover. A port of the VirtualDub plugin [http://www.doki.ca/filters/ Smart Smoother IQ.]
| [[YV12]], [[YUY2]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/ssiq_20070304.zip Plugin]
| {{Author/Myrsloik}}
|-
| [http://avisynth.org.ru/docs/english/externalfilters/tcomb.htm TComb]
| A temporal comb filter (it reduces cross-luminance (rainbowing) and cross-chrominance (dot crawl) artifacts in static areas of the picture).
| [[YV12]], [[YUY2]]
| [http://web.missouri.edu/~kes25c/TCombv2B2.zip Plugin]
| {{Author/tritical}}
|-
| YARK
| Yet Another Rainbow Killer. Based on mfRainbow v0.31, chubbyrain2, and various other scripts shown [http://forum.doom9.org/showthread.php?t=141165 here].
| [[YV12]]
| [http://pastebin.com/sfDZ00rx Script]
| jase99
|}

=== Stabilization ===

{{FilterTable}}
| [[DePan]]
| Tools for estimation and compensation of global motion (pan) .See [http://avisynth.org.ru/depan/depan.html]
| [[YUY2]], [[YV12]]
| [http://avisynth.org.ru/depan/depan.html Plugin]
| {{Author/Fizick}}
|-
| [[Stab]]
| Simple but powerful script to remove small high frequenzy jitter that appears often on old/bad transfers. See [http://forum.doom9.org/showthread.php?p=1222830#post1222830]
|
| Script
| g-force
|-
| [http://code.google.com/p/avisynthrestoration/wiki/TBC TBC]
| Stabilizes horizontal jitter in video from analog VCRs, similar to the function of a Time Base Corrector.(note: will cause SEt's Avisynth 2.6 MT to stop working)
|
| [http://code.google.com/p/avisynthrestoration/downloads/list Script]
|
|-
| [[CelStabilize]]
| Script which holds a fixed background steady. Doesn't work well with pans or fades.
|
| Script
| mg262
|}

== Denoisers ==
[[Denoisers|Strength/Quality of Denoisers]]

(need subclassification)

{{FilterTable}}
| AdaptiveMedian
|
|
| Plugin
|-
| Atc
|
|
| Plugin
|-
| ColourizeSmooth
|
|
| Plugin
|-
| ConditionalTemporalMedian
|
|
| Plugin
|-
| DCTFun4b
|
|
| Plugin
|-
| DeNoise
|
|
| Plugin
|-
| DNR2
|
|
| Plugin
|-
| ExtendedBilateral
|
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?t=84636 MedianBlur]
| Spatial median blur filter with a variable radius
|
| [http://avisynth.nl/users/tsp/ Plugin]
| tsp
|-
| PixieDustPP
|
|
| Plugin
|-
| SmartSmoother
|
|
| Plugin
|-
| SmootherHiQ
|
|
| Plugin
|-
| SSIQ
|
|
| Plugin
|-
| TNLMeans
| TNLMeans is an implementation of the NL-means denoising algorithm. See [http://forum.doom9.org/showthread.php?t=111344 discussion.]
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/TNLMeansv103.zip Plugin]
| {{Author/tritical}}
|-
| UberSmooth (Bloated)
|
|
| Plugin
|-
| UberSmooth (DCTFun)
|
|
| Plugin
|-
| UberSmooth (Deen)
| [http://soulhunter.chronocrossdev.com/#004]
|
| Plugin
|-
| VariableBlur
|
|
| Plugin
|}

=== Spatial Denoisers ===

{{FilterTable}}
| [[_2DCleanYUY2]]
| Averages pixels in a configurable radius around a source pixel that are within a configurable threshold of the central pixel. A port of the VirtualDub plugin [http://neuron2.net/2dcleaner.html 2D Cleaner.]
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/2dcleanyuy2_5F25_dll_20021225.zip Plugin]
| {{Author/kiraru2002}}, {{Author/xeon533}}
|-
| [http://web.archive.org/web/20101001134812/http://home.comcast.net/~tombarry970/Readme_DctFilter.txt DctFilter]
| An experimental filter that operates on DCT coefficients.
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/dctfilter_5F25_dll_20030221.zip Plugin]
| {{Author/Tom Barry}}
|-
| eDeen
| eDeen is a ultra powerfull spatial denoiser for very experienced encoders only.
| [[YV12]]
| [http://ziquash.chez-alice.fr/eDeen%20beta%201.zip Plugin]
| {{Author/Marc FD}}
|-
| [http://web.archive.org/web/20101201051903/http://gpubilateral.sourceforge.net/ GPUBilateral]
| In short, bilateral filter is a edge-preserving smooth filter. See [http://forum.doom9.org/showthread.php?t=136370 discussion.]
| [[RGB32]]
| [http://sourceforge.net/projects/gpubilateral/files/ Plugin]
| Sompon Virojanadara
|-
| [http://neuron2.net/msmooth/msmooth.html Msmooth]
| Masked smoother, designed specifically for anime.
| [[YV12]], [[RGB32]]
| [http://neuron2.net/msmooth/msmooth202.zip Plugin]
| {{Author/Donald Graft}}
|-
| [[RemoveGrain]]
| RemoveGrain is a simple and extremely fast spatial denoiser for progressive and interlaced video.
| [[YV12]], [[YUY2]]
| Plugin
| {{Author/kassandro}}
|-
| TBilateral
| TBilateral is a spatial smoothing filter that uses the bilateral filtering algorithm. It does a nice job of smoothing while retaining picture structure.
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/TBilateralv0911.zip Plugin]
| {{Author/tritical}}
|-
| [http://avisynth.org.ru/vague/vaguedenoiser.html VagueDenoiser]
| This is a Wavelet based Denoiser. Basically, it transforms each frame from the video input into the wavelet domain, using various wavelet filters. Then it applies some filtering to the obtained coefficients. See [http://forum.doom9.org/showthread.php?s=&threadid=56871 discussion.]
| [[YV12]], [[YUY2]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/vaguedenoiser_5F25_dll_20050926.zip Plugin]
| {{Author/Lefungus}}, {{Author/Kurosu}}, {{Author/Fizick}}
|-
| VerticalCleaner
| Fast vertical cleaner. Parameter information [http://videoprocessing.fr.yuku.com/sreply/651/Can-use-quantile-like-vertical-median-filter here.] Explanation of mode 2 [http://videoprocessing.fr.yuku.com/sreply/649/Can-use-quantile-like-vertical-median-filter here.]
| [[YV12]], [[YUY2]]
| [http://home.arcor.de/kassandro/prerelease/VerticalCleaner.rar Plugin]
| {{Author/kassandro}}
|}

=== Temporal Denoisers ===

{{FilterTable}}
| CNR2
| A fast chroma denoiser. Very effective against stationary rainbows and huge analogic chroma activity. Useful to filter VHS/TV caps. See [http://forum.doom9.org/showthread.php?t=78905 discussion.]
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/cnr2_v261.zip Plugin]
| {{Author/Marc FD}}, {{Author/tritical}}
|-
| [http://kvcd.net/sansgrip/avisynth/FluxSmooth-readme.html Fluxsmooth]
| Examines each pixel and compares it to the corresponding pixel in the previous and last frame.
| [[YV12]], [[YUY2]]
| [http://www.videohelp.eu/forum/attachments/avisynth/4d1351428557-sansgrips-avisynth-filters-fluxsmooth-avisynth-sansgriprar Plugin]
| SansGrip (Ross Thomas), Sh0dan
|-
| GrapeSmoother
| This filter averages out visual noise between frames.
| [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/grapesmoother_5F25_dll_20030801.zip Plugin]
| {{Author/Lindsey Dubb}}
|-
| MVDegrain
| Strong and effective temporal denoiser. Part of the [http://avisynth.org.ru/mvtools/mvtools2.html MVTools] package.
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/mvtools/mvtools2.html Plugin]
| {{Author/Fizick}}
|-
| TemporalCleaner
|
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/temporalcleaner_5F25_dll.zip Plugin]
| vlad59
|-
| TTempSmooth
| TTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/TTempSmoothv094.zip Plugin]
| {{Author/tritical}}
|-
| [[Temporal Degrain]]
| SLOW but very effective at removing most grain from video sources.
|
| Script
|}

=== Spatio-Temporal Denoisers ===

{{FilterTable}}
| [[Convolution3D]]
| Convolution3D is a spatio-temporal smoother, it applies a 3D convolution filter to all pixels of consecutive frames. See [http://forum.doom9.org/showthread.php?s=&threadid=38281 discussion].
| [[YUY2]]
| [http://hellninjacommando.com/con3d/ Plugin]
| {{Author/Vlad59}}
|-
| Deen
| Deen is a set of assembly-optimised denoisers, like various 3d and 2d convolutions.
|
| [http://ziquash.chez-alice.fr/ Plugin]
| [http://ziquash.chez-alice.fr/ MarcFD]
|-
| DenoiseMF
| A fast and accurate denoiser for a Full HD video from a H.264 camera. See [http://forum.doom9.org/showthread.php?t=162603 discussion].
|
| Script
| rean
|-
| [[dfttest]]
| A 2D/3D frequency domain denoiser. See [http://forum.doom9.org/showthread.php?t=132194 discussion.]
| [[YV12]], [[YUY2]]
| [http://bengal.missouri.edu/~kes25c/dfttestv18.zip Plugin]
| {{Author/tritical}}
|-
| [[dfttestMC]]
| A script that motion compensates dfttest. See [http://forum.doom9.org/showthread.php?t=147676]
|
| Script
| thewebchat
|-
| [[DeGrainMedian]]
| Two stage Spatio-Temporal Limited Median filter for grain removal. [http://forum.doom9.org/showthread.php?t=80834 See]
|
| [http://avisynth.org.ru/degrain/degrainmedian.html Plugin]
| {{Author/Fizick}}
|-
| [[FFT3DFilter]]
| A 3D Frequency Domain filter - gives strong denoising and moderate sharpening
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/fft3dfilter/fft3dfilter.html Plugin]
| {{Author/Fizick}}
|-
| [[FFT3DGPU]]
| Similar algorithm to FFT3DFilter, but uses graphics hardware for increased speed.
|
| [http://avisynth.nl/users/tsp/ Plugin]
| tsp
|-
| FrFun3b
| Fractal denoising. See [http://forum.doom9.org/showthread.php?t=110200 discussion]
| YV12
| [http://web.archive.org/web/20080905123941/http://soulhunter.chronocrossdev.com/data/frfun3b_rev3.zip Plugin]
| prunedtree
|-
| FrFun7
| Fractal denoising. See [http://forum.doom9.org/showthread.php?t=110200 discussion]
| YV12
| [http://web.archive.org/web/20080905123941/http://soulhunter.chronocrossdev.com/data/frfun7_rev6.zip Plugin]
| prunedtree
|-
| HQdn3d
| see [http://akuvian.org/src/avisynth/hqdn3d/]
|
| Plugin
|-
| [[MC_Spuds]]
| Motion compensated noise removal with sharpening. Extremely slow, but extremely effective.
|
| Script
| Spuds, {{Author/Didée}}
|-
| [[MCTemporalDenoise]]
| Another high quality motion compensated noise removal script with an accompanying post-processing component (with loads of excess feature such as MC-Post-sharpening, MC-antialiasing, deblock, edgeclean and much more)
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=139766 Script]
| {{Author/LaTo}}
|-
| [[MipSmooth]]
|
|
| Plugin
| {{author/Sh0dan}}
|-
| NoMoSmooth
|
|
| Plugin
|-
| PeachSmoother
|
|
| [http://avisynth.org.ru/docs/english/externalfilters/peachsmoother.htm Plugin]
| {{Author/Lindsey Dubb}}
|-
| [[RemoveNoiseMC]]
| Motion compensated filter for removing noise, larger spots and other dirt. Written as an alternative to the old [[Dust]]. Last update Nov 2006. It uses mvtools v1. Jenyok collected together all RemoveNoise and various filters functions and adapted to MVTools v2.
|
| [http://forum.doom9.org/showthread.php?t=110078 Script]
| Heini011
|-
| RemoveDirtMC
|
|
| [http://forum.doom9.org/showthread.php?p=1485300#post1485300 Script]
| Nephilis
|-
| zzz_denoise
| Simple wrapper around a combination of dfttest and MDegrain3. Requires the [[External_filters#Deepcolor_Filters|Dither]] package.
| YV12
| [http://forum.doom9.org/showthread.php?p=1390594#post1390594 Script]
| {{Author/cretindesalpes}}
|}

== Adjustment Filters ==

=== Colourspace Conversion ===

{{FilterTable}}
| [http://neuron2.net/autoyuy2/autoyuy2.html AutoYUY2]
| This filter is correctly converts YV12 to YUY2 without color bias.
| [[YV12]]
| Plugin
| {{Author/Donald Graft}}
|-
| ConvertToYCgCo
| Converts to the YCgCo colorspace. See [http://forum.doom9.org/showthread.php?t=161736 discussion.]
| [[RGB24]], [[RGB32]]
| [http://forum.doom9.org/attachment.php?attachmentid=12748&d=1331769022 Plugin]
| xv
|-
| InterleavedConversions
| Tools for interleaving and de-interleaving 2, 3, and 4-channel data.
|
| Script
| PitifulInsect
|-
| YUY2inRGB
| A quick filter that stuffs YUY2 into RGB24. See [http://forum.doom9.org/showthread.php?p=639948#post639948 discussion.]
| [[YUY2]]
| [http://trevlac.us/YUY2inRGB.zip Plugin]
| {{Author/Trevlac}}
|-
| YUY2toRGB219
| Converts YUY2 to studioRGB. With this kind of conversion, luma will not change, meaning no quantization error on luma. See [http://forum.doom9.org/showthread.php?p=639432#post639432 discussion.]
| [[YUY2]]
| [http://trevlac.us/colorCorrection/YUY2toRGB219.zip Plugin]
| {{Author/Trevlac}}
|-
| YV12toRGB24HQ
| YV12 to RGB24 with dithering.
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/yv12torgb24hq_20060301.zip Plugin]
| prunedtree
|-
| PlanarConversions
| Planar conversion functions for AVISynth.
|
| Script
| PitifulInsect
|}

=== Duplicate Frame Detectors ===

{{FilterTable}}
| Dup
| a robust duplicate frame detector. a frame that is determined to be close enough to its predecessor to be considered a duplicate will be replaced by a copy of the predecessor. This can significantly reduce the size of encoded clips with virtually no visual effect. provides the capability to replace frames with a blend of all the duplicates, providing a valuable noise reduction. Filter by Donald A. Graft.
| [[YV12]], [[YUY2]]
| [http://neuron2.net/dup/dupnew.html Plugin]
| {{Author/Donald Graft}}
|-
| [[Dupped]]
| Another frame duplication function, similar to Dup, but hopefully more accurate. See [http://forum.doom9.org/showthread.php?t=134930]
|
| [http://www.randomdestination.com/members/corran/misc/dupped/dupped.avsi Script]
| Corran
|-
| DeDup
| Remove (drop) duplicate frames in the interest of compression quality and speed. Resulting clip will have a variable frame rate.
| [[YV12]], [[YUY2]]
| [http://akuvian.org/src/avisynth/dedup/ Plugin]
|-
| GetDups
| Selecting unique duplicate frames from clip, it return frames which have copies only, by one from the series (group). Made for 8mm films.
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/getdups/getdups.html Plugin]
|}

=== Effects ===

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?t=111849 AddGrain]
| Generates film like grain or other effects (like rain) by adding random noise to clip. Noise can be horizontally or vertically correlated causing streaking. Contains AddGrain & AddGrainC
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://ldesoras.free.fr/src/avs/AddGrainC-1.7.0.7z Plugin]
| {{Author/Tom Barry}} {{Author/Foxyshadis}}
{{Author/LaTo}} {{Author/cretindesalpes}}
|-
| [http://kvcd.net/sansgrip/avisynth/Blockbuster-readme.html AddNoise/Blockbuster]
| Makes encoder allocate more bits to darker areas, thus eliminating DCT blocks by decreasing the clips compressibility.
|
| [http://kvcd.net/sansgrip/avisynth/Blockbuster-0.7.zip Plugin]
| Ross Thomas
|-
| [http://forum.doom9.org/showthread.php?t=87295 AviShader]
| generic plugin that uses your 3D card's hardware to assist with rendering
| [[RGB32]]
| [http://mediafire.com/?xkmatqlcvaoskv5 Plugin]
| Antitorgo
|-
| [http://forum.doom9.org/showthread.php?t=97706 ColorLooks]
| This plugin is based on Trev's VDub filter Colorlooks and Donald Graft's Colorize (well it works a bit similar). I also added some new stuff. The plugin contains the following filters: Technicolor, Colorize, Sepia and Posterize.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://www.geocities.com/wilbertdijkhof/ColorLooks_v13.zip Plugin]
| {{author/Wilbert Dijkhof}}
|-
| [http://avisynth.nl/users/vcmohan/EffectsMany/EffectsMany_index.html EffectsMany]
| Creates 34 types of special "animated" effects. Effects act on the input clip in the range of the frame numbers specified. The Audio is not affected.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/vcmohan/EffectsMany/EffectsMany.zip Plugin]
| {{Author/vcmohan}}
|-
| [[GrainFactory3]]
| Noise generator that tries to simulate the behavior of silver grain on film. See : [http://forum.doom9.org/showthread.php?t=141303]
|
| [http://forum.doom9.org/showthread.php?p=1191292#post1191292 Script]
| {{Author/Didée}}
|-
| [[GNoise]]
| Adds random noise to a clip. See [http://forum.doom9.org/showthread.php?p=841700#post841700 duscussion.]
| [[YV12]]
| [http://web.archive.org/web/20080905123941/http://soulhunter.chronocrossdev.com/data/gnoise_r5.zip Plugin]
| {{Author/soulhunter}}
|-
| [[HollywoodSQ]]
| Creates popup album, akin to Hollywood squares TV show
|
| [http://avisynth.nl/users/vcmohan/HollywoodSq/HollywoodSq.html Plugin]
| {{Author/vcmohan}}
|-
| [[KenBurnsEffect]]
| Given clip, zooms, pans & rotates clip. See [http://en.wikipedia.org/wiki/Ken_Burns_Effect wikipedia:Ken Burns Effect]
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=135776 Script]
| mikeytown2
|-
| MPlayerNoise
| Noise Generator ported from MPlayer. See [http://forum.doom9.org/showthread.php?t=84181 discussion.]
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/bergfiltercollection_5F25_dll_20041019.zip Plugin]
| {{Author/bergi}}
|-
| [[NoiseGenerator]]
| Newer function based off of Blockbuster. Adds random noise to clip.
|
| [http://avisynth.nl/users/warpenterprises/#noisegenerator Plugin]
| Shubin
|-
| [[Scanlines]]
| Add Scanlines (black horizontal bars) to a video. see [http://en.wikipedia.org/wiki/Scan_line wikipedia:Scan Line]
|
| [http://avisynth.nl/users/warpenterprises/files/scanlines_5F25_dll_20031103.zip Plugin]
| turulo
|-
| StaticNoiseC
| Generates static grain using the Mersenne Twister random number generator. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=8&t=118&start=20#p772 discussion.]
| [[YV12]]
| [http://www.nmm-hd.org/upload/get~YnWFecZw0Uo/StaticNoiseC20110108b.zip Plugin]
| histamine
|-
| [http://www.gyroshot.com/turnstile.htm TurnsTile]
| Applies mosaic and/or palette effects to a clip.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://forum.doom9.org/showthread.php?p=1483856#post1483856 Plugin]
| {{Author/Robert Martens}}
|}

=== Field Order ===

{{FilterTable}}
| PFR
|
|
| Plugin
|-
| ReverseFieldDominance
|
|
| [http://www.reocities.com/siwalters_uk/reversefielddominance.html Plugin]
|}

=== Frame Rate Conversion ===

{{FilterTable}}
| [[AlterFPS]]
| AlterFPS can be used to speed up or slow down a video by adding or removing fields. It works like the 3:2 pulldown of NTSC film material, except you can choose your new speed. It can also blend frames for progressive frame results, and blend fields like ConvertFPS.
|
| Script
|-
| [[convert60ito24p]]
| convert60ito24p converts a 60fps interlaced NTSC Video into a 24fps progressive Video using different blending techniques. discussion.
|
| Script
|-
| FPSDown
| This filter reduces the framerate of a video by 1/2, by blending odd and even frames together. However, it does this in a smart way such that in case of duplicate frames, it will do the smart thing to remove unnecessary blurring in the output video.
| [[RGB32]]
| [https://github.com/arkeet/fpsdown Plugin]
| [https://github.com/arkeet/ arkeet]
|-
| [http://neuron2.net/trbarry/Readme_FrameDbl.txt FrameDbl]
| FrameDbl will generate extra frames to double the frame rate. It does this using a motion compensated approach to interpolating between frames. See [http://forum.doom9.org/showthread.php?t=56036 discussion.]
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/framedbl_5F25_dll_20030621.zip Plugin]
| {{Author/Tom Barry}}
|-
| [http://www.spirton.com/category/interframe/ InterFrame]
| Give videos higher framerates like newer TVs do. Common names are framedoubling, smooth motion and 60FPS conversion. See [http://forum.doom9.org/showthread.php?t=160226 discussion.]
| [[YV12]]
| [http://www.spirton.com/uploads/InterFrame/InterFrame-2.5.0.zip Script]
|{{Author/SubJunk}}
|-
| MotionProtectedFPS (Motion)
|
|
| Script
|-
| MVFlowFPS(2) (MVTools)
|
|
| Plugin
|-
| NTSC tools
| Automatic NTSC to PAL conversion with 24p, 30p, 60i detection. See [http://forum.doom9.org/showthread.php?t=114054]
|
| [http://avisynth.nl/images/NTSC_tools.avsi Script]
| Mug Funky
|-
| [[SalFPS3]]
|
| [[YV12]]
| Script
| Mug Funky, {{Author/Didée}}
|}

=== Levels and Chroma ===

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?t=167573 AutoGain]
| A high quality auto-leveling filter. It calculates statistics of clip, averages them temporally to stabilize data and uses them to adjust gain. AutoGain has a smoothing & dithering algorithm to avoid banding issue. Calculations are made in 32bits float to avoid rounding errors and can also input/output 16-bits. AutoGain is internally multithreaded and SSE2 optimized.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [http://forum.doom9.org/showthread.php?t=167573 Plugin]
| {{Author/LaTo}}
|-
| [http://www.thebattles.net/video/autolevels.html Autolevels]
| Improvement of the [[ColorYUV]] filter's autogain feature. It stretches the luma histogram to use the entire specified range, averaging the amount of "gain" over consecutive frames to better handle flashes and to avoid flickering. [http://forum.doom9.org/showthread.php?t=128585 Discuss]
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://www.thebattles.net/video/autolevels_0.6_20110109.zip Plugin]
| {{Author/frustum}} & Theodor Anschütz
|-
| AWB
| Automatic white balance for real world footage, similar to the known function in digital cameras. See [http://forum.doom9.org/showthread.php?t=168062 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=168062 Script]
| martin53
|-
| [http://forum.doom9.org/showthread.php?t=139361 Color Balance]
| Same tool that is found in Gimp & Cinepaint.
| [[RGB24]], [[RGB32]]
| [http://forum.doom9.org/showthread.php?p=1180090#post1180090 script]
| Gavino & mikeytown2
|-
| [http://www.videohelp.com/forum/archive/nice-results-with-avisynth-color-channel-mixer-t339327.html ChannelMixer]
| Very similar to the ChannelMixer function found in Photoshop. 9 Adjustments are possible, 3 for each color channel.
| [[RGB24]], [[RGB32]]
| Plugin
| Gustaf Ullberg
|-
| [http://forum.doom9.org/showthread.php?t=96308 ColourLike]
| Makes a clip look like a 'reference' clip by adjusting each colour channel.
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/#colourlike Plugin]
| {{Author/mg262}}
|-
| [http://expsat.sourceforge.net/ ExpLabo]
| ExpSat apply a non-linear transformation of saturation, Colorize change the image color dominance in a flexible manner, HLSnoise adds a noise to the image separately to the HLS dimensions. See [http://forum.doom9.org/showthread.php?t=97052 discussion.]
| [[RGB24]], [[RGB32]]
| [http://sourceforge.net/projects/expsat/ Plugin]
| brabbudu
|-
| [[FlimsYlevels]]
| Luma adjustment function to give a more "film-ish" look. (Based on {{Author/Didée}}'s [[Ylevels]]).
| [[YV12]]
| Script
| FlimsyFeet
|-
| [http://forum.doom9.org/showthread.php?p=605890#post605890 GiCocu]
| Use GIMP/Photoshop curve files
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/#gicocu Plugin]
| E-Male
|-
| [http://strony.aster.pl/paviko/hdragc.htm HDRAGC]
| High Dynamic Range Automatic Gain Control - Increase dynamic range of video clips (enhance shadows). It's "simply" gaining (brightening) dark areas of image without causing blow of highlights. Amount of gain is calculated automatically, but can be influenced by parameters. See [http://forum.doom9.org/showthread.php?t=93571 discussion.]
| [[YV12]], [[YUY2]]
| [http://strony.aster.pl/paviko/Hdragc-1.8.7.zip Plugin]
| paviko
|-
| [http://forum.doom9.org/showthread.php?t=161986 HighlightLimiter]
| "Darkening highlight". Works well on over exposed clips. It can also be combined with ContrastMask to create HDR effect
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1522100#post1522100 Script]
| javlak
|-
| [http://avisynth.nl/users/vcmohan/HistogramAdjust/HistogramAdjust.html HistogramAdjust]
| Adjusts the histogram of a frame by either equalizing it or by matching with histogram of another image, or with given histogram table of values.
| [[YV12]], [[YUY2]]
| Plugin
| {{Author/vcmohan}}
|-
| [http://forum.doom9.org/showthread.php?p=1570968#post1570968 Histograms in RGB & CMY]
| Display level histogram in RGB and CMY, and a histogram for RGB parade. Useful for color corrections.
| [[YV12]], [[RGB24]], [[RGB32]]
| Script
| -Vit-
|-
| [[SGradation]]
| SGradation is much like a gamma function, but '2nd order'.
|
| Script
|
|-
| [[SmoothLevels]]
| Advanced levels adjustment function, with limiting & smoothing parameters.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=137479 Script]
| {{Author/LaTo}}
|-
| [[Tint]]
| Tints the image toward a specified colour.
|
| Script
|
|-
| [http://forum.doom9.org/showthread.php?t=74334 TweakColor]
| Target specific hue and saturation ranges for hue and saturation adjustments.
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/tweakcolor_5F25_dll_20040412.zip Plugin]
| {{Author/Trevlac}}
|-
| Tweak3
| Same as [[Tweak]] but with dithering.
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20080905123941/http://soulhunter.chronocrossdev.com/data/tweak3.zip Plugin]
| {{Author/soulhunter}}
|-
| WhiteBalance
| Correct the white balance of a clip with a large degree of control and accuracy over other methods of correcting white balance. See [http://forum.doom9.org/showthread.php?t=106196 discussion.]
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://www.64k.it/andres/data/avisynth/WhiteBalance100.zip Plugin]
| SomeJoe
|-
| [[Ylevels]]
| A simple replacement for Avisynth's internal [[Levels]] command, with a few neat differences.
| [[YV12]]
| Script
| {{Author/Didée}}
|}

=== Linedarkening ===

{{FilterTable}}
| FastLineDarken
| Line darkening script. See [http://forum.doom9.org/showthread.php?t=82125 discussion.]
| [[YV12]]
| Script
| Vectrangle
|-
| FastLineDarkenMOD
| Line darkening script. See original [http://forum.doom9.org/showthread.php?t=82125 discussion.] Updated [http://forum.doom9.org/showthread.php?p=1060081#post1060081 script.] Additional [http://forum.doom9.org/showthread.php?p=1023638#post1023638 information.]
| [[YV12]]
| Script
| Vectrangle / {{Author/Didée}}
|-
| LimitedDarken
|
|
| Plugin
|-
| [[Shared_functions/mfToon|mfToon]]
| mfToon darkens cartoon edges. In default operation, it performs line darkening, Xsharpening, and warp sharpening.
See [http://forum.doom9.org/showthread.php?t=53364 discussion.] Additional information [http://forum.doom9.org/showthread.php?t=125128 here] and [http://forum.doom9.org/showthread.php?t=52066 here]
| [[YV12]]
| [http://web.archive.org/web/20090212071718/http://mf.creations.nl/avs/functions/mfToon-v0.52.avs Script]
| {{Author/mf}}
|-
| SuperToon
| An attempt to optimize/speed up the previous versions of mfToon, vmToon, etc. See [http://forum.doom9.org/showthread.php?t=163987 discussion]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=163987 Script]
| Hadien
|-
| [[Toon]]
| Simple and fast Linedarkener. See [http://forum.doom9.org/showthread.php?t=131454 discussion.] Original Toon [http://forum.doom9.org/showthread.php?p=1022171 discussion] in script form.
Binary patched Toon-v1.0 to use aWarpSharp2 instead of aWarpSharp: [http://forum.doom9.org/showthread.php?t=147285 Toon-v1.1]
| [[YV12]]
| [http://web.archive.org/web/20090218093135/http://mf.creations.nl/avs/filters/Toon-v1.0.dll Plugin]
| {{Author/mf}}
|-
| Toon-lite
| It's the same as Toon, just without the warpsharp processing. For default strength use "1.0".
| [[YV12]]
| [http://web.archive.org/web/20090218093135/http://mf.creations.nl/avs/filters/Toon-v1.0-lite.dll Plugin]
| {{Author/mf}}
|-
| [[vmToon]]
| The successor to mfToon. Darkens lines, thins lines, and does supersampled sharpening all in one, but slow.
| [[YV12]]
| [http://avisynth.nl/images/Vmtoon-v0.74.avsi Script]
| Vectrangle
|}

=== Resizers ===

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?s=&threadid=87602 AutoCrop]
| Automatically crops black borders ([http://en.wikipedia.org/wiki/Letterbox wikipedia:Letterbox], [http://en.wikipedia.org/wiki/Pillar_box_%28film%29 wikipedia:Pillar box], [http://en.wikipedia.org/wiki/Windowbox_%28film%29 wikipedia:Windowbox]) from a clip. Operates in preview mode (overlays the recommended cropping information) or cropping mode. Can also ensure width and height are multiples of specified numbers.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/autocrop_25_dll_20050103.zip Plugin]
|-
| Debilinear
| This filter is designed to reverse the effects of bilinear upsampling.
| RGB, YV12
| [http://rgb.chromashift.org/ Plugin]
| Prunedtree
|-
| EdiUpsizer
| see [http://bengal.missouri.edu/~kes25c/EDIUpsizer.zip]
|
| Plugin
|-
| EEDI2
| see [http://bengal.missouri.edu/~kes25c/EEDI2v092.zip normal] [http://foxyshadis.slightlydark.com/random/Eedi2mt.zip Multi-threaded] [http://members.optusnet.com.au/squid_80/EEDI2_imp64.zip Multi-threaded 64-bit]
|
| Plugin
|-
| FastEDIUpsizer
| [http://members.optusnet.com.au/squid_80/EEDI2_imp64.zip]
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?p=330319#post330319 HybridResize]
| Uses Lanczos (sharp) for edges and Bilinear (soft) on the rest of the image.
|
| [http://web.archive.org/web/20090423011809/http://mf.creations.nl/avs/functions/HybridResize-0.2.avs Script]
| {{Author/mf}}
|-
| [[Lanczosplusv3]]
| Very slow, but high quality resizer. See [http://forum.doom9.org/showthread.php?t=136690]
|
| Script
| *.mp4 guy
|-
| [http://forum.doom9.org/showthread.php?t=129953 NNEDI]
| Neural Network New-Edge Directed Interpolation.
|
| [http://bengal.missouri.edu/~kes25c/ Plugin]
| {{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?t=154674 PointSize]
| A set of [http://en.wikipedia.org/wiki/Pixel_art_scaling_algorithms pixel art resizers]: Scale2x, Scale3x, LQ2x, LQ3x, LQ4x, HQ2x, HQ3x, HQ4x.
| [[RGB32]]
| Plugin
| `Orum
|-
| [http://svn.int64.org/viewvc/int64/resamplehq/doc/index.html ResampleHQ]
| ResampleHQ provides gamma-aware resizing and colorspace conversion.
|
| [http://sourceforge.net/projects/int64/files/ResampleHQ/ResampleHQ-v1.zip/download Plugin]
| Cory Nelson (phrosty [at] gmail.com) (PhrostByte on Doom9
|-
| [[ResizeARC]]
| ResizeARC respects AR as possible maintaining MOD32 resolutions, uses bitrate, bpp and the resize function specified as parameters. Usage:
|
| Script
|-
| [http://forum.doom9.org/showthread.php?t=135735 Seamer]
| Seam Carving/Liquid Rescale for Content-Aware Image Resizing. See [http://en.wikipedia.org/wiki/Seam_carving wikipedia:Seam Carving]
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/vcmohan/Seamer/Seamer.html Plugin]
| {{Author/vcmohan}}
|-
| [[SimpleResize]]
| Very simple and fast two tap linear interpolation. It is unfiltered which means it will not soften much.
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [http://forum.doom9.org/showthread.php?t=147117 SplineResize]
| SplineResize contains two kinds of spline based resizers: The first ones are the (cubic) spline based resizers from Panorama tools: Spline100Resize (using 10 sample points) and Spline144Resize (using 12 sample points) are examples. Other ones are available in AviSynth itself. The second ones are natural cubic splines that use the kernel itself as a spline.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://www.wilbertdijkhof.com/SplineResize_v02.zip Plugin]
| {{Author/Wilbert Dijkhof}}
|-
| [[YV12InterlacedReduceBy2]]
| InterlacedReduceBy2 is a fast Reduce By 2 filter, usefull as a very fast downsize of an interlaced clip. See [http://forum.doom9.org/showthread.php?s=&postid=271863 discussion].
| [[YV12]]
| [http://web.archive.org/web/20110208133956/http://home.comcast.net/~tombarry970/ Plugin]
| {{Author/Tom Barry}}
|-
| [http://forum.doom9.org/showthread.php?t=49429 Zoom]
| Zoom, Pan & Rotate Clip. Adds alpha layer to clip.
| [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/zoom_25_dll_20050122.zip Plugin]
|-
| [http://forum.doom9.org/showthread.php?p=1111789#post1111789 ZoomBox]
| Replacement for ResizeKAR. Resizes clip Keeping the Aspect Ratio. Can set Source/Target PAR/DAR, option to zoom in/out in order to hide/show black borders.
|
| Script
|}

=== Sharpeners ===

{{FilterTable}}
| aSharp
| Adaptive sharpening filter. You can use it for high quality sharpening of soft sources. See [http://forum.doom9.org/showthread.php?s=&threadid=38436 discussion].
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/asharp_5F25_dll_20030118.zip Plugin]
| {{Author/Marc FD}}
|-
| aWarpSharp
| A warp sharpening filter.
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/awarpsharp_5F25_dll_20030203.zip Plugin]
| {{Author/Marc FD}}
|-
| aWarpSharp2
| A modern rewrite of aWarpSharp with several bugfixes and optimizations. See [http://forum.doom9.org/showthread.php?t=147285 discussion]
| [[YV12]]
| [http://www.mediafire.com/?7bu46ab33dwex0o Plugin]
| {{Author/SEt}}
|-
| blah
| A sharpening.
| [[YV12]]
| Script
| *.mp4 guy
|-
| [[LimitedSharpen]]
| LimitedSharpen can be used like a traditional sharpener, but producing much less artefacts. It can be used as a replacement for the common "resize(x4)-XSharpen-resize(x1)" combo, with very similar results (perhaps even better) - but at least 2 times faster, since it requires much less oversampling.
|
| Script
| {{Author/Didée}}
|-
| [[LSFmod]]
| A LimitedSharpenFaster mod with a lot of new features and optimizations.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=142706 Script]
| {{Author/LaTo}}
|-
| MSharpen
| This filter implements an unusual concept in spatial sharpening to sharpen important edges without amplifying noise. Although designed specifically for anime, it also works quite well on normal video. See [http://forum.doom9.org/showthread.php?s=&threadid=42839 discussion].
| [[RGB]], [[YUY2]], [[YV12]]
| [http://neuron2.net/msharpen/msharpen.html Plugin]
| {{Author/Donald Graft}}
|-
| [[Super Slow Sharpen]]
| Very slow, but high quality sharpener. See [http://forum.doom9.org/showthread.php?t=132330]
|
| Script
| *.mp4 guy
|-
| [http://mf.creations.nl/avs/functions/ SSXSharpen]
| Included in SharpTools. Sharpens the picture using [[supersampling]] techniques.
|
| Script
| {{Author/Didée}}
|-
| TUnsharp
| TUnsharp is a basic sharpening filter that uses a couple different variations of unsharpmasking and allows for controlled sharpening based on edge magnitude and min/max neighborhood value clipping. The real reason for its existence is that it sports a gui with real time preview. See [http://forum.doom9.org/showthread.php?t=84344 discussion].
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/tunsharp_5F25_dll_20050524.zip Plugin]
| {{Author/tritical}}
|-
| [[UnFilter]]
| This filter softens/sharpens a clip. It implements horizontal and vertical filters designed to (slightly) reverse previous efforts at softening or edge enhancement that are common (but ugly) in DVD mastering. See [http://forum.doom9.org/showthread.php?s=&threadid=28197&pagenumber=3 discussion].
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/unfilter_5F25_dll_20030116.zip Plugin]
| {{Author/Tom Barry}}
|-
| [[UnsharpHQ]]
| A strong and fast unsharp mask with some new features. See [http://forum.doom9.org/showthread.php?t=159637 discussion].
| [[YV12]]
| [http://www.mediafire.com/download.php?mq3k44q2fvusz17 Plugin]
| list

|-
| WarpSharp Package
| Contains these sharpeners: Unsharpmask, WarpSharp, Xsharpen. See [http://wayback.archive.org/web/20081229042741/http://niiyan.net/?WarpSharpPackage description.]

[http://avisynth.nl/users/warpenterprises/files/warpsharppackage_5F25_dll_20031103.zip 2003 Version]

[http://web.archive.org/web/20070504134119/http://seraphy.fam.cx/~seraphy/program/WarpSharp/index.html 2006 Version]

[http://web.archive.org/web/20120212062428/http://vfrmaniac.fushizen.eu/seraphy_mirror/warpsharp/bin/warpsharp_20080325.7z 2008 Version]
| [[YUY2]], [[YV12]]
| Plugin
| {{Author/seraphy}}
|-
| WarpSharp YV12
| Contains WarpSharp & XSharpen. This version of WarpSharp is very fast.
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/warpsharp_5F25_dll_20030103.zip Plugin]
|

|-
| [[FineSharp]]
| Small and relatively fast realtime-sharpening function, designed for 1080p, or after scaling 720p -> 1080p during playback (to make 720p look more being like 1080p). See [http://forum.doom9.org/showthread.php?p=1569035#post1569035 discussion].
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1569035#post1569035 Script]
| {{Author/Didée}}
|}

=== Blurring ===

{{FilterTable}}
| [https://github.com/chikuzen/BucketMedian BucketMedian]
| BucketMedian is an implementation of spatial median filter adapting bucket(counting) sort algorithm.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [https://dl.dropboxusercontent.com/s/bczippngoqy6xbw/BucketMedian-0.3.1.7z Plugin]
| {{Author/Chikuzen}}
|-
| [[Variableblur]]
| Variableblur is a gaussian, binomial or average blur filter with a variable radius(variance).
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://bengal.missouri.edu/~kes25c/variableblur.zip Plugin]
| {{Author/tritical}}
|}

=== Subtitling ===

{{FilterTable}}
| AssRender
| Libass-based subtitle renderer. See [http://forum.doom9.org/showthread.php?t=148926 discussion].
| RGB32, RGB24, YV24, YV12, Y8
| [http://encodan.srsfckn.biz/assrender/ C Plugin]
| lachs0r, TheFluff
|-
| SubAA
| Single Subtitle with Anti-aliasing.
|
| [http://soulhunter.chronocrossdev.com/data/SSubAA.avs Script]
|-
| [http://avisynth.nl/users/warpenterprises/files/dvutilities_20050717.zip SubtitleEx]
| Similar to the original [[Subtitle]] function but can do more: apply text to range; effects - bold, underline, italic, center, fading, motion, blur, emboss, etc...; alpha channel.
|
| [http://avisynth.nl/users/warpenterprises/files/subtitleex_25_dll_20040819.zip Plugin]
|-
| [http://avisynth.org.ru/docs/english/externalfilters/vsfilter.htm TextSub] (VSFilter)
| Supported Subtitle Formats: VOBsub (.sub/.idx), SubStation Alpha/Advanced SubStation Alpha (.ssa/.ass), SubRip (.srt), MicroDVD (.sub), SAMI (.smi), PowerDivX (.psb), Universal Subtitle Format (.usf), Structured Subtitle Format (.ssf). See [http://en.wikipedia.org/wiki/VSFilter]
|
| [http://sourceforge.net/project/showfiles.php?group_id=205650&package_id=246121&release_id=541232 Plugin]
|-
| [http://avisynth.nl/users/SubtitleMulti SubtitleMulti]
| A parameter-compatible Subtitle function which allows the usage of line breaks. (Wilbert: I can't find the script ...)
|
| Script
| JLennox
|
|-
| VSFilterMod
| A new VSFilter with more ass tags.
|
| Plugin
|
|}

=== Transitions ===

{{FilterTable}}
| [[DissolveAGG]]
| Wipe Transition with a soft edge. See [http://forum.doom9.org/showthread.php?t=118016 discussion].
'''Note:''' There exist multiple variants of the script as the result of the interaction between authors in that discussion.
|
| [http://forum.doom9.org/showthread.php?p=900674#post900674 Script (v1)]
[http://forum.doom9.org/showthread.php?p=1152440#post1152440 Script (v2)]
[http://forum.doom9.org/showthread.php?p=1152632#post1152632 Script (v3)]
| {{Author/zemog}}, {{Author/mikeytown2}}, {{Author/Gavino}} and others
|-
| [http://forum.doom9.org/showthread.php?t=62277 JDL_MaskTransition]
| Combines two clips using the specified mask clip. The audio tracks are blended during the transition. About any transition can be made with this function.
|
| [http://avisynth.nl/users/stickboy/jdl-effects.avsi Script]
| {{Author/stickboy}}
|-
| [http://avisynth.nl/users/vcmohan/TransAll/docs/index.html TransAll]
| Around 150 distinct transitions can be created with this plugin.
| [[RGB]], [[YUY2]], [[YV12]]
| [http://avisynth.nl/users/vcmohan/TransAll/TransAll.zip Plugin]
| {{Author/vcmohan}}
|-
| [[Transition (Albert Gasset)]]
| Various Wipe and Random Block modes. Has 19 built in patterns or it can use an external file.
|
| [http://avisynth.nl/users/warpenterprises/#transition Plugin]
| {{Author/Albert Gasset}}
|-
| [[Transition (shubin)]]
| Contains 2 modes: circle and line. In circle mode the area has radius R and center xCenter,yCenter. In line mode the line passes through xCenter,yCenter with slope R.
|
| [http://avisynth.nl/users/warpenterprises/#transition Plugin]
| {{Author/shubin}}
|}

== Other Filters ==

=== Debugging/Diagnostic Filters ===

{{FilterTable}}
| AVInfo
|
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?t=165528 AVSMeter]
| AVSMeter is a CLI (command line interface) tool that "runs" an Avisynth script without any overhead, displays clip info, CPU and memory usage and the minimum, maximum and average frame rates, indicating how fast Avisynth can serve frames to a client application.
It comes in handy when testing filters to determine their performance and memory requirements.
|
| Command line executable
| Groucho2004
|-
| Avisynth Monitor
|
|
| Plugin
|-
| AvsTimer
|
|
| Plugin
|-
| [[DumpPixelValues]]
| Samples the colors from selected pixels for every frame in a video source and outputs the data to a text or binary file.
| RGB32, YUY2
| Plugin
|-
| Framenumber
| Framenumber inserts the framenumber of the current frame (+ offset).
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?p=1467907#post1467907 Glitch Analyzer]
| Glitch Analyzer generates a diagnostic video, then analyzes the recorded version of it, to detect swapped, dropped, or repeated fields.
| YUY2,YV12
| [http://forum.doom9.org/showthread.php?p=1467907#post1467907 Script]
|-
| Grid
|
|
| Plugin
|-
| [[HDColorBars]]
| A script to create an HD test pattern based on ARIB STD-B28 Rev1. Can easily be adapted to an SMPTE version. [http://avisynthrestoration.googlecode.com/files/ARIB-STD-B28.png Image]
| YV12
| [[HDColorBars]]
|-
| Kronos
|
|
| Plugin
|-
| [http://code.google.com/p/avisynthrestoration/wiki/Measure Measure]
| Measures luminence of greyscale bars and prints results on-screen. Can be used to set brightness/contrast in capture settings accurately.
| YV12
| [http://code.google.com/p/avisynthrestoration/downloads/list Script]
|-
| MonitorFilter
|
|
| Plugin
|-
| [[PixelInfo]]
| A GUI-based filter that lets you pick a pixel and gives you color information.
| RGB32, YUY2
| Plugin
|-
| [[ShowPixelValues]]
| This filter displays the actual Y U and V (or R G and B) values from pixels within a frame.
| RGB32, YUY2
| Plugin
|-
| [http://code.google.com/p/avisynthrestoration/wiki/Testpatterns Testpatterns]
| This filter creates a sinewave frequency sweep directly in YV12, useful to measuring video response.
| YV12
| [http://code.google.com/p/avisynthrestoration/downloads/list Script]
|-
| TMonitor
|
|
| Plugin
|-
| ViewFields/UnViewFields
|
|
| Plugin
|-
| [[Comptest]]
| The script Compressibility test can be used for a compressibility test on a clip.
|
| Script
|
|-
| [[SeeTheDifference]]
| SeeTheDifference just makes the difference visible between an encoded and an original videoclip. So you can see what you really "lose" when encoding a video.
|
| Script
|
|-
| [http://avisynth.nl/users/BoxCompare BoxCompare]
| BoxCompare will let you compare up to 4 clips with simple annotations. It's basically a wrapper for StackHorizontal/StackVertical.
|
| Script
|
|}

=== Export Filters ===

These filters are used to export things from an avs file.

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?t=135928 Immaavs]
| ImmaWrite uses the ImageMagick libraries to write images. Many formats are supported including animations and multipage files.
|
| [http://www.geocities.com/wilbertdijkhof/ Plugin]
| {{author/Wilbert Dijkhof}}
|-
| [http://forum.doom9.org/showthread.php?p=1073371#post1073371 twriteavi]
| Serve AVI file to program requesting it as well as write an avi file. Useful for speeding up 2 pass encodes at the cost of hard drive space.
|
| [http://members.optusnet.com.au/squid_80/twriteavi.zip Plugin]
|}

=== Import Filters ===

These filters are used to import filters written for other audio and video packages.

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?threadid=92174 FreeFrame]
| Allows [http://freeframe.sourceforge.net/ freeframe] filters (mostly effects) to be used directly in avisynth.
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/freeframe_25_dll_20050426.zip Plugin]
|-
| LoadVFApiPlugin
|
|
| Plugin
|}

=== Meta-Filters ===

These filters are primarily designed to be used with other filters, to restrict or augment their effect.

{{FilterTable}}
| Motion
| see [http://avisynth.nl.users/warpenterprises/files/motion_25_dll_20051212.zip]
|
| Plugin
| mg262
|-
| [[MT]]
| MT is a filter that enables other filters to run multithreaded. This should hopefully speed up processing on hyperthreaded/multicore processors or multiprocessor systems. See [http://forum.doom9.org/showthread.php?t=94996]
| Any
| Plugin
| tsp
|-
| [[MVTools]]
| MVTools provides filters for estimation and compensation of objects' motion in video clips. Motion compensation may be used for strong temporal denoising, advanced framerate conversions, image restoration and other tasks. See [http://forum.doom9.org/showthread.php?t=131033]
|
| [http://avisynth.org.ru/mvtools/mvtools2.html Plugin]
| {{Author/Fizick}}
|}

=== Multipurpose Filters ===

{{FilterTable}}
| [[Camembert]]
| Camembert provides [[HQDering]]'s functionality with additional background enhancement.
| [[YV12]]
| Script
|-
| [http://forum.doom9.org/showthread.php?t=146632 HybridFuPP]
| An adaptive processor, allowing picture cleaning and compressibility gain.
|
| [http://avisynth.nl/images/HybridFuPP.avsi Script]
| Fupp
|-
| [[Integrated_Image_Processor|iiP]]
| Integrated Image Processor performs basic denoising and sharpening excluding already hard edges to avoid oversharpening; this should give the best relative compressibility for any level of detail enhancement. Its main purpose is upconversion from DVD resolutions to (pseudo-) HDTV resolutions. It aims at natural sources only. For animated/cartoon content, one is probably better of with [[Shared_functions/mfToon|mfToon]] and [[SharpResize]].
| [[YV12]]
| Script
|-
| [[SeeSaw]]
| SeeSaw uses a balance of denoising and sharpening to enhance a clip. The aim is to enhance weak detail without oversharpening or creating jaggies on strong detail, and produce a result that is temporally stable without detail shimmering.
| [[YV12]]
| Script
|}

=== Support filters ===

These filters are primarily designed to augment the creation of custom script-based filters.

{{FilterTable}}
| CheckMask
|
|
| Plugin
|-
| [[FrameCache]]
| Frame cache plugin. It helps greatly increase performance, especially in combination with another plugins, like SmoothDeinterlace. Usage FrameCache( [number of frames to remember], (path to log file) ).
| any
| johny5 dot coder via gmail
| {{Author/Evgeny}}
|-
| GRunT
| Extends Avisynth's [[Runtime_environment|Runtime Environment]], making it easier to use, especially inside script functions.
| Any
| [http://forum.doom9.org/showthread.php?t=139337 Plugin]
| {{Author/Gavino}}
|-
| GScript
| Extends the Avisynth scripting language to provide additional control-flow constructs: multi-line conditionals (if-then-else blocks), 'while' loops and 'for' loops.
| Any
| [http://forum.doom9.org/showthread.php?t=147846 Plugin]
| {{Author/Gavino}}
|-
| [[MaskTools]]
| This plugin provides tools for the creation, enhancement and manipulation of masks for each component (Y, U, V) of the YV12 [[Color_spaces|color space]]. See [http://forum.doom9.org/showthread.php?s=&threadid=67232 discussion].
'''This version is now deprecated, use MaskTools2 instead for new scripts.'''
| [[YV12]]
| [http://manao4.free.fr/ Plugin]
| {{Author/Kurosu}}
{{Author/Manao}}
|-
| [[MaskTools2]]
| This plugin provides tools for the creation, enhancement and manipulation of masks for each component (Y, U, V) of the YV12 [[Color_spaces|color space]].
| [[YV12]]
| [http://manao4.free.fr/ Plugin]
| {{Author/Manao}}
|-
| MergeClips
|
|
| Plugin
|-
| [[MVTools]]
| This plugin provides a collection of functions for motion estimation and compensation.
| [[YV12]], [[YUY2]]
| [http://avisynth.org.ru/mvtools/mvtools2.html Plugin]
| Various
|-
| PlaneMinMax
|
|
| Plugin
|-
| [[ApplyInterlacedFilter]]
| ApplyInterlacedFilter safely processes interlaced video with spatial and temporal filters.
|
| Script
|
|}

=== Deepcolor Filters ===

{{FilterTable}}
| Deep Color Tools
| This Script provides basic functions to import 10bit video, do color adjustments, and export to 8bit
| [http://developer.apple.com/quicktime/icefloe/dispatch019.html#v210 V210]
| [http://forum.doom9.org/showthread.php?p=1467907#post1467907 Script]
| jmac698
|-
| Dither
| Generates video with up to 16 bits per component after denoising and dithers back to 8 bits for storage. Primarily written to smooth fine gradients to remove colorbanding during/after denoising. Can also recover high bitdepth data potentially contained in a noisy clip; dither a high bitdepth picture into a standard YV12; and perform basic operations (masking, curves...) on high bitdepth pictures, as they cannot be manipulated safely with conventional avisynth filters.
| Planar colorspaces
| [http://forum.doom9.org/showthread.php?p=1386559 Plugin + scripts]
| {{Author/cretindesalpes}}
|}

=== 3D Filters ===

{{FilterTable}}
| [http://web.archive.org/web/20110809073332/http://arenafilm.hu/alsog/anaglyph/ Analglyph Filter]
| This filter produces analglyph video from a stereo pair. Analglyph is a 3d viewing method which uses colored glasses. The plugin supports the advanced [http://web.archive.org/web/20130706165544/www.site.uottawa.ca/~edubois/anaglyph/ Dubois] algorithm, which is able to reduce the ghosting effect that is possible in the conversion.
| RGB24, RGB32, YUY2, YV12
| [http://arenafilm.hu/alsog/anaglyph/ Plugin]
| {{Author/Kertai Gábor}}
|}

=== Libraries ===

{{FilterTable}}
|[http://avslib.sourceforge.net/ AVSLib]
|General purpose toolkit/extension library enhancing AviSynths ability to perform complex linear and non-linear video editing tasks. Includes support for Array containers & operators, debugging tools, math & string functions, filters and many more.
|
|[http://sourceforge.net/projects/avslib/ AVSLib]
|[http://gzarkadas.users.sourceforge.net/ gzarkadas]
|}

== Audio Filters ==

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?t=165703 waveform]
| Displays audio waveforms superimposed on the video, similar to AudioGraph below but with multi-channel support and consistent support for all colourspaces.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://horman.net/waveform0.2.zip Plugin]
| David Horman
|-
| [http://avisynth.org.ru/docs/english/externalfilters/audiograph.htm AudioGraph]
| Displays the audio waveform superimposed on the video. Intended to help with editing rather than for final output. Useful for finding specific dialog or sound, and for checking A/V sync.
| [[YUY2]], [[RGB24]], [[RGB32]]
| [http://avisynth.nl/users/warpenterprises/files/audgraph_25_dll_20040318.zip Plugin]
| {{author/Richard Ling}}
{{author/Sh0dan}}
|-
| BeFa
| Band Eliminate Filter for Audio
| N/A
| [http://niiyan.net/?JapanesePlugins#j0b47027 Plugin]
|-
| [http://forum.doom9.org/showthread.php?p=1043099#post1043099 MinMaxAudio]
| Computes the root mean square, maximal or minimal value over all samples in all channels,or just over all samples in channel, and outputs the value (in decibels) as a string. It's a conditional audio filter, so the computation is done framewise.
| N/A
| [http://www.geocities.com/wilbertdijkhof/MinMaxAudio_v02.zip Plugin]
| {{author/Wilbert Dijkhof}}
|-
| [http://forum.doom9.org/showthread.php?t=104792 Sox Audio Effect Filter]
| Use [http://sox.sourceforge.net/ SOX] effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
| N/A
| [http://forum.doom9.org/showthread.php?p=761154#post761154 Plugin]
| {{author/Sh0dan}}
|-
| ViewAudio
| includes two filters: ViewAudio and AudioCache.
|
| [http://niiyan.net/?JapanesePlugins#j0b47027 Plugin] [http://yo4kazu.110mb.com/ x64]
|-
| [[FindAudioSyncScript]]
| FindAudioSyncScript helps you to find the appropriate audio delays, if you have desync'ed audio.
|
| Script
| IanB
|-
| [[Shared_functions/AddAudio|AddAudio]]
| An AddAudio function that adds silent audio to a clip. Needed for CCE 2.50 users.
|
| Script
|
|}

== As Yet Unclassified ==

{{FilterTable}}
| [http://forum.doom9.org/showthread.php?p=397426#post397426 Adjust]
| Generic Y-Channel mapping. Can define a function for the Y Channel.
| [[YUY2]], [[RGB32]], [[RGB24]]
| [http://avisynth.nl/users/warpenterprises/#adjust Plugin]
|-
| Anaglypher
| A plugin for combining stereopairs into single anaglyph image
| [[RGB24]], [[RGB32]]
| [http://shura.luberetsky.ru/plaginy-dlya-avisynth/anaglypher/ Plugin]
| [http://shura.luberetsky.ru/ Shura Luberetsky]
|-
| [http://forum.doom9.org/showthread.php?t=118430 Average]
| Weighted average of any number of clips (fast). Average(clip clip1, int weight1, ...)
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=118430 Plugin]
|-
| [http://forum.doom9.org/showthread.php?t=45670 BorderControl]
| Add smeared borders instead of a solid if wanted.
|
| [http://www.geocities.com/siwalters_uk/bdrcntrl.html Plugin]
|-
| [http://forum.doom9.org/showthread.php?p=675275#post675275 BeforeAfter]
|
|
| Script
|-
| BeforeAfterDiff
|
|
| Plugin
|-
| BeforeAfterLine
|
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?t=46506 Call]
| Call an external program from the script.
|
| [http://avisynth.nl/users/warpenterprises/#call Plugin]
|-
| Chikitown
| A simple script to do overlay to a video RGBA in AviSynth.
|
| Script
| {{author/Chikitown}}
|-
| [http://forum.doom9.org/showthread.php?t=93990 Colorit]
| Color a black and white image or recolor a color image.
|
| [http://avisynth.nl/users/vcmohan/ColorIt/ColorIt.html Plugin]
|-
| CutFrames
| Cut a range of frames from a single a/v clip. Opposite of Trim with extras.
|
| [http://forum.doom9.org/showthread.php?t=135423 Script]
|-
| DCT
| see [http://avisynth.nl/users/warpenterprises/files/dct_25_dll_20050612.zip]
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?p=1444027#post1444027 DDigit]
| DDigit Plugin Text Rendering Pack for Plugin writers.
|
|
|
|-
| [http://forum.doom9.org/showthread.php?t=80419 DeBlot]
| Color Blot Reduction.
| [[YUY2]],[[YV12]]
| [http://avisynth.nl/users/warpenterprises/#deblot Plugin]
|-
| [http://avisynth.org.ru/exinpaint/exinpaint.html ExInpaint]
| Exemplar-Based Image Inpainting - removing large objects from images..
|
| [http://avisynth.org.ru/exinpaint/exinpaint0200.zip Plugin]
| {{Author/Fizick}}
|-
| [http://forum.doom9.org/showthread.php?t=55881 FillMargins]
| Fills the four margins of a video clip with the outer pixels of the unfilled portion. It takes integer 4 parms specifying the size of the left, top, right, and bottom margins.
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/fillmargins_25_dll_20030618.zip Plugin]
|-
| fftw3
|
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
| Use Avisynth to process still images.
|
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
|-
| GetSystemEnv
|
|
| Plugin
|-
| [http://forum.doom9.org/showthread.php?p=598958#post598958 GraMaMa]
| Gradient Mask Maker
| YV12
| [http://www.geocities.com/wilbertdijkhof/GraMaMa_v02.zip Plugin]
| {{author/E-Male}} and {{author/Wilbert Dijkhof}}
|-
| LBKiller
|
|
| Plugin
|-
| LTSMC
|
|
| Plugin
|-
| MCNR_simple2
|
|
| Plugin
|-
| NeuralNet
|
|
| Plugin
|-
| PseudoColor
| see [http://avisynth.nl/users/warpenterprises/files/pseudocolor_25_dll_20030919.zip]
|
| Plugin
|-
| Reform
| see [http://avisynth.nl/users/warpenterprises/files/reform_20060915.ZIP]
|
| Plugin
|-
| RGBManipulate
| see [http://avisynth.nl/users/warpenterprises/files/rgbmanipulate_20051011.zip]
|
| Plugin
|-
| SceneChangeLavc
| see [http://akuvian.org/src/avisynth/sclavc/]
|
| Plugin
|-
| SCXvid
| SCXvid produces first pass xvid logs from avisynth at the equuivalent of the default vfw preset. These logs are primaliy intended to get scenechange information from but could probably be used in some kind of twisted encoding setup too with lossless encoding of the output.
|
| Plugin
|-
| SlopeBend
|
|
| Plugin
|-
| [[Soothe]]
| Lessens the temporal instability and aliasing caused by sharpening, by comparing the original and sharpened clip, leaving a smoother and slightly softer output.
|
| Plugin
| Didée
|-
| UnSmooth
|
|
| Plugin
|-
| VinVerse
| An effective Function against (residual) combing, by Didée. Useful after deinterlaceing.
| YV12, YUY2
| [http://bengal.missouri.edu/~kes25c/vinverse.zip Plugin] / [http://forum.doom9.org/showthread.php?p=841641#post841641 Script]
| Didée (script) / Tritical (plugin)
|-
| WaterShed
| see [http://avisynth.nl/users/warpenterprises/files/watershed_20061105.zip]
|
| Plugin
|-
| TMM
| see [http://forum.doom9.org/showthread.php?p=980353#post980353]
|
| [http://web.missouri.edu/~kes25c/TMMv1.zip Plugin]
| Tritical
|-
| [http://sourceforge.net/projects/avisynthtrackin/ Tracking]
| demo at [http://www.youtube.com/watch?v=SQ-JtJs7US0 Youtube]. Use computer vision to track objects in the video, and produce ConditionalReader input.
|
| Plugin
| Shlomo Matichin
|
|-
| Unpremultiply
| This plugin convert the input RGBA clip from premultiplied alpha to straight matted alpha.
|
| Plugin
|
|}

[[Category:AviSynth_Usage]]
[[Category:External_filters]]

Trim

2012-11-12T05:02:17Z

Unreal666:

{{Template:Func8Def|
Trim(clip ''clip'', int ''first_frame'', int ''last_frame'' [, bool ''"pad"''])|
Trim(clip ''clip'', int ''first_frame'', int ''-num_frames'' [, bool ''"pad"''])|
Trim(clip, int ''first_frame'', int ''"end"'' [, bool ''"pad"''])|
Trim(clip, int ''first_frame'', int ''"length"'' [, bool ''"pad"''])|
AudioTrim(clip ''clip'', float ''start_time'', float ''end_time'')|
AudioTrim(clip ''clip'', float ''start_time'', float ''-duration'')|
AudioTrim(clip, float ''start_time'', float ''"end"'')|
AudioTrim(clip, float ''start_time'', float ''"length"'')
}}

Trim trims a video clip so that it includes only the frames ''first_frame'' up to ''last_frame ''(''first_frame'' and'' last_frame'' are included). The audio is similarly trimmed so that it stays synchronized. Remember AviSynth starts counting at frame 0.

If you set a negative value for ''last_frame'' you get the frames first_frame to first_frame + (-last_frame - 1) — that is, a clip starting at first_frame will be (-last_frame) frames long. [[http://forum.doom9.org/showthread.php?p=239941#post239941 doom9]]

Prior to v2.60, to trim an audio-only clip, you may not just set a fake frame rate with [[AssumeFPS]]. Instead, you must make a [[BlankClip]], use [[AudioDub]], trim ''that'', and then [[KillVideo]]. Otherwise, AviSynth returns an error message "cannot trim if there is no video".

Since v2.60 you can trim the audio using AudioTrim. The ''start_time'', ''end_time'' and ''duration'' need to be specified in seconds (but can be float). Like Trim it keeps only the audio samples corresponding to ''start_time'' up to ''end_time''. The target source clip does not need to have a video track. If present the video is similarly trimmed so that it stays synchronized within 1 frame duration.

''pad'' (default true) causes the audio stream to be padded to align with the video stream. Otherwise the tail of a short audio stream is left so. When ''last_frame''=0 and ''pad''=false the end of the two streams remains independent.

Since v2.60 you can also use AudioTrim/Trim(3, end=7) instead of AudioTrim/Trim(3, 7) and AudioTrim/Trim(3, length=7) instead of AudioTrim/Trim(3, -7). Note, the End and Length explicitly named parameters have no discontinuous boundary values. End=0 means end at frame 0. Length=0 means return a zero length clip. These are most useful in avoiding unexpected boundary conditions in your user functions.

'''Examples:'''

Trim(100,0) # delete the first 100 frames, audio padded
# or trimmed to match the video length.
Trim(100,0,false) # delete the first 100 frames of audio and video,
# the resulting stream lengths remain independent.
Trim(100,-100) # is the same as trim(100,199) ie, start=100, duration=100
Trim(100,199,false) # audio will be trimmed if longer but not
# padded if shorter to frame 199
Trim(0,-1) # returns only the first frame
Trim(0,End=0) #
Trim(0,Length=1) #
AudioTrim(1,5.5) # keeps the audio samples between 1 and 5.5 seconds
AudioTrim(1,End=5.5) #
AudioTrim(1,-5.5) # cuts the first second and keeps the following 5.5 seconds
AudioTrim(1,Length=5.5) #

'''Changes:'''

{| border="1"
|-
| v2.60
| Added AudioTrim. Added length and end parameters.
|-
| v2.56
| Added pad audio.
|}

[[Category:Internal filters]]

DirectShowSource

2012-11-12T04:30:17Z

Unreal666: /* Description */

{{Template:FuncDef|DirectShowSource(string ''filename'' [, float ''fps'', bool ''seek'', bool ''audio'', bool ''video'', bool ''convertfps'', bool ''seekzero'', int ''timeout'', string ''pixel_type'', int ''framecount'', string ''logfile'', int ''logmask''])}}

== Description ==

'''filename''': DirectShowSource reads the file ''filename'' using MS DirectShow, the same multimedia playback system which Windows Media Player uses. It can read most formats which Media Player can play, including MPEG, MP3, and some [[QuickTime]] files, as well as AVI files that [[AviSource|AVISource]] doesn't support (like DV type 1, or files using DirectShow-only codecs). Try reading AVI files with AVISource first, and if that doesn't work then try this filter instead. Since v2.53 there is also support for [[GraphEdit]] (grf) files.

There are some caveats:

# Some decoders (notably MS MPEG-4) will produce upside-down video. You'll have to use [[Flip|FlipVertical]].
# DirectShow video decoders are not required to support frame-accurate seeking. In most cases seeking will work, but on some it might not.
# DirectShow video decoders are not even required to tell you the frame rate of the incoming video. Most do, but the ASF decoder doesn't. You have to specify the frame rate using the fps parameter, like this: DirectShowSource("video.asf", fps=15).
# This version automatically detects the Microsoft DV codec and sets it to decode at full (instead of half) resolution. I guess this isn't a caveat. :-)
# Also this version attempts to disable any decoder based deinterlacing.

'''fps''': This is sometimes needed to specify the framerate of the video. If the framerate or the number of frames is incorrect (this can happen with asf or mov clips), use this option to force the correct framerate. For live sources, this is like "max fps" that will be displayed.

'''seek''' = true (in v2.53): There is full seeking support (available on most file formats). If problems occur try enabling the '''seekzero''' option first, if seeking still cause problems completely disable seeking. With seeking disabled the audio stream returns silence and the video stream the last rendered frame when trying to seek backwards. Note the Avisynth cache may provide limited access to the previous few frames, beyond that the last frame rendered will be returned.

'''audio''' = true (in v2.53): There is audio support in DirectShowSource. DirectShowSource is able to open formats like WAV/DTS/AC3/MP3, provided you can play them in WMP for example (more exact: provided they are rendered correctly in graphedit). The channel ordening is the same as in the [http://www.cs.bath.ac.uk/~jpff/NOS-DREAM/researchdev/wave-ex/wave_ex.html wave-format-extensible format], because the input is always decompressed to WAV. For more information, see also [[GetChannel]]. AviSynth loads 8, 16, 24 and 32 bit int PCM samples, and float PCM format, and any number of channels.

'''video''' = true (in v2.52): When setting it to false, it lets you open the audio only.

'''convertfps''' = false (in v2.56): When setting it to true, it turns variable framerate video (vfr) into constant framerate video (cfr) by adding frames. This is useful when you want to open vfr video (for example mkv, rmvb, mp4, asf or wmv with hybrid video) in AviSynth. It is most useful when the fps parameter is set to the least common multiple of the component vfr rates, e.g. 120 or 119.880.

'''seekzero''' = false (in v2.56): An option to restrict seeking only back to the beginning. It allows limited seeking with unindexed ASF. Seeking forwards is of course done the hard way (by reading all samples).

'''timeout''' = 60000 (in milliseconds; 60000 ms = 1 min) (in v2.56): To set time to wait when DirectShow refuses to render. Positive values return blank frames and/or silence. Negative values cause a runtime AviSynth exception to be thrown.

'''pixel_type''' (in v2.56): The pixel type of the resulting clip, it can be "YV12", "YUY2", "AYUV", "Y41P", "Y411", "ARGB", "RGB32", "RGB24", "YUV", "RGB" or "AUTO". By default, upstream DirectShow filters are free to bid all of their supported media types in the order of their choice. A few DirectShow filters get this wrong. The '''pixel_type''' argument limits the acceptable video stream subformats for the IPin negotiation. Note the graph builder may add a format converter to satisfy your request, so make sure the codec in use can actually decode to your chosen format. The M$ format converter is just adequate. The "YUV" and "RGB" pseudo-types restrict the negotiation to all supported YUV or RGB formats respectively. The "AUTO" pseudo-type permits the negotiation to use all relevant formats in the order of preference YV12, YUY2, AYUV, Y41P, Y411, ARGB, RGB32, RGB24. Many DirectShow filters get this wrong, which is why it is not enabled by default. The option exists so you have enough control to encourage the maximum range of filters to serve your media. (See [http://forum.doom9.org/showthread.php?t=143321 discussion].)

'''framecount''' (in v2.57): This is sometimes needed to specify the framecount of the video. If the framerate or the number of frames is incorrect (this can happen with asf or mov clips), use this option to force the correct number of frames. If fps is also specified the length of the audio stream is also adjusted. For live sources, specify a very large number.

'''logfile''' (in v2.57): Use this option to specify the name of a debugging logfile.

'''logmask''' = 35 (in v2.57): When a logfile is specified, use this option to select which information is logged.

{| border="1"
|-
| Value
| Data
|-
| 1
| Format Negotiation
|-
| 2
| Receive samples
|-
| 4
| GetFrame/GetAudio calls
|-
| 8
| Directshow callbacks
|-
| 16
| Requests to Directshow
|-
| 32
| Errors
|-
| 64
| COM object use count
|-
| 128
| New objects
|-
| 256
| Extra info
|-
| 512
| Wait events
|}

Add the values together of the data you need logged. Specify -1 to log everything. The default, 35, logs Format Negotiation, Received samples and Errors. i.e 1+2+32

== Examples ==

Opens an avi with the first available RGB format (without audio):

<code>
DirectShowSource("F:\TestStreams\xvid.avi",fps=25, audio=false, pixel_type="RGB")
</code>

Opens a DV clip with the MS DV decoder:

<code>
DirectShowSource("F:\DVCodecs\Analysis\Ced_dv.avi") # MS-DV
</code>

Opens a variable framerate mkv as 119.88 by adding frames (ensuring sync):

<code>
DirectShowSource("F:\Guides\Hybrid\vfr_startrek.mkv", fps=119.88, convertfps=true)
</code>

Opens a realmedia *rmvb clip:

<code>
DirectShowSource("F:\test.rmvb", fps=24, convertfps=true)
</code>

Opens a GraphEdit file:

<code>
V=DirectShowSource("F:\vid_graph.grf", audio=False) # video only (audio renderer removed)
A=DirectShowSource("F:\aud_graph.grf", video=False) # audio only (video renderer removed)
AudioDub(V, A)
</code>

See below for some audio examples.

== Troubleshooting video and audio problems ==
AviSynth will by default try to open only the media it can open without any problems. If one component cannot be opened it will simply not be added to the output. This will also mean that if there is a problem, you will not see the error. To get the error message to the missing component, use audio=false or video=false and disable the component that is actually working. This way AviSynth will print out the error message of the component that doesn't work.

=== The filter graph won't talk to me ===
This is a common error that occurs when DirectShow isn't able to deliver any format that is readable to AviSynth. Try creating a filter graph manually and see if you are able to construct a filter graph that delivers any output AviSynth can open. If not, you might need to download additional DirectShow filters that can deliver correct material.

=== The samplerate is wrong ===
Some filters might have problems reporting the right samplerate, and then correct this when the file is actually playing. Unfortunately there is no way for AviSynth to correct this once the file has been opened. Use [[AssumeSampleRate]] and set the correct samplerate to fix this problem.

=== My sound is choppy ===
Unfortunately Directshow is not required to support sample exact seeking. Open the sound another way, or demux your video file and serve it to AviSynth another way. Otherwise you can specify "seekzero = true" or "seek = false" as parameters or use the [[EnsureVBRMP3Sync]] filter to enforce linear access to the Directshow audio stream.

=== My sound is out of sync ===
This can happen especially with WMV, apparently due to variable frame rate video being returned. Determine what the fps should be and set it explicitly, and also "ConvertFPS" to force it to remain constant. And [[EnsureVBRMP3Sync]] reduces problems with variable rate audio.

<code>
DirectShowSource("video.wmv", fps=25, ConvertFPS=True)
EnsureVBRMP3Sync()
</code>

=== My ASF renders start fast and finish slow ===
Microsoft in their infinite wisdom chose to implement ASF stream timing in the ASF demuxer. As a result it is not possible to strip ASF format files any faster than realtime. This is most apparent when you first start to process the streams, usually after opening the AviSynth script it takes you a while to configure your video editor, all this time the muxer is accumulating credit time. When you then start to process your stream it races away at maximum speed until you catch up to realtime at which point it slows down to the realtime rate of the source material. This feature makes it impossible to use AviSynth to reclock 24fps ASF material up to 25fps for direct PAL playback.

== Common tasks ==
This section will describe various tasks that might not be 100% obvious. :)

=== Opening GRF files ===

[[GraphEdit]] GRF-files are automatically detected by a .grf filename extension and directly loaded by DirectShowSource. For AviSynth to be able to connect to it, you must leave a pin open in GraphEdit of a media types that AviSynth is able to connect to. AviSynth will not attempt to disconnect any filters, so it is important that the output type is correct. DirectShowSource only accepts YV12, YUY2, ARGB, RGB32 and RGB24 video formats and 32, 24, 16 and 8 bit PCM and IEEE FLOAT audio formats.

A given GRF-file should only target one of an audio or video stream to avoid confusion when directshowsource attempts the connection to your open pin(s). From version 2.57 this single stream restriction is enforced.

=== Downmixing AC3 to stereo ===

There are essentially two ways to do this. The first is to set the downmixing in the configuration of your AC3 decoder itself, and the second one is to use the external downmixer of "Trombettworks":

1) Install AC3filter.

a) Open '''AC3Filter Config'''
 
On tab "Main" in section "Output format" select "2/0 - stereo".
 
[Nothing else is needed.]

'''''-OR-'''''

b) Open the AC3 file in WMP6.4 and select the file properties. Set the output of AC3Filter on '''2/0 - stereo'''. If you want the best possible quality, select PCM Float as Sample format.

{| border=0 cellspacing=0 cellpadding=5
| [[Image:ac3downmix1a.jpg]]
|-
| [[Image:ac3downmix1b.jpg]]
|}

Make the following script:

<code>
v = [[Mpeg2Source]]("e:\movie.d2v")
a = DirectShowSource("e:\Temp\Test2\test.ac3")
[[AudioDub]](v,a)
</code>

Finally, open the script in vdub and convert the audio stream to MP3 (of course you can also demux the downmixed WAV stream if needed).

2) Register the directshow filter [http://www.trombettworks.com/directshow.php Channel Downmixer by Trombettworks] (under start -> run):

:''regsvr32 ChannelDownmixer.ax''

Open the AC3 file in WMP6.4 and select the file properties. Set the output of AC3Filter on '''3/2+SW 5.1 channels''' (this downmixer can't handle PCM Float, thus PCM 16 bit is selected here). In the properties of the downmixer, the number of input and output channels should be detected automatically. Check whether this is indeed correct.

{| border=0 cellspacing=0 cellpadding=5
| [[Image:ac3downmix2a.jpg]]
|-
| [[Image:ac3downmix2b.jpg]]
|-
| [[Image:ac3downmix2c.jpg]]
|}

Make the following script:

<code>
v = Mpeg2Source("e:\movie.d2v")
a = DirectShowSource("e:\Temp\Test2\test.ac3")
AudioDub(v,a)
</code>

Finally, open the script in vdub and convert the audio stream to MP3 (of course you can also demux the downmixed WAV stream if needed).

For some reason, I can't get this to work with DTS streams :(

== Windows7 users ==

Windows 7 forces its own DirectShow filters for decoding several audio and video formats. Changing their merits or physically removing those filters doesn't help. clsid made the tool "[http://forum.doom9.org/showthread.php?t=146910 Win7DSFilterTweaker]" to change the preferred filters. However new decoders need to be added each time so it's not the perfect solution.

== Changes ==

{| border=1 cellspacing=1 cellpadding=4
| v2.60
| Added pixel_types "AYUV", "Y41P", "Y411".
|-
| v2.57
| framecount overrides the length of the streams.
|-
|
| logfile and logmask specify debug logging.
|-
| v2.56
| convertfps turns vfr into constant cfr by adding frames
|-
|
| seekzero restricts seeking to beginning only
|-
|
| timeout controls response to recalcitrant graphs
|-
|
| pixel_type specifies/restricts output video pixel format
|}

== See also ==

Haali media splitter also comes with an (unrelated) directshow input plugin [[External_filters|DirectShowSource2]]

[[Category:Internal filters]]
[[Category:Media file filters]]

Internal functions/String functions

2012-11-12T04:14:47Z

Unreal666: /* String functions */

== String functions ==

They provide common operations on string variables.

* {{ScriptFunction|LCase|v2.07|LCase(string)}}
: Returns lower case of string.
: ''Examples:''
LCase("AviSynth") = "avisynth"

* {{ScriptFunction|UCase|v2.07|UCase(string)}}
: Returns upper case of string.
: ''Examples:''
UCase("AviSynth") = "AVISYNTH"

* {{ScriptFunction|StrLen|v2.07|StrLen(string)}}
: Returns length of string.
: ''Examples:''
StrLen("AviSynth") = 8

* {{ScriptFunction|RevStr|v2.07|RevStr(string)}}
: Returns string backwards.
: ''Examples:''
RevStr("AviSynth") = "htnySivA"

* {{ScriptFunction|LeftStr|v2.07|LeftStr(string, int)}}
: Returns first int number of characters.
: ''Examples:''
LeftStr("AviSynth", 3) = "Avi"

* {{ScriptFunction|RightStr|v2.07|RightStr(string, int)}}
: Returns last int number of characters.
: ''Examples:''
RightStr("AviSynth", 5) = "Synth"

* {{ScriptFunction|MidStr|v2.07|MidStr(string, int pos [, int length])}}
: Returns substring starting at ''pos'' for optional ''length'' or to end. ''pos''=1 specifies start.
: ''Examples:''
MidStr("AviSynth", 3, 2) = "iS"

* {{ScriptFunction|FindStr|v2.07|FindStr(string, substring)}}
: Returns position of substring within string (note this function is case-sensitive). Returns 0 if substring is not found.
: ''Examples:''
Findstr("AviSynth", "Syn") = 4

* {{ScriptFunction|FillStr|v2.60|FillStr(int [, string])}}
: Fills a string. When int>1 it concatenates the string int times. String is space by default.
: ''Examples:''
FillStr(1, "AviSynth") = "AviSynth"
FillStr(2, "AviSynth") = "AviSynthAviSynth"

* {{ScriptFunction|StrCmp|v2.60|StrCmp(string, string)}}
: Compares two character strings. The comparison is case-sensitive. If the first string is less than the second string, the return value is negative. If it's greater, the return value is positive. If they are equal, the return value is zero. (The actual value seems to be language dependent so it can't be relied upon.)
: ''Examples:''
StrCmp("AviSynth", "AviSynth") = 0 # strings are equal.
StrCmp("AviSynth", "Avisynth") != 0 # strings are not equal.

* {{ScriptFunction|StrCmpi|v2.60|StrCmpi(string, string)}}
: Compares two character strings. The comparison is not case-sensitive. If the first string is less than the second string, the return value is negative. If it's greater, the return value is positive. If they are equal, the return value is zero. (The actual value seems to be language dependent so it can't be relied upon.)
: ''Examples:''
StrCmpi("AviSynth", "AviSynth") = 0 # strings are equal.
StrCmpi("AviSynth", "Avisynth") = 0 # strings are equal.
StrCmpi("abcz", "abcdefg") != 0 # returns the difference betweeen "z" and "d" (which is positive).

* {{ScriptFunction|Chr|v2.51|Chr(int)}}
: Returns the ASCII character.
: Note that characters above the ASCII character set (ie above 127) are code page dependent and may render different (visual) results in different systems. This has an importance only for user-supplied localised text messages.
: ''Examples:''
Chr(34) returns the quote character
Chr(9) returns the tab character

* {{ScriptFunction|Ord|v2.60|Ord(string)}}
: Gives the ordinal number of the first character of a string.
: ''Examples:''
Ord("a") = 97
Ord("AviSynth") = Ord("A") = 65
Ord("§") = 167

* {{ScriptFunction|Time|v2.51|Time(string)}}
: Returns a string with the current system time formatted as defined by the string.
: The string may contain any of the codes for output formatting presented below:
{| border=1 cellspacing=1 cellpadding=4
|-
! Code
! Description
|-
| %a
%A
| Abbreviated weekday name
Full weekday name
|-
| %b
%B
| Abbreviated month name
Full month name
|-
| %c
| Date and time representation appropriate for locale
|-
| %d
| Day of month as decimal number (01 ? 31)
|-
| %H
%I
| Hour in 24-hour format (00 ? 23)
Hour in 12-hour format (01 ? 12)
|-
| %j
| Day of year as decimal number (001 ? 366)
|-
| %m
| Month as decimal number (01 ? 12)
|-
| %M
| Minute as decimal number (00 ? 59)
|-
| %p
| Current locale?s A.M./P.M. indicator for 12-hour clock
|-
| %S
| Second as decimal number (00 ? 59)
|-
| %U
| Week of year as decimal number, with Sunday as first day of week (00 ? 53)
|-
| %w
| Weekday as decimal number (0 ? 6; Sunday is 0)
|-
| %W
| Week of year as decimal number, with Monday as first day of week (00 ? 53)
|-
| %x
| Date representation for current locale
|-
| %X
| Time representation for current locale
|-
| %y
%Y
| Year without century, as decimal number (00 ? 99)
Year ''with'' century, as decimal number
|-
| %z, %Z
| Time-zone name or abbreviation; no characters if time zone is unknown
|-
| %%
| Percent sign
|}
: The # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows:
{| border=1 cellspacing=1 cellpadding=4
|-
! Code with # flag
! Change in meaning
|-
| %#a, %#A, %#b, %#B,
%#p, %#X, %#z, %#Z, %#%
| No change; # flag is ignored.
|-
| %#c
| Long date and time representation, appropriate for current locale. For example:
?Tuesday, March 14, 1995, 12:41:29?.
|-
| %#x
| Long date representation, appropriate to current locale. For example:
?Tuesday, March 14, 1995?.
|-
| %#d, %#H, %#I, %#j, %#m, %#M,
%#S, %#U, %#w, %#W, %#y, %#Y
| Remove leading zeros (if any).
|}

----
Back to [[Internal functions]].

[[Category:AviSynth_Syntax]]
[[Category:Scripting_Basics]]

User:Fizick/Internal filters

2012-03-29T12:47:29Z

Unreal666: Undo revision 8309 by Playseo (Talk)

In AviSynth v2.5 a fourth color format is available besides RGB24, RGB32 and YUY2: [[YV12]]. See [[FAQ_YV12|YV12 FAQ]] for more information. This color format is special, since video is stored as YV12 in many codecs (including MPEG4 and MPEG2 on DVDs). In AviSynth v2.6 several other planar color formats are available: [[YV24]] (YUV 4:4:4), [[YV16]] (YUV 4:2:2), [[YV411]] (YUV: 4:1:1) and [[Y8]] (greyscale). The available (internal) filters are listed here and divided into categories. A short description is added, including the supported color formats (and samples types) for the audio filters).

An alphabetical listing of the filters can be found here [[:Category:Internal_filters]].

=== Media file filters ===

These filters are to read or write media files. Usually they produce a source clips for processing. See debug filters fo non-file source filters.

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[AviSource]] / [[AviFileSource]] / [[OpenDMLSource]]
| Opens an AVI file.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[DirectShowSource]]
| Opens a filename using [[DirectShow]].
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ImageReader]] / [[ImageSource]]
| This filter produces a video clip by reading in still images.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ImageWriter]]
| Writes frames as images to your hard disk.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Import]]
| Imports an AviSynth script into the current script.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SegmentedAviSource]] / [[SegmentedDirectShowSource]]
| This filter automatically loads up to 100 avi files per argument.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[WavSource]]
| Opens a WAV file or the audio of an AVI file.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SoundOut]]
| SoundOut is a GUI driven sound output module for AviSynth (it exports audio to several compressors).
| All audio.
|}

=== Color filters ===

These are to change clip color format or adjust frame colors (uniformly or with a mask).

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[ColorKeyMask]]
| Sets the alpha-channel (similar as Mask does) but generates it by comparing the color.
| RGB32
|-
| [[ColorYUV]]
| Adjusts colors and luma independently.
| YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ConvertBackToYUY2]]
| Converts a RGB clip back to YUY2.
| RGB24, RGB32
|-
| [[ConvertToRGB]]
| Converts to RGB32 unless clip is RGB24.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ConvertToRGB24]] / [[ConvertToRGB32]] / [[ConvertToYUY2]] / [[ConvertToY8]] / [[ConvertToYV411]] / [[ConvertToYV12]] / [[ConvertToYV16]] / [[ConvertToYV24]]
| Converts to RGB24 / RGB32 / YUY2 / Y8 / YV411 / YV12 / YV16 (planar version of YUY2) / YV24 (full YUV).
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[GreyScale]]
| Converts a video to greyscale.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Invert]]
| Inverts selected color channels of a video.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24 ?
|-
| [[Layer]]
| Layering two videos.
| RGB32, YUY2
|-
| [[Levels]]
| The Levels filter scales and clamps the blacklevel and whitelevel and adjusts the gamma.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Limiter]]
| A filter for clipping levels to within CCIR-601 range.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Mask]]
| Applies an alpha-mask to a clip.
| RGB32
|-
| [[MaskHS]]
| This filter returns a mask (as Y8) of clip using a given hue and saturation range.
| YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[MergeARGB]] / [[MergeRGB]]
| This filter makes it possible to select and combine a color channel from each of the input videoclips.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[MergeChroma]] / [[MergeLuma]]
| This filter makes it possible to merge chroma/luma from a videoclip into another. There is an optional weighing, so a percentage between the two clips can be specified.
| YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Merge]]
| This filter makes it possible to merge both luma and chroma from a videoclip into another. There is an optional weighing, so a percentage between the two clips can be specified.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Overlay]]
| Overlay puts two clips on top of eachother with an optional displacement of the overlaying image, and using different overlay methods. Furthermore opacity can be adjusted for the overlay clip.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ResetMask]]
| Applies an "all-opaque" alpha-mask to clip.
| RGB32
|-
| [[RGBAdjust]]
| Adjusts each color channel seperately.
| RGB24, RGB32
|-
| [[ShowAlpha]] / [[ShowRed]] / [[ShowGreen]] / [[ShowBlue]]
| Shows the selected channel of an (A)RGB clip.
| RGB24, RGB32
|-
| [[SwapUV]]
| Swaps chroma channels.
| YUY2, Y8, YV411, YV12, YV16, YV24 ?
|-
| [[Subtract]]
| Produces an output clip in which every pixel is set according to the difference between the corresponding pixels.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16 (?), YV24
|-
| [[UToY]] / [[VToY]]
| Copies chroma U/V plane to Y plane (image is now half as big)
| YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[UToY8]] / [[VToY8]]
| Shorthand for UToY.ConvertToY8 / VToY.ConvertToY8.
| YUY2, YV411, YV12, YV16, YV24
|-
| [[YToUV]]
| Puts the luma channels of the two clips as U and V channels. Image is now twice as big, and luma is 50% grey. Use MergeLuma, if you want to add luma values.
| YUY2, YV12 ?
|-
| [[Tweak]]
| Adjusts the hue, saturation, brightness, and contrast.
| YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[FixLuminance]]
| Correct shifting vertical luma offset.
| YUY2
|}

=== Geometric filters ===

These filters are to change image size, process borders or make other deformation

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[AddBorders]]
| Adds black borders around the image.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Crop]]
| Crops excess pixels off of each frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[CropBottom]]
| Crops excess pixels off of the bottom of each frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Letterbox]]
| Letterbox simply blackens out the top and the bottom and optionally left and right side of each frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ReduceBy2]]
| Reduces the size of each frame by half.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[HorizontalReduceBy2]] / [[VerticalReduceBy2]]
| Reduces the size of each frame by half horizontally/vertically.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[BicubicResize]] / [[BilinearResize]] / [[GaussResize]] / [[LanczosResize]] / [[Lanczos4Resize]] / [[PointResize]] / [[Spline16Resize]] / [[Spline36Resize]]
| The resize filters rescale the input video frames to an arbitrary new resolution, using different sampling algorithms.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[FlipHorizontal]] / [[FlipVertical]]
| Flips the video from left to right/upside-down.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[TurnLeft]] / [[TurnRight]] / [[Turn180]]
| Rotates the clip 90 degrees counterclock wise / 90 degrees clock wise.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[StackHorizontal]] / [[StackVertical]]
| Takes two or more video clips and displays them together in left-to-right/up-to-down order.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|}

=== Pixel filters ===

These filters are for image detail (pixel) restoration (like denoising, sharpening).
Most such filters are implemented as a AviSynth external plugins with various advanced algorithmes of pixel processing.

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[Blur]] / [[Sharpen]]
| This a simple 3x3-kernel blurring/sharpening filter.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[GeneralConvolution]]
| General 3x3 or 5x5 convolution matrix.
| RGB32
|-
| [[SpatialSoften]] / [[TemporalSoften]]
| Removes noise from a video clip by selectively blending pixels spatially/temporally.
| YUY2 (SpatialSoften), Y8, YV411, YV12, YV16, YV24
|-
| [[FixBrokenChromaUpsampling]]
| The free Canopus DV Codec v1.00 upsamples the chroma channels incorrectly (although newer non-free versions appear to work fine). FixBrokenChromaUpsampling filter compensates for it.
| YUY2
|}

=== Timeline editing filters ===

This filters are to arrange frames in a time (clip cutting, splicing and other editing).

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[AlignedSplice]] / [[UnalignedSplice]]
| Joins two or more video clips end to end.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[AssumeFPS]] / [[AssumeScaledFPS]] / [[ChangeFPS]] / [[ConvertFPS]]
| Changes framerates in different ways.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[DeleteFrame]]
| Deletes a single frame, given as an argument.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Dissolve]]
| Like [[AlignedSplice]], except that the clips are combined with some overlap.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[DuplicateFrame]]
| Duplicates a single frame given as an argument.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[FadeIn0]] / [[FadeIn]] / [[FadeIn2]] / [[FadeOut0]] / [[FadeOut]] / [[FadeOut2]] / [[FadeIO0]] / [[FadeIO]] / [[FadeIO2]]
| Causes the video stream to fade linearly to black at the start or end.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[FreezeFrame]]
| Replaces all the frames between first-frame and last-frame with a selected frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Interleave]]
| Interleaves frames from several clips on a frame-by-frame basis.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Loop]]
| Loops the segment from start frame to end frame a given number of times.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Reverse]]
| This filter makes a clip play in reverse.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SelectEven]] / [[SelectOdd]]
| Makes an output video stream using only the even/odd numbered frames.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SelectEvery]]
| Selects frames with a fixed period, it is a generalization of [[SelectEven]] and [[SelectOdd]].
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SelectRangeEvery]]
| Selects a range of frames with a fixed period.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Trim]]
| Trims a video clip so that it includes only the frames first-frame through last-frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|}

=== Interlace filters ===

These filters are for treating interlaced video.
Currently (v2.5x and older versions), AviSynth has no interlaced flag which can be used for interlaced video. There is a field-based flag, but contrary to what you might expect, this flag is not related to interlaced video. In fact, all video (progressive or interlaced) is framebased, unless you use AviSynth filters to change that. There are two filters who turn framebased video into fieldbased video: [[SeparateFields]] and [[AssumeFieldBased]]. More information about field-based video can be found here (...).

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[AssumeFrameBased]] / [[AssumeFieldBased]]
| Forces frame-based or field-based material.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[AssumeBFF]] / [[AssumeTFF]]
| Forces field order.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Bob]]
| Bob takes a clip and bob-deinterlaces it.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ComplementParity]]
| Changes top fields to bottom fields and vice-versa.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[DoubleWeave]]
| The filter operates like [[Weave]], except that it produces double the number of frames by combining both the odd and even pairs of fields.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Pulldown]]
| This filter simply selects two out of every five frames of the source video.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SeparateFields]]
| Takes a frame-based clip and splits each frame into its component top and bottom fields.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[SwapFields]]
| Swaps the two fields in an interlaced frame.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Weave]]
| Weave takes even pairs of fields from a Fields Separated input video clip and combines them together to produce interlaced frames.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[PeculiarBlend]]
| This filter blends each frame with the following frame in a peculiar way.
| YUY2
|}

=== Audio filters ===

Prior to v2.5 the audio samples are converted to 16 bits when using one of these audio filters. Starting from v2.5 the audio samples will be automatically converted if any filters requires a special type of sample. This means that most filters will accept several types of input, but 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 colorspace 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.

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Sample type
|-
| [[Amplify]] / [[AmplifydB]]
| Amplify multiply audio samples by amount.
| 16Bit, 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
|-
| [[ConvertAudioTo8bit]] / [[ConvertAudioTo16bit]] / [[ConvertAudioTo24bit]] / [[ConvertAudioTo32bit]] / [[ConvertAudioToFloat]]
| Converts audio samples to 8/16/24/32/Float bits.
| All
|-
| [[ConvertToMono]]
| Merges all audio channels.
| 16Bit, 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 from a clip completely.
| All
|-
| [[MergeChannels]]
| Merges channels of two audio clips.
| All
|-
| [[MixAudio]]
| Mixes audio from two clips.
| 16Bit, Float
|-
| [[MonoToStereo]]
| Converts two mono signals to one stereo signal.
| 16Bit, Float
|-
| [[Normalize]]
| Amplifies the entire waveform as much as possible, without clipping.
| 16Bit, Float
|-
| [[ResampleAudio]]
| Performs a high-quality change of audio sample rate.
| 16Bit
|-
| [[SuperEQ]]
| High quality 16 band sound equalizer.
| Float
|-
| [[SSRC]]
| Very high quality samplerate conversion.
| Float
|-
| [[TimeStretch]]
| This filter can change speed of the sound without changing the pitch, and change the pitch of a sound without changing the length of a sound.
| Float
|-
| [[Tone]]
| This will generate sound.
| Float
|}

=== Meta filters ===

These are special filters to control other filters execution.

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[Animate]] / [[ApplyRange]]
| Animate (ApplyRange) is a meta-filter which evaluates its parameter filter with continuously varying (the same) arguments.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24 ?
|-
| [[ConditionalFilter]] / [[FrameEvaluate]] / [[ScriptClip]] / [[ConditionalReader]]
| ConditionalFilter returns source1 if some condition is met, otherwise it returns source2. ScriptClip returns the clip which is returned by the function evaluated on every frame.
| YV12 ?
|-
| [[TCPServer]] / [[TCPSource]]
| This filter will enable you to send clips over your network. You can connect several clients to the same machine.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|}

=== Debug filters ===

{| style="height:100px" border="1" cellpadding="4"
!width=25%| Filter
!width=50%| Description
!width=25%| Color format
|-
| [[BlankClip]] / [[Blackness]]
| This filter produces a solid color, silent video clip of the specified length (in frames).
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[ColorBars]]
| This filter produces a video clip containing SMPTE color bars scaled to any image size.
| RGB32, YUY2, YV12
|-
| [[Compare]]
| Compares two clips and prints out information about the differences.
| RGB24, RGB32, YUY2
|-
| [[Histogram]]
| Adds a histogram.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Info]]
| Prints out image and sound information.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[MessageClip]]
| Produces a clip containing a text message.
| RGB32
|-
| [[ShowFiveVersions]]
| Takes five video streams and combines them in a staggered arrangement from left to right.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16 (?), YV24
|-
| [[ShowFrameNumber]] / [[ShowSMPTE]]
| Draws text on every frame indicating what number AviSynth thinks it is.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[Subtitle]]
| Adds a single line of anti-aliased text to a range of frames.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24
|-
| [[WriteFile]] / [[WriteFileIf]] / [[WriteFileStart]] / [[WriteFileEnd]]
| Output to a textfile.
| RGB24, RGB32, YUY2, Y8, YV411, YV12, YV16, YV24 ?
|-
| [[Version]]
| Generates a video clip with a short version and copyright statement.
| RGB24
|}

[[Category:AviSynth_Syntax]]

Internal functions/Conversion functions

2012-01-10T18:26:06Z

Unreal666: corrected example for Hex ( Hex ("A52A2A") = 10824234 => Hex (10824234) = "A52A2A" )

== Conversion functions ==

These functions convert between different types. There are also some [[Internal_functions/Numeric_functions|numeric functions]] that can be classified in this category, namely: <tt>Ceil, Floor, Float, Int</tt> and <tt>Round</tt>.

* {{ScriptFunction|Value|v2.07|Value(string)}}
: Converts a decimal string to its associated numeric value.
: ''Examples:''
Value ("-2.7") = -2.7

* {{ScriptFunction|HexValue|v2.07|HexValue(string)}}
: Converts a hexadecimal string to its associated numeric value.
: ''Examples:''
HexValue ("FF00") = 65280

* {{ScriptFunction|Hex|v2.60|Hex(int)}}
: Converts a numerical value to its hexadecimal value. See [[Colors]] for more information on specifying colors.
: ''Examples:''
Hex (10824234) = "A52A2A"

* {{ScriptFunction|String|v2.07|String(float / int [, string format_string])}}
: Converts a variable to a string.
: If the variable is float or integer, it first converts it to a float and then uses format_string to convert the float to a string. The syntax of format_string is as follows:
: <tt>%[flags][width][.precision]f</tt>
: ''width'': the minimum width (the string is never truncated)
: ''precision'': the number of digits printed
: ''flags'':
:: <tt>- </tt> left align (instead right align)
:: <tt>+ </tt> always print the +/- sign
:: <tt>0 </tt> padding with leading zeros
:: <tt>' '</tt> print a blank instead of a "+"
:: <tt># </tt> always print the decimal point
: You can also put arbitrary text around the format_string as defined above, similar to the C-language ''printf'' function.
: ''Examples:''
[[Subtitle]]( "Clip height is " + String(last.height) )
[[Subtitle]]( String(x, "Value of x is %.3f after AR calc") )
[[Subtitle]]( "Value of x is " + String(x, "%.3f") + " after AR calc") ) # same as above
String(1.23, "%f") = '1.23'
String(1.23, "%5.1f") = ' 1.2'
String(1.23, "%1.3f") = '1.230'
String(24, "%05.0f") = '00024'

----
Back to [[Internal functions]].

[[Category:AviSynth_Syntax]]
[[Category:Scripting_Basics]]

SoundOut

2011-10-29T04:25:03Z

Unreal666: del of spam

SoundOut is a GUI driven sound output module for AviSynth.

== Installation and Usage ==

The filter is implemented as a plugin, which currently can be downloaded from [http://forum.doom9.org/showthread.php?t=120025 this Doom9 forum thread].
It will be included in AviSynth from v2.6 on.

Copy "SoundOut.dll" and "libsndfile-1.dll" to your AviSynth plugin directory, usually "c:\program files\avisynth 2.5\plugins". If you want to have "SoundOut.dll" in another location, you should move "libsndfile-1.dll" to your system32 folder, usually "c:\windows\system32".

Add SoundOut() to your script where you would like to export audio. If you have your video stored in a [[Script_variables|variable]], use SoundOut(variable) to add SoundOut. A GUI should then pop up when you open your script. Here is a simple example of how to use it:

[[AviSource]]("myvideo.avi")
SoundOut()

If you need to do some sample processing, i.e. to change the samplerate or otherwise edit your video, you must do it before calling the SoundOut module. Like this:

AviSource("myvideo.avi")
[[Amplify|AmplifydB]](3)
[[SSRC]](44100)
SoundOut()

== Output Modules ==

=== WAV/AIF/CAF ===

This will allow you to export uncompressed audio to the following formats:

* Microsoft WAV format
* Apple/SGI AIFF format
* Sun/NeXT AU format
* RAW PCM data
* Sonic Foundry's 64 bit RIFF/WAV (WAVE64)
* Apple Core Audio File format
* Microsoft WAV format with Broadcast Wave Format chunk.

Note, that 8 bit samples are NOT supported in the Core Audio File and Sun/NeXT AU format.

=== FLAC ===

This will allow you to export lossless compressed audio FLAC format.

FLAC supports 8, 16 or 24 bit audio. Any other format is internally converted to 24 bit.

=== APE ===

This will allow you to export lossless compressed audio to the Monkey Audio Codec (APE) format. APE does not support input sample sizes that are larger than 2GB. Use only for smaller files.

APE supports 8, 16 or 24 bit audio. Any other format is internally converted to 24 bit.

=== MP2 ===

This will allow you to compress your audio to MPEG 1 Layer 2 (MP2).

TwoLame only supports 16 mono or stereo audio. If you attempt to compress more than two channels, an error will be shown. Any other format than 16 bit integer samples are internally converted to 16 bit.
=== MP3 ===

This will allow you to compress your audio to MPEG 1 Layer 3 (MP3) using LAME v3.97 encoder.

LAME Supports up to two channels of audio and the following samplerates: 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025 and 8000Hz.

=== AC3 ===

This will allow you to compress your audio to A/52 (AC3). The encoding is done via libaften.

Aften supports 1 to 6 channel audio. Supported samplerates are 48000, 44100 or 32000 samples per second.

Channel mapping is:
{| border="1"
| Number of channels
| Channel order
|-
| 1
| Center
|-
| 2
| Left, Right
|-
| 3
| Left, Center, Right
|-
| 4
| Left, Right, Surround Left, Surround Right
|-
| 5
| Left, Center, Right, Surround Left, Surround Right
|-
| 6
| Left, Center, Right, Surround Left, Surround Right, LFE
|}

=== OGG ===

This will allow you to compress your audio to an Vorbis encoded OGG file. It is possible to give an average bitrate, or do the encode as CBR.

=== WavPack ===

WavPack is a completely open audio compression format providing lossless, high-quality lossy compression mode. Compatible with virtually all PCM audio formats including 8, 16, 24, and 32-bit ints; 32-bit floats; mono, stereo, and multichannel; sampling rates from 6 to 192 kHz (and non-standard rates)

=== Commandline Output ===

This output module will allow you to output to any program that supports input from stdin. This gives you complete control of your encoding, if you have commandline tools for the job.

You can select the format SoundOut should deliver to the application you use. There are three WAV formats and RAW PCM data. This is sent to stdin of the application. The program builds the command line from 4 parts, the executable, command line options before the output file, the output file that is selected, and command line options after the output file name.

There are two ways of specifying the executable. Either give complete path to the executable, or simply enter the executable's filename, and place it in a subdirectory called SoundOut in your plugin directory.

== Exporting from script ==

It is possible to use SoundOut as an ordinary filter, running inside the script and giving parameters for each output mode. The parameters consists of two things: General Parameters, which can be used for all filters, and filter specific parameters, which gives parameters to the active output module.

The out parameter determines whether the GUI will be shown, if it is properly set, the filter will begin exporting audio as soon as it is started.

If the out parameter is not set, it is still possible to set additional parameters. The defaults will however be retrieved from the registry, but specific parameters override

=== General Parameters ===

{| border="1"
| Parameter name
| Type
| Values
|-
| output
| string
| Select output module to use. Possible values are: 
"WAV", "AC3", "MP2", "MP3", "OGG", "FLAC", "MAC", "WV" and "CMD". 
If none, or an invalid value is given, the ordinary GUI will be shown.
|-
| filename
| string
| Full path to the output filename, including extension. 
No extra quotes are required. 
If no filename is given a file selector will pop up.
|-
| showprogress
| boolean
| Show the progress window? Default: true
|-
| overwritefile
| string
| "Yes": Always overwrite file. 
"No": Never Overwrite file. 
"Ask": Ask if file should be overwritten.
|-
| autoclose
| bool
| Should the progress window close automatically 5 seconds after encoding has finished? 
This will also code the window, even though an error occurred. 
Default: false
|-
| silentblock
| bool
| When processing, enabling this option will return silent samples instead of blocking the requesting application. If disabled, any application requesting audio will be blocking, while sound is being exported 
Default: true
|-
| addvideo
| bool
| When enabled, this will add video to the current output, if none is present. The video is a black 32x32 pixels at 25fps, with the length of the audio. 
Default: true
|-
| wait
| integer
| How many seconds should the output window be shown, if autoclose is on. 
Default: 5.
|}

=== WAV/AIF/CAF Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| type
| integer
| Select WAVE format 
0: Microsoft WAV (default), 
1: WAV with WAVEFORMATEX, 
2: Apple/SGI AIFF, 
3: Sun/NeXT AU, 
4: RAW PCM, 
5: S.F. WAVE64, 
6: Core Audio File, 
7: Broadcast Wave.
|-
|format
|integer
|Sets the sample format number of bits per sample. 
0: 16bit per sample, 
1: 24bit per sample, 
2: 32bit per sample, 
3: 32bit float per sample, 
Default: Same as input.
|-
| peakchunck
| boolean
| Add Peak chunk to WAV file? 
Default: false
|}

Audio will be written in the format delivered to the SoundOut plugin. All internal sound formats are supported.

=== FLAC Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| compressionlevel
| integer
| Sets the compression level. 1 (fastest) to 8 (slowest) 
Default: 6
|}

=== APE Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| compressionlevel
| integer
| Sets the compression level. 1 (fastest) to 6 (slowest) 
Default: 3
|}

=== MP2 Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| bitrate
| integer
| Sets Bitrate for CBR or maximum bitrate for VBR. 
Default: 192
|-
| stereomode
| integer
| -1: Automatic (default) 
0: Separate Stereo 
1: Separate Stereo 
2: Joint Stereo 
3: Dual Channel 
4: Mono
|-
| psymodel
| integer
| -1: Fast & Dumb 
0: Low complexity 
1: ISO PAM 1 
2: ISO PAM 2 
3: PAM 1 Rewrite (default) 
4: PAM 2 Rewrite
|-
| vbrquality
| float
| Sets VBR Quality. Useful range is about -10 to 10. 
Default is 0
|-
| vbr
| boolean
| Encode as VBR? 
Default: false.
|-
| quick
| boolean
| Quick Encode? 
Default: false.
|-
| dab
| boolean
| Add DAB Extensions? 
Default: false. 
According to TwoLame documentation this might not be reliable.
|-
| crc
| boolean
| Add CRC Error checks? 
Default: false.
|-
| original
| boolean
| Set Original Flag? 
Default: false.
|-
| copyright
| boolean
| Set Copyright flag? 
Default: false.
|-
| emphasis
| integer
| Set Emphasis flag. 
0: No Emphasis (default) 
1: 50/15 ms 
3: CCIT J.17
|}

=== MP3 Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| mode
| integer
| Sets Encoding mode: 
0: VBR (default) 
1: ABR 
2: CBR
|-
| vbrpreset
| integer
| Sets quality preset, when using VBR mode. 
Standard = 1001 (default), 
extreme = 1002, 
insane = 1003, 
standard_fast = 1004, 
extreme_fast = 1005, 
medium = 1006, 
medium_fast = 1007
|-
| abrrate
| integer
| Sets Average bitrate for ABR encoding. 
Default: 128 
cbrrate integer Sets Bitrate for CBR encoding. 
Default: 128
|}

=== AC3 Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| iscbr
| boolean
| Encode at Constant Bitrate? 
Default: true.
|-
| cbrrate
| integer
| Sets Bitrate for CBR or maximum bitrate for VBR. 
Default: 384
|-
| vbrquality
| integer
| VBR Bitrate quality. Values between 1 and 1023 are accepted. 
Default: 220.
|-
| drc
| integer
| Dynamic Range Compression
0: Film Light 
1: Film Standard 
2: Music Light 
3: Music Standard 
4: Speech 
5: None (default)
|-
| acmod
| integer
| Set channel mapping. 
0 = 1+1 (Ch1,Ch2) 
1 = 1/0 (C) 
2 = 2/0 (L,R) 
3 = 3/0 (L,R,C) 
4 = 2/1 (L,R,S) 
5 = 3/1 (L,R,C,S) 
6 = 2/2 (L,R,SL,SR) 
7 = 3/2 (L,R,C,SL,SR)
|-
| dialognormalization
| integer
| Dialog normalization. Values from 0 to 31 are accepted. 
Default: 31.
|-
| islfe
| boolean
| Is there LFE channel present? 
Default: false if less than 4 channels, true otherwise.
|-
| bandwidthfilter
| boolean
| Use the bandwidth low-pass filter? 
Default: false.
|-
| lfelowpass
| boolean
| Use the LFE low-pass filter. 
Default: false.
|-
| dchighpass
| boolean
| Use the DC high-pass filter. 
Default: false.
|-
| dolbysurround
| boolean
| Is the material Dolby Surround encoded? (only applies to stereo sound, otherwise ignored) 
Default: false.
|-
| blockswitch
| boolean
| Selectively use 256-point MDCT? 
Default: false (Use only 512-point MDCT).
|-
| accuratealloc
| boolean
| Do more accurate encoding? 
Default: true.
|}

=== OGG Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| vbrbitrate
| integer
| Selects the average bitrate to encode at. 
Default: 128.
|-
| cbr
| boolean
| Encode as CBR? 
Default: false.
|}

=== Wavpack Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| compressionlevel
| integer
| Sets the compression level. 0(Very Fast) to 5(Extremely Slow) 
Default: 2 (Normal)
|-
|format
|integer
|Sets the sample format number of bits per sample. 
0: 8bit per sample, 
1: 16bit per sample, 
2: 24bit per sample, 
3: 32bit per sample, 
4: 32bit float per sample, 
Default: Same as input.
|}
=== Commandline Output Script Parameters: ===

{| border="1"
| Parameter name
| Type
| Values
|-
| type
| integer
| Select WAVE format. 
0: Microsoft WAV (default), 
1: WAV with WAVEFORMATEX, 
2: RAW PCM, 
3: S.F. WAVE64.
|-
| format
| integer
| Select Output Bits per sample. 
0: 16 Bit 
1: 24 Bit 
2: 32 Bit 
3: 32 bit float 
Default is same as input.
|-
| executable
| string
| Executable to use. 
Default: "aften.exe" (without quotes).
|-
| prefilename
| string
| Parameters that are placed before the output filename. 
Default: "-b 384 -" (without quotes).
|-
| postfilename
| string
| Parameters that are placed after the output filename. 
Default: "" (without quotes).
|-
| showoutput
| boolean
| Show the output window? 
Default: true.
|-
| nofilename
| boolean
| Encode without output filename, and don't use postfilename? 
Default: false.
|}

== Examples ==

SoundOut(output = "mp3", filename="c:\outputFile.mp3", autoclose = true, showprogress = true, mode = 2, cbrrate = 192)

Engages mp3 output module with CBR at 192kbit/sec.

== Implementation notes ==

SoundOut is multi-threaded, and uses one thread for requesting audio from the previous filters, and another thread for encoding. The threads are given a "below normal" priority.

Only attempt to run two exports at the same time at your own risk. It is most likely slower and could potentially crash. You can safely export sound while you encode, if your encode does not read audio from AviSynth.

== Changelist ==

{|border=1 cellspacing=1 cellpadding=4
| v2.60
| Initial Release; based on v1.1.1
|}

v1.1.1
* Downgraded FLAC to v1.2.0, to avoid backwards incompatible 24 bit files.
* Conversion tune-up.
* OverWriteFile set to "No" was not respected.
* Client sample requests shown in GUI.

v1.1.0
* Added WavPack output module.
* Added Sample type selection to WAV Output.
* Updated FLAC to v 1.2.1 - 24 bit/sample seems broken, so only 8 & 16 bit are enabled.
* Fixed bug in FLAC to enable files larger than 2GB.
* FLAC now uses the same GUI as other filters.
* Aften updated.
* Re-enabled Aften multithreading.
* Faster 3DNOW! float to 24 bit conversion.

v1.0.3
* Vorbis, AC3 and MP3 now checks if file can be created.
* Fixed hang in aften on multiprocessor machines.
* Added wait parameter, how many seconds should SoundOut wait on autoclose.
* Avoid lockup if encoder cannot be initialized and set for direct output.
* Fixed OverwriteFile was not always being respected.

v1.0.2
* Updated libaften to rev534.
* Fixed overwriteFile not being recognized in script.
* Fixed crash if mp2 file could not be opened for writing.
* Exit blocked, even if filter is (almost) instantly destroyed, if script is set for output.
* AC3 is now reporting the actual samples encoded (including padding).

v1.0.1
* Updated libaften to rev. 512.
* Added overwriteFile="yes"/"no"/"ask". Default is Ask.

v1.0.0
* The application will not exit, as long as an encode window is open.
* Fixed "nofilename" not being recognized in script.
* LFE no longer overridden by registry, when using GUI.

v0.9.9
* Added ReplayGain calculation to Analyze.
* Parent filters are now blocked, or silent samples are returned, if the filter is currently exporting sound.
* Video is automatically added, if none is present. (black 32x32 RGB32)
* Buttons for export are disabled when output window is open.
* Main window is now minimized when export module is selected.
* Fixed Analyze bug on 16 bit samples.
* Fixed WAVEFORMATEXTENSIBLE channel mapping in Commandline Output.
* AC3 output: LFE option disabled when not relevant.
* AC3 output: LFE option named properly.

v0.9.8
* Added Analyze option to calculate average, maximum and RMS levels. Only available through GUI.
* WAVEFORMATEXTENSIBLE in commandline out attempts to set channel maps based on channel number.
* Fixed thread race issue on very fast encoders.
* Minor GUI tweaks.

v0.9.7
* Added channelmapping to AC3 output.
* Added LFE channel indicator switch to AC3 output.
* GUI now spawned in a new thread, fixing GUI lockup in foobar2000 and similar.
* Fixed general thread race issue, where a fast encoder might lead to incomplete output.
* Fixed WAVE_FORMAT_EXTENSIBLE header without info in CmdLine Output.
* Fixed "Format" not working on Commandline output.
* Fixed Filename dialog not appearing.
* Forced final samplereading to be correct.
* Removed "private" option from MP2 GUI and script, as there is no way to set it via twolame.
* Removed DAB Extensions from MP2 GUI, as TwoLame reports it as not functioning.

v0.9.6
* Added complete script customization.
* Added possibility to set output file from script.
* Added window autoclose option to script.
* Added option to script to disable progress window.
* GUI creates message handle thread.
* Settings are now saved to registry if output filter initializes successfully.
* Updated documentation.

v0.9.5
* Added Broadcast WAVE out.
* Fixed OGG Vorbis support.
* Fixed Text fields not being correctly read.
* Fixed AC3 settings not being restored properly.
* Added: MP2 settings are now saved.

v0.9.4
* Added OGG Vorbis support.
* Added: Parameters stored (on save) and read to registry.
* Added: "No filename needed" option in commandline output, to disable output filename prompt.
* Fixed collision between libaften and libvorbis.
* Updated libaften to rev 257.
* Enabled SSE optimizations in libaften.
* Hopefully fixed issue with commandline executable filename becoming garbled.

v 0.9.3
* Added Commandline piping output.
* Added MP3 / LAME output.
* Fixed AC3 VBR Error sometimes wrongly being displayed.
* Fixed AC3 DRC Setting not being respected.
* Various GUI bugfixes.

v 0.9.2
* Updated AC3 GUI.
* Fixed crash in WAV output.
* More stats during conversion.

v 0.9.1
* Added AC3 Output.
* Added new parameter handling.
* Fixed last block not being encoded.

[[Category:Internal filters]]
[[Category:Media file filters]]

NTSC

2011-09-14T17:19:56Z

Unreal666: New page: TODO Category:Glossary

TODO

[[Category:Glossary]]

PAL

2011-09-14T17:19:06Z

Unreal666: New page: TODO Category:Glossary

TODO

[[Category:Glossary]]

Ffdshow

2011-09-14T15:46:17Z

Unreal666:

ffdshow is DirectShow and VFW codec for decoding/encoding many video and audio formats, including DivX and XviD movies using libavcodec, xvid and other opensourced libraries with a rich set of postprocessing filters.

* original: http://sourceforge.net/projects/ffdshow
* latest versions: http://ffdshow-tryout.sourceforge.net/

[[Category:Glossary]]

GraphEdit

2011-09-14T15:15:48Z

Unreal666:

"GraphEdit is a visual tool for building and testing filter graphs. It is provided as an executable with the DirectX SDK. With GraphEdit, you can quickly build and test filter graphs to see if they function as you expect. You can even view a filter graph created by an application running in another process." (Taken from the GraphEdit help file)

A filter in this case is the front end of a codec. GraphEdit lets you visually connect codecs together, allowing you to override default priorities of the codecs. Also allowing access to disabled codecs. GraphEdit was designed for the testing of codecs.

To get the latest version download the [http://www.microsoft.com/downloads/details.aspx?FamilyId=484269E2-3B89-47E3-8EB7-1F2BE6D7123A&displaylang=en Platform SDK], [http://www.videohelp.com/tools/GraphEdit GraphEdit] only. The latest version of GraphEdit is 9.04.78.0000 Build 060303.

[[Category:Glossary]]

MakeAVIS

2011-09-14T14:45:46Z

Unreal666:

MakeAVIS is an AVI wrapper which is included in [[ffdshow]] ([http://forum.doom9.org/showthread.php?s=&threadid=49964 discussion]). Note that this program was also included in the installation of AviSynth v2.52.

Get updated versions of MakeAvis from [http://forum.doom9.org/showthread.php?t=120465 ffdshow-tryout project]

[[Category:Glossary]]

Vfapi

2011-09-14T14:42:50Z

Unreal666:

VFAPI is an AVI wrapper. For VFAPI you need to install the [http://www.vcdhelp.com/forum/userguides/87270.php ReadAVS plugin]. Just copy ReadAVS.dll to the VFAPI reader directory and open the reg-file ReadAVS.reg in notepad and change the corresponding path. Save it, and doubleclick on it to merge it with your registry-file.

[[Category:Glossary]]

Huffyuv

2011-09-14T13:23:42Z

Unreal666:

Huffyuv is a lossless video codec created by BenRG (the original developer of AviSynth), patterned after JPEG-LS. It supports RGB, UYVY, and YUY2.

Its homepage used to be at [http://math.berkeley.edu/~benrg/huffyuv.html] but has disappeared. It is mirrored [http://web.archive.org/web/20020607190222/math.berkeley.edu/~benrg/huffyuv.html here]. Version 2.1.1 (binaries and source) is downloadable at [http://neuron2.net/www.math.berkeley.edu/benrg/huffyuv.html Donald Graft's mirror].

Latest Huffyuv can be found here: [http://www.doom9.org/index.html?/software2.htm Huffyuv v2.1.1 CCE SP-Patch v0.2.5, released Dec 22, 2003]. Get the file huffyuv_ccesp-patch_025.zip.

Another implementation exists within libavcodec (MPlayer, FFDShow, etc), which extends the format to support YV12.

[[Category:Glossary]]
[[Category:LosslessCodecs]]
[[Category:Codecs]]

MPEG-4

2011-09-14T13:09:38Z

Unreal666:

TODO

[[Category:Glossary]]

Formal AviSynth grammar

2011-04-10T16:46:02Z

Unreal666: /* The AviSynth Grammar in EBNF Notation */ spelling: extened -> extended

== Introduction ==

This page presents the ''formal grammar'' of the AviSynth script language. This is a dense representation of all the rules of the AviSynth script language. While it probably is of more interest to a developer than to an average user, it is nevertheless an essential piece of documentation for any programming language and it is thus provided here for those more inclined to abstract mathematical reasoning. Have fun!

Before going to the grammar, a few introductory material will be necessary for all those that don't eat bytes for breakfast. If you are familiar with BNF / EBNF syntax then skip the following section.

== Background Information ==

Formal grammars of programming and scripting languages are typically written in Backus-Naur Form (BNF) or Extended Backus-Naur Form (EBNF) syntax. We have chosen the EBNF syntax because it is easier for human comprehension and thus it is a slightly better selection for documentation purposes. The syntax used here follows the ISO/IEC 14977 Standard, "Extended BNF". The table below summarizes the notation used (<tt>infix</tt> means that the operator has left associativity; <tt>postfix</tt> that it has right associativity).

{|width=85% border=1 cellspacing=2 cellpadding=4
! Extended BNF
! Operator
! Meaning
! Comment
|-
| unquoted words
|
| Non-terminal symbol
| A symbol that is a grouping of low-level symbols (ie not a fundamental one).
|-
| "..."
|
| Terminal symbol
| A fundamental (ie not further divisible) symbol of the language.
|-
| '...'
|
| Terminal symbol
| Same as above.
|-
| (...)
|
| Brackets
| Parentheses just group the symbols inside them in a single (non-terminal) symbol.
|-
| [...]
|
| Optional symbols
| The symbols inside square braces are optional (ie they are present either 0 or 1 times)
|-
| {...}
|
| Symbols repeated ''zero or more'' (ie >= 0) times
|
|-
| {...}-
|
| Symbols repeated ''one or more'' (ie >= 1) times
| Note that the - immediately ''follows'' the curly braces.
|-
| =
| infix
| Defining symbol
| This is the "assignment" operator of EBNF; the left (non-terminal) symbol is (equal to) the right grouping of symbols.
|-
| ;
| postfix
| Rule terminator
| This operator signals the end of the (assignment) rule (just like in C ; ends a statement).
|-
| <nowiki>|</nowiki>
| infix
| Alternative
| Either one of the alternative terminal or non-terminal symbols (and only one) will be matched.
|-
| ,
| infix
| Concatenation
| Symbols on both ends of the , (comma) operator are joined sequentially to form a single (non-terminal) symbol.
|-
| -
| infix
| Exception
| The effect is the logical negation of the rule following. For example -"a" becomes ? all characters not equal to a ?.
|-
| *
| infix
| Occurences of
| The effect of this operator is to repeat the symbol to its right {n} times, where n is the value to its left. For example to state that a (fortran) label has exactly 5 characters, one can state: <tt>label = 5 * character;</tt>.
|-
| (*...*)
|
| Comment
| Arbitrary text documenting something (this is the comment facility of the EBNF language).
|-
| ?...?
|
| Special sequence
| Arbitrary text whose interpretation is beyond the scope of the EBNF standard.
|}

'''Note:'''
For defining character sequences as terminal symbols one can either use the "string" or 'string' facilities of the EBNF language or to use the concatenation operator: character-a , character-b , ..., character-z. However for some repetitive tasks such as enumerating all characters of the alphabet or all numeric digits, etc. it is common to use a range notation of the form <tt>start...end</tt> as an extension to the standard. We use it also here.

== The AviSynth Grammar in EBNF Notation ==

In the formulation of the AviSynth grammar below, there are certain items that are not considered part of the grammar and thus are considered responsibilities of the tokenizer (to process and strip-off). These are the following:
* Whitespace.
* Comments (both single-line and multi-line).
* Line continuations.
* The end-of-file condition.

<pre>
script =
{ declaration }-
;
declaration =
statement
| function_definition
;
function_definition =
kw_function , identifier , '(' , [ parameters_list ] , ')' ,
compound_statement
;
(* optional arguments must come after all positional arguments *)
parameters_list =
arguments , ',' , optional_arguments (* either both types in order *)
| arguments (* or only one (any) of them *)
| optional_arguments
;
arguments =
argument , [ { ',' , argument } ]
;
(* Note: If type_spec is missing, it is implicitly assumed to be: t_val *)
argument =
[ type_spec ] , identifier
;
optional_arguments =
optional_argument , [ { ',' , optional_argument } ]
;
(* Despite the formulation, the tokenizer does not handle whitespace correctly. *)
(* Example: an optional argument declared simply "int f" parses without error. *)
optional_argument =
[ type_spec ] , quote , identifier , quote
;
type_spec =
t_val | t_string | t_bool | t_int | t_float | t_clip
;
(* This is probably a parser bug (due to C-origin) because there is only one global *)
(* function table in AviSynth; it should be '{' , { statement } , '}' instead and *)
(* statement definition below would include function_definition. Then, declaration *)
(* would be un-needed as a grammar rule and also: script = { statement }- ; *)
compound_statement =
'{' , { declaration } , '}'
;
statement = (* free-standing compound statements are ?not? allowed *)
expression
| try_statement
| jump_statement
;
try_statement =
kw_try , compound_statement ,
kw_catch , '(' , [ identifier ] , ')' , compound_statement
;
jump_statement =
kw_return , [ expression ]
;
(* Although expression has only one subtype, keep as a separate production rule *)
(* for documentation and for easier update of the grammar if extended at future. *)
expression =
assignment_exp
;
assignment_exp =
conditional_exp
| [ kw_global ] , identifier , '=' , assignment_exp
;
conditional_exp =
logical_or_exp
| logical_or_exp , '?' , expression , ':' , conditional_exp
;
logical_or_exp =
logical_and_exp
| logical_or_exp , '||' , logical_and_exp
;
logical_and_exp =
equality_exp
| logical_and_exp , '&&' , equality_exp
;
equality_exp =
relational_exp
| equality_exp , equ_binary_operator , relational_exp
;
equ_binary_operator =
'==' | '!=' | '<>'
;
relational_exp =
additive_exp
| relational_exp , rel_binary_operator , additive_exp
;
rel_binary_operator =
'<' | '>' | '<=' | '>='
;
additive_exp =
multiplicative_exp
| additive_exp , add_binary_operator , multiplicative_exp
;
add_binary_operator =
'+' | '-' | '++' (* ++ is for clips *)
;
multiplicative_exp =
unary_exp
| multiplicative_exp , mul_binary_operator , unary_exp
;
mul_binary_operator =
'*' | '/' | '%'
;
unary_exp =
[ unary_operator ] , postfix_exp
;
unary_operator =
sign | '!'
;
(* Because OOP notation simply puts the 1st argument of a function in front of its call *)
(* it can be chained to all alternatives of primary_exp; therefore this is its place *)
postfix_exp =
primary_exp
| function_call
| primary_exp , { '.' , function_call }- (* the OOP notation *)
;
function_call =
identifier , [ '(' , [ argument_exp_list ] , ')' ]
;
(* Assignment is allowed only to optional arguments, *)
(* which must come after all positional arguments *)
argument_exp_list =
positional_arg_list , ',' , optional_arg_list (* either both types in order *)
| positional_arg_list (* or only one (any) of them *)
| optional_arg_list
;
positional_arg_list =
expression
| positional_arg_list , ',' , expression
;
optional_arg_list =
identifier , '=' , expression
| optional_arg_list , ',' , identifier , '=' , expression
;
primary_exp =
constant
| identifier
| '(' , expression , ')'
;
identifier =
( letter | "_" ) , { letter | digit | "_" }
;
constant =
integer_constant | float_constant | boolean_constant | stringliteral
;
stringliteral =
quote , { -quote } , quote | tripleqouote , { -tripleqouote } , tripleqouote
;
boolean_constant =
true | false | yes | no
;
integer_constant =
decimalinteger | hexinteger
;
float_constant =
[ sign ] , ( [ intpart ] , fraction | intpart , '.' )
;
decimalinteger =
[ sign ] , ( nzero_digit , { digit } | '0' )
;
hexinteger =
"$" , { hexdigit }-
;
fraction =
'.' , intpart
;
intpart =
{ digit }-
;
hexdigit =
digit | 'a'...'f' | 'A'...'F'
;
letter =
'a'...'z' | 'A'...'Z'
;
digit =
'0' | nzero_digit
;
nzero_digit =
'1'...'9'
;
sign =
'-' | '+'
;

quote = '"' ;
triplequote = '"""' ;

true = i_t , i_r , i_u , i_e ;
false = i_f , i_a , i_l , i_s , i_e ;
yes = i_y , i_e , i_s ;
no = i_n , i_o ;

t_val = i_v , i_a , i_l ;
t_string = i_s , i_t , i_r , i_i , i_n , i_g ;
t_bool = i_b , i_o , i_o , i_l ;
t_int = i_i , i_n , i_t ;
t_float = i_f , i_l , i_o , i_a , i_t ;
t_clip = i_c , i_l , i_i , i_p ;

kw_function = i_f , i_u , i_n , i_c , i_t , i_i , i_o , i_n ;
kw_try = i_t , i_r , i_y ;
kw_catch = i_c , i_a , i_t , i_c , i_h ;
kw_global = i_g , i_l , i_o , i_b , i_a , i_l ;
kw_return = i_r , i_e , i_t , i_u , i_r , i_n ;

i_a = ( 'a' | 'A' ) ;
i_b = ( 'b' | 'B' ) ;
i_c = ( 'c' | 'C' ) ;
i_e = ( 'e' | 'E' ) ;
i_f = ( 'f' | 'F' ) ;
i_g = ( 'g' | 'G' ) ;
i_h = ( 'h' | 'H' ) ;
i_i = ( 'i' | 'I' ) ;
i_l = ( 'l' | 'L' ) ;
i_n = ( 'n' | 'N' ) ;
i_o = ( 'o' | 'O' ) ;
i_p = ( 'p' | 'P' ) ;
i_r = ( 'r' | 'R' ) ;
i_s = ( 's' | 'S' ) ;
i_t = ( 't' | 'T' ) ;
i_u = ( 'u' | 'U' ) ;
i_v = ( 'v' | 'V' ) ;
i_y = ( 'y' | 'Y' ) ;

</pre>
----
Back to the [[AviSynth Syntax]]

[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

The full AviSynth grammar

2011-04-04T10:34:47Z

Unreal666: /* The Full Avisynth Grammar - For Language Lawyers */ spelling

== Introduction ==

From the perspective of the AviSynth interpreter each script is a series of tokens. The general term <tt>token</tt> corresponds to the basic building element of a script (if we imagine a script as a wall, then the tokens are the bricks). The AviSynth grammar is the set of rules (the recipe) for identifying and grouping tokens into higher-level structures.

We present those rules in the following sections, in a bottom-up fashion (from low-level to higher-level constructs). However, for a reader with a basic understanding of programming that wants a ''quick tour'' of the language another road is possible: start directly with the [[#Expressions and Statements|Expressions and Statements]] section and visit previous sections if a clarification is needed.

== Case ==

The very first and maybe most important one rule of the AviSynth grammar is case. '''AviSynth ignores case''':

aViSouRCe

is just as good as

AVISource

For the AviSynth Grammar both entries correspond to the '''same token'''. Thus, you should always have in mind that capitalisation does not matter when defining your variables and functions; you must always ensure that they are unique in a ''case-insensitive'' manner.

== Whitespace, Line Continuation and Comments ==

The first layer of grammar rules concerns the identification of tokens out of the overall script text. Text that does not belong to a token is commonly referred to as ''whitespace'' in most programming and scripting languages.

=== Whitespace ===

Whitespace in AviSynth language consists of:
* Space, tab and newline characters (except inside ''string literals'').
* The backslash (\) character when it is the ''first or last non-whitespace character in a line'' (and ''not inside a string literal'').
* Comments.
* Anything from the appearance of the <nowiki>__END__</nowiki> special keyword up to the end of the script file.

=== Backslash ===

The backslash character serves the role of ''line continuation''. It is used to split a large line of code in multiple ones for better readability of the script when editing, yet serve it to the AviSynth interpreter as a single logical line of code. Line splitting examples (both valid and equal):

Subtitle("Hello, World!", 100, 200, 0, \
999999, "Arial", 24, $00FF00)
-or-
Subtitle("Hello, World!", 100, 200, 0,
\ 999999, "Arial", 24, $00FF00)

=== Comments ===

Comments serve the purpose of code documentation. They come in the following flavors:

* ''Standard comments'': They start with a pound ('''#''') character and extend to the end of the line.

* ''Block comments'' (AviSynth v2.58 and later): They start either with '''/*''' or '''[*''' and extend until a (closing) '''*/''' or '''*]''', respectively, is found downstream the script text. They can span multiple lines and the '''[*''' form also supports nested block comments.

Examples of comments:

[[AviSource]]("myclip.avi") # this is a standard comment

/* this is a block comment
we can write a lot here
SubTitle("Hello, World!")
and also comment out multiple lines of code
*/

[* this is a nested block comment
[*
a meaningful example will follow later :)
*]
for the time being just experiment *]

The comments mechanism has higher precedence than the backslash. If you comment out a line that ends with \, line continuation will '''not''' happen. A quick example from real life (someone did submitted a bug report for this):

[[ColorBars]]
[[ShowFrameNumber]]
Trim(0,9) # select some frames \
+ Trim(20,29)

The above example does not return frames [0..9,20..29] as the user intended because the "\" is masked by the comment start "#" character before it; thus the line continuation never happens. The comment should go at the last line.

=== The <nowiki>__END__</nowiki> special keyword ===

The <nowiki>__END__</nowiki> special keyword can be used to quickly disable some last commands of the script. Example:

[[Version]]()
<nowiki>__END__</nowiki>
[[ReduceBy2]]()
Result is not reduced and we can write any text here

== Keywords, Identifiers, Literals and Punctuation ==

The second layer of grammar rules - once whitespace has been handled and tokens have been identified - concerns the categorisation of tokens (that is, finding the ''type'' of the tokens). Tokens generally belong to one of the following categories:

* ''Keywords'': Tokens with specific, standard meaning for the AviSynth language (ie ''reserved words'').
* ''Identifiers'': Tokens that identify an entity (a variable, a function, etc.).
* ''Literals'': Tokens that represent a value (ie a constant quantity).
* ''Punctuation'': This generic term comprises all tokens with specific, standard meaning for the AviSynth language that are too short to be considered keywords. They include:
:* [[Operators]].
:* Grouping and ordering tokens.

=== Keywords ===

The following are AviSynth language's keywords. We use here an all lowercase notation, but bear in mind that since AviSynth ''ignores case'', any equivalent combination of uppercase / lowercase letters counts as a keyword (for example: try, Try, tRy, trY, TRy, TrY, tRY, TRY):

* function : Begins the declaration of a [[User_defined_script_functions|user-defined script function]].
* global : Modifies a variable, such that it has global scope.
* return : Returns (the result of the expression on the right) from the enclosing 'script block' - usually a function or the main script, but may also be a try or catch block, an Eval string or an Import file.
* try : Starts the try part of a <tt>try..catch</tt> block. See [[Control structures]] for details.
* catch : Starts the catch part of a <tt>try..catch</tt> block. See [[Control structures]] for details.

The following keyword is a special [[#Identifiers|identifier]] (ie variable):

* last : The special ''last'' variable available on any scope for implicit assignment (see below in [[#Expressions and Statements|Expressions and Statements]] for details).

The following keywords are special [[#Literals|literals]] (ie constants):

* true : Boolean constant denoting a positive truth value (a true statement).
* false : Boolean constant denoting a negative truth value (a false statement).
* yes : Same as true.
* no : Same as false.

The following keywords are used only inside arguments lists of function declarations to declare the ''type'' of arguments:

* clip : The function argument following the keyword is a video clip.
* int : The function argument following the keyword is an integer.
* float : The function argument following the keyword is a floating point number.
* string : The function argument following the keyword is a character string.
* bool : The function argument following the keyword is a boolean (true/false) variable.
* val : The function argument following the keyword can be of '''any''' type (ie any of the above types).

=== Identifiers ===

Identifiers, as the term suggests, are specific and unique names that you use in your script to refer to distinct entities. In AviSynth language identifiers are used to ''name'' the following types of entities:

* [[Script_variables|Variables]] : A variable is a symbolic placeholder for a value that can be read and changed (as a result of an assignment) many times during script execution.
* Functions : A function is a piece of code that performs a specific computation and returns its result to the caller.

Thus, whenever you need in your script to refer to a variable or function, either [[Internal_functions|built-in]] or [[User_defined_script_functions|user-defined]] you have to use an identifier. Bear in mind that since AviSynth ''ignores case'', your identifiers should be unique in a '''case-insensitive''' manner.

For example, the following is probably an error:

MyClip = [[AviSource]]("clip1.avi")
myclip = AviSource("clip2.avi") # oops! these two lines assign to the *same* variable

while this is correct:

MyClip = AviSource("clip1.avi")
YourClip = AviSource("clip2.avi")

=== Literals ===

Literals are all the constant (ie specific) values that you use in your scripts. For instance, all the tokens that appear at the right side of the assignment operator (the "=" character) in the examples below are literals:

a_num = 123
another_num = 2.456

a_string = "this is a string literal"

another_string = """this is a multiline
string literal. Note that the 2nd line has leading spaces (which are included)
while this line has not. Also newlines are included in this type
of strings"""

a_boolean = true

As you can see, literals can be of any type (except clips; currently AviSynth does not have clip-type literals). The thing that differentiates them from identifiers is that they are not names that hold a value but bare values.

=== Punctuation ===

As said before, this generic term comprises all tokens with specific, standard meaning for the AviSynth language that are too short to be considered keywords. The tokens that are bundled under this catch-all category are:

* [[Operators|operators]]: Operators apply an operation to one or more entities (and allow to retrieve the result of the operation); this is the reason that they are named that way.
: In essence operators are mini-functions that are defined in the script grammar with a more user-friendly syntax (for instance, instead of calling <tt>Add(a, b)</tt> it is easier to write <tt>a + b</tt>).
: Due to their significance in the AviSynth language operators are documented in a [[Operators|separate page]]. They are just listed here for completeness:
:* Assignment: =
:* Sign and common math operations: + , - , * , / , % , ++ (the last is for clips only)
:* Comparisons: ==, != , <> , < , > , <= , >=
:* Boolean operations: ! , && , ||
:* Ternary operation (if...else): ?:

* Grouping / ordering tokens. These include:
:* The comma character [''',''']: For separating arguments in function argument lists only.
:* The dot character ['''.''']: When successive calls to functions are chained together with the use of the OOP notation.
:* The parenthesis, opening and closing ['''()''']: For grouping expressions into a single unit. Also for grouping arguments of a function declaration or call.
:* The (curly) brackets ['''{}''']: For grouping multiple statements in a single ''block'' of code (currently: function bodies and <tt>try...catch</tt> blocks only).

== Expressions and Statements ==

The third layer of grammar rules - after whitespace has been handled and tokens have been identified and distributed to the available categories (keywords, identifiers, etc.) - concerns the grouping of tokens in higher-level structures of the grammar: expressions and statements. A little terminology is necessary at this point to clarify the difference between them.

* Expressions are groupings of tokens that perform a computation and return a value. They form a distinct part of either a larger enclosing expression or a statement.
* Statements are the smallest standalone element of an AviSynth script; in other words a statement is a single unit of script code (in the case of AviSynth language, this is typically a line of script code).

Having made this distinction, lets see each one in more detail at the sections that follow.

=== Expressions ===

Expressions are the first step in the creation of the higher-level grammar constructs. They combine tokens in order to ''compute a new value'' from old ones and deliver this new value to either a surrounding expression or directly to an even higher-level construct, ie a statement.

A few examples will help to fully understand the concepts presented above:

# 10 is a literal;
# it is also an expression; a grouping can have just 1 element
a = 10

# a + 7 is an expression; so is (a + 7) / 5
b = (a + 7) / 5

# b > 0, 12, 25 are expressions (see 1st line);
# [b > 0 ? 12 : 25] is also an expression
c = b > 0 ? 12 : 25

# BlankClip(...) below is an expression;
# so is Trim(...)
[[Trim]]([[BlankClip]](width=b, height=c, pixel_type="[[RGB32]]"), 0, a)

# all the above lines of code are statements

Most of the time the result of an expression will be a video clip; however an expression's result can be of any type supported by the scripting language (clip, int, float, bool, string) and this is how utility functions such as [[Internal_functions|internal script functions]] operate.

Combining all information presented above, we can now see that an AviSynth ''expression'' typically has one of these forms (with square brackets, ([]), we enclose optional elements, with the vertical bar character, (|), we separate alternatives, with the pound character, (#), we enclose comments):

* ''Literal'', ie:
numeric_constant
| string_constant
| bool_constant

The value of the ''expression'' is the value of the constant.

* ''Identifier'', ie:
variable_name
| [[Clip_properties|clip_property]]
| function_name # without (args) #

The value of the expression is the value returned by [[Clip_properties|clip properties]] or contained inside [[Script_variables|script variables]] (which must have been previously initialized).

* ''Expression'', ie:
[ + | - | ! ] expression # unary operator expression #
| ( expression ) # expression inside parentheses #
| expression-1 operator expression-2 # binary operator expression #
| bool_expression ? expression-1 : expression-2 # the ternary operator #
| function_name[ ( args ) ] # function call #
| expression.function_name[ ( args ) ] # OOP notation #

The value of the expression is either the result of the computation of the sub-expressions or the return value of the function_name call.

Looking a bit closer at the possible expression alternatives, the following notes can be made:
* The first three cases show that one can manipulate expressions using all of the usual arithmetic and logical [[operators]] (from C) as you'd expect on ints, floats, vals, and bools.
:* Strings can be concatenated with '+'.
:* The following operators are also defined on video clips:
a + b
# is equivalent to:
[[Splice|UnalignedSplice]](a, b)
:: and:
a ++ b
# is equivalent to:
[[Splice|AlignedSplice]](a, b)
* The fourth case shows that one can execute code conditionally with the ternary operator.
* The fifth case shows that a function call is, from the grammar's perspective, a special type of expression.
* The sixth case shows '''OOP notation''', an alternate syntax for chaining function calls, which is equivalent to:
function_name(expression, args)

=== Statements ===

Statements are the smallest standalone element of an AviSynth script/ Statements do not compute a value; ''they are evaluated for their side effects'' (which are most of the time the assignment of a value computed by an expression to a [[Script_variables|variable]]).

Statements are grouped together to form a script. An AviSynth script is simply the aggregate of a number of statements.

All statements in AviSynth scripting language have one of these forms (with square brackets, ([]), we enclose optional elements, with the vertical bar character, (|), we separate alternatives, with the pound character, (#), we enclose comments):

[ global ] variable_identifier = expression
| [ return ] expression
| try_catch_block
| function_declaration

For each specific type of statement, the following notes can be made:

* In the first case, ''expression'' is evaluated and the result is assigned to an identifier. The identifier can only identify a variable, either local or global (if the optional <tt>global</tt> keyword is present). That is you can only assign to [[Script_variables|variables]]. Hence the name ''variable_identifier''.

* In the second case, ''expression'' is evaluated and the result is used as follows:
:* If the <tt>return</tt> keyword is present or the statement is the last in its script block, it is used as the "return value" of the active script block - that is, either a function or the entire script. In the latter case, the return value is typically the video clip that will be seen by the application which opens the AVS file.
:* Otherwise, if the result is a clip, it is assigned to the special variable <tt>last</tt>. If the result is not a clip, it is simply discarded.

The last two cases are the only ''compound statements'' supported by AviSynth script language. They are presented in detail in the section that follows.

=== Compound Statements ===

A compound statement is a block of statements that is considered a single unit of code (ie statement). Thus a compound statement is a multiline statement. As we saw, AviSynth supports two types of compound statements: the ''try_catch_block'' and ''function_declaration''.

* The ''try_catch_block'' statement has the following form:

try { # the try part is always executed #
[ statement # you can put as many statements as you want #
...
statement ] # an empty block is allowed (but not very useful!) #
}
catch (variable_identifier) { # catch part is executed only if an error occurs in try part #
[ statement # you can put as many statements as you want #
...
statement ] # an empty block is allowed and causes the error to be ignored #
}

: It implements the <tt>try..catch</tt> [[Control_structures|control structure]]. See there for details.

* The ''function_declaration'' statement has the following form:

function identifier( [ argument_list ] )
/* from v2.60 you can also put comments here */
{
[ statement # you can put as many statements as you want #
...
statement ] # an empty function is allowed (but not very useful!) #
}
: It declares a [[User_defined_script_functions|user-defined function]] and makes it available for calling to the rest of script code, by using the ''identifier'' as the name of the function to be called.

: The optional ''argument_list'' (yes, you can have functions without arguments) declares the type and name of function's arguments, as well as whether they are required or are optional. Optional arguments are also called ''named arguments'', because you can supply them by name in a function call. It has the following form:

argument-1 , ... , argument-K , optional_argument-K+1 , ... , optional_argument-N

: ''argument-i'' (i = 1 to K) and ''optional_argument-j'' (j = K + 1 to N) have the following forms (again, with square brackets, ([]), we enclose optional elements, with the vertical bar character, (|), we separate alternatives, with the pound character, (#), we enclose comments), respectively:

[ type_keyword ] identifier # (normal) argument
[ type_keyword ] "identifier" # optional argument

As you can see, optional arguments distinguish from (normal) arguments in that they are enclosed in double quotation marks. In a function call you can refer to an optional argument as: ''identifier'' = value. You can also refer to in the normal way as if it was a normal, positional argument.

Three more things to note are the following:
* Once you declare an optional argument, all subsequent arguments ''must'' also be declared optional.
* If you don't supply the type of the argument in the declaration (ie one of the type [[#Keywords|keywords]] presented above), the argument is of the <tt>val</tt> type. That is it can be of any type. Consequently in the body of the function you have to query for its type, if you want your code to be robust.
* Function declarations can be written in any order and at any point in the script where a statement is allowed, independently of where the functions themselves are called. The presence of the declaration itself does not interfere with the order of script execution or its result. However, the usual convention is to group functions together at the start of the script.

A few examples will help to clarify things:

function MyFunc1() { # a function with no arguments
...
}

function MyFunc2(clip c, int n) { # a function with two (normal) arguments
...
}

function MyFunc3(clip c, string "text", bool "invert") {
... # a function with one argument and two optional arguments
} # if they are not supplied, it uses some default values

function MyFunc4(clip "c", bool "invert, int "n") {
... # you can declare a function with all arguments optional
}

function MyFunc5(clip clp, effect, "text") {
... # a function with two normal and one optional argument
} # the last two arguments are of val (ie any) type
...
f = MyFunc1()
g = MyFunc2([[ColorBars]](), 6) # all normal arguments *must* be supplied
...
h = MyFunc3(g, "some text", false) # you can supply optional arguments as if they were normal
i = MyFunc3(g) # but you can omit them also entirely
j = MyFunc3(g, invert=true) # or you can pass some of them by name
...
k = MyFunc4() # MyFunc4 will use defaults for all its arguments
l = MyFunc4(g, n=12) # you can supply some optional arguments as positional
... # and some by name
...
m = MyFunc5(g, 25, "test") # you can pass any type in the last two arguments of MyFunc5
n = MyFunc5(g, "dissolve", text=m) # this can be both flexible *AND* dangerous if you don't check
o = MyFunc5(g, g) # the type of the arguments; you can of course omit optional ones

== Closing Remarks ==

The set of rules for identifying and grouping tokens into higher-level structures (ie the AviSynth Grammar) ends with statements. An AviSynth script is simply the aggregate of a number of statements. In it you place as many statements as required to do the job. The grammar does not care how you do so. However, there are a couple of things that are worth noting here to make developing scripts easier:

* The return value of the entire script is either (cf. the second case of [[#Statements|Statements]] section above):
:* The result of a <tt>return expression</tt> statement anywhere in the main script block (ie not in a function body or inside a <tt>try...catch</tt> block); all statements below that one will be ignored. As a shorthand, a bare expression as the final statement is treated as if the keyword '''return''' was present.
:* If there is no (explicit or implicit) return, a void value (ie a value of the 'undefined' type) is returned. For example, this will happen if the last statement is an assignment.

* AviSynth provides a mechanism to include other scripts inside the current script block: the [[Import]] function. The result of calling Import is the same as if you have typed the entire imported script text at the point of the function call.

* Making self-contained scripts and using [[Import]] to include them in you scripts is a way to organise and ''reuse'' your code (for example, your favorite [[User_defined_script_functions|used-defined functions]]).

== The Full Avisynth Grammar - For Language Lawyers ==

For those readers that prefer a formal definition of the AviSynth script language's grammar, there is one available (though '''not''' "officially-endorsed" at the moment) in [[Formal_AviSynth_grammar|Extended Backus-Naur form]] (or EBNF for short).

[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

Histogram

2011-04-01T12:03:09Z

Unreal666: /* Luma mode */ planar mode -> Available in planar and YUY2 modes.

{{Template:FuncDef|Histogram(clip ''clip'' [, string ''mode''] [, float ''factor''])}}

Adds a luminance histogram to the right side of the clip.

Starting from AviSynth '''v2.50''' this filter will also show valid and invalid colors in [[YUV]] mode. Invalid values (below 16 and above 235) will be colored brown/yellow-ish.

Starting in '''v2.53''' an optional mode parameter has been added to show additional information of a clip. Mode can be "classic" (default old mode), "levels", "color", "luma" ('''v2.54'''), "stereo" ('''v2.54'''), "stereooverlay" ('''v2.54'''), "audiolevels" ('''v2.58'''), "color2" ('''v2.58''') and "stereoY8" ('''v2.60'''). Since '''v2.60''' an optional factor parameter is added which can be used for the mode "levels".

=== Classic mode ===

[[Image:histogram_classic.jpg]]

This will add a per-line luminance graph (which is actually called a Waveform Monitor) on the right side of the video. the left side of the graph represents luma = 0 and the right side represents luma = 255. The non-valid CCIR-601 ranges are shown in a brown/yellow-ish color, and a greenish line represents Y = 128.

Available in YUV mode.

=== Levels mode ===

[[Image:histogram_modelevels.jpg]]

This mode will display three [[Levels|level]]-graphs on the right side of the video frame (which are called Histograms). This will show the distribution of the Y, U and V components in the current frame.

The top graph displays the luma (Y) distribution of the frame, where the left side represents Y = 0 and the right side represents Y = 255. The valid CCIR601 range has been indicated by a slightly different color and Y = 128 has been marked with a dotted line. The vertical axis shows the number of pixels for a given luma (Y) value. The middle graph displays the U component, and the bottom graph displays the V component.

The "factor" option (100.0 by default) specifies the way how the graphs are displayed. It is specified as percentage of the total population (that is number of luma or chroma pixels in a frame). For example, HistoGram("Levels", 1.5625) will achieve a 1/64th cap.

Available in all planar modes, except [[Y8]].

=== Color mode ===

[[Image:histogram_modecolor.jpg]]

This mode will display the chroma values (U/V color placement) in a two dimensional graph (which is called a vectorscope) on the right side of the video frame. It can be used to read of the hue and saturation of a clip. At the same time it is a histogram. The whiter a pixel in the vectorscope, the more pixels of the input clip correspond to that pixel (that is the more pixels have this chroma value).

The U component is displayed on the horizontal (X) axis, with the leftmost side being U = 0 and the rightmost side being U = 255. The V component is displayed on the vertical (Y) axis, with the top representing V = 0 and the bottom representing V = 255.

The position of a white pixel in the graph corresponds to the chroma value of a pixel of the input clip. So the graph can be used to read of the hue (color flavor) and the saturation (the dominance of the hue in the color). As the hue of a color changes, it moves around the square. At the center of the square, the saturation is zero, which means that the corresponding pixel has no color. If you increase the amount of a specific color, while leaving the other colors unchanged, the saturation increases, and you move towards the edge of the square.

Available in all planar modes except Y8.

=== Color2 mode ===

[[Image:histogram_modecolor2.jpg]]

This mode will display the pixels in a two dimensional graph (which is called a vectorscope) on the right side of the video frame. It can be used to read of the hue and saturation of a clip.

The U component is displayed on the horizontal (X) axis, with the leftmost side being U = 0 and the rightmost side being U = 255. The V component is displayed on the vertical (Y) axis, with the top representing V = 0 and the bottom representing V = 255. The grey square denotes the valid CCIR-601 range.

The position of a pixel in the graph corresponds to the chroma value of a pixel of the input clip. So the graph can be used to read of the hue (color flavor) and the saturation (the dominance of the hue in the color). As the hue of a color changes, it moves around the circle. At the center of the circle, the saturation is zero, which means that the corresponding pixel has no color. If you increase the amount of a specific color, while leaving the other colors unchanged, the saturation increases, and you move towards the edge of the circle. A color wheel is plotted and divided into six hues (red, yellow, green, cyan, blue and magenta) to help you reading of the hue values. Also every 15 degrees a white dot is plotted.

At U=255, V=128 the hue is zero (which corresponds to blue) and the saturation is maximal, that is, sqrt( (U-128)^2 + (V-128)^2 ) = 127. When turning clock-wise, say 90 degrees, the chroma is given by U=128, V=255 (which corresponds to red). Keeping the hue constant and decreasing the saturation, means that we move from the circle to the center of the vectorscope. Thus the color flavor remains the same (namely red), only it changes slowly to [[GreyScale|greyscale]]. Etc ...

Available in all planar modes except Y8.

=== Luma mode ===

[[Image:histogram_modeluma.jpg]]

This mode will [[Amplify|amplify]] luminance, and display very small luminance variations. This is good for detecting blocking and noise, and can be helpful at adjusting [[Internal_filters|filter]] parameters. In this mode a 1 pixel luminance difference will show as a 16 pixel luminance pixel, thus seriously enhancing small flaws.

Available in planar and YUY2 modes.

=== Stereo, StereoY8 and StereoOverlay mode ===

[[Image:histogram_modestereo.gif]]

This mode shows a classic stereo graph, from the audio in the clip. Some may know these from recording studios. This can be used to see the left-right and phase distribution of the input signal. StereoOverlay will overlay the graph on top of the original. Each frame will contain only information from the current frame to the beginning of the next frame. The signal is linearly upsampled 8x, to provide clearer visuals. Stereo and StereoY8 won't overlay the graph on the video, but will just return the graph (in YV12 respectively Y8 format).

This mode requires a stereo signal input and StereoOverlay input is planar only.

=== Audiolevels mode ===

[[Image:histogram_audiolevels.jpg]]

This mode shows the audiolevels for each channel in decibels (multichannel is supported). More accurately it determines:

* the root mean square value of the samples belonging to each frame (let's say n samples) and converts this value to decibels using the following formula:

<math> RMS = 20 \cdot log_{10}( 1/32768 \cdot \sqrt{ 1/n \cdot \sum_{j=1}^{n} sample(j)^{2}} ) </math> # for each channel

* the maximum volume of the samples belonging to each frame and converts this value to decibels using the following formula:

<math> max = 20 \cdot log_{10}(max_{j} (sample(j)) / 32768) </math> # for each channel

The bars corresponding to the root mean square value are green, and to the maximum are blue. The filter is available in planar mode and the audio is converted to 16 bit. Note that for 16 bit audio, the maximal volume could be

<math> 20 \cdot log_{10}(32768/32768) = 0 \ dB </math> (since 2^16/2 = 32768)

and the minimal volume

<math> 20 \cdot log_{10}(1/32768) = - 90.31 \ dB </math>

=== Changes ===

{| border="1"
|-
| v2.60
| Added StereoY8 mode. Added factor option.
|-
| v2.58
| Added planar support. Color2 and Audiolevels modes added.
|-
| v2.56
| Added invalid colors in YUY2 mode.
|-
| v2.56
| Added dots to mode = "stereo" to show bias/offsets.
|-
| v2.53
| Added different modes.
|}

[[Category:Internal filters]]

Block statements

2011-03-30T03:27:13Z

Unreal666: /* For..Next loop with access to variables in local scope */ succintly -> succinctly

== Background ==

A first glance at Avisynth documentation leaves the impression that aside from function definitions, block statements are not possible in Avisynth script. However, there are specific features of the language allowing the construction of block statements that have remained unaltered to date and probably will remain so in the future since block statements are very useful in extending the capabilities of the script language.

Indeed, in most programming and scripting languages, block statements are very useful tools for grouping together a set of operations that should be applied together under certain conditions. They are also useful in Avisynth scripts.

Assume, for example, that after an initial processing of your input video file, you want to further process your input differently (for example, apply a different series of [[Internal_filters|filters]] or apply the same set of filters with different order) based on a certain condition calculated during the initial processing, which is coded at the value of Boolean variable ''cond''.

Instead of making an ugly series of successive conditional assignments using the conditional (ternary) [[Operators|operator]], <tt>?:</tt>, as in '''Example 1''' below (items in brackets are not needed if you use the implicit ''last'' variable to hold the result):

'''Example 1'''
[result_1 = ]cond ? filter1_1 : filter2_1
[result_2 = ]cond ? filter1_2 : filter2_2
...
[result_n = ]cond ? filter1_n : filter2_n

It would be nice to be able to construct two blocks of filter operations and branch in a single step, as in the (ideal) '''Example 2''' below:

'''Example 2'''
[result = ] cond ? {
filter1_1
filter1_2
...
filter1_n
} : {
filter2_1
filter2_2
...
filter2_n
}

Something approaching this construction (and others) '''is''' possible; perhaps some constraints may apply, but you will nevertheless be capable of providing more powerful flow control to your scripts. The rest of this section will show you how to implement them using standard Avisynth constructs.

(An alternative, and possibly more user-friendly, approach would be to use the external [http://forum.doom9.org/showthread.php?t=147846 GScript] plugin, which extends the Avisynth scripting language to provide multi-line conditionals (if-then-else blocks), 'while' loops and 'for' loops.)

=== Features enabling construction of block statements ===

The list below briefly presents the features making possible the creation of block statements in your script. Listed first are the more obvious ones, followed by those that are somewhat more esoteric and require a little digging inside the Avisynth documentation and experimenting with test cases to discover them.

* globals (in particular, variables preceded by the "global" keyword) allow the communication of information between code blocks executing in different context.

* The conditional operator (condition ? expr_if_true : expr_if_false) can contain an arbitrary number of nested expressions, if grouped by parentheses.

* Strings can contain double quote (") characters inside them if they are surrounded by three-double-quotes (""").
*: Thus, the following strings are valid in Avisynth script (note that the 2nd and 3rd ones could be lines in a script):
** """this is a string with " inside it"""
** """var = "a string value" """
** """var = "a string value" # this is a comment"""

* There is a script function, [[Internal_functions/Control_functions|Eval()]], that allows the evaluation of strings containing arbitrary script expressions.
*: Thus, every expression that you can write in a script can be, if stored in a string, passed to Eval.
*: Eval returns the result of the evaluated expression, ie ''anything'' that can be constructed by such an expression (a clip, a number, a bool, a string).
*: The evaluation of the string is done in the same context as the call to Eval. Thus, if Eval is called at the script level, the expression is assumed to reference script-level variables or / and globals (globals are allowed everywhere). But if Eval is called inside a user-defined function then the expression is assumed to reference variables local to the function (ie arguments and any locally declared variable)

* There is a script function, [[Import]](), that allows the evaluation of arbitrary Avisynth scripts.
*: Thus, any script written in Avisynth script language can be evaluated by Import. Import returns the return value of the script.
*: Despite the common misbelief that this can only be a clip, it can actually be ''any'' type of variable (a clip, a number, a bool, a string).
*: Like Eval, the evaluation of the script is done in the same context as the call to Import.
*: Hence, as a side-effect of the script evaluation any functions and variables declared inside the imported script are accessible from the caller script, from the point of the Import call and afterwards.

* Recursion (ie calling a function from inside that function) can be used for traversing elements of a collection.
*: Thus, for..next, do..while, do..until loops can be constructed by using recursion.

* Multiline strings, ie strings that contain newlines (the CR/LF pair) inside them, are allowed by the script language.

* Multiline strings are parsed by [[Internal_functions/Control_functions|Eval()]] as if they were scripts.
*: Thus, each line of a multiline string will be evaluated as if it was a line in a script.
*: Also, return statements inside the string are allowed (the value of their expression will be the return value of Eval), as well as comments, function calls and in general every feature of the script language.

Consider the following '''Example 3''', of a (useless) script that returns some black frames followed by some white frames:

'''Example 3'''

<pre>
c = BlankClip().Trim(0,23)
d = BlankClip(color=$ffffff).Trim(0,23)
b = true
dummy = b ? Eval("""
k = c # here comments are allowed!
l = d
return k # this will be stored in dummy
""") : Eval("""
k = d
l = c
return k # this will be stored in dummy
""")
# variables declared inside a multiline string
# are available to the script after calling Eval
return k + l
</pre>

Variables ''k'', ''l'' are not declared anywhere before the evaluation of the if..else block. However, since Eval evaluates the string at the script-level context, it is as if the statements inside the string were written at the script level. Therefore, after Eval() they are available to the script. A few other interesting things to note are the following:

* The return statement at the end of the selected (by the value of ''b'') string for evaluation is the value that will be returned to the ''dummy'' variable.

* Contrary to the case of line continuation by backslashes, a multiline string allows comments everywhere that they would be allowed in a script.

== Implementation Guide ==

The features above can be used to construct block statements in various ways. The most common implementation cases are presented in this section, grouped by block statement type.

=== The if..else block statement ===

==== Using Eval() and three-double-quotes quoted strings ====

This is by far the more flexible implementation, since the flow of text approaches most the "natural" (ie the commonly used in other languages) way of branching code execution.

Using the rather common case illustrated by '''Example 1''', the solution would be (again items in square brackets are optional):

'''Example 4'''

[result = ] cond ? Eval("""
filter1_1
filter1_2
...
filter1_n
[ return {result of last filter} ]
""") : Eval("""
filter2_1
filter2_2
...
filter2_n
[ return {result of last filter} ]
""")

In short, you write the code blocks as if Avisynth script would support block statements and then enclose the blocks in three-double-quotes to make them multiline strings, wrap a call to [[Internal_functions/Control_functions|Eval]] around each string and finally assemble Eval calls into a conditional operator statement.

The return statements at the end of each block are needed only if you want to assign a useful value to the ''result'' variable. If you simply want to execute the statements without returning a result, then you can omit the ''return'' statement at the end of each block.

One important thing to note is that the implicit setting of ''last'' continues to work as normal inside the Eval block. If the result of Eval is assigned to a variable, ''last'' will not be updated for the final expression in the block (with or without ''return''), but it will be (where appropriate) for other statements in the block.

If the block statement produces a result you intend to use, it is clearer to enter a ''return {result}'' line as the last line of each block, but the keyword ''return'' is not strictly necessary.

The following real-case examples illustrate the above:

'''Example 5'''
In this example, all results are assigned to script variables, so ''last'' is unchanged.

c = [[AviSource]](...)
...
cond = {expr}
...
cond ? Eval("""
text = "single double quotes are allowed inside three-double-quotes"
pos = FindStr(text, "llo") # comments also
d = c.[[Subtitle]](LeftStr(text, pos - 1))
""") : Eval("""
text = "thus by using three-double-quotes you can write expressions like you do in a script"
pos = FindStr(text, "tes")
d = c.SubTitle(MidStr(text, pos + StrLen("tes")))
""")
return d

'''Example 6'''
This example assigns a different clip to d depending on the [[Clip_properties|Framecount]] of a source clip.

a = AviSource(...)
c = [[BlankClip]]().SubTitle("a test case for an if..else block statement")
d = a.Framecount >= c.Framecount ? Eval("""
a = a.[[BilinearResize]](c.Width, c.Height)
c = c.Tweak(hue=120)
return [[Overlay]](a, c, opacity=0.5)
""") : Eval("""
c = c.BilinearResize(a.Width, a.Height)
a = a.[[Tweak]](hue=120)
return Overlay(c, a, opacity=0.5)
""")
return d

'''Example 7'''
This example is a recode of Example 6 using implicit assignment to the ''last'' special variable. Since the result of the entire Eval() is not assigned to another variable, the implicit assignments to ''last'' on each line of the string (including the ''last line'' of the string) are preserved and thus the desired result is obtained.

c = BlankClip().SubTitle("a test case for an if..else block statement")
AviSource(...)
last.Framecount >= c.Framecount ? Eval("""
BilinearResize(c.Width, c.Height)
c = c.Tweak(hue=120)
Overlay(last, c, opacity=0.5)
""") : Eval("""
c = c.BilinearResize(last.Width, last.Height)
Tweak(hue=120)
Overlay(c, last, opacity=0.5)
""")

The only disadvantage of the Eval approach is that coding errors inside the string blocks are masked by the [[Internal_functions/Control_functions|Eval()]] call, since the parser actually parses a '''single line''' of code:

[result = ] cond ? Eval("""block 1""") : Eval("""block 2""")

Thus, any error(s) inside the blocks will be reported as a single error happening on the above line. You will not be pointed to the exact line of error as in normal script flow. Therefore, you will have to figure out where exactly the error occured, which can be a great debugging pain, especially if you write big blocks.

==== Using separate scripts as blocks and the Import() function ====

Using '''Example 1''' as above, the solution would be (again items in square brackets are optional):

'''Example 8'''
Code of script file ''block1.avs'':

filter1_1
filter1_2
...
filter1_n

Code of script file ''block2.avs'':

filter2_1
filter2_2
...
filter2_n

Code of main script where the conditional branch is desired:

...
[result = ]cond ? Import("block1.avs") : Import("block2.avs")
...

In short, you create separate scripts for each block and then conditionally import them at the main script.

If you need to pass [[Script_variables|variables]] as "parameters" to the blocks, declare them in your main script and just reference them into the block scripts. The following example demonstrates this:

'''Example 9'''
Code of script file ''block1.avs'':

filter1_1(..., param1, ...)
filter1_2(..., param2, ...)
...
filter1_n(..., param3, ...)

Code of script file ''block2.avs'':

filter2_1(..., param1, ...)
filter2_2(..., param2, ...)
...
filter2_n(..., param3, ...)

Code of main script where the conditional branch is desired:

# variables must be defined *before* importing the block script
param1 = ...
param2 = ...
param3 = ...
...
[result = ]cond ? Import("block1.avs") : Import("block2.avs")
...

Using [[Import]]() instead of [[Internal_functions/Control_functions|Eval()]] and three-double-quoted multiline strings has some disadvantages:

* There is an administration overhead because instead of one file ''2k + 1'' files have to be maintained (''k'' = the number of conditional branches in your script).
* The code has less clarity, in the sense that it does not visually appears as a block statement, neither the communication of parameters is apparent by inspection of the main script.

On the other hand:

* Debugging is not an issue; every error will be reported with accurate line information.
* You can reuse scripts that you frequently use and build more complex ones by simply importing ready-made components.
* For large-scale operations where few parameters have to be communicated it is usually a better approach.

One useful general purpose application of this implementation is to prototype, test and debug a block conditional branch and then recode it (by adding the Eval() and three-double-quotes wrapper code and removing the [[Script_variables|global]] keyword before the parameter's declarations) so that a single script using multiline strings as blocks is created. This workaround compensates for the main disadvantage of the Eval() and three-double-quotes implementation.

==== Using functions (one function for each block) ====

This is the most "loyal" to the Avisynth script's [[AviSynth_Syntax|syntax]] approach. Using '''Example 1''' as above, the solution would be (again items in square brackets are optional):

'''Example 10'''

Function block_if_1()
{
filter1_1
filter1_2
...
filter1_n
}

Function block_else_1()
{
filter2_1
filter2_2
...
filter2_n
}
...
[result = ]cond ? block_if_1() : block_else_1()
...

In short, you create separate functions for each block and then conditionally call them at the branch point.

If you need to pass variables as "parameters" to the blocks, either declare them ''global'' in your main script and just reference them into the functions or - better - use argument lists at the functions. The following example demonstrates this:

'''Example 11'''

Function block_if_1(arg1, arg2, arg3, ...)
{
filter1_1(..., arg1, ...)
filter1_2(..., arg2, ...)
...
filter1_n(..., arg3, ...)
}

Function block_else_1(arg1, arg2, arg3, ...)
{
filter2_1(..., arg1, ...)
filter2_2(..., arg2, ...)
...
filter2_n(..., arg3, ...)
}
...
[result = ]cond \
? block_if_1(arg1, arg2, arg3, ...) \
: block_else_1(arg1, arg2, arg3, ...)
...

Compared to the other two implementations this one has the following disadvantages:

* There is an extra overhead due to the need for supplying function headers and (typically) argument lists.
* It tends to "pollute" the global namespace, thus having the potential of strange errors due to name conflicts; use a clear naming scheme, as the suggested above.

On the other hand:

* It is '''portable'''; it does not depend on any type of hack or specific behavior to work. It is thus guaranteed to continue working in the long term.
* It does not raise any special debuging difficulties.
* It has coding clarity.

=== The if..elif..else block statement ===

By nesting If..Else block expressions inside the conditional operator, you can create entire if..elseif...else conditional constructs of any level desired to accomodate more complex needs.

A generic example for each if..else implementation presented above is following. Of course, any combination of the three above pure cases is possible.

==== Using Eval() and three-double-quotes quoted strings ====

The solution would be (again items in square brackets are optional):

'''Example 12'''

[result = \]
cond_1 ? Eval("""
statement 1_1
...
statement 1_n
""") : [(] \
cond_2 ? Eval(""" # inner a?b:c enclosed in parentheses for clarity (optional)
statement 2_1
... # since backslash line continuation is used between Eval blocks
statement 2_n # place comments only inside the strings
""") : [(] \
...
cond_n ? Eval("""
statement n_1
...
statement n_n
""") \
: Eval("""
statement n+1_1
...
statement n+1_n
""")[...))] # 1 closing parenthesis for Eval() + n-1 to balance the opening ones (if used)

==== Using separate scripts as blocks and the Import() function ====

The solution would be (again items in square brackets are optional):

'''Example 13'''

# here no comments are allowed; every line but the last must end with a \
[result = \]
cond_1 ? \
Import("block1.avs") : [(] \
cond_2 ? \
Import("block2.avs") : [(] \
...
cond_n ? \
Import("blockn.avs") \
: \
Import("block-else.avs") \
[)...))] # n-1 closing parentheses to balance the opening ones (if used)

==== Using functions (one function for each block) ====

The solution would be (again items in square brackets are optional):

'''Example 14'''

# here no comments are allowed; every line but the last must end with a \
[result = \]
cond_1 ? \
function_block_1({arguments}) : [(] \
cond_2 ? \
function_block_2({arguments}) : [(] \
...
cond_n ? \
function_block_n({arguments}) \
: \
function_block_else({arguments}) \
[)...))] # n-1 closing parentheses to balance the opening ones (if used)

=== The for..next block statement ===

The problem here is to implement the <tt>for..next</tt> loop in a way that allows accessing variables in the local scope, so that changes made in local scope variables inside the loop can be accessible by the caller when it is finished. This is the way that the <tt>for..next</tt> loop works in most programming languages that provide it. In addition, a means for getting out of the loop before is finished (ie breaking out of the loop) should be available.

There is of course the alternative to implement the <tt>for..next</tt> loop in a way that does not allow access to local variables. This is easier in AviSynth, since then it can be implemented by a function; but it is also less useful. However in many cases it would be appropriate to use such a construct and thus it will be presented here.

==== For..Next loop with access to variables in local scope ====

# Use a <tt>ForNext(start, end, step, blocktext)</tt> function to create a multiline string (a script) that will unroll the loop in a series of statements and then
# use Eval() to execute the script in the current scope.

The <tt>blocktext</tt> is a script text, typically a multiline string in triple double quotes, that contains the instructions to be executed in each loop, along with special variables (say ${i} for the loop counter) that are textually replaced by the <tt>ForNext</tt> function with the current value(s) in each loop. The [http://avslib.sourceforge.net/functions/s/strreplace.html StrReplace()] function is particularly suited for the replacement task.

A little tweak is needed in order to implement the <tt>break</tt> statement; the unrolled string must be constructed in such a way that when the break flag is set the rest of the code is skipped.

The following proof-of-concept example demonstrates the procedure:

a = [[AviSource]]("c:\some.avi")
cnt = 12
b = a.[[Trim]](0,-4)
cond = false

# here we would like to do the following
# for (i = 0; i < 6; i++) {
# b = b + a.Trim(i*cnt, -4)
# cond = b.Framecount() > 20 ? true : false
# if (cond)
# break
# }

return b

In order to make this happen in AviSynth, our script with <tt>ForNext</tt> would look like that:

a = [[AviSource]]("c:\some.avi")
cnt = 12
b = a.[[Trim]](0,-4)
block = ForNext(0, 5, 1, """
b = b + a.Trim(${i}*cnt, -4)
cond = b.Framecount() > 20 ? true : false
${break(cond)}
""")
void = Eval(block)
return b

or more succinctly:

a = [[AviSource]]("c:\some.avi")
cnt = 12
b = a.[[Trim]](0,-4)
void = Eval(ForNext(0, 5, 1, """
b = b + a.Trim(${i}*cnt, -4)
cond = b.Framecount() > 20 ? true : false
${break(cond)}
"""))
return b

and the output of ForNext with the above arguments should be something like this (the only problem is that string literals cannot be typed inside the block text):

"""
__break = false
dummy = __break ? NOP : Eval("
b = b + a.Trim(0*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
dummy = __break ? NOP : Eval("
b = b + a.Trim(1*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
dummy = __break ? NOP : Eval("
b = b + a.Trim(2*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
dummy = __break ? NOP : Eval("
b = b + a.Trim(3*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
dummy = __break ? NOP : Eval("
b = b + a.Trim(4*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
dummy = __break ? NOP : Eval("
b = b + a.Trim(5*cnt, -4)
cond = b.Framecount() > 20 ? true : false
__break = cond ? true : false
")
"""

TO BE CONTINUED...

==== For..Next loop without access to variables in local scope ====

If we don't care for accessing variables in the local scope, then the implementation is straightforward:

# Create an [[Arrays|AVSLib array]] with the appropriate loop values.
# Define needed globals (for example a bool flag to return immediately from the block if true).
# Pack the block's code inside a function.
# Use an [http://avslib.sourceforge.net/tutorials/operators.html array operator] to execute the block for every loop value.

TO BE CONTINUED...

=== The do..while and do..until block statements ===

TODO...

== Deciding which implementation to use ==

To be frank, there is no clear-cut answer to this question; it depends on the purpose that the script will serve, your coding abilities and habits, whether there are ready-made components available and what type are they (scripts, function libraries, etc.) and similar factors.

Thus, only some generic guidelines will be presented here, grouped on the type of block statement

=== The if..else and if..elif..else block statements ===

* For short (up to say 10 lines) blocks, using Eval() and three-double-quotes quoted strings is generally the best solution; it is fast to code and presents a "natural" text flow to the reader (thus it is easy to comprehend).

* For long blocks, using any of the other two implementations is generally better because it is easier to debug.

* If the blocks pre-exist as independent scripts, using [[Import]]() is, obviously, preferred.

* If building a function library, usually an implementation with functions will be easier to maintain and debug. However using [[Internal_functions/Control_functions|Eval]]() for small blocks is still an option to consider, to minimise the risk of namespace clashing with user's own functions.

=== The for..next block statement ===

TODO...

=== The do..while and do..until block statements ===

TODO...

== References ==

[1] http://www.avisynth.org/stickboy/ternary_eval.html

[2] http://forum.doom9.org/showthread.php?t=102929

[3] http://forum.doom9.org/showthread.php?p=732882#post732882

----
Back to [[Scripting_reference|scripting reference]].
[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

User functions

2011-03-22T02:29:02Z

Unreal666: /* The function body */ recipy -> recipe

Having read the basics about [[User_defined_script_functions|user-defined script functions]], we can now step forward to examine in detail each function building block and identify rules for effective code development.

== The function declaration (header) ==

The function declaration consists of the keyword <tt>function</tt> followed by the function's name and a (possibly empty) list of parameters (arguments) enclosed in a pair of parentheses. Its purpose is to declare the function, that is both make its name visible to the running script and state the number and type of the arguments that it expects in subsequent invocations (function calls).

Note that in AviSynth script language the declaration is also a definition; the function body (the code that is executed every time the function is called) must be supplied immediately after.

=== The function name ===

To name your user function you can pick any name that appropriately describes the purpose of it. You should however avoid naming a function with an already widely used name; the AviSynth script language namespace is flat and thus any such name collision means you (and others) cannot use both functions together. Note also that function names (as everything in AviSynth script language) are case insensitive.

=== The argument list ===

Regarding the possible different kinds of arguments a function can declare, there are two orthogonal to each other categorical divisions:
# '''Typed''' vs '''variable''' arguments.
# '''Required''' vs '''optional''' arguments.

==== Typed and variable (<tt>val</tt>) arguments ====

Typed arguments have a fixed type, decided by the specific type prefix (clip, int, float, bool, string) used during function declaration. Whenever a script is calling a function, AviSynth checks the supplied values for all typed arguments to ensure that they are of the proper type; if a discrepancy is found an error condition is triggered. Therefore, typed arguments can always be assumed of being the correct type (but not 'value'!) inside the body of the function, simplifying coding.

Variable arguments can accept ''any'' AviSynth type (clip, int, float, bool, string) when the function is called. You can declare a function argument as being variable with either of two ways:
* specify <tt>val</tt> as the type of the argument, for example:
function myfunc(clip c, val effect) { ... }
function myfunc2(clip c, '''val "action"''') { ... }
* do ''not'' specify a type for the argument, for example:
function myfunc(clip c, effect) { ... }
function myfunc2(clip c, '''"action"''') { ... }
As a side effect, whenever you neglet to provide the type of an argument you will get a variable argument. Keep this in mind when you are debugging your scripts.

Variable arguments can also be optional. To do so, you simply enclose the argument in double quotes, as for typed arguments.

Variable arguments are useful in some situations because they provide flexibility and reduce the size of the argument list. However, they have the drawback that your function code has to check the type of each variable argument in order to ensure its validity for the intended operation (for typed arguments, the type check is performed by AviSynth).

==== Required and optional arguments ====

Required arguments must always be supplied when you are calling the function

Optional arguments need not be supplied; they default (if the function is coded correctly) to reasonable initial values.

== The function body ==

The function body contains the bulk of the code that makes up your function. Since they strongly depend on the tasks-on-hand, the contents of the function body are quite arbitrary. However, there are some frequently occuring coding patterns that together form a more or less "standard" recipe for constructing the function body. These are in the usual order of appearance the following:

* Argument validation and setup of local variables.
* Performance of intermediate computations.
* Return of final computation outcome to the caller of the function.

We will now look closer on each one in the paragraphs that follow.

=== Argument validation and setup of local variables ===

=== Performance of intermediate computations ===

=== Return of final computation outcome to the caller ===

== Designing and developing user functions ==

=== Defining goals ===

=== Manipulating globals ===
how to use effectively and safely

=== Recursion ===
the only tool to act upon collections

== Tuning performance ==

== Design and coding-style considerations ==

== Organising user defined functions ==

----
Back to [[Scripting_reference|scripting reference]].
[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

The script execution model/Scope and lifetime of variables

2011-03-21T07:19:02Z

Unreal666:

There are essentially two scope types in the AviSynth script language:

=== Global scope ===

Every [[Script_variables|variable]] placed in this scope can be freely accessed from any nested block of script code at any level of nesting. That is, you can access a global from the top-level script block, from inside a user [[Script_functions|function]] at any level of recursion, as well as from inside [[Runtime_environment|runtime scripts]].

'''Note:'''
One important precondition for the above rule to apply is that ''you must not have a local variable with the same name as a global one''. If you define a local variable with the same name as a global one, then you can no longer get (read) the value of the global variable in that specific local scope.
This is because AviSynth when given a variable's name it first searches in the current local scope; only if the search fails the global scope is searched. You can however set (write) the global's value, since in that case the use of the keyword <tt>global</tt> distinguishes between a global and a local variable.

=== Local scope ===

Variables placed in this scope can be accessed (read or written) ''only'' from script code within that scope. This allows the isolation of nested local scopes and makes the creation and usage of script functions possible.

The most important local scope is the top-level script scope (the one that is created just before the executing script is parsed and evaluated). All non-global variables defined inside the script-level source code reside there. All the other local scopes are created due to function calls and are nested inside this one.

Nested local scopes result from function or filter calls (plugin writers can create nested scopes through <tt>env->PushContext()</tt> and <tt>env->PopContext()</tt>) and can be created at an arbitrary depth. For example, a recursive user function such as the one below:

function strfill(string s, int count) {
return count > 0 ? s + strfill(s, count - 1) : ""
}

will result during its evaluation in the creation and subsequent destruction of eleven nested local scopes if called with a value ten for its <tt>count</tt> argument.

=== Lifetime of variables ===

The lifetime of variables defined at the global and top-level script (local) scope spans from the time of the definition (that is the first statement that assigns a value to them) to the end of frame serving and the unload of <tt>avisynth.dll</tt>.

The lifetime of variables defined at nested local scopes spans from the time of the definition in the nested local scope to the end of the nested local scope's lifetime. Since nested local scopes result from function / filter calls, the nested scope's lifetime is the lifetime of the function / filter call.

=== A variables scope and lifetime example ===

To clarify the statements of the previous section, the following example demonstrates the scope and lifetime of variables in a moderately complex AviSynth script that also includes runtime scripts.

What the script does is to divide a clip (after some processing tweaks) in 4 equal-sized regions and evaluate the average luma of each region per frame. If this is outside a range defined by two thresholds, the corresponding region is turned to all black (if below) or white (if above) for that frame.

function Quartile(clip c, int quartile) {
[[Internal_functions/Control_functions|Assert]](quartile >= 0 && quartile <= 3, "Invalid Quartile!")
hw = [[Internal_functions/Numeric_functions|Int]](c.[[Clip_properties|Width]]() / 2)
hh = Int(c.[[Clip_properties|Height]]() / 2)
return [[Internal_functions/Control_functions|Select]](quartile, \
[[Crop]](c, 0, 0, hw, hh), Crop(c, hw, 0, hw, hh), \
Crop(c, 0, hh, hw, hh), Crop(c, hw, hh, hw, hh))
}

function bracket_luma(clip c, float th1, float th2) {
Assert(0 <= th1 && th1 < th2 && th2 <= 255, "Invalid thresholds!")
script = "th1 = " + [[Internal_functions/Conversion_functions|String]](th1) + Chr(13) + Chr(10) + \
"th2 = " + String(th2) + """
avl = [[Internal_functions/Runtime_functions|AverageLuma()]]
return avl <= th1 ? last.[[BlankClip]]() : (avl >= th2 ? \
last.BlankClip(color=color_white) : last)
"""
return [[ScriptClip]](c, script)
}

clp = [[AviSource]]("myclip.avi")
clp = [[Tweak]](clp, hue=20, sat=1.1)
threshold1 = 12.0
threshold2 = 78.0
q0 = Quartile(clp, 0).bracket_luma(threshold1, threshold2)
q1 = Quartile(clp, 1).bracket_luma(threshold1, threshold2)
q2 = Quartile(clp, 2).bracket_luma(threshold1, threshold2)
q3 = Quartile(clp, 3).bracket_luma(threshold1, threshold2)
[[StackVertical]](StackHorizontal(q0, q1), [[StackHorizontal]](q2, q3))

The scope and lifetime of all variables in the example script is presented in the following timeline (the <tt>color_white</tt> global is from the autoloaded .avsi that ships with AviSynth):

+-- scope --+------- parsing phase ---------------------->+----- frame serving phase ------->+
| | |
| global |color_white - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ->|
+-----------+---------------------------------------------+----------------------------------|
| local, |clp - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ->|
| top-level | threshold1,threshold2- - - - - - - - - - - - - - - - - - - - - - - - - - - - ->|
| | q0- -q1- -q2- -q3 - - - - - - - - - - - - - - - - ->|
| | |th1,th2,avl - - - - - - - - - - ->|
+-----------+---------------------------------------------+----------------------------------|
| local, | c, - - - ->| | |
| Quartile | quartile, ->| | repeated |
| function | hw,hh- - ->| | three times, |
+-----------+-------------------------->| in immediate ->|
| local, | |c, - - - ->| succession |
| bracket_l.| |th1,th2, ->| |
| function | | script- ->| |
+-----------+---------------------------------------------+----------------------------------|

=== Code-injecting language facilities and scopes ===

There are certain language constructs (functions, filters and control structures) that allow the injection of code in the script, ie the execution of arbitrary sequences of AviSynth script language [[AviSynth_Syntax|statements]].

This is a ''very'' useful functionality that allows among other things dynamic code evaluation, the creation of [[Block_statements|block statements]] and [[Arrays|arrays]], the organisation of AviSynth code in libraries, etc. However, there are some subtle issues regarding variables' scope and visibility that can lead to surprises if not fully understood.

==== Import and Eval ====

[[Import]]() and [[Internal_functions/Control_functions|Eval]]() evaluate the passed-in script source code in the context of the current local scope.

This means that variables contained in the top-level scope of the imported script or in the code string passed to Eval() are created inside the current local scope and become available for read/write to the following script source code. For example:

'''1. File "a.avs"'''
x = 12
y = 24
c = [[BlankClip]](pixel_type="[[YV12]]", color=color_orange, width=240, height=180)

'''2. File "b.avs"'''
[[Import]]("a.avs")
[[AviSource]]("myvideo.avi")
[[Levels]]('''x''', 1.0, 255, '''y''', 242)
[[Overlay]]('''c''', x=last.Width-320, y=last.Height-240, mode="chroma")

In addition, the imported script or the code string passed to Eval() can use previously defined in that scope local variables (as well as globals, of course). For example (the use of multiline triply quoted strings makes easier the writing of [[Block_statements|block statements]]):

x = 5
AviSource("aclip.avi")
f = [[Clip_properties|Framecount]]()
f < 100 ? [[Internal_functions/Control_functions|Eval]]("""
[[Trim]](x, f-2)
x = 0
""") : Eval("""
Trim(x, 15*x + 30)
x = 1
""")
x == 0 ? [[Invert]]() : [[Subtitle]](String(last.Framecount))

Especially the later is something that you must always keep in mind -mostly for [[Import]]() since the code is not immediately visible; only the filename shows up in the script- because it has the potential to introduce bugs by unexpected overriding of a variable's value.

Consider, the following example:

'''1. File "mylib.avsi"'''
function preset(int num) { # 0 to 3
return [[Internal_functions/Control_functions|Select]](num, AviSource("..."), AviSource("..."), AviSource("..."), AviSource("..."))
}
global def_preset = preset(0)

'''2. File "myscript.avs"'''
global def_preset = [[AviSource]]("myfav.avi")
Import("mylib.avsi")
[[Tweak]](def_preset, hue=20) # oops, using clip from mylib.avsi instead of myscript.avs!
...

The imported script changed a previously defined variable and the results will now be surprising (until of course the bug is discovered).

However, this same feature has a number of interesting possibilities, for example:

* You can define sub-scripts that communicate with the parent script through a defined set of variables.
* You can create libraries (AviSynth include files) that perform initialisation code based on "environment" variables (the ones you set in the parent script before importing) and / or return status information (through a variable that they set at the global or top-script level code)
* You can implement [[Block_statements|block statements]].

'''Note:''' To test for the existence of input/output variables in the above scenarios try to read their value in a <tt>try..catch</tt> block; else your script will die hard if for any reason they do not exist.

==== Runtime scripts ====

Local variables inside runtime filters' scripts are '''always''' bound to the top-level script local scope; even if the filter calls were made inside a user function. This is because the parsing of runtime scripts is done ''after'' the parsing of the script, at the frame serving phase. At that point in script execution, nested local scopes have already vanished and only the global and the top-level script local scopes survive.

The same is true for the [[Runtime_environment|special variables]] set by the runtime filters (such as for example <tt>current_frame</tt>); they are defined at the top-level script local scope.

Some consequences of the above setup are the following:

* You can use top-level script local variables inside the runtime scripts to pass information, just as is customary to do with global ones.
* You must be careful if you define local variables in your runtime scripts not to clash with local variables in other runtime scripts in the filter chain. This is also true for globals, but globals are typically used for inter-filter communication; use of locals is not so common and thus may be overlooked by script writers.
* Overriding a variable (either local or global) does not have an effect on the main script, because the evaluation of the main script is done at the parsing phase, before the execution of any runtime script.
* When examining the way that a variable will be modified by a chain of runtime scripts, you must remember that the evaluation of scripts is done from bottom to top, just like the fetching of frames.

Consider the following example:

[[AviSource]]("myclip.avi")
x = 5
fc = Framecount()
fc > 2x ? [[Trim]](x, fc - x) : Trim(0, fc - x)
fc = Framecount()
[[ScriptClip]]("""[[Subtitle]]("and the value of x is : " + String(x))""")
FrameEvaluate("x = (x % 3 == (fc - x - 1) % 3) ? x + 2 : x - 1")
[[FrameEvaluate]]("x = current_frame")

The assignment <tt>x = 5</tt> at the main script is used to control trimming of the source clip. <tt>x</tt> is passed as argument in the [[Trim]] filter during the script's parsing phase. Thus the modifications by the runtime scripts that start at the frame serving phase have no effect on the values passed to Trim.

By the time the first frame is fetched, <tt>x</tt> will have been overwritten by the <tt>x = current_frame</tt> assignment in the last [[FrameEvaluate]] filter's runtime script. Thus its value in the script has no effect (in this particular case) on the results of the runtime filter's processing.

Here, using <tt>x</tt> in all runtime filter scripts does not pose a naming clash problem. <tt>x</tt> is the variable used to communicate state information along the runtime filter chain. However, if we had needed a conditional assignment by frame number and we had accidentally used the following runtime script in place of the last FrameEvaluate line,

FrameEvaluate("""
fc = 12
x = current_frame < fc ? current_frame : fc
""")

then there would be a clash with the use of <tt>fc</tt> in the previous line (the clips framecount would have been overwritten with an unrelated value) and the logic of our processing would be in error.

Similarly, a ''later'' assignment to <tt>fc</tt> in the ''main'' script would alter the value seen by the runtime script. The point to note is that the value in the run-time script is evaluated at a later point in time, which is after all statements in the main script have been evaluated.

==== The try...catch block ====

This may seem surprising at first, but the <tt>try...catch</tt> block does inject code in the script (at the scope that contains it). If this code defines new variables, then those variables are available to the code in the section that follows the <tt>try...catch</tt> block. More specifically, there are two possibilities:

* ''No error'' occurs inside the <tt>try{...}</tt> section.
:# All statements of the code contained in the <tt>try{...}</tt> section are evaluated and affect the script code that follows.
* An error ''does'' occur inside the <tt>try{...}</tt> section.
:# Statements of the code contained in the <tt>try{...}</tt> section up to the point of error are evaluated and affect the script code that follows.
:# All statements of the code contained in the <tt>catch{...}</tt> section are evaluated and affect the script code that follows.
:# The variable that is used the <tt>catch{...}</tt> section to store the error message becomes available to the script code that follows.

The following example code excerpt clarifies the above:

a = ... # it is assumed that the (missing) code may result in a being either 1 or 0
try {
y = 3
x = 6 / a # if a == 0 this will lead to an error
z = 12
}
catch (msg) {
NOP
}
...code that follows...

Now, if <tt>a</tt> is ''not'' zero at the point the <tt>try...catch</tt> block is evaluated, then three new local variables in the current scope will be created (<tt>x</tt>, <tt>y</tt> and <tt>z</tt>) and be available for use by the code that follows.

If however, <tt>a</tt> ''is'' zero, then from the three variables in the try section only <tt>y</tt> will be created; in addition, since the catch section will be evaluated, <tt>msg</tt> will be created. Thus the variables available for use by the code that follows will be <tt>y</tt> and <tt>msg</tt>.

----
Back to the [[The_script_execution_model|script execution model]].
[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

The script execution model/Performance considerations

2011-03-21T03:56:36Z

Unreal666: /* What not to include in runtime scripts */ circmustances -> circumstance

This section presents some performance-related issues that originate from the way AviSynth scripts are executed; it also provides advice on how to optimise your scripts and AviSynth configuration so that your scripts are parsed and/or encoded faster.

=== Plugin auto-loading ===

An important thing to note is that auto-loading, although a convenient method to have all your favorite filters on hand, ''does'' incur a speed penalty. The penalty is twofold:

# The loading, registering and unloading of plugins takes some time. The parsing of .avsi scripts also takes some time. This time, although small, is paid ''in every'' AviSynth script invocation.
# The registering of many functions and globals increases the size of internal AviSynth data structures, which in turn increases the seek time to locate a filter / variable during the parsing phase as well as during runtime script parsing.

For small scripts and / or small number of auto-loading plugins the ease of use outweighs the above speed penalty (since there is also a speed penalty in writing a lot of [[LoadPlugin]] calls in every script that needs them). However if you regularly write large and complex scripts and have a large number of plugins / include scripts in your AviSynth plugin folder, you should consider a more granular approach to increase overall script parsing / encoding performance.

For example, you could group [[LoadPlugin]] calls for related plugins in separate .avsi scripts and have a central .avsi script with a config function that loads different .avsi scripts depending on its arguments. Then place in the plugin folder only the central .avsi script and the bare-essential plugins that you use almost every time.

=== Frame caching and the effect on splitting filter graph's paths ===

In order to improve performance AviSynth places, transparently to script writers, a specialised Cache filter just after each filter. The purpose of the cache is to avoid the computationally expensive generation of a video frame that has recently been created; if the frame is in the cache then it is returned immediately, avoiding a possibly long chain of filter calls.

The presence of the cache gives a speed and memory advantage to filter graphs that split processing paths ''as late as possible''. In our [[# An example of a filter graph|filter graph example]] above, if instead of:

ov = AviSource("clip2.avi")
ov1 = [[Lanczos4Resize]](ov, 280, 210)
ov2 = ov1.[[Invert]]()

we had used the following code:

ov = AviSource("clip2.avi")
ov2 = ov
ov1 = [[Lanczos4Resize]](ov, 280, 210)
ov2 = ov2.Lanczos4Resize(280, 210).[[Invert]]()

then the respective part of the filter graph would have been:

...
|
AviSource(clip2) <--+-- Lanczos4Resize <--+-- Overlay <--+
| |
+-- Lanczos4Resize <-- Invert <------+-- Overlay (filter graph's root)

In the latter case we would have one more filter (and cache) in the filter chain and -more importantly- we would have to generate two resized frames for each call by the host application to get a frame instead of one.

Therefore, always try to split processing paths as late as possible; it will make your scripts faster.

=== What ''not'' to include in runtime scripts ===

Although, as said above, runtime scripts are parsed as regular scripts and thus every statement allowed to a regular script is allowed in a runtime script, some statements are not advisable from a performance point of view.

The principal reason is that runtime script parsing occurs in ''every'' frame requested. Therefore, as a rule of thumb, computationally expensive actions should in general be placed outside the runtime environment (in the main script) in order to be executed only once. This practice trades some start-up overhead with savings during frame serving, which in general dominates the overall clip rendering / encoding time; thus it is justified as an optimisation. This is of course to be taken with a grain of salt because there are circumstance where the application needs force the (balanced) use of such statements.

Having said all that, let's see our not-to-do-in-runtime-scripts list (and some interesting counter-examples):

* The following actions should most of the time be avoided:
** Importing a script.
** Loading a plugin.
** Defining a user function.
: Issuing them on every frame will slow down (maybe significantly) encoding speed and (subject to implementation details) eat valuable memory. Moreover, this overhead will be borne without returning significant gains. It is in general much better to place them in the main script.
: See however an example of acceptable use: [http://forum.doom9.org/showthread.php?t=129191 Subtitles from a changing text-file].

* Calling a lot of filters / functions inside the runtime script will slow down your encoding speed. Those filters will be created and destroyed on every frame; thus you pay initialisation/cleanup costs at every frame.
: If you can, put outside the runtime environment those filter calls not essential for the runtime processing; break the runtime script into more scripts if you have to. For example, instead of doing this:

[[AviSource]]("myclip.avi")
total_frames = [[Clip_properties|Framecount]]()
[[ScriptClip]]("""
[[Levels]](0, 0.9, 255, 5, 250)
total_frames % current_frame < 2 ? [[FlipHorizontal]] : last
[[Tweak]](hue=18)
[[Subtitle]]("frame: " + String(current_frame), y=320)
""")

do this:

[[AviSource]]("myclip.avi")
total_frames = [[Clip_properties|Framecount]]()
[[Levels]](0, 0.9, 255, 5, 250)
[[ConditionalFilter]]([[FlipHorizontal]], last, "total_frames % current_frame", "<", "2")
[[Tweak]](hue=18)
ScriptClip("""[[Subtitle]]("frame: " + String(current_frame), y=320)""")

* [[Arrays]], due to their recursive, script-based implementation can be expensive to parse, especially if they host a large number of elements. Using them without paying attention to minimize operations will slow down your encoding speed.
: See however an example of acceptable use: [http://avslib.sourceforge.net/examples/example-016.html Per frame filtering, exporting specific frame(s)] (note that FrameFilter is a wrapper around [[ScriptClip]]).

----
Back to the [[The_script_execution_model|script execution model]].
[[Category:AviSynth_Syntax]]
[[Category:Scripting_Reference]]

Добро пожаловать

2011-03-20T19:09:18Z

Unreal666: /* Фильтры, внешние плагины, скриптовые функции и утилиты */

[http://sourceforge.net/project/showfiles.php?group_id=57023 Загрузить] | [[AviSynth FAQ]] | [[Internal filters|Внутренние фильтры]] | [[External filters|Внешние фильтры]] | [http://forum.doom9.org/forumdisplay.php?s=&forumid=33 Doom9 форум] | [http://sourceforge.net/projects/avisynth2/ Страница проекта] | [[Feedback|Обратная связь]]

Внимание: данная страница и сайт в целом переведены на русский язык далеко не полностью (то есть вообще не переведены). Имеющаяся команда переводчиков сосредоточила имеющиеся силы на переводе офф-лайновой документации, распространяющейся с дистрибутивом AviSynth (смотри сайт [http://avisynth.org.ru www.avisynth.org.ru]).

Однако вы можете переводить и дополнять статьи Wiki данного сайта самостоятельно (используя переведенные части офф-лайновой документации для единства стиля и терминов), добавляя к английским именам страниц окончание /ru (или создать страницы с русским именем - можно и то и другое с перенаправлением).

== Что такое AviSynth? ==

AviSynth - это мощное средство для пост-обработки видео. Он предоставляет методы для редактирования и обработки видео файлов. AviSynth работает как [[фрэймсервер]], обеспечивая мгновенное редактирования без необходимости временных файлов.

AviSynth сам по себе не имеет графического интерфейса пользователя (GUI), но вместо этого зависит от системы скриптов (сценариев, команд), которая позволяет продвинутое нелинейное редактирование. В то время как на первый взгляд это может показаться утомительным и не-интуитивным, это является замечательно мощным и очень хорошим способом управлять проектами точным, согласованным и воспроизводимым образом. Поскольку текстовые скрипты являются вполне читаемыми (по-английски), проекты естественным образом само-документируются. Язык скриптов прост, но мощен, и из базовых операций могут быть построены весьма сложные фильтры, для разработки богатой палитры полезных и уникальных эффектов.

Заинтересовались? На этом сайте вы можете узнать [[more about AviSynth|больше об AviSynth]], изучить официальное [[Internal filters|руководство по AviSynth]], и просмотреть [[AviSynth FAQ|часто задаваемые вопросы и ответы]]. Или вы можете перейти прямо на [http://sourceforge.net/project/showfiles.php?group_id=57023 страницу загрузки] на [[SourceForge]]. AviSynth - свободно распространяемая программа с открытым кодом.

== Использование ==
=== Что нового в AviSynth - Начните с малого! ===

* [[first script|Ваш первый скрипт]] - Руководство для начинающих.
* [[Getting started|С чего начать]] - Краткая инструкция об использовании AviSynth.
* [[Filter introduction|Обзор фильтров]] - Краткий обзор наиболее часто используемых фильтров AviSynth.
* [[Script examples|Примеры скриптов]] - Несколько примеров, используемых во всем Мире.
* Несколько руководств, разъясняющих использование AviSynth:
** [http://www.doom9.org/capture/postprocessing_avisynth.html Руководство захвата аналогового сигнала]. The AviSynth part of the capture guide is about what filters can be used to enhance the quality of the capture. It discusses things like deinterlacing, denoising, cropping and resizing and color adjustment. Which makes it really useful to learn about some of the capabilities of AviSynth in a schematic way.
** [http://www.animemusicvideos.org/guides/avtech/avisyntha.html Введение в AviSynth от AnimeMusicVideos.org]. Простая инструкция, описывающая деинтерлизинг, изменение размера и некоторые другие базовые действия.
** [http://www.animemusicvideos.org/guides/avtech/avspostqual.html Введение в фильтры AviSynth от AnimeMusicVideos.org]. Простая инструкция, описывающая фильтры сглаживания, удаления муара, повышения резкости, управления цветом и некоторых других.
* [[Troubleshooting|Обнаружение проблем]] в Ваших скриптах и конфигурации.

=== Фильтры, внешние плагины, скриптовые функции и утилиты ===

* [[Internal filters|Внутренние фильтры]] - Официальный список включенных в AviSynth фильтров с описанием, сгруппированный по категориям.
* [[External filters|Внешние фильтры]] - Документация некоторых скриптовых функций и плагинов для AviSynth версии 2.5x.
** [[External plugins old|Внешние плагины (устар.)]] - Документация по плагинам AviSynth версий v1.0x/v2.0x (устаревшие плагины, однако некоторые из них по прежнему могут быть использованы).
* [http://www.avisynth.org/warpenterprises/ Коллекция плагинов AviSynth] собранная WarpEnterprises.
* [[Shared functions|Общие функции]] - Полезные скриптовые функции.
* [[Utilities]] - Список GUIs, командных, групповых и других AviSynth-утилит.

=== Синтаксис AviSynth-скрипта ===

* [[AviSynth Syntax|Синтаксис]] - Официальная документация.
** [[Grammar|Грамматика]] - Грамматика скриптового языка AviSynth. Введение в скриптовый язык AviSynth.
** [[Script variables|Переменные]] - Как объявлять и использовать их в скриптах.
** [[Operators|Операторы]] - Допустимые операторы и их приоритет.
** [[Clip properties|Свойства клипа]] - Функции, возвращающие свойства клипа.
** [[Control structures|Структуры управления]] - Языковые конструкции управления потоком.
** [[Internal functions|Встроенные функции]] - Ready-made non-clip функции для использования в скриптах.
** [[User defined script functions|Определяемые пользователем скриптовые функции]] - Как их объявлять и использовать.
** [[Plugins|Плагины]] - Как подключать плагины AviSynth, VirtualDub, VFAPI и C-плагины, их автозагрузка и именные предпочтения.
** [[Runtime environment|Runtime-окружение]] - Скриптовое описание для использования отдельных кадров клипа.
* [[Scripting reference|Руководство по скриптам]] - Выход за пределы базовых приемов написания скриптов.
** [[The full AviSynth grammar|Полное руководство по грамматике]] - Полное руководство по использованию AviSynth.
** [[The script execution model|Модель выполнения скриптов]] - The steps behind the scenes from the script to the final video clip output. The filter graph. Scope and lifetime of variables. Evaluation of runtime scripts.
** [[User functions|Функции пользователя]] - Как эффективно создавать пользовательские скриптовые функции; как избегать общих ошибок; способы организации ваших функций в коллекции, создание библиотек функций и многое другое.
** [[Block statements|Блоковые конструкции]] - Технические идиомы для создания блоков AviSynth-скриптов.
** [[Arrays|Массивы]] - Использование массивов (и соответствующих операторов) для управления наборами данных в один шаг.
** [[Scripting at runtime|Выполнение скриптов]] - Как раскрыть все возможности runtime фильтров и создавать комплексные скрипты, которые реализуют интересные (и эффективные по быстродействию) эффекты и операции.

=== FAQ, Руководства и дополнительные материалы ===

* [[AviSynth FAQ]] - Ответы на часто задаваемые вопросы.
* [[Aspect ratios|Пропорции клипов]] - Введение в соотношение сторон клипов (DAR, PAR, SAR), как правильно измененять размер исходных клипов.
* [[Guides|Руководства]] - Советы по конкретным типам конвертирования и общие задачи.
* [[Advanced topics|Дополнительные советы]] - Рассказывают о таких вещах как ошибка Chroma Upsampling, преобразование цветов, гибридное видео, компенсация движения и т.д.

== Разработка ==

* Хотите [[get involved|принять участие]]?
* Официальный [http://sourceforge.net/projects/avisynth2/ SourceForge] проект.
* О том, [[compile AviSynth|как откомпилировать AviSynth]] и плагины.
* [[Filter SDK]] - Советы по программированию AviSynth-плагинов.
* [http://forum.doom9.org/forumdisplay.php?s=&forumid=69 Форум разработчиков].
* Список [[changelist|последних изменений]].
* О разработке платформонезависимой [[AviSynth v3]].

== Wiki ==

Добро пожаловать на MediaWiki. Не стесняйтесь в наполнении данного сайта! Нам нужна Ваша помощь в наполнении данного Wiki-сайта. Ознакомьтесь с [http://meta.wikimedia.org/wiki/Помощь:Содержание руководством пользователя] по редактированию данного сайта.

== Авторские права на документацию ==

Права на документацию AviSynth (c) 2002-2007 принадлежат группе разработчиков AviSynth и других людей, сделавших вклад.

С 5 августа 2007 года информация на данном сайте публикуется под лицензией [http://creativecommons.org/licenses/by-sa/3.0/ CreativeCommons Attribution-ShareAlike 3.0 License] (сокращенно "CC BY-SA 3.0", см. [http://creativecommons.org/licenses/by-sa/3.0/legalcode полные правила лицензирования]). Перевод на русский: http://wiki.ccrussia.org/index.php?title=Attribution-ShareAlike_3.0_Unported_Commons_Deed . Дополнительная информация о правах доступна [[Avisynth:Copyrights|здесь]].

[http://wikipedia.dn.ua Википедия Донбасса]