Avisynth wiki - User contributions [en]

Avsresize

2026-01-30T20:41:08Z

Pinterf: Version update r26

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1=[https://github.com/sekrit-twc sekrit-twc], [https://codeberg.org/StvG StvG]
|2=r26
|3=[https://codeberg.org/StvG/avsresize/releases avsresize_r26.7z]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=173986 Doom9 Forum]
}}
<br>
== Description ==
[https://github.com/sekrit-twc/zimg z.lib] resizers for AviSynth+<br>
<br>
== Requirements ==
* [[AviSynth+]] x86/x64, latest binaries are 64-bit only
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**All [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha) are supported.
<br>

== [[Script variables|Syntax and Parameters]] ==

Syntax was updated here till r21 (?), for up-to-date list, check documentation.

===z_ConvertFormat===
Scaling, colorspace conversion, and depth conversion.
:{{Template:FuncDef|z_ConvertFormat (clip clip, int "width", int "height", string "pixel_type", string "colorspace_op", string "chromaloc_op", bool "interlaced", float "src_left", float "src_top", float "src_width", float "src_height", string "resample_filter", float "filter_param_a", float "filter_param_b", string "resample_filter_uv", float "filter_param_a_uv", float "filter_param_b_uv", string "dither_type", string "cpu_type", float "nominal_luminance", bool "approximate_gamma", bool "use_props", bool "scene_referred")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2|width|int| }}
::{{Par2|height|int| }}
:::Output width and height in pixels.
<br>
::{{Par2|pixel_type|string| }}
:::Output pixel type ("YV12", "YUV420P16", etc.).
::::{|class="wikitable" style="height:100px; width:240px; border="1" cellpadding="4"
|-
!width=10%| Bit Depth
!width=10%| Grey
!width=10%| YUV420
!width=10%| YUVA420
!width=10%| YUV422
!width=10%| YUVA422
!width=10%| YUV444
!width=10%| YUVA444
!width=10%| RGB
!width=10%| RGBA
|-
!8
|Y8
|YV12<br>YUV420<br>YUV420P8
|YUVA420<br>YUVA420P8
|YV16<br>YUV422<br>YUV422P8
|YUVA422<br>YUVA422P8
|YV24<br>YUV444<br>YUV444P8
|YUVA444<br>YUVA444P8
|RGBP<br>RGBP8
|RGBAP<br>RGBAP8
|-
!10
|Y10
|YUV420P10
|YUVA420P10
|YUV422P10
|YUVA422P10
|YUV444P10
|YUVA444P10
|RGBP10
|RGBAP10
|-
!12
|Y12
|YUV420P12
|YUVA420P12
|YUV422P12
|YUVA422P12
|YUV444P12
|YUVA444P12
|RGBP12
|RGBAP12
|-
!14
|Y14
|YUV420P14
|YUVA420P14
|YUV422P14
|YUVA422P14
|YUV444P14
|YUVA444P14
|RGBP14
|RGBAP14
|-
!16
|Y16
|YUV420P16
|YUVA420P16
|YUV422P16
|YUVA422P16
|YUV444P16
|YUVA444P16
|RGBP16
|RGBAP16
|-
!32
|Y32
|YUV420PS
|YUVA420PS
|YUV422PS
|YUVA422PS
|YUV444PS
|YUVA444PS
|RGBPS
|RGBAPS
|-
! colspan="10"| All colorspaces are planar. "YUV9" and "YV411" ("YUV411", "YUV411P8") were omitted from table above. See [[Avisynthplus_color_formats#Color_Format_Table|AviSynth+ color formats table]].
|}
<br>
::{{Par2|colorspace_op|string| }}
:::Colorspace operation description.
:::Format is <code>"matS[:transS[:primS[:rangeS]]]=>matD[:transD[:primD[:rangeD]]]"</code>
:::Example JPEG to MPEG: <code>"170m:709:709:f=>709:709:709:l"</code>
:::There is keyword "auto" for source matrix, transfer, primaries, range. When it's used the corresponding input frame properties are used, if such frame properties don't exist either an error is raised or default matrix and color range are used.
:::There is keyword "same" for destination matrix, transfer, primaries, range. When it's used the corresponding source value is applied for destination too so there is no conversion.
:::See [[#Examples|examples]] for more information.
::::{|class="wikitable" style="height:100px; width:240px; border="1" cellpadding="4"
|-
!width=25%| MATRIX COEFFICIENTS
!width=25%| TRANSFER CHARACTERISTICS
!width=25%| COLOR PRIMARIES
!width=25%| PIXEL RANGE
|-
|"rgb"
|"709"
|"709"
|"limited"
|-
|"709"
|"unspec"
|"unspec"
|"l"
|-
|"unspec"
|"470m"
|"470m"
|"full"
|-
|"fcc"
|"470bg"
|"470bg"
|"f"
|-
|"470bg"
|"601"
|"170m"
|
|-
|"170m"
|"240m"
|"240m"
|
|-
|"240"
|"linear"
|"film"
|
|-
|"ycgco"
|"log100"
|"2020"
|
|-
|"2020ncl"
|"log316"
|"st428"
|
|-
|"2020cl"
|"xvycc"
|"st431-2"
|
|-
|"chromancl"
|"srgb"
|"st432-1"
|
|-
|"chromacl"
|"2020_10"
|"jedec-p22"
|
|-
|"ictcp"
|"2020_12"
|"prophoto"
|
|-
|Compatibility aliases
|"st2084"
|Compatibility aliases
|
|-
|"601" same as "470bg"
|"std-b67"
|"xyz" same as "st428"
|
|-
|"2020" same as "2020ncl"
|"prophoto"
|"dci-p3" same as "st431-2"
|
|-
|
|Compatibility aliases
|"display-p3" same as "st432-1"
|
|-
|
|"2020" same as "2020_10"
|
|
|-
! colspan="4"| see tables on [http://www.vapoursynth.com/doc/functions/video/resize.html VapourSynth resize documentation]
|}
<br>
::{{Par2|chromaloc_op|string| }}
:::Chroma location operation description.
:::Format is <code>"[locS]=>[locD]"</code>
:::There is keyword "auto" for source chromaloc_op. When it's used the corresponding input frame property is used, if such frame property doesn't exist default chromaloc is used.
:::There is keyword "same" for destination chromaloc_op. When it's used the corresponding source value is applied for destination too so there is no conversion.
:::See [[#Examples|examples]] for more information.
::::Chroma location table, names in parenthesis are compatibility aliases:
::::* <code>"left" ("mpeg2") | "center" ("jpeg" and "mpeg1") | "top_left"</code>
:::Example JPEG to MPEG2: <code>"center=>left"</code>
<br>
::{{Par2|interlaced|bool|false}}
:::Whether to use interlaced mode.
<br>
::{{Par2|src_left|float|0.0}}
::{{Par2|src_top|float|0.0}}
::{{Par2|src_width|float|Source width}}
::{{Par2|src_height|float|Source height}}
:::Optional crop rectangle in the input frame.
<br>
::{{Par2|resample_filter|string|"bicubic"}}
:::Resampling modes: <code>"point" | "bilinear" | "bicubic" | "spline16" | "spline36" | "spline64" | "lanczos"</code>
<br>
::{{Par2|filter_param_a|float| }}
::{{Par2|filter_param_b|float| }}
:::First and second parameter to resampler.
:::Example Bicubic (Mitchell-Netravali): <code>resample_filter="bicubic", filter_param_a=0.333, filter_param_b=0.333</code>
:::Example 4-tap Lanczos: <code>resample_filter="lanczos", filter_param_a=4</code>
:::Default for "bicubic": <code>filter_param_a=0.0, filter_param_b=0.5</code>
:::Default for "lanczos": <code>filter_param_a=3</code>
<br>
::{{Par2|resample_filter_uv|string|resample_filter}}
:::Resampling mode for chroma.
<br>
::{{Par2|filter_param_a_uv|float|filter_param_a}}
::{{Par2|filter_param_b_uv|float|filter_param_b}}
:::First and second parameter to chroma resampler.
<br>
::{{Par2|dither_type|string|"none"}}
:::Dithering type: <code>"none" | "ordered" | "random" | "error_diffusion"</code>
<br>
::{{Par2|cpu_type|string| }}
:::CPU type, names in parenthesis are compatibility aliases:
:::*<code>"none" | "avx" | "avx_e" ("ivy") | "avx2" | "avx512f | "avx512_skx" ("skx") | "avx512_clx" | "avx512_pmc" ("cannon") | "avx512_snc" ("ice")</code>
<br>
::{{Par2|nominal_luminance|float|100.0}}
:::Nominal peak luminance in cd/m^2 when converting HDR content to RGB Linear. More info [https://github.com/sekrit-twc/zimg/blob/93f8504a67373d428158219eb3aca0455e4c20ca/src/zimg/api/zimg.h#L595 here].
<br>
::{{Par2|approximate_gamma|bool|true}}
:::Evaluating transfer functions at reduced precision.
<br>
::{{Par2|use_props|int|}}
:::Whether to read and set frame properties:
:::*-1: If frame properties are supported - if every option of <code>colorspace_op</code> and <code>chromaloc_op</code> are specified and different than "auto", 0, otherwise 1. <br> If frame properties are not supported - 0.
:::*0: If frame properties are supported - only set frame properties.
:::*1: Read and set frame properties.
:::*2: Save properties of the source clip as frame properties: <code>z_ChromaLocation, z_ColorRange, z_Matrix, z_Transfer, z_Primaries</code>. <br> Every option of <code>colorspace_op</code> and <code>chromaloc_op</code> must be specified and different than "auto".
:::*3: Save properties of the source clip as frame properties: <code>z_ChromaLocation, z_ColorRange, z_Matrix, z_Transfer, z_Primaries</code>. <br> Frame properties <code>_ChromaLocation, _ColorRange, _Matrix, _Transfer, _Primaries</code> must exist. <br> Frame properties <code>_Matrix, _Transfer, _Primaries</code> must have values different than 2 (unspec).
:::*4: Use z_xxx frame properties as target values. <br> z_xxx frame properties are removed after the colorspace conversion.
<br>
:::<code>use_props=0</code> is faster than <code>use_props=1</code>
:::<code>use_props=2</code> is faster than <code>use_props=3</code>
:::Example <code>use_props=2</code> and <code>use_props=4</code>
<div style="margin-left: 6em; max-width: 87em">
<pre>
z_ConvertFormat(pixel_type="rgbp", colorspace_op="709:709:709:l=>rgb:linear:709:f", chromaloc_op="left=>left", use_props=2)
z_ConvertFormat(pixel_type="yv12", use_props=4)
</pre>
</div>
:::Example <code>use_props=3</code> and <code>use_props=4</code>
<div style="margin-left: 6em; max-width: 87em">
<pre>
z_ConvertFormat(pixel_type="rgbp", colorspace_op="709:709=>rgb:linear", use_props=3)
z_ConvertFormat(pixel_type="yv12", use_props=4)
</pre>
</div>
<br>
::{{Par2|scene_referred|bool|false}}
:::Whether to use scene-referred transfer function (default false).
<br>

====Frame Properties====
*The name of the frame properties that are read and set are: <code>_ChromaLocation, _ColorRange, _Matrix, _Transfer, _Primaries</code>
*The frame properties read and set the corresponding numerical index of the parameters. For example: matrix <code>"709"</code> has numerical index `1` and the frame property have value of `1`.
*If colorspace_op is not defined and there are frame properties, they are used for default source values.
*If colorspace_op is not defined and there are no frame properties or they are not supported, default values are used as before (there are default values for matrix, range and chromaloc).
*If colorspace_op is defined and you want to use the frame property for a source value, use "auto".
*If colorspace_op is defined and you use "auto" without frame property, the default value for that argument will be used if exist.
*If you use "auto" for argument with frame property that has value of 2 (unspec) and use anything different than "same" for destination, error will be raised.
*If you use "auto=>same" for matrix/transfer/primaries with frame property 2 (unspec) and you want to make colorspace conversion, error will be raised. For example:
<pre>
#transfer property has value of 2
#primaries 709 (1)
#input yv12
z_convertformat(pixel_type="rgbp", colorspace_op="auto:auto:709=>rgb:same:470bg") # error raised
#z_convertformat(pixel_type="rgbp", colorspace_op="auto:709:709=>rgb:709:470bg") # ok
#z_convertformat(pixel_type="rgbp", colorspace_op="auto:709:auto=>rgb:same:470bg") # ok
#z_ConvertFormat(colorspace_op="auto:auto=>same:470bg") # error
#z_ConvertFormat(colorspace_op="auto:auto:auto:auto=>same:same:same:f") # ok
</pre>

<br>

===Resizers===
z.lib compatibility wrappers with the same syntax as the [[Resize|built-in resizers]].
:{{Template:FuncDef|z_PointResize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_BilinearResize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_BicubicResize (clip, int target_width, int target_height, float "b", float "c", float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_LanczosResize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", int "taps", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_Lanczos4Resize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", int "taps", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_Spline16Resize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_Spline36Resize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}

:{{Template:FuncDef|z_Spline64Resize (clip, int target_width, int target_height, float "src_left", float "src_top", float "src_width", float "src_height", string "chromaloc_op", string "dither", bool "interlaced")}}
<br>
<br>
::{{Par2| |clip| }}
:::A clip to process. All planar formats are supported.
<br>
::{{Par2||int| }}
:::<code>target_width</code>: the width of the output.
<br>
::{{Par2||int| }}
:::<code>target_height</code>: the height of the output.
<br>
::{{Par2|b|float|0.0}}
::{{Par2|c|float|0.5}}
:::Parameters for <code>z_BicubicResize</code> only.
:::<code>b</code> and <code>c</code> can be used to tweak the filter’s behavior. For upscaling, it is recommended to use values that satisfy the equation <code>b + 2c = 1</code>.
:::Roughly speaking, raising B will cause blurring and raising C will cause ringing.
:::*<code>b=1.0, c=0.0</code> : B-Spline
:::*<code>b=0.0, c=0.0</code> : Hermite
:::*<code>b=1/3, c=1/3</code> : Mitchell-Netravali cubic filter
:::*<code>b=0.0, c=0.5</code> : Catmull-Rom spline (default)
:::*<code>b=0.0, c=0.75</code> : VirtualDub's "Precise Bicubic"
:::*<code>b=0.0, c=1.0</code> : Sharp Bicubic
:::Hermite is often considered one of the best choices for downscaling, as it produces only minimal artifacts, at the cost of slight blurriness.[https://guideencodemoe-mkdocs.readthedocs.io/encoding/resampling/#mitchell-netravali-bicubic]
:::B/C splines by Nicolas Robidoux:
:::*<code>b=0.3782, c=0.3109</code> : Robidoux
:::*<code>b=0.2620, c=0.3690</code> : RobidouxSharp
:::*<code>b=0.6796, c=0.1602</code> : RobidouxSoft
:::Note: these numbers are rounded, exact values can be found [https://legacy.imagemagick.org/discourse-server/viewtopic.php?f=22&t=19823&start=30 here] and [https://github.com/mpv-player/mpv/issues/2637 here]
:::Didée's method to resize 1080p content to 720p: <code>b=-0.5, c=0.25</code> [https://forum.doom9.org/showthread.php?p=1579385#post1579385] [https://forum.doom9.org/showthread.php?p=1748922#post1748922]
<br>
::{{Par2|src_left|float|0.0}}
::: Cropping of the left edge.
<br>
::{{Par2|src_top|float|0.0}}
:::Cropping of the top edge.
<br>
::{{Par2|src_width|float|Source width}}
:::If > 0.0 it sets the width of the clip before resizing.
:::If <= 0.0 it sets the cropping of the right edges before resizing.
<br>
::{{Par2|src_height|float|Source height}}
:::If > 0.0 it sets the height of the clip before resizing.
:::If <= 0.0 it sets the cropping of the bottom edges before resizing
<br>
::{{Par2|taps|int|3}}
:::Parameter for <code>z_LanczosResize</code> only.
:::Controls the filter’s number of lobes, or taps. Increasing the number of lobes improves sharpness at the cost of increased ringing.
:::You might occasionally see the tap count appended to the filter name to clarify the exact filter used, e.g. Lanczos2 for 2 taps.
:::For downscaling, higher tap counts might help in suppressing [http://www.imagemagick.org/Usage/filter/#aliasing Moiré effects].
<br>
::{{Par2|chromaloc_op|string|<nowiki>"left=>left"</nowiki>}}
:::Chroma location operation description.
:::Format is <code>"[locS]=>[locD]"</code>
::::Chroma location table, names in parenthesis are compatibility aliases:
::::* <code>"left" ("mpeg2") | "center" ("jpeg" and "mpeg1") | "top_left"</code>
:::Example JPEG to MPEG2: <code>"center=>left"</code>
<br>
::{{Par2|dither|string|"none"}}
:::Dithering type: <code>"none" | "ordered" | "random" | "error_diffusion"</code>
<br>
::{{Par2|interlaced|bool|false}}
:::Whether to use interlaced mode.
<br>

==Examples==
===YUV⟷RGB Conversion===
*'''HD YUV 4:2:0 Rec. 709 to 16-bit RGB:'''
AviSource("blah.avi")
z_ConvertFormat(pixel_type="RGBP16", colorspace_op="709:709:709:limited=>rgb:709:709:full")

*'''RGB to 8-bit YV12 (YUV 4:2:0 Rec. 709):'''
AviSource("blah.avi")
ConvertToPlanarRGB() # omit if source is already planar RGB
z_ConvertFormat(pixel_type="YUV420P8", colorspace_op="rgb:709:709:full=>709:709:709:limited")
Note: RGB input must be planar, use [[Convert|ConvertToPlanarRGB()]].

===Changing Colorimetry===
*'''SD NTSC Rec. 601 to HD Rec. 709'''
AviSource("blah.avi") # let's assume the source is a NTSC DVD clip
z_ConvertFormat(colorspace_op="470bg:601:170m:full=>709:709:709:full")

*'''SD PAL Rec. 601 to HD Rec. 709'''
AviSource("blah.avi") # let's assume the source is a PAL DVD clip
z_ConvertFormat(colorspace_op="470bg:601:470bg:full=>709:709:709:full")

*'''Rec. 709 SDR to Rec. 2020 SDR'''
AviSource("blah.avi") # let's assume the source is BT709 SDR
z_ConvertFormat(colorspace_op="709:709:709:full=>2020:2020:2020:full")

*'''Rec. 709 SDR to Rec. 2020 HLG HDR'''
AviSource("blah.avi") # let's assume the source is BT709 SDR
z_ConvertFormat(colorspace_op="709:709:709:full=>2020ncl:std-b67:2020:full")

*'''Rec. 2020 SDR to Rec. 709 SDR'''
AviSource("blah.avi") # let's assume the source is BT2020 SDR
z_ConvertFormat(colorspace_op="2020:2020:2020:full=>709:709:709:full")

* Note that the examples above use full=>full since it does not truncate the brightest and darkest pixels, as opposed to limited=>limited. [https://forum.doom9.org/showthread.php?p=1906754&highlight=full#post1906754].
* To learn more about matrix, transfer, and primaries and its different names, see [https://forum.doom9.org/showthread.php?p=1897824#post1897824 this post on Doom9].
<br>

===Linear Light Downscaling===
In the following examples, the source is first converted to linear light RGB, then resized and converted back to the original format.<br>
By default <code>approximate_gamma=true</code>, you can set it to false but the speed decrease dramatically and it's probably not worth it.<br>
Also note that scaling in linear light could easily lead to increased/or even create haloing. The chance is very high when using spline36 as the resample filter [https://forum.doom9.org/showthread.php?p=1948138#post1948138].

*'''HD (Rec709) content:'''
z_ConvertFormat(pixel_type="RGBPS", colorspace_op="709:709:709:limited=>rgb:linear:709:full", resample_filter="spline36")
z_ConvertFormat(width=1280, height=720, pixel_type="YUV420P16", colorspace_op="rgb:linear:709:full=>709:709:709:limited", resample_filter="spline36")

*'''SD NTSC content:'''
z_ConvertFormat(pixel_type="RGBPS", colorspace_op="470bg:601:170m:limited=>rgb:linear:170m:full", resample_filter="spline36")
z_ConvertFormat(width=320, height=240, pixel_type="YUV420P16", colorspace_op="rgb:linear:170m:full=>470bg:601:170m:limited", resample_filter="spline36")

*'''SD PAL content:'''
z_ConvertFormat(pixel_type="RGBPS", colorspace_op="470bg:601:470bg:limited=>rgb:linear:470bg:full", resample_filter="spline36")
z_ConvertFormat(width=320, height=240, pixel_type="YUV420P16", colorspace_op="rgb:linear:470bg:full=>470bg:601:470bg:limited", resample_filter="spline36")

*'''JPEG (e.g. pictures):'''
z_ConvertFormat(pixel_type="RGBPS", colorspace_op="601:601:470bg:full=>rgb:linear:470bg:full", chromaloc_op="center=>center", resample_filter="spline36")
z_ConvertFormat(width=480, height=360, pixel_type="YUV420P16", colorspace_op="rgb:linear:470bg:full=>601:601:470bg:full", chromaloc_op="center=>center", resample_filter="spline36")

*'''RGB content:'''
z_ConvertFormat(pixel_type="RGBPS", colorspace_op="rgb:srgb:709:full=>rgb:linear:709:full", resample_filter="spline36")
z_ConvertFormat(width=1280, height=720, pixel_type="RGBP16", colorspace_op="rgb:linear:709:full=>rgb:srgb:709:full", resample_filter="spline36")

<br>

== Changelog ==
Version Date Changes<br>
r26 2025/08/31 - ?
r21 2023/02/15 - changes by [https://forum.doom9.org/showthread.php?p=1982991#post1982991 StvG]
- throw error if IsFieldBased()=true and interlaced=false/use_props=1;
- resizer wrappers: added parameter interlaced;
- changed behavior of interlaced=true - previously it force use_props=0; now it doesn't have effect when use_props=1.<BR>
r20 2023/01/30 - changes by [https://forum.doom9.org/showthread.php?p=1982087#post1982087 StvG]
- not read "_FieldBased" frame prop when use_props=0;
- added ProPhotoRGB (TomArrow).<br>
r19 2022/08/17 - changes by [https://forum.doom9.org/showthread.php?p=1973326#post1973326 StvG]
- fixed the behavior when missing frame property;
- the matrix between yuv<->grey isn't silently changed anymore.<br>
r18 2022/08/15 - changes by [https://forum.doom9.org/showthread.php?p=1973192#post1973192 StvG]
- fixed output frame properties when use_props=0 and colorspace_op/chromaloc_op not specified.<br>
r17 2022/08/13 - changes by [https://forum.doom9.org/showthread.php?p=1973142#post1973142 StvG]
- use_props=-1 improved a bit more.<br>
r16 2022/08/09 - changes by [https://forum.doom9.org/showthread.php?p=1972971#post1972971 StvG]
- improved use_props=-1;
- throw error when use_props=0 and _FieldBased/_Field > 0;
- added support for interlaced clips: when interlaced=true, always use_props=0. <br>
r15 2022/08/06 - changes by [https://forum.doom9.org/showthread.php?p=1972716#post1972716 StvG]
- relaxed restrictions for use_props=0;
- added scene_referred parameter (default false).<br>
r14 2022/04/18 - changes by [https://forum.doom9.org/showthread.php?p=1967682#post1967682 StvG]
- fixed regression (r12) when reading frame properties (use_props=3/4).<br>
r13 2022/04/14 - changes by [https://forum.doom9.org/showthread.php?p=1967463#post1967463 StvG]
- zimg@dd4c4df;
- use_props= -1: If frame properties are supported - if every option of colorspace_op
and chromaloc_op (for src/dst colorspace with subsampling w/h > 0) are specified
and different than "auto", 0, otherwise 1.<br>
r12 2021/11/21 - changes by [https://forum.doom9.org/showthread.php?p=1957876#post1957876 StvG]
- changed use_props type from bool to int.<br>
r11 2021/11/18 - changes by [https://forum.doom9.org/showthread.php?p=1957643#post1957643 StvG]
- added parameter use_props (whether to read and set frame properties)
- zimg 3.0.3.<br>
r10 2021/08/12 - changes by [https://forum.doom9.org/showthread.php?p=1949669#post1949669 StvG]
- do not set matrix frame property when source matrix frame property is undef and color family is not changed
- zimg@bf73dbe.<br>
r9 2021/06/30 - changes by [https://forum.doom9.org/showthread.php?p=1946523#post1946523 StvG]
- do not use the same color range for the destination when frame property available
and source/destination color family is different;
- set the correct color range frame property value for destination YUV 32-bit.<br>
r8 2021/06/29 - changes by [https://forum.doom9.org/showthread.php?p=1946427#post1946427 StvG]
- changed MT mode to [[MT_MULTI_INSTANCE]]<br>
r7 2021/06/23 - changes by [https://forum.doom9.org/showthread.php?p=1945780#post1945780 StvG]
- fixed frame properties reading.<br>
r6 2021/05/31 - changes by [https://forum.doom9.org/showthread.php?p=1943908#post1943908 StvG]
- registered as MT_NICE_FILTER
- read frame properties from every frame (previously only from the first frame)
- zimg@8d0b839.<br>
r5 2020/10/30 - changes by [https://forum.doom9.org/showthread.php?p=1927059#post1927059 StvG]
- use chromaloc frame property (when available) for the legacy resizers.<br>
r4 2020/10/21 - changes by [https://forum.doom9.org/showthread.php?p=1926438#post1926438 StvG]
- fixed crashing when avs+ doesn't support frame properties;
- set _SARNum and _SARDen properties;
- read the input frame property _ChromaLocation if available;
- do not process clips with frame property _FiledBased > 0.<br>
r3 2020/10/15 - changes by [https://forum.doom9.org/showthread.php?p=1925849#post1925849 StvG]
- removed parameter prefer_props;
- added keyword "auto" for source matrix, transfer, primaries, range.
When it's used the corresponding input frame properties are used,
if such frame properties don't exist either an error is raised or
default matrix and color range are used;
- added keyword "auto" for source chromaloc_op.
When it's used the corresponding input frame property is used,
if such frame property doesn't exist default chromaloc is used.<br>
r2 2020/10/14 - changes by [https://forum.doom9.org/showthread.php?p=1925801#post1925801 StvG]
- added keyword 'same' for destination matrix, transfer, primaries, range, chromaloc_op.
- When it's used the source value (argument or frame property) is used for destination too.<br>
r1g 2020/10/03 - changes by [https://forum.doom9.org/showthread.php?p=1924923#post1924923 StvG]
- added parameter prefer_props; read and set _ChromaLocation, _ColorRange, _Matrix, _Transfer,
_Primaries frame properties; added chromaloc_op parameters - bottom_left and bottom.<br>
r1f 2020/08/25 - changes by [https://forum.doom9.org/showthread.php?p=1921975#post1921975 StvG]
- added @[https://forum.doom9.org/showthread.php?p=1920920#post1920920 Losko] patch, zimg v3.0.1, added support for frame properties.<br>
r1e 2020/04/23 - changes by [https://forum.doom9.org/showthread.php?p=1908845#post1908845 StvG]
- update to zimg@8815111;
- z_ConvertFormat: added pixel type RGBP8, RGBAP8, YUV444, YUV444P8, YUVA444P8, YUV422,
YUV422P8, YUVA422P8, YUV420, YUV420P8 , YUVA420P8, YUV411, YUV411P8
- added version.<br>
2020/04/08 - changes by [https://forum.doom9.org/showthread.php?p=1906771#post1906771 StvG]
- update to zimg@5896a26
- z_ConvertFormat: add "cpu_type", "nominal_luminance", and "approximate_gamma" parameters
- z_ConvertFormat: remove "gauss", "lanczos4", "blackman", and "sinc" compatibility aliases
- z_ConvertFormat: remove "dv" compatibility alias from chromaloc_op
- resizers: add "chromaloc_op" and "dither" parameters
- resizers: remove z_BlackmanResize(), z_GaussResize(),
and z_SincResize() compatibility aliases.<br>
r1d 2018/03/21 - ...............<br>
r1 2016/10/29 - initial release
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="400px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!r26
|[https://forum.doom9.org/showthread.php?p=2022249#post2022249 avsresize_r26.7z]
|[https://codeberg.org/StvG/avsresize/releases avsresize_r26.7z]
|-
!r21
|[https://forum.doom9.org/showthread.php?p=1982991#post1982991 avsresize_r21.7z]
|[https://web.archive.org/web/20230215081928if_/https://files.videohelp.com/u/223002/avsresize_r21.7z avsresize_r21.7z]
|-
!r20
|[https://forum.doom9.org/showthread.php?p=1982087#post1982087 avsresize_r20.7z]
|[https://web.archive.org/web/20230130075804if_/https://files.videohelp.com/u/223002/avsresize_r20.7z avsresize_r20.7z]
|-
!r19
|[https://forum.doom9.org/showthread.php?p=1973326#post1973326 avsresize_r19.7z]
|[https://web.archive.org/web/20220818022554if_/https://files.videohelp.com/u/223002/avsresize_r19.7z avsresize_r19.7z]
|-
!r18
|[https://forum.doom9.org/showthread.php?p=1973192#post1973192 avsresize_r18.7z]
|[https://web.archive.org/web/20220815000722if_/https://files.videohelp.com/u/223002/avsresize_r18.7z avsresize_r18.7z]
|-
!r17
|[https://forum.doom9.org/showthread.php?p=1973142#post1973142 avsresize_r17.7z]
|[https://web.archive.org/web/20220813203417if_/https://files.videohelp.com/u/223002/avsresize_r17.7z avsresize_r17.7z]
|-
!r16
|[https://forum.doom9.org/showthread.php?p=1972971#post1972971 avsresize_r16.7z]
|[https://web.archive.org/web/20220810145814if_/https://files.videohelp.com/u/223002/avsresize_r16.7z avsresize_r16.7z]
|-
!r15
|[https://forum.doom9.org/showthread.php?p=1972716#post1972716 avsresize_r15.7z]
|[https://web.archive.org/web/20220806144931if_/https://files.videohelp.com/u/223002/avsresize_r15.7z avsresize_r15.7z]
|-
!r14
|[https://forum.doom9.org/showthread.php?p=1967682#post1967682 avsresize_r14.7z]
|[https://web.archive.org/web/20220419113153if_/https://files.videohelp.com/u/223002/avsresize_r14.7z avsresize_r14.7z]
|-
!r13
|[https://forum.doom9.org/showthread.php?p=1967463#post1967463 avsresize_r13.7z]
|[https://web.archive.org/web/20220415100326if_/https://files.videohelp.com/u/223002/avsresize_r13.7z avsresize_r13.7z]
|-
!r12
|[https://forum.doom9.org/showthread.php?p=1957876#post1957876 avsresize_r12.7z]
|[https://web.archive.org/web/20211121225346if_/https://files.videohelp.com/u/223002/avsresize_r12.7z avsresize_r12.7z]
|-
!r11
|[https://forum.doom9.org/showthread.php?p=1957643#post1957643 avsresize_r11.7z]
|[https://web.archive.org/web/20211118222533if_/https://files.videohelp.com/u/223002/avsresize_r11.7z avsresize_r11.7z]
|-
!r10
|[https://forum.doom9.org/showthread.php?p=1949669#post1949669 avsresize_r10.7z]
|[https://web.archive.org/web/20210813212341if_/https://files.videohelp.com/u/223002/avsresize_r10.7z avsresize_r10.7z]
|-
!r9
|[https://forum.doom9.org/showthread.php?p=1946523#post1946523 avsresize_r9.7z]
|[https://web.archive.org/web/20210721045904if_/https://files.videohelp.com/u/223002/avsresize_r9.7z avsresize_r9.7z]
|-
!r8
|[https://forum.doom9.org/showthread.php?p=1946427#post1946427 avsresize_r8.7z]
|[https://web.archive.org/web/20210721050245if_/https://files.videohelp.com/u/223002/avsresize_r8.7z avsresize_r8.7z]
|-
!r7
|[https://forum.doom9.org/showpost.php?p=1945780&postcount=163 avsresize_r7.7z]
|[https://web.archive.org/web/20210625201951if_/https://files.videohelp.com/u/223002/avsresize_r7.7z avsresize_r7.7z]
|-
!r6
|[https://cloud.owncube.com/s/KfAcEpqkMPSdagr/download avsresize_r6.7z]
|[https://web.archive.org/web/20210606012435if_/https://files.videohelp.com/u/223002/avsresize_r6.7z avsresize_r6.7z]
|-
!r5
|[https://cloud.owncube.com/s/Zq6iPjyYGcTLAT8/download avsresize_r5.7z]
|[https://web.archive.org/web/20201101042308if_/https://files.videohelp.com/u/223002/avsresize_r5.7z avsresize_r5.7z]
|-
!r4
|[https://cloud.owncube.com/s/ScA6xEADaHLiAFd/download avsresize_r4.7z]
|[https://web.archive.org/web/20201023043116if_/https://files.videohelp.com/u/223002/avsresize_r4.7z avsresize_r4.7z]
|-
!r3
|[https://cloud.owncube.com/s/f6rQEcCLA95jZMN/download avsresize_r3.7z]
|[https://web.archive.org/web/20201016173250if_/https://files.videohelp.com/u/223002/avsresize_r3.7z avsresize_r3.7z]
|-
!r2
|[https://cloud.owncube.com/s/jfDf8rERkxEFTqW/download avsresize_r2.7z]
|[https://web.archive.org/web/20201014204436if_/https://files.videohelp.com/u/223002/avsresize_r2.7z avsresize_r2.7z]
|-
!r1g
|[https://cloud.owncube.com/s/rqiwDJT7dncATgr/download avsresize_r1g.7z]
|[https://web.archive.org/web/20201004164145if_/https://files.videohelp.com/u/223002/avsresize_r1g.7z avsresize_r1g.7z]
|-
!r1f
|[https://cloud.owncube.com/s/XCLyRtnysGXY92c/download avsresize_r1f.7z]
|[https://web.archive.org/web/20200829234447if_/https://files.videohelp.com/u/223002/avsresize_r1f.7z avsresize_r1f.7z]
|-
!r1e
|[https://cloud.owncube.com/s/a2Jg7j4ojEKkYoD avsresize_r1e.7z]
|[https://web.archive.org/web/20200520165136if_/https://files.videohelp.com/u/223002/avsresize_r1e.7z avsresize_r1e.7z]
|-
!2020/04/08
|[https://cloud.owncube.com/s/DjHxaH7YdEieY3s avsresize.7z]
|[https://web.archive.org/web/20200605163637if_/https://files.videohelp.com/u/223002/avsresize_20200408.7z avsresize_20200408.7z] 
|-
!r1d
|[https://web.archive.org/web/20200605163506if_/https://files.videohelp.com/u/223002/avsresize-r1d.7z avsresize-r1d.7z]
|[https://web.archive.org/web/20200420200859if_/http://s000.tinyupload.com/download.php?file_id=84753125388772791779&t=8475312538877279177900406 avsresize-r1d.7z]
|}
<br>

== External Links ==
*[https://forum.doom9.org/showthread.php?t=175428 Doom9 Forum] - 8bit or greater (AviSynth+) linear/gamma light aware resizing?
*[https://forum.doom9.org/showthread.php?t=176773 Doom9 Forum] - HDRTools vs DitherTools vs ColorMatrix
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Resizers|External Filters]] ←'''

AssRender

2026-01-28T14:27:29Z

Pinterf: New version 0.36

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Subtitling|Deep_color_tools}}
{{Filter3
|1=pinterf, vadosnaprimer, Blitzker, pingplug, lachs0r, TheFluff, Seiya
|2=v0.36
|3=[https://github.com/pinterf/assrender/releases/ assrender-0.36.7z]
|4=Subtitling
|5=Source code is MIT license, binaries are GPL
|6=[https://forum.doom9.org/showthread.php?t=148926 Doom9 Thread]}}
<br>
== Description ==
AssRender is an AviSynth plugin that renders ASS/SSA and SRT (without the HTML-like markup) subtitles. It uses libass to render the subtitles.

This also means that it is much more picky about script syntax than VSFilter and friends, so keep that in mind before blaming the filter. Yes, people have reported a lot of errors that were actually the script author’s fault and libass vs VSFilter compatibility.
<br>
<br>
<span style="color:red">'''Note:'''</span> AssRender is a C-plugin so on Avisynth 3.6 it must be loaded using [[Plugins#LoadCPlugin|LoadCPlugin]]. AviSynth+ has no special treatment. It loads C-plugins similarly to C++.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
** AviSynth+: all [[planar]] formats (8/10/12/14/16bit, Y/YUV/RGB with or without alpha) are supported. [[RGB48]] and [[RGB64]] are also supported.
<br>
* Being a C plugin, minimum required Avisynth+ version varies on which Avisynth version's .LIB was it linked with. v0.36 may require at least Aviysnth 3.7.5.

== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|assrender (clip, string file, string "vfr", int "hinting", float "scale", float "line_spacing", float "dar", float "sar", int "top", int "bottom", int "left", int "right", string "charset", int "debuglevel", string "fontdir", string "srt_font", string "colorspace") }}

v0.36:
:{{Template:FuncDef|assrender (clip, string file, string "vfr", int "hinting", float "scale", float "line_spacing", int frame_width, int frame_height, bool set_default_storage_size, float "dar", float "sar", int "top", int "bottom", int "left", int "right", string "charset", int "debuglevel", string "fontdir", string "srt_font", string "colorspace") }}

<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Your subtitle file. May be ASS, SSA or SRT.
<br>
::{{Par2|vfr|string| }}
:::Specify timecodes v1 or v2 file when working with VFRaC.
<br>
::{{Par2|hinting|int|0}}
:::Font hinting mode. Choose between:
:::*none (0, default), light (1), normal (2) and Freetype native (3) autohinting.
<br>
::{{Par2|scale|float|1.0}}
:::Font scale. Defaults to 1.0.
<br>
::{{Par2|line_spacing|float|1.0}}
:::Line spacing in pixels. Defaults to 1.0 and won’t be scaled with frame size.
<br>
::{{Par2|frame_width|int|}}
::{{Par2|frame_height|int|}}
:::Actual displayed size, provide more information than dar & sar. Of course you need to set both parameters.
<br>
::{{Par2|set_default_storage_size|bool|True}}
:::Whether to render ASS according to storage size, default is True.
<br>
::{{Par2|dar|float| }}
::{{Par2|sar|float| }}
:::Aspect ratio. Of course you need to set both parameters. Less priority than frame_width & frame_height.
<br>
::{{Par2|top|int|0}}
::{{Par2|bottom|int|0}}
::{{Par2|left|int|0}}
::{{Par2|right|int|0}}
:::Margins. They will be added to the frame size and may be negative.
<br>
::{{Par2|charset|string|"UTF-8"}}
:::Character set to use, in GNU iconv or enca format. Defaults to UTF-8.
:::Example enca format: enca:pl:cp1250 (guess the encoding for Polish, fall back on cp1250)
<br>
::{{Par2|debuglevel|int|0}}
:::How much crap assrender is supposed to spam to stderr.
<br>
::{{Par2|fontdir|string|""}}
:::Additional font directory.
:::Useful if you are lazy but want to keep your system fonts clean.
<br>
::{{Par2|srt_font|string|"Sans"}}
:::Font to use for SRT subtitles. Defaults to whatever Fontconfig chooses for “Sans”.
<br>
::{{Par2|colorspace|string|""}}
:::The color space of your (YUV) video. Possible values:
:::* "Rec2020", "BT.2020"
:::* "Rec709", "BT.709"
:::* "Rec601", "BT.601"
:::* "PC.709"
:::* "PC.601"
:::* "TV.fcc", "PC.fcc"
:::* "TV.240m", "PC.240m"
:::* "none", "guess"
:::Default is to use the ASS script's "YCbCr Matrix" or "Video Colorspace" property.
:::Recognized .ASS properties: "TV.601" "TV.709", "PC.601" "PC.709" "TV.240m" "PC.240m" "TV.fcc" "PC.fcc" and "none".

:::"none" and "guess" decides upon on video resolution: width > 1280 or height > 576 → BT.709, else → BT.601. When no hint found in ASS script and 'colorspace' parameter is empty then the default is BT.601.
<br>

== Examples ==

[[AviSource]]("Blah.avi")
AssRender("subtitles.ass")

<br>

== Changelog ==
<pre>

2026-01-22 - seiya-git, pinterf
* Version 0.36:
- Binaries using AviSynth 3.7.5's lib, VS2022 MSVC 14.38 toolset
- Update build instructions
- Fix hinting
- Fix ass_set_storage_size not be called
- Switch submodule build system to meson
- Update avisynth(plus) headers to v12
- Update libass to 0.17.4
- Unicode-safe file reading
- Add frame size parameters
- Add set_default_storage_size boolean
- Use frame properties if they available for "YCbCr Matrix: None"
- Work with frame copy instead of just modifying it

2021-03-04 - pinterf
* Version 0.35:
- Windows MSVC: Update to libass v0.15 (git submodule update --init --recursive --remote)
For changes since v0.14 see https://github.com/libass/libass/blob/master/Changelog
- don't guess base on video resolution (realfinder)
if .ass file has no Matrix info then it should be treated as it "Rec601" to maintain compatibility
- Parameter 'colorspace' default value is no longer "guess"
- Add more color options: PC.709, PC.601, TV.fcc, PC.fcc, TV.240m, PC.240m, none.
"none" and "guess" implies "guess-by-resolution".
- Fix: possible crash on initializing phase (buffer overread, linux crashed, Windows was just lucky)

2021-03-01 - pinterf
* Version 0.34:
- Fix the fix: revert matrix change made in 0.33
- Fix: Check matrix from .ASS file "YCbCr Matrix:" section besides "Video Colorspace:"
Recognized values are "tv.601" and "tv.709"

2021-02-28 - pinterf
* Version 0.33:
- Fix: wrong Bt.709 matrix (it wasn't :) )

2021-02-27 - pinterf
* Version 0.32:
- Fix: treat I420 variant as YV12 instead of unsupported color space

2021-02-18 - pinterf
* Version 0.31:
- Fix colors for planar RGB
- code: hidden ifdef FOR_AVISYNTH_26_ONLY for Avisynth 2.6-only build

2021-02-17 - pinterf
* Version 0.30:
- 10-16 bit support (including RGB48 and RGB64)
- YV411, Planar RGB support

2021-02-16 - pinterf
* Version 0.29:
- project moved to https://github.com/pinterf/assrender from https://github.com/vadosnaprimer/assrender
- Move to Visual Studio 2019 - v142 platform toolset
- Add .def module definition file for Avisynth 2.6 std compatibility (function name mangling)
- Update Avisynth C headers
- Check Linux and gcc-MinGW CMake build
- Add build instructions and change log to README

2019-01-14 - vadosnaprimer
- https://github.com/vadosnaprimer/assrender/
- add batch that lets not to change deps sdk and vs version copied from SMP libass
- update SMP submodules

2016-10-18 - Blitzker
- https://github.com/Blitzker/assrender
- Visual Studio 2015 support

2012-04-20 - lachs0r
* Version 0.25:
- code restructured
- added support for the BT.709 color space and the “Video Colorspace”
property that has been introduced with recent versions of Aegisub.
binary:
- updated everything, switched to MinGW-w64
(same toolchain as mplayer2 now)

2011-09-22 - lachs0r
* Version 0.24.1:
binary:
- updated libass to current git HEAD
- switched Harfbuzz to libass’ compatibility branch
- compiled Harfbuzz without Uniscribe backend
fixes lots of crashes and misbehavior

2011-07-29 - lachs0r
* Version 0.24:
binary:
- updated libass to current git HEAD:
- fixed performance regression

2011-07-29 - lachs0r
* Version 0.23:
- disabled font hinting by default
binary:
- updated libass to current git HEAD and included Harfbuzz:
- added support for bidirectional text, Arabic shaping etc.
- added proper support for @fonts (vertical writing)
- slight performance regression
(glyph cache not hooked up with Harfbuzz yet)
- updated FreeType to current git HEAD:
- fixed outline stroker for some broken fonts

2011-06-16 - lachs0r
* Version 0.22:
- fixed hang when a glyph with zero dimensions was encountered
(mostly vector clips)

2011-06-08 - lachs0r <lachs0r@srsfckn.biz>
* Version 0.21:
- finally implemented proper subsampling for YV12
- temporarily removed YV16 support
- renamed parameter verbosity → debuglevel
- code cleanups
binary:
- reverted to GCC 4.5.2 (4.6 miscompiles MinGW)

2011-06-01 - lachs0r
* Version 0.20:
- fixed the masksub stuff
- properly output debug messages to stderr instead of stdout
- reformatted source and corrected/removed some comments
- modified CMakeLists.txt to strip the binary by default
binary:
- now built with GCC 4.6 instead of 4.5.2
- included enca again
- patched fontconfig:
- prettier debug output
- use the correct location for its cache

2011-02-01 - lachs0r
* Version 0.19:
This is a bugfix/cleanup release.
- fixed possible buffer overflows in timecodesv1 and SRT parsing
- fixed random crashes on unloading
- probably fixed compilation with MSVC (patch by TheFluff)
- very slightly improved performance with GCC
- various code cleanups

2011-01-25 - lachs0r
* Version 0.18:
- improved YV12 support (should be somewhat usable now)
- added support for RGB24, YV24, YV16 and Y8 (YUY2 coming soon)
- added SRT subtitle format support
additional parameter: srt_font (font to use for srt subs)
- exposed some libass parameters:
line_spacing (line spacing)
dar, sar (aspect ratio)
top, bottom, left, right (margins)
fontdir (additional font directory)
- masksub equivalent if used on a blankclip
(still buggy - read source for details)
- no more global variables

2011-01-17 - lachs0r
* Version 0.17:
- added rudimentary YV12 support (chroma subsampling still needs work)
- binary: Previously, I linked against a very old avisynth_c.lib - now
you shouldn’t get any error messages about “avisynth_c.dll”
- tidied up the RGB32 blitter a bit

2011-01-16 - lachs0r
* Version 0.15:
- reimplemented as AviSynth C plugin - this fixed several crashes and
got rid of the major pain in the ass that is MSVC
- binary: built with patched Fontconfig (no longer needs fonts.conf)
* Version 0.16:
- implemented VFRaC support via timecodes files (v1 and v2 supported)
</pre>
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v0.25
|[http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|[https://web.archive.org/web/20180118024447if_/http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|}

<br>

== External Links ==
*[http://github.com/pinterf/assrender GitHub] - Updated version (v0.30+)
*[http://github.com/pingplug/assrender GitHub] - Updated version (v0.28), only source code available.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Subtitling|External Filters]] ←'''

AssRender

2026-01-28T14:22:12Z

Pinterf: /* Syntax and Parameters */ add frame_width, frame_height, set_default_storage_size

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Subtitling|Deep_color_tools}}
{{Filter3
|1=pinterf, vadosnaprimer, Blitzker, pingplug, lachs0r, TheFluff
|2=v0.35
|3=[https://github.com/pinterf/assrender/releases/ assrender-0.35.7z]
|4=Subtitling
|5=Source code is MIT license, binaries are GPL
|6=[https://forum.doom9.org/showthread.php?t=148926 Doom9 Thread]}}
<br>
== Description ==
AssRender is an AviSynth plugin that renders ASS/SSA and SRT (without the HTML-like markup) subtitles. It uses libass to render the subtitles.

This also means that it is much more picky about script syntax than VSFilter and friends, so keep that in mind before blaming the filter. Yes, people have reported a lot of errors that were actually the script author’s fault and libass vs VSFilter compatibility.
<br>
<br>
<span style="color:red">'''Note:'''</span> AssRender is a C-plugin so it must be loaded using [[Plugins#LoadCPlugin|LoadCPlugin]], except if you're using AviSynth+, it allows autoloading of C-plugins.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
** AviSynth+: all [[planar]] formats (8/10/12/14/16bit, Y/YUV/RGB with or without alpha) are supported. [[RGB48]] and [[RGB64]] are also supported.
<br>

== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|assrender (clip, string file, string "vfr", int "hinting", float "scale", float "line_spacing", float "dar", float "sar", int "top", int "bottom", int "left", int "right", string "charset", int "debuglevel", string "fontdir", string "srt_font", string "colorspace") }}

v0.36:
:{{Template:FuncDef|assrender (clip, string file, string "vfr", int "hinting", float "scale", float "line_spacing", int frame_width, int frame_height, bool set_default_storage_size, float "dar", float "sar", int "top", int "bottom", int "left", int "right", string "charset", int "debuglevel", string "fontdir", string "srt_font", string "colorspace") }}

<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Your subtitle file. May be ASS, SSA or SRT.
<br>
::{{Par2|vfr|string| }}
:::Specify timecodes v1 or v2 file when working with VFRaC.
<br>
::{{Par2|hinting|int|0}}
:::Font hinting mode. Choose between:
:::*none (0, default), light (1), normal (2) and Freetype native (3) autohinting.
<br>
::{{Par2|scale|float|1.0}}
:::Font scale. Defaults to 1.0.
<br>
::{{Par2|line_spacing|float|1.0}}
:::Line spacing in pixels. Defaults to 1.0 and won’t be scaled with frame size.
<br>
::{{Par2|frame_width|int|}}
::{{Par2|frame_height|int|}}
:::Actual displayed size, provide more information than dar & sar. Of course you need to set both parameters.
<br>
::{{Par2|set_default_storage_size|bool|True}}
:::Whether to render ASS according to storage size, default is True.
<br>
::{{Par2|dar|float| }}
::{{Par2|sar|float| }}
:::Aspect ratio. Of course you need to set both parameters. Less priority than frame_width & frame_height.
<br>
::{{Par2|top|int|0}}
::{{Par2|bottom|int|0}}
::{{Par2|left|int|0}}
::{{Par2|right|int|0}}
:::Margins. They will be added to the frame size and may be negative.
<br>
::{{Par2|charset|string|"UTF-8"}}
:::Character set to use, in GNU iconv or enca format. Defaults to UTF-8.
:::Example enca format: enca:pl:cp1250 (guess the encoding for Polish, fall back on cp1250)
<br>
::{{Par2|debuglevel|int|0}}
:::How much crap assrender is supposed to spam to stderr.
<br>
::{{Par2|fontdir|string|""}}
:::Additional font directory.
:::Useful if you are lazy but want to keep your system fonts clean.
<br>
::{{Par2|srt_font|string|"Sans"}}
:::Font to use for SRT subtitles. Defaults to whatever Fontconfig chooses for “Sans”.
<br>
::{{Par2|colorspace|string|""}}
:::The color space of your (YUV) video. Possible values:
:::* "Rec2020", "BT.2020"
:::* "Rec709", "BT.709"
:::* "Rec601", "BT.601"
:::* "PC.709"
:::* "PC.601"
:::* "TV.fcc", "PC.fcc"
:::* "TV.240m", "PC.240m"
:::* "none", "guess"
:::Default is to use the ASS script's "YCbCr Matrix" or "Video Colorspace" property.
:::Recognized .ASS properties: "TV.601" "TV.709", "PC.601" "PC.709" "TV.240m" "PC.240m" "TV.fcc" "PC.fcc" and "none".

:::"none" and "guess" decides upon on video resolution: width > 1280 or height > 576 → BT.709, else → BT.601. When no hint found in ASS script and 'colorspace' parameter is empty then the default is BT.601.
<br>

== Examples ==

[[AviSource]]("Blah.avi")
AssRender("subtitles.ass")

<br>

== Changelog ==
<pre>

2026-01-22 - seiya-git, pinterf
* Version 0.36:
- Binaries using AviSynth 3.7.5's lib, VS2022 MSVC 14.38 toolset
- Update build instructions
- Fix hinting
- Fix ass_set_storage_size not be called
- Switch submodule build system to meson
- Update avisynth(plus) headers to v12
- Update libass to 0.17.4
- Unicode-safe file reading
- Add frame size parameters
- Add set_default_storage_size boolean
- Use frame properties if they available for "YCbCr Matrix: None"
- Work with frame copy instead of just modifying it

2021-03-04 - pinterf
* Version 0.35:
- Windows MSVC: Update to libass v0.15 (git submodule update --init --recursive --remote)
For changes since v0.14 see https://github.com/libass/libass/blob/master/Changelog
- don't guess base on video resolution (realfinder)
if .ass file has no Matrix info then it should be treated as it "Rec601" to maintain compatibility
- Parameter 'colorspace' default value is no longer "guess"
- Add more color options: PC.709, PC.601, TV.fcc, PC.fcc, TV.240m, PC.240m, none.
"none" and "guess" implies "guess-by-resolution".
- Fix: possible crash on initializing phase (buffer overread, linux crashed, Windows was just lucky)

2021-03-01 - pinterf
* Version 0.34:
- Fix the fix: revert matrix change made in 0.33
- Fix: Check matrix from .ASS file "YCbCr Matrix:" section besides "Video Colorspace:"
Recognized values are "tv.601" and "tv.709"

2021-02-28 - pinterf
* Version 0.33:
- Fix: wrong Bt.709 matrix (it wasn't :) )

2021-02-27 - pinterf
* Version 0.32:
- Fix: treat I420 variant as YV12 instead of unsupported color space

2021-02-18 - pinterf
* Version 0.31:
- Fix colors for planar RGB
- code: hidden ifdef FOR_AVISYNTH_26_ONLY for Avisynth 2.6-only build

2021-02-17 - pinterf
* Version 0.30:
- 10-16 bit support (including RGB48 and RGB64)
- YV411, Planar RGB support

2021-02-16 - pinterf
* Version 0.29:
- project moved to https://github.com/pinterf/assrender from https://github.com/vadosnaprimer/assrender
- Move to Visual Studio 2019 - v142 platform toolset
- Add .def module definition file for Avisynth 2.6 std compatibility (function name mangling)
- Update Avisynth C headers
- Check Linux and gcc-MinGW CMake build
- Add build instructions and change log to README

2019-01-14 - vadosnaprimer
- https://github.com/vadosnaprimer/assrender/
- add batch that lets not to change deps sdk and vs version copied from SMP libass
- update SMP submodules

2016-10-18 - Blitzker
- https://github.com/Blitzker/assrender
- Visual Studio 2015 support

2012-04-20 - lachs0r
* Version 0.25:
- code restructured
- added support for the BT.709 color space and the “Video Colorspace”
property that has been introduced with recent versions of Aegisub.
binary:
- updated everything, switched to MinGW-w64
(same toolchain as mplayer2 now)

2011-09-22 - lachs0r
* Version 0.24.1:
binary:
- updated libass to current git HEAD
- switched Harfbuzz to libass’ compatibility branch
- compiled Harfbuzz without Uniscribe backend
fixes lots of crashes and misbehavior

2011-07-29 - lachs0r
* Version 0.24:
binary:
- updated libass to current git HEAD:
- fixed performance regression

2011-07-29 - lachs0r
* Version 0.23:
- disabled font hinting by default
binary:
- updated libass to current git HEAD and included Harfbuzz:
- added support for bidirectional text, Arabic shaping etc.
- added proper support for @fonts (vertical writing)
- slight performance regression
(glyph cache not hooked up with Harfbuzz yet)
- updated FreeType to current git HEAD:
- fixed outline stroker for some broken fonts

2011-06-16 - lachs0r
* Version 0.22:
- fixed hang when a glyph with zero dimensions was encountered
(mostly vector clips)

2011-06-08 - lachs0r <lachs0r@srsfckn.biz>
* Version 0.21:
- finally implemented proper subsampling for YV12
- temporarily removed YV16 support
- renamed parameter verbosity → debuglevel
- code cleanups
binary:
- reverted to GCC 4.5.2 (4.6 miscompiles MinGW)

2011-06-01 - lachs0r
* Version 0.20:
- fixed the masksub stuff
- properly output debug messages to stderr instead of stdout
- reformatted source and corrected/removed some comments
- modified CMakeLists.txt to strip the binary by default
binary:
- now built with GCC 4.6 instead of 4.5.2
- included enca again
- patched fontconfig:
- prettier debug output
- use the correct location for its cache

2011-02-01 - lachs0r
* Version 0.19:
This is a bugfix/cleanup release.
- fixed possible buffer overflows in timecodesv1 and SRT parsing
- fixed random crashes on unloading
- probably fixed compilation with MSVC (patch by TheFluff)
- very slightly improved performance with GCC
- various code cleanups

2011-01-25 - lachs0r
* Version 0.18:
- improved YV12 support (should be somewhat usable now)
- added support for RGB24, YV24, YV16 and Y8 (YUY2 coming soon)
- added SRT subtitle format support
additional parameter: srt_font (font to use for srt subs)
- exposed some libass parameters:
line_spacing (line spacing)
dar, sar (aspect ratio)
top, bottom, left, right (margins)
fontdir (additional font directory)
- masksub equivalent if used on a blankclip
(still buggy - read source for details)
- no more global variables

2011-01-17 - lachs0r
* Version 0.17:
- added rudimentary YV12 support (chroma subsampling still needs work)
- binary: Previously, I linked against a very old avisynth_c.lib - now
you shouldn’t get any error messages about “avisynth_c.dll”
- tidied up the RGB32 blitter a bit

2011-01-16 - lachs0r
* Version 0.15:
- reimplemented as AviSynth C plugin - this fixed several crashes and
got rid of the major pain in the ass that is MSVC
- binary: built with patched Fontconfig (no longer needs fonts.conf)
* Version 0.16:
- implemented VFRaC support via timecodes files (v1 and v2 supported)
</pre>
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v0.25
|[http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|[https://web.archive.org/web/20180118024447if_/http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|}

<br>

== External Links ==
*[http://github.com/pinterf/assrender GitHub] - Updated version (v0.30+)
*[http://github.com/pingplug/assrender GitHub] - Updated version (v0.28), only source code available.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Subtitling|External Filters]] ←'''

AssRender

2026-01-28T14:13:28Z

Pinterf: /* Changelog */

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Subtitling|Deep_color_tools}}
{{Filter3
|1=pinterf, vadosnaprimer, Blitzker, pingplug, lachs0r, TheFluff
|2=v0.35
|3=[https://github.com/pinterf/assrender/releases/ assrender-0.35.7z]
|4=Subtitling
|5=Source code is MIT license, binaries are GPL
|6=[https://forum.doom9.org/showthread.php?t=148926 Doom9 Thread]}}
<br>
== Description ==
AssRender is an AviSynth plugin that renders ASS/SSA and SRT (without the HTML-like markup) subtitles. It uses libass to render the subtitles.

This also means that it is much more picky about script syntax than VSFilter and friends, so keep that in mind before blaming the filter. Yes, people have reported a lot of errors that were actually the script author’s fault and libass vs VSFilter compatibility.
<br>
<br>
<span style="color:red">'''Note:'''</span> AssRender is a C-plugin so it must be loaded using [[Plugins#LoadCPlugin|LoadCPlugin]], except if you're using AviSynth+, it allows autoloading of C-plugins.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
** AviSynth+: all [[planar]] formats (8/10/12/14/16bit, Y/YUV/RGB with or without alpha) are supported. [[RGB48]] and [[RGB64]] are also supported.
<br>

== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|assrender (clip, string file, string "vfr", int "hinting", float "scale", float "line_spacing", float "dar", float "sar", int "top", int "bottom", int "left", int "right", string "charset", int "debuglevel", string "fontdir", string "srt_font", string "colorspace") }}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Your subtitle file. May be ASS, SSA or SRT.
<br>
::{{Par2|vfr|string| }}
:::Specify timecodes v1 or v2 file when working with VFRaC.
<br>
::{{Par2|hinting|int|0}}
:::Font hinting mode. Choose between:
:::*none (0, default), light (1), normal (2) and Freetype native (3) autohinting.
<br>
::{{Par2|scale|float|1.0}}
:::Font scale. Defaults to 1.0.
<br>
::{{Par2|line_spacing|float|1.0}}
:::Line spacing in pixels. Defaults to 1.0 and won’t be scaled with frame size.
<br>
::{{Par2|dar|float| }}
::{{Par2|sar|float| }}
:::Aspect ratio. Of course you need to set both parameters.
<br>
::{{Par2|top|int|0}}
::{{Par2|bottom|int|0}}
::{{Par2|left|int|0}}
::{{Par2|right|int|0}}
:::Margins. They will be added to the frame size and may be negative.
<br>
::{{Par2|charset|string|"UTF-8"}}
:::Character set to use, in GNU iconv or enca format. Defaults to UTF-8.
:::Example enca format: enca:pl:cp1250 (guess the encoding for Polish, fall back on cp1250)
<br>
::{{Par2|debuglevel|int|0}}
:::How much crap assrender is supposed to spam to stderr.
<br>
::{{Par2|fontdir|string|""}}
:::Additional font directory.
:::Useful if you are lazy but want to keep your system fonts clean.
<br>
::{{Par2|srt_font|string|"Sans"}}
:::Font to use for SRT subtitles. Defaults to whatever Fontconfig chooses for “Sans”.
<br>
::{{Par2|colorspace|string|""}}
:::The color space of your (YUV) video. Possible values:
:::* "Rec2020", "BT.2020"
:::* "Rec709", "BT.709"
:::* "Rec601", "BT.601"
:::* "PC.709"
:::* "PC.601"
:::* "TV.fcc", "PC.fcc"
:::* "TV.240m", "PC.240m"
:::* "none", "guess"
:::Default is to use the ASS script's "YCbCr Matrix" or "Video Colorspace" property.
:::Recognized .ASS properties: "TV.601" "TV.709", "PC.601" "PC.709" "TV.240m" "PC.240m" "TV.fcc" "PC.fcc" and "none".

:::"none" and "guess" decides upon on video resolution: width > 1280 or height > 576 → BT.709, else → BT.601. When no hint found in ASS script and 'colorspace' parameter is empty then the default is BT.601.
<br>

== Examples ==

[[AviSource]]("Blah.avi")
AssRender("subtitles.ass")

<br>

== Changelog ==
<pre>

2026-01-22 - seiya-git, pinterf
* Version 0.36:
- Binaries using AviSynth 3.7.5's lib, VS2022 MSVC 14.38 toolset
- Update build instructions
- Fix hinting
- Fix ass_set_storage_size not be called
- Switch submodule build system to meson
- Update avisynth(plus) headers to v12
- Update libass to 0.17.4
- Unicode-safe file reading
- Add frame size parameters
- Add set_default_storage_size boolean
- Use frame properties if they available for "YCbCr Matrix: None"
- Work with frame copy instead of just modifying it

2021-03-04 - pinterf
* Version 0.35:
- Windows MSVC: Update to libass v0.15 (git submodule update --init --recursive --remote)
For changes since v0.14 see https://github.com/libass/libass/blob/master/Changelog
- don't guess base on video resolution (realfinder)
if .ass file has no Matrix info then it should be treated as it "Rec601" to maintain compatibility
- Parameter 'colorspace' default value is no longer "guess"
- Add more color options: PC.709, PC.601, TV.fcc, PC.fcc, TV.240m, PC.240m, none.
"none" and "guess" implies "guess-by-resolution".
- Fix: possible crash on initializing phase (buffer overread, linux crashed, Windows was just lucky)

2021-03-01 - pinterf
* Version 0.34:
- Fix the fix: revert matrix change made in 0.33
- Fix: Check matrix from .ASS file "YCbCr Matrix:" section besides "Video Colorspace:"
Recognized values are "tv.601" and "tv.709"

2021-02-28 - pinterf
* Version 0.33:
- Fix: wrong Bt.709 matrix (it wasn't :) )

2021-02-27 - pinterf
* Version 0.32:
- Fix: treat I420 variant as YV12 instead of unsupported color space

2021-02-18 - pinterf
* Version 0.31:
- Fix colors for planar RGB
- code: hidden ifdef FOR_AVISYNTH_26_ONLY for Avisynth 2.6-only build

2021-02-17 - pinterf
* Version 0.30:
- 10-16 bit support (including RGB48 and RGB64)
- YV411, Planar RGB support

2021-02-16 - pinterf
* Version 0.29:
- project moved to https://github.com/pinterf/assrender from https://github.com/vadosnaprimer/assrender
- Move to Visual Studio 2019 - v142 platform toolset
- Add .def module definition file for Avisynth 2.6 std compatibility (function name mangling)
- Update Avisynth C headers
- Check Linux and gcc-MinGW CMake build
- Add build instructions and change log to README

2019-01-14 - vadosnaprimer
- https://github.com/vadosnaprimer/assrender/
- add batch that lets not to change deps sdk and vs version copied from SMP libass
- update SMP submodules

2016-10-18 - Blitzker
- https://github.com/Blitzker/assrender
- Visual Studio 2015 support

2012-04-20 - lachs0r
* Version 0.25:
- code restructured
- added support for the BT.709 color space and the “Video Colorspace”
property that has been introduced with recent versions of Aegisub.
binary:
- updated everything, switched to MinGW-w64
(same toolchain as mplayer2 now)

2011-09-22 - lachs0r
* Version 0.24.1:
binary:
- updated libass to current git HEAD
- switched Harfbuzz to libass’ compatibility branch
- compiled Harfbuzz without Uniscribe backend
fixes lots of crashes and misbehavior

2011-07-29 - lachs0r
* Version 0.24:
binary:
- updated libass to current git HEAD:
- fixed performance regression

2011-07-29 - lachs0r
* Version 0.23:
- disabled font hinting by default
binary:
- updated libass to current git HEAD and included Harfbuzz:
- added support for bidirectional text, Arabic shaping etc.
- added proper support for @fonts (vertical writing)
- slight performance regression
(glyph cache not hooked up with Harfbuzz yet)
- updated FreeType to current git HEAD:
- fixed outline stroker for some broken fonts

2011-06-16 - lachs0r
* Version 0.22:
- fixed hang when a glyph with zero dimensions was encountered
(mostly vector clips)

2011-06-08 - lachs0r <lachs0r@srsfckn.biz>
* Version 0.21:
- finally implemented proper subsampling for YV12
- temporarily removed YV16 support
- renamed parameter verbosity → debuglevel
- code cleanups
binary:
- reverted to GCC 4.5.2 (4.6 miscompiles MinGW)

2011-06-01 - lachs0r
* Version 0.20:
- fixed the masksub stuff
- properly output debug messages to stderr instead of stdout
- reformatted source and corrected/removed some comments
- modified CMakeLists.txt to strip the binary by default
binary:
- now built with GCC 4.6 instead of 4.5.2
- included enca again
- patched fontconfig:
- prettier debug output
- use the correct location for its cache

2011-02-01 - lachs0r
* Version 0.19:
This is a bugfix/cleanup release.
- fixed possible buffer overflows in timecodesv1 and SRT parsing
- fixed random crashes on unloading
- probably fixed compilation with MSVC (patch by TheFluff)
- very slightly improved performance with GCC
- various code cleanups

2011-01-25 - lachs0r
* Version 0.18:
- improved YV12 support (should be somewhat usable now)
- added support for RGB24, YV24, YV16 and Y8 (YUY2 coming soon)
- added SRT subtitle format support
additional parameter: srt_font (font to use for srt subs)
- exposed some libass parameters:
line_spacing (line spacing)
dar, sar (aspect ratio)
top, bottom, left, right (margins)
fontdir (additional font directory)
- masksub equivalent if used on a blankclip
(still buggy - read source for details)
- no more global variables

2011-01-17 - lachs0r
* Version 0.17:
- added rudimentary YV12 support (chroma subsampling still needs work)
- binary: Previously, I linked against a very old avisynth_c.lib - now
you shouldn’t get any error messages about “avisynth_c.dll”
- tidied up the RGB32 blitter a bit

2011-01-16 - lachs0r
* Version 0.15:
- reimplemented as AviSynth C plugin - this fixed several crashes and
got rid of the major pain in the ass that is MSVC
- binary: built with patched Fontconfig (no longer needs fonts.conf)
* Version 0.16:
- implemented VFRaC support via timecodes files (v1 and v2 supported)
</pre>
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v0.25
|[http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|[https://web.archive.org/web/20180118024447if_/http://srsfckn.biz/assrender/assrender-0.25.7z assrender-0.25.7z]
|}

<br>

== External Links ==
*[http://github.com/pinterf/assrender GitHub] - Updated version (v0.30+)
*[http://github.com/pingplug/assrender GitHub] - Updated version (v0.28), only source code available.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Subtitling|External Filters]] ←'''

TIVTC

2025-12-10T19:36:28Z

Pinterf: New version 1.0.30

{{FilterCat6|External_filters|Plugins|Plugins_x64|IVTC|Decimation|Deep_color_tools}}
{{Filter3
|1={{Author/tritical}}, {{Author/pinterf}}
|2=1.0.30
|3=[https://github.com/pinterf/TIVTC/releases TIVTC-v1.0.30.7z]
|4=[[:Category:IVTC|IVTC]] & [[:Category:Decimation|Decimation]]
|5=[https://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[https://forum.doom9.org/showthread.php?t=82264 Doom9 Thread]}}

==Description==
'''TIVTC''' is a plugin package containing 7 different filters and 3 conditional functions. The seven filters included are '''[[TIVTC/TFM|TFM]], [[TIVTC/TDecimate|TDecimate]], [[TIVTC/MergeHints|MergeHints]], [[TIVTC/FrameDiff|FrameDiff]], [[TIVTC/FieldDiff|FieldDiff]], [[TIVTC/ShowCombedTIVTC|ShowCombedTIVTC]],''' and '''[[TIVTC/RequestLinear|RequestLinear]]'''.

*'''TFM''' is a field matching filter that will recreate the original progressive frames in a telecined source, and '''TDecimate''' is a decimation filter that removes duplicates. These filters can be used together to achieve an [http://en.wikipedia.org/wiki/Ivtc IVTC] or separately to accomplish other tasks.

*'''TDecimate''' also provides special options for handling hybrid material which include [[VFR]] via [http://en.wikipedia.org/wiki/Matroska Matroska] (using a timecodes file) and blend decimation/upconversion for CFR solutions.

*'''Mergehints, RequestLinear, FrameDiff, FieldDiff,''' and '''ShowCombedTIVTC''' are special utility filters included to help perform specific functions.

*The conditional functions are '''IsCombedTIVTC, CFieldDiff,''' and '''CFrameDiff''' which can be used via AviSynth's [[ConditionalFilter|conditional filtering]] environment to test if frames are combed, determine how well two fields fit together, or calculate the difference between frames.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6.0]
* [x64]: [[AviSynth+]]
* Supported color formats: [[YUY2]], [[YV12]], [[YV16]], [[YV411]], [[YV24]]
**AviSynth+: all [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported.
<br>
==Usage Examples==

====NTSC cases:====

1.) NTSC Film, normal source (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate()

2.) NTSC Film, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=1)

3.) NTSC Hybrid, using blend decimation on video sections (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(hybrid=1)

4.) NTSC Hybrid, using blend decimation on video sections, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=1,hybrid=1)

5.) NTSC Hybrid, using vfr via mkv (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=3,hybrid=2,vfrDec=0,mkvOut="mkv-timecodesfile.txt")

6.) NTSC Hybrid, using vfr via mkv, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=3,hybrid=2,vfrDec=1,mkvOut="mkv-timecodesfile.txt")

7.) NTSC, two pass (enables use of conCycleTP parameter) mkv vfr for hybrid source.
First pass:
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",output="matches.txt")
tdecimate(mode=4,output="metrics.txt")
Second pass (not anime or cartoon):
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",input="matches.txt")
tdecimate(mode=5,hybrid=2,vfrDec=0,input="metrics.txt",tfmIn="matches.txt",mkvOut="mkv-timecodesfile.txt")
Second pass (anime or cartoon):
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",input="matches.txt")
tdecimate(mode=5,hybrid=2,vfrDec=1,input="metrics.txt",tfmIn="matches.txt",mkvOut="mkv-timecodesfile.txt")

====PAL Cases:====

1.) PAL, no decimation (just field matching)
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")

2.) PAL, decimate 1 in 25 (most similar)
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(cycle=25)
<br>
== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.0.5
|[https://web.archive.org/web/20140420181748if_/http://bengal.missouri.edu/~kes25c/TIVTCv105.zip TIVTCv105.zip]
|[https://web.archive.org/web/20120223025813if_/http://ivtc.org/yatta%20support/TIVTCv105.zip TIVTCv105.zip]
|}

<br>

==External Links==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#IVTC_.26_Decimation|External Filters]] ←'''
-----------------------------------------------

Layer

2025-01-15T14:21:23Z

Pinterf: /* Layer */ Mention Avs+ documentation link

<div style="max-width:82em; min-width:42em;" >
{{AvsStarFilter}}
__TOC__
== Layer ==
<div style="max-width:62em" >

<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/layer.html https://avisynthplus.readthedocs.io]
</div>

Layer (aka ''overlay'', ''blend'', ''merge'') two clips of possibly different sizes, but with the same color format.

For pixel-wise transparency information, the alpha channel of an RGBA ''overlay_clip'' is used as a mask.<br>

{{AvsPluscon}} Before Avisynth+ 3.4.0 Layer was working only for RGB32 and YUY2. Filter "Overlay" was used primarily for YUV. Now Layer accepts practically all formats (also RGB24/48 since v3.5).<br>
Note that some modes can be similar to Overlay, but the two filters are still different.<br>
Overlay accepts mask clip, Layer would use existing A plane.<br>
Overlay "blend" is Layer "add", Overlay "add" is different.<br>
Lighten and darken is a bit different in Overlay.<br>
Layer has "placement" parameter for proper mask positioning over chroma.<br>

{{FuncDef
|Layer( clip ''base_clip'', clip ''overlay_clip'' [, string ''op'', int ''level'', int ''x'', int ''y'', int ''threshold'', bool ''use_chroma'' ] )
}}

{{AvsPluscon}}<br>
{{FuncDef
|Layer( clip ''base_clip'', clip ''overlay_clip'' [, string ''op'', int ''level'', int ''x'', int ''y'', int ''threshold'', bool ''use_chroma'', float ''opacity'', string ''placement'' ] )
}}

:{{Par2|base_clip|clip|}}
:: The underlying clip, which determines the size and all other video and audio properties of the result.
::Color format must be [[YUY2]] or [[RGB32]].
::{{AvsPluscon}} supports all color spaces, except YV411.

:{{Par2|overlay_clip|clip|}}
:: The clip which is merged onto {{FuncArg|clip}}. If [[RGB32]] or other alpha-aware color space, the alpha channel is used as a mask.
::Color format must match {{FuncArg|base_clip}}.
::{{AvsPluscon}}Non-alpha plane YUV/planar RGB color spaces act as having a fully transparent alpha channel (like the former YUY2 only working mode)

:{{Par2|op|string|"add"}}
::The merge operation to be performed, which can be one of the following:
<div style="max-width:56em;margin:0 0 0 3.5em" >
{| class="wikitable"
|-
!style="min-width:4em"| Op
! Example
! Description
|-
|style="vertical-align:top"| ''add''
|[[File:Layer-base-Lena.png]] [[File:Layer-over-grad.png]]

[[File:Layer-example-add.png]]
|style="vertical-align:top"| This is the default mode. Equivalent to [[Overlay]](mode="blend").<br>{{FuncArg|overlay_clip}} will be copied on top of the original, in proportion to {{FuncArg|level}}, and subject to the alpha channel. <br><br>The difference between {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}} is multiplied with alpha and added to {{FuncArg|base_clip}}.
*alpha=0{{D}}    → only {{FuncArg|base_clip}} visible
*alpha=128{{D}} → {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}} equally blended
*alpha=255{{D}} → only {{FuncArg|overlay_clip}} visible
Formula used :
*RGB:  [[File:Layer-Eq1.png]]
*YUY2: [[File:Layer-Eq2.png]]
*In general, see {{FuncArg|opacity}} parameter
*Alpha-aware: base = base + (overlay - base) * opacity * alpha / max_range{{D}}
*No alpha: base = base + (overlay - base) * opacity
|-
|style="vertical-align:top"| ''subtract''
|style="vertical-align:top"| [[File:Layer-example-sub.png]]
|style="vertical-align:top"| {{FuncArg|base_clip}} minus {{FuncArg|overlay_clip}}. The same as ''add'', but {{FuncArg|overlay_clip}} is inverted before adding.<br><br>If both clips are equal and {{FuncArg|level}}=128, a flat gray field is returned; compare to [[Subtract]].
|-
|style="vertical-align:top"| ''lighten''
|style="vertical-align:top"| [[File:Layer-example-lite.png]]
|style="vertical-align:top"| Copy {{FuncArg|overlay_clip}} over {{FuncArg|base_clip}} in areas where {{FuncArg|overlay_clip}} is lighter by {{FuncArg|threshold}}. <br><br>Performs the same operation as ''add'', but only when {{FuncArg|overlay_clip}} is BRIGHTER than {{FuncArg|base_clip}}. {{FuncArg|use_chroma}} must be ''true''.
<br> Also known as [http://photoblogstop.com/photoshop/photoshop-blend-modes-explained ''lighter color.'']
|-
|style="vertical-align:top"| ''darken''
| [[File:Layer-example-dark.png]]
|style="vertical-align:top"| Copy {{FuncArg|overlay_clip}} over {{FuncArg|base_clip}} in areas where {{FuncArg|overlay_clip}} is darker by {{FuncArg|threshold}}. <br><br>The same as "lighten", but it is performed only when {{FuncArg|overlay_clip}} is DARKER than {{FuncArg|base_clip}}. {{FuncArg|use_chroma}} must be ''true''.
<br>Also known as [http://photoblogstop.com/photoshop/photoshop-blend-modes-explained ''darker color.'']
|-
|style="vertical-align:top"| ''mul''
|style="vertical-align:top"| [[File:Layer-example-mul-rgb.png]]
|style="vertical-align:top"| {{FuncArg|base_clip}} multiplied by {{FuncArg|overlay_clip}}. This will generally make the output darker.
*alpha=0{{D}}    → only {{FuncArg|base_clip}} visible.
*alpha=255{{D}} → approx. the same luminance as {{FuncArg|base_clip}} but with the colors of {{FuncArg|overlay_clip}}.
See [http://docs.gimp.org/2.8/en/gimp-concepts-layer-modes.html#layer-mode-multiply GIMP: Multiply]
|-
|style="vertical-align:top"| ''fast''
|
|style="vertical-align:top"| Like ''add'', but without masking. {{FuncArg|use_chroma}} must be ''true''; {{FuncArg|level}} and {{FuncArg|threshold}} are not used. The result is simply the average of {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}}.
|}

:{{Par2|level|int|(maximum)}}
::The strength of the performed operation:
::* 0 – no effect: {{FuncArg|base_clip}} is returned unchanged
::* 257 (256 for YUY2) – maximum strength
::{{AvsPluscon}} deprecated – use {{FuncArg|opacity}} instead.

:{{Par2|x|int|0}}
:{{Par2|y|int|0}}
::offset position of {{FuncArg|overlay_clip}}

:{{Par2|threshold|int|0}}
::Changes the transition point of {{FuncArg|op}} = "darken", "lighten."
::{{AvsPluscon}} automatically scaled for bit depths over 8, keep it between 0 and 255

:{{Par2|use_chroma|bool|true}}
::Use chroma of the {{FuncArg|overlay_clip}}. Default=true. When false, only luma is used.
::Must be true for {{FuncArg|op}} = "darken", "lighten", "add."

:{{Par2|opacity|float|1.0}}
::{{AvsPluscon}} usable for all bit depths, replaces the previous {{FuncArg|level}} parameter. Similar to "opacity" in "Overlay"
::valid values are 0.0 to 1.0. Default value is 1.0 if {{FuncArg|level}} does not exist (full transparency)
::If {{FuncArg|level}} parameter is given then opacity is calculated as:
:::for color spaces having alpha: opacity = level / ((1 << bits_per_pixel) + 1) which gives 1.0 for level=257 (@8bit) and 65537 (@16 bits)
:::for color spaces not having alpha: opacity = level / ((1 << bits_per_pixel)) e.g. for YUY2 or other non-Alpha, gives 1.0 for level=256 (@8bit)
:::Note: originally level was used in formula: (alpha*level + 1) / range_size, now level is calculated from opacity as: level = opacity * ((1 << bits_per_pixel) + 1)

:{{Par2|placement|string|"mpeg2"}}
::{{AvsPluscon}} Possible values: "mpeg2" (default), "mpeg1".
::Used in "mul", "darken" and "lighten", "add" and "subtract" modes with planar YUV 4:2:0 or 4:2:2 color spaces (not available for YUY2) in order to properly apply luma/overlay mask on U and V chroma channels.

Audio, [[Clip_properties|FrameRate]] and [[Clip_properties|FrameCount]] are taken from the first clip.

There are some differences in the behaviour and the allowed parameter depending on the color format and the operation; here are the details:

*There is no mask (alpha channel) in [[YUY2]], so the alpha channel is assumed to be fully opaque (255{{D}}) everywhere.

*In [[RGB32]] the {{FuncArg|overlay_clip}} alpha channel is multiplied with {{FuncArg|level}}, so the resulting alpha is
:: (alpha * {{FuncArg|level}} + 1) / 256.
:This means for full strength of operation, alpha has to be 255{{D}} and {{FuncArg|level}} has to be 257.

*{{AvsPluscon}} in alpha-aware color spaces alpha channel is multiplied with {{FuncArg|opacity}}, so the resulting alpha is
:: alpha * opacity
:This means for full strength of operation, alpha has to be 255{{D}} and {{FuncArg|opacity}} has to be 1.0.

====Examples====
*'''Layer''' can be used to combine two captures of different broadcasts for reducing noise. A discussion of this idea can be found {{doom9|28438}}. Of course you have to ensure that the frames of the two clips match exactly -- use [[Trim]] or [[DeleteFrame]] as necessary. A sample script:
<div {{BoxWidthIndent|46|1.5}} >
clip1 = [[AviSource]]("capture-pass-1.avi").[[ConvertToYUY2]]
clip2 = [[AviSource]]("capture-pass-2.avi").[[ConvertToYUY2]].[[Trim]](101, 0)
return Layer(clip1, clip2, "fast")
</div>
</div>

== Mask ==
<div style="max-width:62em" >

<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/mask.html#mask https://avisynthplus.readthedocs.io]
</div>

Applies a defined alpha-mask to a clip, by converting [[RGB32]]-only {{FuncArg|mask_clip}} to greyscale and copying that greyscale information to the alpha channel of RGB32-only {{FuncArg|clip}}. In the alpha channel, "black" means transparent and "white" means opaque. For those of you who familiar with Photoshop masks, the concept is the same. In fact you can create a black and white photo in Photoshop, load it in your script and use it as a mask.

{{FuncDef|Mask(clip ''clip'', clip ''mask_clip'')}}

:{{Par2|clip|clip|}}
:: The base clip, which determines the size and all other video and audio properties of the result.
:: Color format must be [[RGB32]].
::{{AvsPluscon}} also supports [[RGB64]] and [[PlanarRGBA]].

:{{Par2|mask_clip|clip|}}
:: Alpha-mask source, as described above. Size and color format must match {{FuncArg|clip}}.

====Examples====
Suppose "ss.jpg" is a snapshot from a video clip, which served as a guideline to create the mask using Paint. We use [[ImageSource]] to load the image in the script and '''Mask''' to apply it.
<div {{BoxWidthIndent|68|1}} >
bg = [[AviSource]]("01gray.avi").[[ConvertToRGB32]] # here is the background clip
mk = [[ImageSource]]("ss.jpg").ConvertToRGB32 # load the image
top = AviSource("k3.avi").ConvertToRGB32.Mask(mk) # load the top layer clip and apply the mask to it
Layer(bg, top) # layer the background and the top layer with mask
</div>
</div>

== ResetMask ==
<div style="max-width:62em" >

<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/mask.html#resetmask https://avisynthplus.readthedocs.io]
</div>

Applies an opaque (white) alpha channel to a clip. The alpha channel of an [[RGB32]] clip is not always well-defined, depending on the source (it may contain random data); this filter is a fast way to apply an all-white mask.

{{FuncDef|ResetMask(clip ''clip'')}}

{{FuncDef|ResetMask(clip ''clip'', float ''mask'')}} {{AvsPluscon}}

:{{Par2|clip|clip|}}
:: Source clip. Alpha channel will be set to opaque. Color format must be [[RGB32]].
::{{AvsPluscon}} also supports [[RGB64]], [[PlanarRGBA]] and [[YUVA]].

:{{Par2|float|mask|}}
::{{AvsPluscon}} Optional mask value to set. No bit-depth scaling occurs, but value is clipped to be between 0 and maximum_pixel_value.
::Maximum opacity is 1.0 for 32 bit float formats, and (1^bit_depth) - 1 for 8-16 bit formats
</div>

== ColorKeyMask ==
<div style="max-width:62em" >

<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/mask.html#colorkeymask https://avisynthplus.readthedocs.io]
</div>

Clears pixels in the alpha channel by comparing to a transparent {{FuncArg|color}} (default black).

Each pixel with a color differing less than ({{FuncArg|tolB}},{{FuncArg|tolR}},{{FuncArg|tolG}}) (default 10{{D}}) is set to transparent (black); otherwise it is left unchanged – note, it is NOT set to opaque (white). That's why you might need '''ResetMask''' before applying this filter. This behaviour allows an aggregate mask to be constructed with multiple calls to '''ColorKeyMask'''.

When {{FuncArg|tolR}} or {{FuncArg|tolG}} are not set, they get the value of {{FuncArg|tolB}} by default. Normally you start with a '''ResetMask''', then chain a few calls to '''ColorKeyMask''' to cause transparent holes where each color of interest occurs. See [[Overlay]] for examples.

{{FuncDef|ColorKeyMask(clip ''clip'', int ''color'' [, int ''tolB'', int ''tolG'', int ''tolR''])}}

:{{Par2|clip|clip|}}
::Source clip. Color format must be [[RGB32]].
::{{AvsPluscon}} also supports [[RGB64]] and [[PlanarRGBA]].

:{{Par2|color|int|black}}
::Transparent color. Default black.

:{{Par2|tolB|int|10{{Template:D}}}}
:{{Par2|tolG|int|(tolB)}}
:{{Par2|tolR|int|(tolB)}}
::Color tolerance. See description above.
</div>
</div>

== Changelog ==

{|border=1 cellspacing=1 cellpadding=4
| v2.58
| ColorKeyMask: Added separate tolerance levels.
|}

[[Category:Internal filters]]
[[Category:Layering]]
[[Category:Masking]]

RemoveDirt

2025-01-09T07:20:19Z

Pinterf: /* SCSelect */ mention YUY2 unsupport, cache hints

{{FilterCat6|External_filters|Plugins|Plugins_x64|Restoration_filters|Luma_equalization|Deep_color_tools}}
{{Filter3
| {{Author/kassandro}}, {{Author/pinterf}}
| v1.1
| [http://github.com/pinterf/RemoveDirt/releases RemoveDirt-1.1.7z]
| Luma Equalization
| [http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[http://forum.doom9.org/showthread.php?t=70856 Doom9 Thread (original)], [http://forum.doom9.org/showthread.php?t=176199 Doom9 Thread (update)]}}

== Description ==
RemoveDirt is a temporal cleaner for AviSynth 2.6, [[AviSynth+]] and VapourSynth. It has now become a script function which involves RestoreMotionBlocks and various filters from the [[RgTools|RemoveGrain]] package.
<br>
<br>
The plugin contains 2 filters:
*[[#RestoreMotionBlocks|RestoreMotionBlocks]] which is the main function used in the [[#RemoveDirt Script|RemoveDirt script]].
*[[#SCSelect|SCSelect]] is a scence change detention filter meant to be use with RestoreMotionBlocks.
<br>

== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: All [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported. [[#SCSelect|SCSelect]] also supports 32-bit float and planar RGB.
<br>

== [[Script variables|Syntax and Parameters]] ==

===RestoreMotionBlocks===
:{{Template:FuncDef|RestoreMotionBlocks (clip filtered, clip restore, clip "neighbour", clip "neighbour2", clip "alternative", bool "planar", bool "show", bool "debug", int "gmthreshold", int "mthreshold", int "noise", int "noisy", int "dist", int "tolerance", int "dmode", int "pthreshold", int "cthreshold", bool "grey")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2|neighbour|clip| }}
::{{Par2|neighbour2|clip| }}
::{{Par2|alternative|clip| }}
:::The first five variables are clip variables. All clips must be of the same type (same width, height and color space). The number of frames is the minimum of the length of all these five clips. The first two variables are mandatory and are unnamed. "filtered" is usually an aggressively filtered clip, from which motion artifacts have to removed. If RestoreMotionBlocks identfies an 8x8 block as a motion block, it copies this block from the clip "restore" to the clip "filtered". This is the basic operation of RestoreMotionBlocks. To identify motion blocks RestoreMotionBlocks uses the clip "neighbour". The default value for neighbour is the "restore" clip. However, in the RemoveDirt script "neighbour" is different from "restore".
:::*The "neighbour2" is for using RemoveDirt in combination with motion compensation filters like [[MVTools]] (see RemoveDirtMC below). Finally, if the number of motion blocks exceeds the percentage specified in the "gmthreshold" variable, then RestoreMotionBlocks simply takes the frame from the clip "alternative". In this way, scene switches or global motion can be handled specifically. The clip "restore" is the default value for "alternative".
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value). The parameter is ineffective from v1.0 since YUY2 is no longer supported.
<br>
::{{Par2|show|bool|false}}
::{{Par2|debug|bool|false}}
:::The boolean variables "show" and "debug" are used for debugging (see section Debugging).
<br>
::{{Par2|gmthreshold|int|80}}
:::The default value for gmthreshold is 80, i.e. if 80% of the blocks are motion blocks, then the frame is taken from "alternative" clip.
<br>
::{{Par2|mthreshold|int|160}}
:::"mthreshold" is similar as in the old RemoveDirt. However, because we now use the ordinary SAD for block comparison, the values should be somewhat higher, especially if the value of noise is low. The default value for "mthreshold" is 160
<br>
::{{Par2|noise|int|0}}
::{{Par2|noisy|int|-1}}
:::With the variable "noise" one can specify a noise level, which should be ignored by the motion detection. The default value of "noise" is 0.
:::The variable "noisy" is used to specify the number of noisy pixels of an 8x8 block, which must be exceeded for a motion block. The default value of "noisy" is -1.
:::If noisy >= 0 and noise > 0, then the value of "mthreshold" is ignored.
<br>
::{{Par2|dist|int|1}}
::{{Par2|tolerance|int|12}}
:::dist and tolerance control basic motion detection. dist=1 and tolerance=12 are the default values. A block B is considered a neighbor of a block A by RestoreMotionBlocks, if both horizontally and vertically both blocks are only dist blocks apart. For dist=0 a block has only one neighbor, the block itself. If dist=1, then a block has 9 neighbors, if it is not located at the boundary. If dist=2, then each inner block has 25 neighbors and if dist= 3 then it has 49 neighbors etc.. Now for a given block RestoreMotionBlocks counts all the neighbor blocks which are marked as motion blocks. If the percentage of motion blocks among all neighbor blocks exceeds the value of tolerance, then the block is not cleaned. Thus in the default case of 9 neighbor blocks and tolerance=12 one motion block is allowed and cleaning will nevertheless be allowed. In particular, a motion block is cleaned, if it has no other motion blocks as neighbors. This is reasonable, because motion rarely occurs on one tiny block alone. On the other, if motion blocks have a certain density then also the neighbors should not be cleaned. This is the idea behind the variables dist and tolerance. A higher value of dist results in less cleaning. The higher the value of tolerance, the more cleaning. If tolerance >=100 then all blocks are cleaned.
<br>
::{{Par2|dmode|int|0}}
:::*If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit.
:::*If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is discarded if there exists no further phase 1 motion block with a distance less than 1.
:::*Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded.
<br>
::{{Par2|pthreshold|int|10}}
::{{Par2|cthreshold|int|pthreshold}}
:::Parameters "pthreshold" and "cthreshold" are thresholds for luma and chroma, respectively. For 10-16 bits (where actual pixel values and thus SAD values are larger) the parameter is automatically normalized internally. You can keep it the same across different formats for the same effect.<br>For postprocessing RestoreMotionBlocks uses the variable pthreshold and cthreshold. If the total luma difference of the two adjacent border line increases by more than pthreshold, then cleaning of the block is undone by RestoreMotionBlocks. Similarily cleaning is undone, if the chroma difference exceedes cthreshold. The maximal difference of 8 pixels is 8*255. If cthreshold is larger than this value, then chroma postprocessing is disabled. If both, pthreshold and cthreshold, are larger than the maximal value, then postprocessing is completely disabled. pthreshold=10 is the default value and if nothing else is specified cthreshold has the same value as pthreshold. Clearly luma postprocessing is much more important than chroma postprocessing. If cthreshold and especially pthreshold, then rather unpleasant blocky artifacts become visible. These are much more likely in areas with very flat contrast. Of course, there must be motion as well to get such artifacts. If you see these typical blocky artifacts, you should lower the thresholds. Postprocessing should only be disabled if all the cleaned frames are checked for artifacts. By the very nature of the algorithm no postprocessing will occur if all blocks were cleaned. There must be at least one block, which has not been cleaned to trigger postprocessing. The postprocessing algorithm loops through all the blocks as long as it can find blocks to be restored, nevertheless it is quite efficient. It is the basic philosophy of RestoreMotionBlocks, that motion detection needs only detect at least one but not all blocks of a moving object. The rest is then taken care by postprocessing.

:::Negative values are allowed for pthreshold and cthreshold, but are not very reasonable.
<br>
::{{Par2|grey|bool|false}}
:::If grey=true the chroma of the clip "filtered" is not touched by RestoreMotionBlocks. Also for postprocessing only the luma is used. This is slightly faster than grey=false. If you use grey=false for b&w clips, then it not only takes longer but also the quality may degrade, because chroma noise may trigger false postprocessing. Thus "grey=true" is highly recommended for b&w clips. <br>Greyscale (Y8..Y16) clips are automatically treated as grey=true.
<br>
====How RestoreMotionBlocks works====
To use the above variables properly, one has to understand how RestoreMotionBlocks works. It consists of three phases. For the first phase only the clip "neighbour" is used. Each frame is divided into a grid of 8x8 blocks. If n is the number of the current frame, then for each block of this grid RestoreMotionBlocks looks at the luma of this block in neighbour(n-1) and neighbour(n+1). Note that we don't use the frame neighbour(n). There are three comparison methods (the old RemoveDirt has only one).
#If noise= 0, then simply the SAD of each block in neighbour(n-1) and neighbour(n+1) is computed. If it is >= mthreshold, the block is identified as a motion block of frame n. This is the fasted method and a similar method was used in the old RemoveDirt. Its key disadvantage is that it may easily misled by noise.
#If noise >=0, then instead of SUM(|y-x|) RestoerMotionBlocks calculates SUM(| |y-x|-noise |). In particular, differences with absolute value <= noise are ignored. If it is >= mthreshold, then this block is identified as a motion block. We call this the noise adjusted SAD. From the way how the noise adjusted SAD is calculated, it is clear, that "mthreshold" should be decreased if "noise" is increased.
#If noise >= 0 and noisy >= 0, then RestoreMotionblocks counts the number of pixels of a block, for which the absolute difference between neighbour(n-1) and neighbour(n+1) is >= noise. If this number is >= value of "noisy", then the block is identified as a motion block. We call this the NPC (= noisy pixel counting) method. The value of mthreshold is ignored, if NPC is selected.
Note that a block has 64 pixels. Thus, if noisy > 64, then there can't be any motion blocks. In my view NPC is clearly the best method. It has likely about half the speed of SAD and about the same speed as NSAD. Noise=-1 and noisy=-1 are the default values. Thus SAD is the default method for the first phase. I ran most of my RemoveDirt tests with noise=8 or 10 and noisy= 12.

In the sequel the motion blocks found in the first phase are called phase 1 motion blocks. In the second phase, for each block all the motion blocks found in the first phase which have a distance <= dist are counted. If the result is >= (tolerance /100) * (the number of all first phase blocks with distance <= dist) , then this block is called a motion neighbour block. For instance, if dist = 1 and tolerance= 12 (the default values), then there are 9 blocks with a distance <= 1. Since 1 < (12/100)*9 < 2, there must be at least 2 phase 1 motion blocks among the 9 neighbour blocks such that the block is marked as a motion neighbour block. If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit. If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is dicarded if there exists no further phase 1 motion block with a distance less than 1. Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded. If dist=0 or dmode=2 gmthreshold should be lowered to 60 or even 50.

The third phase, called the postprocessing phase, starts with restoring the phase 2 motion blocks by copying them from the clip "restore" to the clip "filtered". All phase 2 motion blocks become also phase 3 motion blocks. Then the edges between motion and non-motion blocks are inspected. To this end the SAD of the two adjacent border line segments is calculated twice (these line segments are either horizontal or vertical and are 8 pixels long). It is calculated first in the clip "restore" and then in the clip "filtered". In the clip "filtered" the two blocks are from two different sources, one block, the motion block was restored from the clip "restore" and the non-motion block is from the original clip "filtered". Since the frames of the clip "restore" are not changed at all, both blocks are from the same source and should therefore fit together. If the edge SAD in the clip "filtered" > (edge SAD in the clip restore) + pthreshold, then the block is marked as a new (additional) phase 3 motion block and the block is restored by copying it from "restore" to "filtered", because the two blocks in "filtered" don't fit together well enough compared with the two blocks in "restore". In other words, in this phase, it is checked whether a restored block fits to the yet unrestored blocks. If it doesn't, the not yet restored blocks, which do not fit well, are marked as phase 3 motion blocks and are restored as well. This procedure is repeated until there are no more blocks, which can be tested. If the value of the grey variable is false, then the same is done for the luma and the chroma (for the chroma the variable cthreshold is used instead of pthreshold). If grey= true, then postprocessing is only done for the luma.
Finally, if the percentage of all phase 3 motion blocks with respect to all blocks exceeds the value of gmthreshold, then the "filtered" frame is discarded and replaced by the corresponding frame in "alternative". In this way, we can give special treatments for sharp scene switches and scenes with a moving or zooming camera.
<br>
<br>
====Debugging====

The boolean variable debug and show are used for debugging. If show=true, then the blocks, which are marked as motion blocks in the first phase are colored red, those found in the second phase are colored green and finally the motion blocks marked by postprocessing are colored blue. In this way, one can easily check whether the above variables were selected appropriately. if debug=true, then RestoreMotionBlocks sends output of the following kind to the debugview utility:

<pre>
[348] [21495] RemoveDirt: motion blocks = 942(14%), 1652(25%), 635( 9%), loops = 31
[348] [21496] RemoveDirt: motion blocks = 1745(26%), 2330(35%), 64( 0%), loops = 3
[348] [21497] RemoveDirt: motion blocks = 1480(22%), 1973(30%), 45( 0%), loops = 4
[348] [21498] RemoveDirt: motion blocks = 1081(16%), 1915(29%), 65( 1%), loops = 2
[348] [21499] RemoveDirt: motion blocks = 1403(21%), 2380(36%), 235( 3%), loops = 10
[348] [21500] RemoveDirt: motion blocks = 2618(40%), 2204(34%), 59( 0%), loops = 5
[348] [21501] RemoveDirt: motion blocks = 986(15%), 2065(31%), 75( 1%), loops = 3
[348] [21502] RemoveDirt: motion blocks = 1214(18%), 2291(35%), 78( 1%), loops = 3
[348] [21503] RemoveDirt: motion blocks = 1348(20%), 2179(33%), 57( 0%), loops = 4
[348] [21504] RemoveDirt: motion blocks = 961(14%), 1957(30%), 71( 1%), loops = 3
[348] [21505] RemoveDirt: motion blocks = 1833(28%), 2201(33%), 38( 0%), loops = 3
[348] [21506] RemoveDirt: motion blocks = 1644(25%), 2183(33%), 53( 0%), loops = 5
[348] [21507] RemoveDirt: motion blocks = 1420(21%), 2541(39%), 132( 2%), loops = 5
[348] [21508] RemoveDirt: motion blocks = 2238(34%), 2229(34%), 104( 1%), loops = 4
[348] [21509] RemoveDirt: motion blocks = 1351(20%), 2294(35%), 181( 2%), loops = 6
[348] [21510] RemoveDirt: motion blocks = 931(14%), 1800(27%), 229( 3%), loops = 5
</pre>

The first number in brackets on the left hand side is the id of the process, which runs the script, the second number in brackets is the frame number. The first number (with percentages in brackets) after "motion blocks =" is the number of phase 1 motion blocks, the second is the difference between phase 2 and phase 1 motion blocks (always >=0 if dmode=0, always <= 0 if dmode= 2) and the third is the difference between phase 3 and phase 2 motion blocks (always >= 0). Finally the number after "loops =" is the number of postprocessing loops used for this frame. Debug=true can be used to monitor RestoreMotionBlocks in an encoding process. Of course, show=true can only be used before an encoding process to find the right values for the various variables.
<br>
<br>

----

===SCSelect===
SCSelect is a special filter, which distinguishes between scene begins, scene ends and global motion. The output of SCClense is used as an "alternative" clip for RestoreMotionBlocks. It can hardly used for other purposes, because it can only make proper decisions if there are a lot of motion blocks. Only if the percentage of motion blocks is > gmthreshold, then RestoreMotionBlocks chooses a frame from the clip specified with the alternative variable and then there are always a lot of motion blocks, if gmthreshold is not too small (gmthreshold >= 30 should be sufficiently large). SCSelect yields nonsense results if there are only few motion blocks. SCSelect is used as follows:

:{{Template:FuncDef|SCSelect (clip input, clip scene_begin, clip scene_end, clip global_motion, float "dfactor", bool "debug", bool "planar", int "cache", int "gcache")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
:::The first four clip variables are mandatory and have no name. All four clips must have the same color space, width and height. The first clip is the clip, on which SCSelect bases its decision. Usually it should be the same clip, which was specified with the "neighbour" variable in RestoreMotionBlocks. If SCSelect realises a scene begin, it selects its output frame from the clip scene_begin. If SCSelect realises a scene end, it selects its output frame from the clip scene_end. If SCSelect realises a global motion, it selects its output frame from the clip global motion. Thus SCSelect doesn't produce any new frames. It only makes a selection from three different sources.
<br>
::{{Par2|dfactor|float|4.0}}
:::Dfactor is the key variable for scene switch sensitivity. The higher dfactor the less scene begins and scene ends and the more global motion frames are detected. Dfactor=4.0 is the default value.
<br>
::{{Par2|debug|bool|false}}
:::If debug=true, then SCSelect sends output of the following type to the [http://technet.microsoft.com/en-us/library/bb896647.aspx DebugView] utility:
<div style="margin-left: 6em; max-width: 47em">
<pre>
[3416] [67865] SCSelect: global motion
[3416] [67866] SCSelect: global motion
[3416] [67870] SCSelect: global motion
[3416] [67871] SCSelect: global motion
[3416] [67873] SCSelect: global motion
[3416] [67874] SCSelect: global motion
[3416] [67877] SCSelect: global motion
[3416] [68318] SCSelect: global motion
[3416] [68319] SCSelect: global motion
[3416] [68557] SCSelect: scene end
[3416] [68558] SCSelect: scene begin
[3416] [69481] SCSelect: scene end
[3416] [69482] SCSelect: scene begin
[3416] [70240] SCSelect: scene end
[3416] [70241] SCSelect: scene begin
[3416] [70406] SCSelect: global motion
[3416] [70407] SCSelect: global motion
[3416] [70408] SCSelect: global motion
[3416] [70409] SCSelect: global motion
[3416] [70410] SCSelect: global motion
[3416] [72032] SCSelect: global motion
[3416] [72164] SCSelect: global motion
[3416] [72165] SCSelect: global motion
</pre>
</div>
:::To describe the basic idea behind SCSelect let SAD(n) be the SAD difference between the frames input(n) and input(n+1). Now, if SAD(n) > dfactor * SAD(n-1), then SCSelect recognizes a scene end and pulls the frame from the clip scene_end. If SAD(n-1) > dfactor * SAD(n), then SCSelect recognizes a scene begin and pulls the frame from the clip scene_begin. If both SAD(n) <= dfactor * SAD(n-1) and SAD(n-1) <= dfactor * SAD(n), then SCSelect recognizes a global motion and pulls the frame from the clip global_motion. From this description it is clear that dfactor must be > 1 for getting reasonable results. The above algorithm is optimized such that often only one and not two SADs are calculated for one requested frame. However, there are certain shortcomings. If a scene ends with global motion, then SCSelect often can't detect the scene end. If a scene begins with global motion, then SCSelect often can't detect the scene begin. These two effects are usually responsible if lonely scene begins and scene ends are detected by SCSelected, otherwise each scene begin should be preceded by a scene end. By refining the above algorithm we could avoid lonely scene begins and scene ends, but there is one situation, where even such a refinement fails. Namely if the scene ends with global motion and the new scene starts with global motion. Then a sharp scene switch can only be detected reliably with a good motion analysis, which would result in an extreme slow down of the filter.
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value). The parameter is ineffective from v1.0 since YUY2 is no longer supported.
<br>
::{{Par2|cache|int|2}}
::{{Par2|gcache|int|0}}
:::Undocumented parameters, meant to add Avisynth video cache hints (up to Avisynth 2.6).
<br>

== RemoveDirt Script ==
RemoveDirt has now become a script function, which involves RestoreMotionBlocks and various filters from [[RgTools|RemoveGrain]] package.

During the tests I used the following script:

<pre>
function RemoveDirt(clip input, bool "_grey", int "repmode")
{
_grey=default(_grey, false)
repmode=default(repmode, 16)
clmode=17
clensed=Clense(input, grey=_grey, cache=4)
sbegin = ForwardClense(input, grey=_grey, cache=-1)
send = BackwardClense(input, grey=_grey, cache=-1)
alt=Repair(SCSelect(input, sbegin, send, clensed, debug=true), input, mode=repmode, modeU = _grey ? -1 : repmode )
restore=Repair(clensed, input, mode=repmode, modeU = _grey ? -1 : repmode)
corrected=RestoreMotionBlocks(clensed, restore, neighbour=input, alternative=alt, gmthreshold=70, dist=1, dmode=2, debug=false, noise=10, noisy=12, grey=_grey)
return RemoveGrain(corrected, mode=clmode, modeU = _grey ? -1 : clmode )
}
</pre>

Let us discuss this script in some detail. Firstly, we apply the brutal temporal clenser from the RemoveGrain package to obtain the clip "clensed". Then we use the filters ForwardClense and BackwardClense from RemoveGrain to construct the clip "alt", which is then used as the "alternative" variable in the subsequent RestoreMotionBlocks. While Clense does a lot of cleaning it certainly creates a lot of artifacts in motion areas. In RemoveDirt this repair is only made in motion areas. The static areas are not repaired. Since the clip is used only for restoring motion areas, we can use the much stronger Repair mode 16, which restores thin lines destroyed by clense. Finally, because there may be some left over from temporal cleaning especially when grain is dense, we use the spatial denoiser RemoveGrain(mode=17) to remove these dirt or grain rests.

=== Optimal Usage ===

1. If possible, crop after RestoreMotionBlocks. Modern codecs divide the frames in the same way as RemoveDirt into a grid of 8x8 pixel blocks to perform the crucial discret cosine transform for such blocks. Now if the clip is cropped after RemoveDirt, then the grid of RemoveDirt and the codec are likely to be different resulting in inferior compression. There is one exception, though: cropping afterwards does not hurt, if all four sides are cropped by a multiple of 8. For instance, crop(8,64,0,-72) is ok. On the other hand, one should crop after RemoveGrain/Repair if possible, because this filters cannot process the boundary pixels. Thus the optimal solution is to crop afterwards and then only by multiples of 8, which unfortunately is not always possible.

2. Avisynth 2.6 hint: Crop only with "align=true". RestoreMotionBlocks uses SSE2 instructions. If you crop without "align= true" before RestoreMotionBlocks, then the data on the frames may not be properly aligned and RemoveDirt will execute substantially slower. As a consequence you should always crop with Avisynth and not with DVD2AVI or DGIndex.
For Avisynth+ there is no need for such precautions, Crop is always producing aligned frames.

3. Telecined movies must be inverse telecined before RemoveDirt. If a film is telecined some fields are doubled in order to increase the frame rate from 24fps to 30fps. Hence on such doubled fields the basic property of dirt, described above, is no more valid and no temporal cleaner can ever spot dirt on such doubled fields. On the other hand, after an inverse telecine usually every fourth frame is composed of fields, which originate from two different frames. Visually these two fields fit together well but both are from a different compression context, which can mislead RemoveDirt to false motion detection. In extreme cases, one field may be from an I- or P-frame, while the other is from a B-frame. But even if the fields are from from frames of identical type, the different compression context has a substantial effect. Consequently RemoveDirt performes less well on inverse telecined movies than on natively progressive movies. By the same reason also compression of inverse telcined movies is worse than of natively progressive movies. We in Europe should thank god every day that we are not getting telecined. However, here in Germany we have digital tv broadcasters, which like to comb progressive films (about 5% of all progressive movies from ARD and especially ZDF are combed). Fortunately these idiots are not able to double fields, so RemoveDirt should work, but on combed films the dirt is always split over two frames which clearly hurts RemoveDirt. On the other hand, if these combed films are uncombed, then we have the compression context problem for any frame and not only for any fourth frame. Stepping through the video with the builtin filter Bob() one can decide with near absolute certainty, whether the video is truely progressive, interlaced, telecined, field blended or progressive with a field shift.

4. Put other filters after RemoveDirt. Except those filters mentioned before, like crop and inverse telecine, all other filters should be put after RemoveDirt in the Avisynth script, because most filters have a negative rather than a positive impact on dirt detection.
<br>
<br>
== Change Log ==

* v1.1 (20250108)
- Fix SCSelect (VapourSynth)

* v1.0 (20250108)
- Remove YUY2 support (not even with "planar hack")
- VapourSynth support (API 4) (dual Avisynth/VapourSynth plugin)
VS version supports the very same basic parameters like the Avisynth version except
some historical compatibility parameters:
- RestoreMotionBlocks is omitting "planar"
- SCSelect is omitting "planar", "cache", "gcache"

* v0.9.3 (20210223)
- Fix a crash, which can occur on non mod8 sources

* v0.9.2 (20190324)
- RestoreMotionBlocks: 10-16 bit support. Relevant threshold and noise parameters are bit depth independent.
- minor speedup
- SCSelect: add support for 10-16 bits and 32 bit float clips
- SCSelect: add support for planar RGB
- FIX: SCSelect: make it work properly for large frames (>8MPixel)
- FIX: SCSelect: Makes use the whole frame: now counts the rightmost non-mod32 pixels as well.
- Clang support (LLVM) with Visual Studio 2017
- update html docs
- add clang-built DLLs to the released version

* v0.9.1 (20190314)
- project moved to github: https://github.com/pinterf/RemoveDirt
- built using Visual Studio 2017
- x64 build for Avisynth+
- Added version resource to DLL
- Changed to AVS 2.6 plugin interface
- Fix: RestoreMotionBlocks: grey=false: it was copying 8x4 chroma pixels for YV12 and 8x8 for YUY2 instead of 4x4 and 8x4 blocks
- Fix: SCSelect: Old v0.9 SSE2 code omitted difference checking for every second 8 columns
- Removed MMX code, now requires SSE2
- Reports MT Modes for Avisynth+: [[MT_SERIALIZED]] for SCSelect
- Reports MT Modes for Avisynth+: [[MT_MULTI_INSTANCE]] for RestoreMotionBlocks (may not be any faster)
- Added Y, YV16 and YV24 support besides existing YV12 and planar-hacked-YUY2

* v0.9 (20050507)
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="100%"
|-
!!width="100px"| Version
!!width="300px"| Download
!!width="300px"| Mirror
!!width="500px"| Comments
!!width="500px"| Source code
|-
!v0.9
|[http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|[https://web.archive.org/web/20150405173333if_/http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|includes statically and dynamically linked [[SSE2]] binaries compiled with MSVC2010. Dynamically linked binaries requires the [http://www.microsoft.com/en-us/download/details.aspx?id=8328 Microsoft Visual C++ 2010 Redistributable Package (x86)] to be installed.
|Included with the binaries.
|-
!v0.9
|<strike>[https://web.archive.org/web/20140723074402if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.zip ReduceDirt.zip]</strike>
|
|includes 3 binaries: one statically linked (<tt>RemoveDirtS.dll</tt>) and two dynamically linked (<tt>RemoveDirt.dll, RemoveDirtSSE2.dll</tt>).
SSE2 version is recommended but unfortunately it requires the <tt>Msvcr71.dll</tt> runtime component from the very ancient Microsoft Visual C++ .NET 2003. For this reason this package is considered deprecated!
|[https://web.archive.org/web/20141121054131if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt-src.zip ReduceDirt-src.zip]
|-
!v0.6.1
|[https://web.archive.org/web/20050215121957if_/http://home.pages.at/kassandro/RemoveDirt/RemoveDirt.zip RemoveDirt.zip]
|
|Old archived documentation: [https://web.archive.org/web/20050311122626/http://www.removedirt.de.tf www.removedirt.de.tf]
|}
<br>
== External Links ==
*[https://web.archive.org/web/20160610102940/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.htm RemoveDirt.htm] - official v0.9 documentation.
*http://forum.doom9.org/showthread.php?p=641337#post641337
*http://forum.doom9.org/showthread.php?p=1560013&highlight=scselect#post1560013
*http://forum.doom9.org/showthread.php?p=1564754&highlight=scselect#post1564754
*http://forum.doom9.org/showthread.php?p=1518730&highlight=scselect#post1518730
*http://forum.doom9.org/showthread.php?p=1409324#post1409324
*http://forum.doom9.org/showthread.php?p=1483843&highlight=scselect#post1483843
*http://forum.doom9.org/showthread.php?p=1488392&highlight=scselect#post1488392
*http://forum.doom9.org/showthread.php?p=1479632&highlight=scselect#post1479632
*http://forum.doom9.org/showthread.php?t=145753&highlight=scselect&page=2
*http://forum.doom9.org/showthread.php?p=1206869&highlight=scselect#post1206869
*http://forum.doom9.org/showthread.php?p=1351709&highlight=scselect#post1351709
*http://forum.doom9.org/showthread.php?p=1405939&highlight=scselect#post1405939
*http://forum.doom9.org/showthread.php?p=1205317&highlight=scselect#post1205317
*http://forum.doom9.org/showthread.php?p=1507954&highlight=scselect#post1507954
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Luma_Equalization|External Filters]] ←'''

RemoveDirt

2025-01-09T07:18:23Z

Pinterf: /* RestoreMotionBlocks */ YUY2 planar not supported

{{FilterCat6|External_filters|Plugins|Plugins_x64|Restoration_filters|Luma_equalization|Deep_color_tools}}
{{Filter3
| {{Author/kassandro}}, {{Author/pinterf}}
| v1.1
| [http://github.com/pinterf/RemoveDirt/releases RemoveDirt-1.1.7z]
| Luma Equalization
| [http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[http://forum.doom9.org/showthread.php?t=70856 Doom9 Thread (original)], [http://forum.doom9.org/showthread.php?t=176199 Doom9 Thread (update)]}}

== Description ==
RemoveDirt is a temporal cleaner for AviSynth 2.6, [[AviSynth+]] and VapourSynth. It has now become a script function which involves RestoreMotionBlocks and various filters from the [[RgTools|RemoveGrain]] package.
<br>
<br>
The plugin contains 2 filters:
*[[#RestoreMotionBlocks|RestoreMotionBlocks]] which is the main function used in the [[#RemoveDirt Script|RemoveDirt script]].
*[[#SCSelect|SCSelect]] is a scence change detention filter meant to be use with RestoreMotionBlocks.
<br>

== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: All [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported. [[#SCSelect|SCSelect]] also supports 32-bit float and planar RGB.
<br>

== [[Script variables|Syntax and Parameters]] ==

===RestoreMotionBlocks===
:{{Template:FuncDef|RestoreMotionBlocks (clip filtered, clip restore, clip "neighbour", clip "neighbour2", clip "alternative", bool "planar", bool "show", bool "debug", int "gmthreshold", int "mthreshold", int "noise", int "noisy", int "dist", int "tolerance", int "dmode", int "pthreshold", int "cthreshold", bool "grey")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2|neighbour|clip| }}
::{{Par2|neighbour2|clip| }}
::{{Par2|alternative|clip| }}
:::The first five variables are clip variables. All clips must be of the same type (same width, height and color space). The number of frames is the minimum of the length of all these five clips. The first two variables are mandatory and are unnamed. "filtered" is usually an aggressively filtered clip, from which motion artifacts have to removed. If RestoreMotionBlocks identfies an 8x8 block as a motion block, it copies this block from the clip "restore" to the clip "filtered". This is the basic operation of RestoreMotionBlocks. To identify motion blocks RestoreMotionBlocks uses the clip "neighbour". The default value for neighbour is the "restore" clip. However, in the RemoveDirt script "neighbour" is different from "restore".
:::*The "neighbour2" is for using RemoveDirt in combination with motion compensation filters like [[MVTools]] (see RemoveDirtMC below). Finally, if the number of motion blocks exceeds the percentage specified in the "gmthreshold" variable, then RestoreMotionBlocks simply takes the frame from the clip "alternative". In this way, scene switches or global motion can be handled specifically. The clip "restore" is the default value for "alternative".
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value). The parameter is ineffective from v1.0 since YUY2 is no longer supported.
<br>
::{{Par2|show|bool|false}}
::{{Par2|debug|bool|false}}
:::The boolean variables "show" and "debug" are used for debugging (see section Debugging).
<br>
::{{Par2|gmthreshold|int|80}}
:::The default value for gmthreshold is 80, i.e. if 80% of the blocks are motion blocks, then the frame is taken from "alternative" clip.
<br>
::{{Par2|mthreshold|int|160}}
:::"mthreshold" is similar as in the old RemoveDirt. However, because we now use the ordinary SAD for block comparison, the values should be somewhat higher, especially if the value of noise is low. The default value for "mthreshold" is 160
<br>
::{{Par2|noise|int|0}}
::{{Par2|noisy|int|-1}}
:::With the variable "noise" one can specify a noise level, which should be ignored by the motion detection. The default value of "noise" is 0.
:::The variable "noisy" is used to specify the number of noisy pixels of an 8x8 block, which must be exceeded for a motion block. The default value of "noisy" is -1.
:::If noisy >= 0 and noise > 0, then the value of "mthreshold" is ignored.
<br>
::{{Par2|dist|int|1}}
::{{Par2|tolerance|int|12}}
:::dist and tolerance control basic motion detection. dist=1 and tolerance=12 are the default values. A block B is considered a neighbor of a block A by RestoreMotionBlocks, if both horizontally and vertically both blocks are only dist blocks apart. For dist=0 a block has only one neighbor, the block itself. If dist=1, then a block has 9 neighbors, if it is not located at the boundary. If dist=2, then each inner block has 25 neighbors and if dist= 3 then it has 49 neighbors etc.. Now for a given block RestoreMotionBlocks counts all the neighbor blocks which are marked as motion blocks. If the percentage of motion blocks among all neighbor blocks exceeds the value of tolerance, then the block is not cleaned. Thus in the default case of 9 neighbor blocks and tolerance=12 one motion block is allowed and cleaning will nevertheless be allowed. In particular, a motion block is cleaned, if it has no other motion blocks as neighbors. This is reasonable, because motion rarely occurs on one tiny block alone. On the other, if motion blocks have a certain density then also the neighbors should not be cleaned. This is the idea behind the variables dist and tolerance. A higher value of dist results in less cleaning. The higher the value of tolerance, the more cleaning. If tolerance >=100 then all blocks are cleaned.
<br>
::{{Par2|dmode|int|0}}
:::*If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit.
:::*If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is discarded if there exists no further phase 1 motion block with a distance less than 1.
:::*Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded.
<br>
::{{Par2|pthreshold|int|10}}
::{{Par2|cthreshold|int|pthreshold}}
:::Parameters "pthreshold" and "cthreshold" are thresholds for luma and chroma, respectively. For 10-16 bits (where actual pixel values and thus SAD values are larger) the parameter is automatically normalized internally. You can keep it the same across different formats for the same effect.<br>For postprocessing RestoreMotionBlocks uses the variable pthreshold and cthreshold. If the total luma difference of the two adjacent border line increases by more than pthreshold, then cleaning of the block is undone by RestoreMotionBlocks. Similarily cleaning is undone, if the chroma difference exceedes cthreshold. The maximal difference of 8 pixels is 8*255. If cthreshold is larger than this value, then chroma postprocessing is disabled. If both, pthreshold and cthreshold, are larger than the maximal value, then postprocessing is completely disabled. pthreshold=10 is the default value and if nothing else is specified cthreshold has the same value as pthreshold. Clearly luma postprocessing is much more important than chroma postprocessing. If cthreshold and especially pthreshold, then rather unpleasant blocky artifacts become visible. These are much more likely in areas with very flat contrast. Of course, there must be motion as well to get such artifacts. If you see these typical blocky artifacts, you should lower the thresholds. Postprocessing should only be disabled if all the cleaned frames are checked for artifacts. By the very nature of the algorithm no postprocessing will occur if all blocks were cleaned. There must be at least one block, which has not been cleaned to trigger postprocessing. The postprocessing algorithm loops through all the blocks as long as it can find blocks to be restored, nevertheless it is quite efficient. It is the basic philosophy of RestoreMotionBlocks, that motion detection needs only detect at least one but not all blocks of a moving object. The rest is then taken care by postprocessing.

:::Negative values are allowed for pthreshold and cthreshold, but are not very reasonable.
<br>
::{{Par2|grey|bool|false}}
:::If grey=true the chroma of the clip "filtered" is not touched by RestoreMotionBlocks. Also for postprocessing only the luma is used. This is slightly faster than grey=false. If you use grey=false for b&w clips, then it not only takes longer but also the quality may degrade, because chroma noise may trigger false postprocessing. Thus "grey=true" is highly recommended for b&w clips. <br>Greyscale (Y8..Y16) clips are automatically treated as grey=true.
<br>
====How RestoreMotionBlocks works====
To use the above variables properly, one has to understand how RestoreMotionBlocks works. It consists of three phases. For the first phase only the clip "neighbour" is used. Each frame is divided into a grid of 8x8 blocks. If n is the number of the current frame, then for each block of this grid RestoreMotionBlocks looks at the luma of this block in neighbour(n-1) and neighbour(n+1). Note that we don't use the frame neighbour(n). There are three comparison methods (the old RemoveDirt has only one).
#If noise= 0, then simply the SAD of each block in neighbour(n-1) and neighbour(n+1) is computed. If it is >= mthreshold, the block is identified as a motion block of frame n. This is the fasted method and a similar method was used in the old RemoveDirt. Its key disadvantage is that it may easily misled by noise.
#If noise >=0, then instead of SUM(|y-x|) RestoerMotionBlocks calculates SUM(| |y-x|-noise |). In particular, differences with absolute value <= noise are ignored. If it is >= mthreshold, then this block is identified as a motion block. We call this the noise adjusted SAD. From the way how the noise adjusted SAD is calculated, it is clear, that "mthreshold" should be decreased if "noise" is increased.
#If noise >= 0 and noisy >= 0, then RestoreMotionblocks counts the number of pixels of a block, for which the absolute difference between neighbour(n-1) and neighbour(n+1) is >= noise. If this number is >= value of "noisy", then the block is identified as a motion block. We call this the NPC (= noisy pixel counting) method. The value of mthreshold is ignored, if NPC is selected.
Note that a block has 64 pixels. Thus, if noisy > 64, then there can't be any motion blocks. In my view NPC is clearly the best method. It has likely about half the speed of SAD and about the same speed as NSAD. Noise=-1 and noisy=-1 are the default values. Thus SAD is the default method for the first phase. I ran most of my RemoveDirt tests with noise=8 or 10 and noisy= 12.

In the sequel the motion blocks found in the first phase are called phase 1 motion blocks. In the second phase, for each block all the motion blocks found in the first phase which have a distance <= dist are counted. If the result is >= (tolerance /100) * (the number of all first phase blocks with distance <= dist) , then this block is called a motion neighbour block. For instance, if dist = 1 and tolerance= 12 (the default values), then there are 9 blocks with a distance <= 1. Since 1 < (12/100)*9 < 2, there must be at least 2 phase 1 motion blocks among the 9 neighbour blocks such that the block is marked as a motion neighbour block. If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit. If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is dicarded if there exists no further phase 1 motion block with a distance less than 1. Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded. If dist=0 or dmode=2 gmthreshold should be lowered to 60 or even 50.

The third phase, called the postprocessing phase, starts with restoring the phase 2 motion blocks by copying them from the clip "restore" to the clip "filtered". All phase 2 motion blocks become also phase 3 motion blocks. Then the edges between motion and non-motion blocks are inspected. To this end the SAD of the two adjacent border line segments is calculated twice (these line segments are either horizontal or vertical and are 8 pixels long). It is calculated first in the clip "restore" and then in the clip "filtered". In the clip "filtered" the two blocks are from two different sources, one block, the motion block was restored from the clip "restore" and the non-motion block is from the original clip "filtered". Since the frames of the clip "restore" are not changed at all, both blocks are from the same source and should therefore fit together. If the edge SAD in the clip "filtered" > (edge SAD in the clip restore) + pthreshold, then the block is marked as a new (additional) phase 3 motion block and the block is restored by copying it from "restore" to "filtered", because the two blocks in "filtered" don't fit together well enough compared with the two blocks in "restore". In other words, in this phase, it is checked whether a restored block fits to the yet unrestored blocks. If it doesn't, the not yet restored blocks, which do not fit well, are marked as phase 3 motion blocks and are restored as well. This procedure is repeated until there are no more blocks, which can be tested. If the value of the grey variable is false, then the same is done for the luma and the chroma (for the chroma the variable cthreshold is used instead of pthreshold). If grey= true, then postprocessing is only done for the luma.
Finally, if the percentage of all phase 3 motion blocks with respect to all blocks exceeds the value of gmthreshold, then the "filtered" frame is discarded and replaced by the corresponding frame in "alternative". In this way, we can give special treatments for sharp scene switches and scenes with a moving or zooming camera.
<br>
<br>
====Debugging====

The boolean variable debug and show are used for debugging. If show=true, then the blocks, which are marked as motion blocks in the first phase are colored red, those found in the second phase are colored green and finally the motion blocks marked by postprocessing are colored blue. In this way, one can easily check whether the above variables were selected appropriately. if debug=true, then RestoreMotionBlocks sends output of the following kind to the debugview utility:

<pre>
[348] [21495] RemoveDirt: motion blocks = 942(14%), 1652(25%), 635( 9%), loops = 31
[348] [21496] RemoveDirt: motion blocks = 1745(26%), 2330(35%), 64( 0%), loops = 3
[348] [21497] RemoveDirt: motion blocks = 1480(22%), 1973(30%), 45( 0%), loops = 4
[348] [21498] RemoveDirt: motion blocks = 1081(16%), 1915(29%), 65( 1%), loops = 2
[348] [21499] RemoveDirt: motion blocks = 1403(21%), 2380(36%), 235( 3%), loops = 10
[348] [21500] RemoveDirt: motion blocks = 2618(40%), 2204(34%), 59( 0%), loops = 5
[348] [21501] RemoveDirt: motion blocks = 986(15%), 2065(31%), 75( 1%), loops = 3
[348] [21502] RemoveDirt: motion blocks = 1214(18%), 2291(35%), 78( 1%), loops = 3
[348] [21503] RemoveDirt: motion blocks = 1348(20%), 2179(33%), 57( 0%), loops = 4
[348] [21504] RemoveDirt: motion blocks = 961(14%), 1957(30%), 71( 1%), loops = 3
[348] [21505] RemoveDirt: motion blocks = 1833(28%), 2201(33%), 38( 0%), loops = 3
[348] [21506] RemoveDirt: motion blocks = 1644(25%), 2183(33%), 53( 0%), loops = 5
[348] [21507] RemoveDirt: motion blocks = 1420(21%), 2541(39%), 132( 2%), loops = 5
[348] [21508] RemoveDirt: motion blocks = 2238(34%), 2229(34%), 104( 1%), loops = 4
[348] [21509] RemoveDirt: motion blocks = 1351(20%), 2294(35%), 181( 2%), loops = 6
[348] [21510] RemoveDirt: motion blocks = 931(14%), 1800(27%), 229( 3%), loops = 5
</pre>

The first number in brackets on the left hand side is the id of the process, which runs the script, the second number in brackets is the frame number. The first number (with percentages in brackets) after "motion blocks =" is the number of phase 1 motion blocks, the second is the difference between phase 2 and phase 1 motion blocks (always >=0 if dmode=0, always <= 0 if dmode= 2) and the third is the difference between phase 3 and phase 2 motion blocks (always >= 0). Finally the number after "loops =" is the number of postprocessing loops used for this frame. Debug=true can be used to monitor RestoreMotionBlocks in an encoding process. Of course, show=true can only be used before an encoding process to find the right values for the various variables.
<br>
<br>

----

===SCSelect===
SCSelect is a special filter, which distinguishes between scene begins, scene ends and global motion. The output of SCClense is used as an "alternative" clip for RestoreMotionBlocks. It can hardly used for other purposes, because it can only make proper decisions if there are a lot of motion blocks. Only if the percentage of motion blocks is > gmthreshold, then RestoreMotionBlocks chooses a frame from the clip specified with the alternative variable and then there are always a lot of motion blocks, if gmthreshold is not too small (gmthreshold >= 30 should be sufficiently large). SCSelect yields nonsense results if there are only few motion blocks. SCSelect is used as follows:

:{{Template:FuncDef|SCSelect (clip input, clip scene_begin, clip scene_end, clip global_motion, float "dfactor", bool "debug", bool "planar", int "cache", int "gcache")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
:::The first four clip variables are mandatory and have no name. All four clips must have the same color space, width and height. The first clip is the clip, on which SCSelect bases its decision. Usually it should be the same clip, which was specified with the "neighbour" variable in RestoreMotionBlocks. If SCSelect realises a scene begin, it selects its output frame from the clip scene_begin. If SCSelect realises a scene end, it selects its output frame from the clip scene_end. If SCSelect realises a global motion, it selects its output frame from the clip global motion. Thus SCSelect doesn't produce any new frames. It only makes a selection from three different sources.
<br>
::{{Par2|dfactor|float|4.0}}
:::Dfactor is the key variable for scene switch sensitivity. The higher dfactor the less scene begins and scene ends and the more global motion frames are detected. Dfactor=4.0 is the default value.
<br>
::{{Par2|debug|bool|false}}
:::If debug=true, then SCSelect sends output of the following type to the [http://technet.microsoft.com/en-us/library/bb896647.aspx DebugView] utility:
<div style="margin-left: 6em; max-width: 47em">
<pre>
[3416] [67865] SCSelect: global motion
[3416] [67866] SCSelect: global motion
[3416] [67870] SCSelect: global motion
[3416] [67871] SCSelect: global motion
[3416] [67873] SCSelect: global motion
[3416] [67874] SCSelect: global motion
[3416] [67877] SCSelect: global motion
[3416] [68318] SCSelect: global motion
[3416] [68319] SCSelect: global motion
[3416] [68557] SCSelect: scene end
[3416] [68558] SCSelect: scene begin
[3416] [69481] SCSelect: scene end
[3416] [69482] SCSelect: scene begin
[3416] [70240] SCSelect: scene end
[3416] [70241] SCSelect: scene begin
[3416] [70406] SCSelect: global motion
[3416] [70407] SCSelect: global motion
[3416] [70408] SCSelect: global motion
[3416] [70409] SCSelect: global motion
[3416] [70410] SCSelect: global motion
[3416] [72032] SCSelect: global motion
[3416] [72164] SCSelect: global motion
[3416] [72165] SCSelect: global motion
</pre>
</div>
:::To describe the basic idea behind SCSelect let SAD(n) be the SAD difference between the frames input(n) and input(n+1). Now, if SAD(n) > dfactor * SAD(n-1), then SCSelect recognizes a scene end and pulls the frame from the clip scene_end. If SAD(n-1) > dfactor * SAD(n), then SCSelect recognizes a scene begin and pulls the frame from the clip scene_begin. If both SAD(n) <= dfactor * SAD(n-1) and SAD(n-1) <= dfactor * SAD(n), then SCSelect recognizes a global motion and pulls the frame from the clip global_motion. From this description it is clear that dfactor must be > 1 for getting reasonable results. The above algorithm is optimized such that often only one and not two SADs are calculated for one requested frame. However, there are certain shortcomings. If a scene ends with global motion, then SCSelect often can't detect the scene end. If a scene begins with global motion, then SCSelect often can't detect the scene begin. These two effects are usually responsible if lonely scene begins and scene ends are detected by SCSelected, otherwise each scene begin should be preceded by a scene end. By refining the above algorithm we could avoid lonely scene begins and scene ends, but there is one situation, where even such a refinement fails. Namely if the scene ends with global motion and the new scene starts with global motion. Then a sharp scene switch can only be detected reliably with a good motion analysis, which would result in an extreme slow down of the filter.
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value).
<br>
::{{Par2|cache|int|2}}
::{{Par2|gcache|int|0}}
:::Undocumented parameters.
<br>

== RemoveDirt Script ==
RemoveDirt has now become a script function, which involves RestoreMotionBlocks and various filters from [[RgTools|RemoveGrain]] package.

During the tests I used the following script:

<pre>
function RemoveDirt(clip input, bool "_grey", int "repmode")
{
_grey=default(_grey, false)
repmode=default(repmode, 16)
clmode=17
clensed=Clense(input, grey=_grey, cache=4)
sbegin = ForwardClense(input, grey=_grey, cache=-1)
send = BackwardClense(input, grey=_grey, cache=-1)
alt=Repair(SCSelect(input, sbegin, send, clensed, debug=true), input, mode=repmode, modeU = _grey ? -1 : repmode )
restore=Repair(clensed, input, mode=repmode, modeU = _grey ? -1 : repmode)
corrected=RestoreMotionBlocks(clensed, restore, neighbour=input, alternative=alt, gmthreshold=70, dist=1, dmode=2, debug=false, noise=10, noisy=12, grey=_grey)
return RemoveGrain(corrected, mode=clmode, modeU = _grey ? -1 : clmode )
}
</pre>

Let us discuss this script in some detail. Firstly, we apply the brutal temporal clenser from the RemoveGrain package to obtain the clip "clensed". Then we use the filters ForwardClense and BackwardClense from RemoveGrain to construct the clip "alt", which is then used as the "alternative" variable in the subsequent RestoreMotionBlocks. While Clense does a lot of cleaning it certainly creates a lot of artifacts in motion areas. In RemoveDirt this repair is only made in motion areas. The static areas are not repaired. Since the clip is used only for restoring motion areas, we can use the much stronger Repair mode 16, which restores thin lines destroyed by clense. Finally, because there may be some left over from temporal cleaning especially when grain is dense, we use the spatial denoiser RemoveGrain(mode=17) to remove these dirt or grain rests.

=== Optimal Usage ===

1. If possible, crop after RestoreMotionBlocks. Modern codecs divide the frames in the same way as RemoveDirt into a grid of 8x8 pixel blocks to perform the crucial discret cosine transform for such blocks. Now if the clip is cropped after RemoveDirt, then the grid of RemoveDirt and the codec are likely to be different resulting in inferior compression. There is one exception, though: cropping afterwards does not hurt, if all four sides are cropped by a multiple of 8. For instance, crop(8,64,0,-72) is ok. On the other hand, one should crop after RemoveGrain/Repair if possible, because this filters cannot process the boundary pixels. Thus the optimal solution is to crop afterwards and then only by multiples of 8, which unfortunately is not always possible.

2. Avisynth 2.6 hint: Crop only with "align=true". RestoreMotionBlocks uses SSE2 instructions. If you crop without "align= true" before RestoreMotionBlocks, then the data on the frames may not be properly aligned and RemoveDirt will execute substantially slower. As a consequence you should always crop with Avisynth and not with DVD2AVI or DGIndex.
For Avisynth+ there is no need for such precautions, Crop is always producing aligned frames.

3. Telecined movies must be inverse telecined before RemoveDirt. If a film is telecined some fields are doubled in order to increase the frame rate from 24fps to 30fps. Hence on such doubled fields the basic property of dirt, described above, is no more valid and no temporal cleaner can ever spot dirt on such doubled fields. On the other hand, after an inverse telecine usually every fourth frame is composed of fields, which originate from two different frames. Visually these two fields fit together well but both are from a different compression context, which can mislead RemoveDirt to false motion detection. In extreme cases, one field may be from an I- or P-frame, while the other is from a B-frame. But even if the fields are from from frames of identical type, the different compression context has a substantial effect. Consequently RemoveDirt performes less well on inverse telecined movies than on natively progressive movies. By the same reason also compression of inverse telcined movies is worse than of natively progressive movies. We in Europe should thank god every day that we are not getting telecined. However, here in Germany we have digital tv broadcasters, which like to comb progressive films (about 5% of all progressive movies from ARD and especially ZDF are combed). Fortunately these idiots are not able to double fields, so RemoveDirt should work, but on combed films the dirt is always split over two frames which clearly hurts RemoveDirt. On the other hand, if these combed films are uncombed, then we have the compression context problem for any frame and not only for any fourth frame. Stepping through the video with the builtin filter Bob() one can decide with near absolute certainty, whether the video is truely progressive, interlaced, telecined, field blended or progressive with a field shift.

4. Put other filters after RemoveDirt. Except those filters mentioned before, like crop and inverse telecine, all other filters should be put after RemoveDirt in the Avisynth script, because most filters have a negative rather than a positive impact on dirt detection.
<br>
<br>
== Change Log ==

* v1.1 (20250108)
- Fix SCSelect (VapourSynth)

* v1.0 (20250108)
- Remove YUY2 support (not even with "planar hack")
- VapourSynth support (API 4) (dual Avisynth/VapourSynth plugin)
VS version supports the very same basic parameters like the Avisynth version except
some historical compatibility parameters:
- RestoreMotionBlocks is omitting "planar"
- SCSelect is omitting "planar", "cache", "gcache"

* v0.9.3 (20210223)
- Fix a crash, which can occur on non mod8 sources

* v0.9.2 (20190324)
- RestoreMotionBlocks: 10-16 bit support. Relevant threshold and noise parameters are bit depth independent.
- minor speedup
- SCSelect: add support for 10-16 bits and 32 bit float clips
- SCSelect: add support for planar RGB
- FIX: SCSelect: make it work properly for large frames (>8MPixel)
- FIX: SCSelect: Makes use the whole frame: now counts the rightmost non-mod32 pixels as well.
- Clang support (LLVM) with Visual Studio 2017
- update html docs
- add clang-built DLLs to the released version

* v0.9.1 (20190314)
- project moved to github: https://github.com/pinterf/RemoveDirt
- built using Visual Studio 2017
- x64 build for Avisynth+
- Added version resource to DLL
- Changed to AVS 2.6 plugin interface
- Fix: RestoreMotionBlocks: grey=false: it was copying 8x4 chroma pixels for YV12 and 8x8 for YUY2 instead of 4x4 and 8x4 blocks
- Fix: SCSelect: Old v0.9 SSE2 code omitted difference checking for every second 8 columns
- Removed MMX code, now requires SSE2
- Reports MT Modes for Avisynth+: [[MT_SERIALIZED]] for SCSelect
- Reports MT Modes for Avisynth+: [[MT_MULTI_INSTANCE]] for RestoreMotionBlocks (may not be any faster)
- Added Y, YV16 and YV24 support besides existing YV12 and planar-hacked-YUY2

* v0.9 (20050507)
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="100%"
|-
!!width="100px"| Version
!!width="300px"| Download
!!width="300px"| Mirror
!!width="500px"| Comments
!!width="500px"| Source code
|-
!v0.9
|[http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|[https://web.archive.org/web/20150405173333if_/http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|includes statically and dynamically linked [[SSE2]] binaries compiled with MSVC2010. Dynamically linked binaries requires the [http://www.microsoft.com/en-us/download/details.aspx?id=8328 Microsoft Visual C++ 2010 Redistributable Package (x86)] to be installed.
|Included with the binaries.
|-
!v0.9
|<strike>[https://web.archive.org/web/20140723074402if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.zip ReduceDirt.zip]</strike>
|
|includes 3 binaries: one statically linked (<tt>RemoveDirtS.dll</tt>) and two dynamically linked (<tt>RemoveDirt.dll, RemoveDirtSSE2.dll</tt>).
SSE2 version is recommended but unfortunately it requires the <tt>Msvcr71.dll</tt> runtime component from the very ancient Microsoft Visual C++ .NET 2003. For this reason this package is considered deprecated!
|[https://web.archive.org/web/20141121054131if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt-src.zip ReduceDirt-src.zip]
|-
!v0.6.1
|[https://web.archive.org/web/20050215121957if_/http://home.pages.at/kassandro/RemoveDirt/RemoveDirt.zip RemoveDirt.zip]
|
|Old archived documentation: [https://web.archive.org/web/20050311122626/http://www.removedirt.de.tf www.removedirt.de.tf]
|}
<br>
== External Links ==
*[https://web.archive.org/web/20160610102940/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.htm RemoveDirt.htm] - official v0.9 documentation.
*http://forum.doom9.org/showthread.php?p=641337#post641337
*http://forum.doom9.org/showthread.php?p=1560013&highlight=scselect#post1560013
*http://forum.doom9.org/showthread.php?p=1564754&highlight=scselect#post1564754
*http://forum.doom9.org/showthread.php?p=1518730&highlight=scselect#post1518730
*http://forum.doom9.org/showthread.php?p=1409324#post1409324
*http://forum.doom9.org/showthread.php?p=1483843&highlight=scselect#post1483843
*http://forum.doom9.org/showthread.php?p=1488392&highlight=scselect#post1488392
*http://forum.doom9.org/showthread.php?p=1479632&highlight=scselect#post1479632
*http://forum.doom9.org/showthread.php?t=145753&highlight=scselect&page=2
*http://forum.doom9.org/showthread.php?p=1206869&highlight=scselect#post1206869
*http://forum.doom9.org/showthread.php?p=1351709&highlight=scselect#post1351709
*http://forum.doom9.org/showthread.php?p=1405939&highlight=scselect#post1405939
*http://forum.doom9.org/showthread.php?p=1205317&highlight=scselect#post1205317
*http://forum.doom9.org/showthread.php?p=1507954&highlight=scselect#post1507954
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Luma_Equalization|External Filters]] ←'''

RemoveDirt

2025-01-09T07:14:58Z

Pinterf: New version 1.1

{{FilterCat6|External_filters|Plugins|Plugins_x64|Restoration_filters|Luma_equalization|Deep_color_tools}}
{{Filter3
| {{Author/kassandro}}, {{Author/pinterf}}
| v1.1
| [http://github.com/pinterf/RemoveDirt/releases RemoveDirt-1.1.7z]
| Luma Equalization
| [http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[http://forum.doom9.org/showthread.php?t=70856 Doom9 Thread (original)], [http://forum.doom9.org/showthread.php?t=176199 Doom9 Thread (update)]}}

== Description ==
RemoveDirt is a temporal cleaner for AviSynth 2.6, [[AviSynth+]] and VapourSynth. It has now become a script function which involves RestoreMotionBlocks and various filters from the [[RgTools|RemoveGrain]] package.
<br>
<br>
The plugin contains 2 filters:
*[[#RestoreMotionBlocks|RestoreMotionBlocks]] which is the main function used in the [[#RemoveDirt Script|RemoveDirt script]].
*[[#SCSelect|SCSelect]] is a scence change detention filter meant to be use with RestoreMotionBlocks.
<br>

== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: All [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported. [[#SCSelect|SCSelect]] also supports 32-bit float and planar RGB.
<br>

== [[Script variables|Syntax and Parameters]] ==

===RestoreMotionBlocks===
:{{Template:FuncDef|RestoreMotionBlocks (clip filtered, clip restore, clip "neighbour", clip "neighbour2", clip "alternative", bool "planar", bool "show", bool "debug", int "gmthreshold", int "mthreshold", int "noise", int "noisy", int "dist", int "tolerance", int "dmode", int "pthreshold", int "cthreshold", bool "grey")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2|neighbour|clip| }}
::{{Par2|neighbour2|clip| }}
::{{Par2|alternative|clip| }}
:::The first five variables are clip variables. All clips must be of the same type (same width, height and color space). The number of frames is the minimum of the length of all these five clips. The first two variables are mandatory and are unnamed. "filtered" is usually an aggressively filtered clip, from which motion artifacts have to removed. If RestoreMotionBlocks identfies an 8x8 block as a motion block, it copies this block from the clip "restore" to the clip "filtered". This is the basic operation of RestoreMotionBlocks. To identify motion blocks RestoreMotionBlocks uses the clip "neighbour". The default value for neighbour is the "restore" clip. However, in the RemoveDirt script "neighbour" is different from "restore".
:::*The "neighbour2" is for using RemoveDirt in combination with motion compensation filters like [[MVTools]] (see RemoveDirtMC below). Finally, if the number of motion blocks exceeds the percentage specified in the "gmthreshold" variable, then RestoreMotionBlocks simply takes the frame from the clip "alternative". In this way, scene switches or global motion can be handled specifically. The clip "restore" is the default value for "alternative".
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value).
<br>
::{{Par2|show|bool|false}}
::{{Par2|debug|bool|false}}
:::The boolean variables "show" and "debug" are used for debugging (see section Debugging).
<br>
::{{Par2|gmthreshold|int|80}}
:::The default value for gmthreshold is 80, i.e. if 80% of the blocks are motion blocks, then the frame is taken from "alternative" clip.
<br>
::{{Par2|mthreshold|int|160}}
:::"mthreshold" is similar as in the old RemoveDirt. However, because we now use the ordinary SAD for block comparison, the values should be somewhat higher, especially if the value of noise is low. The default value for "mthreshold" is 160
<br>
::{{Par2|noise|int|0}}
::{{Par2|noisy|int|-1}}
:::With the variable "noise" one can specify a noise level, which should be ignored by the motion detection. The default value of "noise" is 0.
:::The variable "noisy" is used to specify the number of noisy pixels of an 8x8 block, which must be exceeded for a motion block. The default value of "noisy" is -1.
:::If noisy >= 0 and noise > 0, then the value of "mthreshold" is ignored.
<br>
::{{Par2|dist|int|1}}
::{{Par2|tolerance|int|12}}
:::dist and tolerance control basic motion detection. dist=1 and tolerance=12 are the default values. A block B is considered a neighbor of a block A by RestoreMotionBlocks, if both horizontally and vertically both blocks are only dist blocks apart. For dist=0 a block has only one neighbor, the block itself. If dist=1, then a block has 9 neighbors, if it is not located at the boundary. If dist=2, then each inner block has 25 neighbors and if dist= 3 then it has 49 neighbors etc.. Now for a given block RestoreMotionBlocks counts all the neighbor blocks which are marked as motion blocks. If the percentage of motion blocks among all neighbor blocks exceeds the value of tolerance, then the block is not cleaned. Thus in the default case of 9 neighbor blocks and tolerance=12 one motion block is allowed and cleaning will nevertheless be allowed. In particular, a motion block is cleaned, if it has no other motion blocks as neighbors. This is reasonable, because motion rarely occurs on one tiny block alone. On the other, if motion blocks have a certain density then also the neighbors should not be cleaned. This is the idea behind the variables dist and tolerance. A higher value of dist results in less cleaning. The higher the value of tolerance, the more cleaning. If tolerance >=100 then all blocks are cleaned.
<br>
::{{Par2|dmode|int|0}}
:::*If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit.
:::*If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is discarded if there exists no further phase 1 motion block with a distance less than 1.
:::*Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded.
<br>
::{{Par2|pthreshold|int|10}}
::{{Par2|cthreshold|int|pthreshold}}
:::Parameters "pthreshold" and "cthreshold" are thresholds for luma and chroma, respectively. For 10-16 bits (where actual pixel values and thus SAD values are larger) the parameter is automatically normalized internally. You can keep it the same across different formats for the same effect.<br>For postprocessing RestoreMotionBlocks uses the variable pthreshold and cthreshold. If the total luma difference of the two adjacent border line increases by more than pthreshold, then cleaning of the block is undone by RestoreMotionBlocks. Similarily cleaning is undone, if the chroma difference exceedes cthreshold. The maximal difference of 8 pixels is 8*255. If cthreshold is larger than this value, then chroma postprocessing is disabled. If both, pthreshold and cthreshold, are larger than the maximal value, then postprocessing is completely disabled. pthreshold=10 is the default value and if nothing else is specified cthreshold has the same value as pthreshold. Clearly luma postprocessing is much more important than chroma postprocessing. If cthreshold and especially pthreshold, then rather unpleasant blocky artifacts become visible. These are much more likely in areas with very flat contrast. Of course, there must be motion as well to get such artifacts. If you see these typical blocky artifacts, you should lower the thresholds. Postprocessing should only be disabled if all the cleaned frames are checked for artifacts. By the very nature of the algorithm no postprocessing will occur if all blocks were cleaned. There must be at least one block, which has not been cleaned to trigger postprocessing. The postprocessing algorithm loops through all the blocks as long as it can find blocks to be restored, nevertheless it is quite efficient. It is the basic philosophy of RestoreMotionBlocks, that motion detection needs only detect at least one but not all blocks of a moving object. The rest is then taken care by postprocessing.

:::Negative values are allowed for pthreshold and cthreshold, but are not very reasonable.
<br>
::{{Par2|grey|bool|false}}
:::If grey=true the chroma of the clip "filtered" is not touched by RestoreMotionBlocks. Also for postprocessing only the luma is used. This is slightly faster than grey=false. If you use grey=false for b&w clips, then it not only takes longer but also the quality may degrade, because chroma noise may trigger false postprocessing. Thus "grey=true" is highly recommended for b&w clips. <br>Greyscale (Y8..Y16) clips are automatically treated as grey=true.
<br>
====How RestoreMotionBlocks works====
To use the above variables properly, one has to understand how RestoreMotionBlocks works. It consists of three phases. For the first phase only the clip "neighbour" is used. Each frame is divided into a grid of 8x8 blocks. If n is the number of the current frame, then for each block of this grid RestoreMotionBlocks looks at the luma of this block in neighbour(n-1) and neighbour(n+1). Note that we don't use the frame neighbour(n). There are three comparison methods (the old RemoveDirt has only one).
#If noise= 0, then simply the SAD of each block in neighbour(n-1) and neighbour(n+1) is computed. If it is >= mthreshold, the block is identified as a motion block of frame n. This is the fasted method and a similar method was used in the old RemoveDirt. Its key disadvantage is that it may easily misled by noise.
#If noise >=0, then instead of SUM(|y-x|) RestoerMotionBlocks calculates SUM(| |y-x|-noise |). In particular, differences with absolute value <= noise are ignored. If it is >= mthreshold, then this block is identified as a motion block. We call this the noise adjusted SAD. From the way how the noise adjusted SAD is calculated, it is clear, that "mthreshold" should be decreased if "noise" is increased.
#If noise >= 0 and noisy >= 0, then RestoreMotionblocks counts the number of pixels of a block, for which the absolute difference between neighbour(n-1) and neighbour(n+1) is >= noise. If this number is >= value of "noisy", then the block is identified as a motion block. We call this the NPC (= noisy pixel counting) method. The value of mthreshold is ignored, if NPC is selected.
Note that a block has 64 pixels. Thus, if noisy > 64, then there can't be any motion blocks. In my view NPC is clearly the best method. It has likely about half the speed of SAD and about the same speed as NSAD. Noise=-1 and noisy=-1 are the default values. Thus SAD is the default method for the first phase. I ran most of my RemoveDirt tests with noise=8 or 10 and noisy= 12.

In the sequel the motion blocks found in the first phase are called phase 1 motion blocks. In the second phase, for each block all the motion blocks found in the first phase which have a distance <= dist are counted. If the result is >= (tolerance /100) * (the number of all first phase blocks with distance <= dist) , then this block is called a motion neighbour block. For instance, if dist = 1 and tolerance= 12 (the default values), then there are 9 blocks with a distance <= 1. Since 1 < (12/100)*9 < 2, there must be at least 2 phase 1 motion blocks among the 9 neighbour blocks such that the block is marked as a motion neighbour block. If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit. If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is dicarded if there exists no further phase 1 motion block with a distance less than 1. Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded. If dist=0 or dmode=2 gmthreshold should be lowered to 60 or even 50.

The third phase, called the postprocessing phase, starts with restoring the phase 2 motion blocks by copying them from the clip "restore" to the clip "filtered". All phase 2 motion blocks become also phase 3 motion blocks. Then the edges between motion and non-motion blocks are inspected. To this end the SAD of the two adjacent border line segments is calculated twice (these line segments are either horizontal or vertical and are 8 pixels long). It is calculated first in the clip "restore" and then in the clip "filtered". In the clip "filtered" the two blocks are from two different sources, one block, the motion block was restored from the clip "restore" and the non-motion block is from the original clip "filtered". Since the frames of the clip "restore" are not changed at all, both blocks are from the same source and should therefore fit together. If the edge SAD in the clip "filtered" > (edge SAD in the clip restore) + pthreshold, then the block is marked as a new (additional) phase 3 motion block and the block is restored by copying it from "restore" to "filtered", because the two blocks in "filtered" don't fit together well enough compared with the two blocks in "restore". In other words, in this phase, it is checked whether a restored block fits to the yet unrestored blocks. If it doesn't, the not yet restored blocks, which do not fit well, are marked as phase 3 motion blocks and are restored as well. This procedure is repeated until there are no more blocks, which can be tested. If the value of the grey variable is false, then the same is done for the luma and the chroma (for the chroma the variable cthreshold is used instead of pthreshold). If grey= true, then postprocessing is only done for the luma.
Finally, if the percentage of all phase 3 motion blocks with respect to all blocks exceeds the value of gmthreshold, then the "filtered" frame is discarded and replaced by the corresponding frame in "alternative". In this way, we can give special treatments for sharp scene switches and scenes with a moving or zooming camera.
<br>
<br>
====Debugging====

The boolean variable debug and show are used for debugging. If show=true, then the blocks, which are marked as motion blocks in the first phase are colored red, those found in the second phase are colored green and finally the motion blocks marked by postprocessing are colored blue. In this way, one can easily check whether the above variables were selected appropriately. if debug=true, then RestoreMotionBlocks sends output of the following kind to the debugview utility:

<pre>
[348] [21495] RemoveDirt: motion blocks = 942(14%), 1652(25%), 635( 9%), loops = 31
[348] [21496] RemoveDirt: motion blocks = 1745(26%), 2330(35%), 64( 0%), loops = 3
[348] [21497] RemoveDirt: motion blocks = 1480(22%), 1973(30%), 45( 0%), loops = 4
[348] [21498] RemoveDirt: motion blocks = 1081(16%), 1915(29%), 65( 1%), loops = 2
[348] [21499] RemoveDirt: motion blocks = 1403(21%), 2380(36%), 235( 3%), loops = 10
[348] [21500] RemoveDirt: motion blocks = 2618(40%), 2204(34%), 59( 0%), loops = 5
[348] [21501] RemoveDirt: motion blocks = 986(15%), 2065(31%), 75( 1%), loops = 3
[348] [21502] RemoveDirt: motion blocks = 1214(18%), 2291(35%), 78( 1%), loops = 3
[348] [21503] RemoveDirt: motion blocks = 1348(20%), 2179(33%), 57( 0%), loops = 4
[348] [21504] RemoveDirt: motion blocks = 961(14%), 1957(30%), 71( 1%), loops = 3
[348] [21505] RemoveDirt: motion blocks = 1833(28%), 2201(33%), 38( 0%), loops = 3
[348] [21506] RemoveDirt: motion blocks = 1644(25%), 2183(33%), 53( 0%), loops = 5
[348] [21507] RemoveDirt: motion blocks = 1420(21%), 2541(39%), 132( 2%), loops = 5
[348] [21508] RemoveDirt: motion blocks = 2238(34%), 2229(34%), 104( 1%), loops = 4
[348] [21509] RemoveDirt: motion blocks = 1351(20%), 2294(35%), 181( 2%), loops = 6
[348] [21510] RemoveDirt: motion blocks = 931(14%), 1800(27%), 229( 3%), loops = 5
</pre>

The first number in brackets on the left hand side is the id of the process, which runs the script, the second number in brackets is the frame number. The first number (with percentages in brackets) after "motion blocks =" is the number of phase 1 motion blocks, the second is the difference between phase 2 and phase 1 motion blocks (always >=0 if dmode=0, always <= 0 if dmode= 2) and the third is the difference between phase 3 and phase 2 motion blocks (always >= 0). Finally the number after "loops =" is the number of postprocessing loops used for this frame. Debug=true can be used to monitor RestoreMotionBlocks in an encoding process. Of course, show=true can only be used before an encoding process to find the right values for the various variables.
<br>
<br>

----

===SCSelect===
SCSelect is a special filter, which distinguishes between scene begins, scene ends and global motion. The output of SCClense is used as an "alternative" clip for RestoreMotionBlocks. It can hardly used for other purposes, because it can only make proper decisions if there are a lot of motion blocks. Only if the percentage of motion blocks is > gmthreshold, then RestoreMotionBlocks chooses a frame from the clip specified with the alternative variable and then there are always a lot of motion blocks, if gmthreshold is not too small (gmthreshold >= 30 should be sufficiently large). SCSelect yields nonsense results if there are only few motion blocks. SCSelect is used as follows:

:{{Template:FuncDef|SCSelect (clip input, clip scene_begin, clip scene_end, clip global_motion, float "dfactor", bool "debug", bool "planar", int "cache", int "gcache")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
:::The first four clip variables are mandatory and have no name. All four clips must have the same color space, width and height. The first clip is the clip, on which SCSelect bases its decision. Usually it should be the same clip, which was specified with the "neighbour" variable in RestoreMotionBlocks. If SCSelect realises a scene begin, it selects its output frame from the clip scene_begin. If SCSelect realises a scene end, it selects its output frame from the clip scene_end. If SCSelect realises a global motion, it selects its output frame from the clip global motion. Thus SCSelect doesn't produce any new frames. It only makes a selection from three different sources.
<br>
::{{Par2|dfactor|float|4.0}}
:::Dfactor is the key variable for scene switch sensitivity. The higher dfactor the less scene begins and scene ends and the more global motion frames are detected. Dfactor=4.0 is the default value.
<br>
::{{Par2|debug|bool|false}}
:::If debug=true, then SCSelect sends output of the following type to the [http://technet.microsoft.com/en-us/library/bb896647.aspx DebugView] utility:
<div style="margin-left: 6em; max-width: 47em">
<pre>
[3416] [67865] SCSelect: global motion
[3416] [67866] SCSelect: global motion
[3416] [67870] SCSelect: global motion
[3416] [67871] SCSelect: global motion
[3416] [67873] SCSelect: global motion
[3416] [67874] SCSelect: global motion
[3416] [67877] SCSelect: global motion
[3416] [68318] SCSelect: global motion
[3416] [68319] SCSelect: global motion
[3416] [68557] SCSelect: scene end
[3416] [68558] SCSelect: scene begin
[3416] [69481] SCSelect: scene end
[3416] [69482] SCSelect: scene begin
[3416] [70240] SCSelect: scene end
[3416] [70241] SCSelect: scene begin
[3416] [70406] SCSelect: global motion
[3416] [70407] SCSelect: global motion
[3416] [70408] SCSelect: global motion
[3416] [70409] SCSelect: global motion
[3416] [70410] SCSelect: global motion
[3416] [72032] SCSelect: global motion
[3416] [72164] SCSelect: global motion
[3416] [72165] SCSelect: global motion
</pre>
</div>
:::To describe the basic idea behind SCSelect let SAD(n) be the SAD difference between the frames input(n) and input(n+1). Now, if SAD(n) > dfactor * SAD(n-1), then SCSelect recognizes a scene end and pulls the frame from the clip scene_end. If SAD(n-1) > dfactor * SAD(n), then SCSelect recognizes a scene begin and pulls the frame from the clip scene_begin. If both SAD(n) <= dfactor * SAD(n-1) and SAD(n-1) <= dfactor * SAD(n), then SCSelect recognizes a global motion and pulls the frame from the clip global_motion. From this description it is clear that dfactor must be > 1 for getting reasonable results. The above algorithm is optimized such that often only one and not two SADs are calculated for one requested frame. However, there are certain shortcomings. If a scene ends with global motion, then SCSelect often can't detect the scene end. If a scene begins with global motion, then SCSelect often can't detect the scene begin. These two effects are usually responsible if lonely scene begins and scene ends are detected by SCSelected, otherwise each scene begin should be preceded by a scene end. By refining the above algorithm we could avoid lonely scene begins and scene ends, but there is one situation, where even such a refinement fails. Namely if the scene ends with global motion and the new scene starts with global motion. Then a sharp scene switch can only be detected reliably with a good motion analysis, which would result in an extreme slow down of the filter.
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value).
<br>
::{{Par2|cache|int|2}}
::{{Par2|gcache|int|0}}
:::Undocumented parameters.
<br>

== RemoveDirt Script ==
RemoveDirt has now become a script function, which involves RestoreMotionBlocks and various filters from [[RgTools|RemoveGrain]] package.

During the tests I used the following script:

<pre>
function RemoveDirt(clip input, bool "_grey", int "repmode")
{
_grey=default(_grey, false)
repmode=default(repmode, 16)
clmode=17
clensed=Clense(input, grey=_grey, cache=4)
sbegin = ForwardClense(input, grey=_grey, cache=-1)
send = BackwardClense(input, grey=_grey, cache=-1)
alt=Repair(SCSelect(input, sbegin, send, clensed, debug=true), input, mode=repmode, modeU = _grey ? -1 : repmode )
restore=Repair(clensed, input, mode=repmode, modeU = _grey ? -1 : repmode)
corrected=RestoreMotionBlocks(clensed, restore, neighbour=input, alternative=alt, gmthreshold=70, dist=1, dmode=2, debug=false, noise=10, noisy=12, grey=_grey)
return RemoveGrain(corrected, mode=clmode, modeU = _grey ? -1 : clmode )
}
</pre>

Let us discuss this script in some detail. Firstly, we apply the brutal temporal clenser from the RemoveGrain package to obtain the clip "clensed". Then we use the filters ForwardClense and BackwardClense from RemoveGrain to construct the clip "alt", which is then used as the "alternative" variable in the subsequent RestoreMotionBlocks. While Clense does a lot of cleaning it certainly creates a lot of artifacts in motion areas. In RemoveDirt this repair is only made in motion areas. The static areas are not repaired. Since the clip is used only for restoring motion areas, we can use the much stronger Repair mode 16, which restores thin lines destroyed by clense. Finally, because there may be some left over from temporal cleaning especially when grain is dense, we use the spatial denoiser RemoveGrain(mode=17) to remove these dirt or grain rests.

=== Optimal Usage ===

1. If possible, crop after RestoreMotionBlocks. Modern codecs divide the frames in the same way as RemoveDirt into a grid of 8x8 pixel blocks to perform the crucial discret cosine transform for such blocks. Now if the clip is cropped after RemoveDirt, then the grid of RemoveDirt and the codec are likely to be different resulting in inferior compression. There is one exception, though: cropping afterwards does not hurt, if all four sides are cropped by a multiple of 8. For instance, crop(8,64,0,-72) is ok. On the other hand, one should crop after RemoveGrain/Repair if possible, because this filters cannot process the boundary pixels. Thus the optimal solution is to crop afterwards and then only by multiples of 8, which unfortunately is not always possible.

2. Avisynth 2.6 hint: Crop only with "align=true". RestoreMotionBlocks uses SSE2 instructions. If you crop without "align= true" before RestoreMotionBlocks, then the data on the frames may not be properly aligned and RemoveDirt will execute substantially slower. As a consequence you should always crop with Avisynth and not with DVD2AVI or DGIndex.
For Avisynth+ there is no need for such precautions, Crop is always producing aligned frames.

3. Telecined movies must be inverse telecined before RemoveDirt. If a film is telecined some fields are doubled in order to increase the frame rate from 24fps to 30fps. Hence on such doubled fields the basic property of dirt, described above, is no more valid and no temporal cleaner can ever spot dirt on such doubled fields. On the other hand, after an inverse telecine usually every fourth frame is composed of fields, which originate from two different frames. Visually these two fields fit together well but both are from a different compression context, which can mislead RemoveDirt to false motion detection. In extreme cases, one field may be from an I- or P-frame, while the other is from a B-frame. But even if the fields are from from frames of identical type, the different compression context has a substantial effect. Consequently RemoveDirt performes less well on inverse telecined movies than on natively progressive movies. By the same reason also compression of inverse telcined movies is worse than of natively progressive movies. We in Europe should thank god every day that we are not getting telecined. However, here in Germany we have digital tv broadcasters, which like to comb progressive films (about 5% of all progressive movies from ARD and especially ZDF are combed). Fortunately these idiots are not able to double fields, so RemoveDirt should work, but on combed films the dirt is always split over two frames which clearly hurts RemoveDirt. On the other hand, if these combed films are uncombed, then we have the compression context problem for any frame and not only for any fourth frame. Stepping through the video with the builtin filter Bob() one can decide with near absolute certainty, whether the video is truely progressive, interlaced, telecined, field blended or progressive with a field shift.

4. Put other filters after RemoveDirt. Except those filters mentioned before, like crop and inverse telecine, all other filters should be put after RemoveDirt in the Avisynth script, because most filters have a negative rather than a positive impact on dirt detection.
<br>
<br>
== Change Log ==

* v1.1 (20250108)
- Fix SCSelect (VapourSynth)

* v1.0 (20250108)
- Remove YUY2 support (not even with "planar hack")
- VapourSynth support (API 4) (dual Avisynth/VapourSynth plugin)
VS version supports the very same basic parameters like the Avisynth version except
some historical compatibility parameters:
- RestoreMotionBlocks is omitting "planar"
- SCSelect is omitting "planar", "cache", "gcache"

* v0.9.3 (20210223)
- Fix a crash, which can occur on non mod8 sources

* v0.9.2 (20190324)
- RestoreMotionBlocks: 10-16 bit support. Relevant threshold and noise parameters are bit depth independent.
- minor speedup
- SCSelect: add support for 10-16 bits and 32 bit float clips
- SCSelect: add support for planar RGB
- FIX: SCSelect: make it work properly for large frames (>8MPixel)
- FIX: SCSelect: Makes use the whole frame: now counts the rightmost non-mod32 pixels as well.
- Clang support (LLVM) with Visual Studio 2017
- update html docs
- add clang-built DLLs to the released version

* v0.9.1 (20190314)
- project moved to github: https://github.com/pinterf/RemoveDirt
- built using Visual Studio 2017
- x64 build for Avisynth+
- Added version resource to DLL
- Changed to AVS 2.6 plugin interface
- Fix: RestoreMotionBlocks: grey=false: it was copying 8x4 chroma pixels for YV12 and 8x8 for YUY2 instead of 4x4 and 8x4 blocks
- Fix: SCSelect: Old v0.9 SSE2 code omitted difference checking for every second 8 columns
- Removed MMX code, now requires SSE2
- Reports MT Modes for Avisynth+: [[MT_SERIALIZED]] for SCSelect
- Reports MT Modes for Avisynth+: [[MT_MULTI_INSTANCE]] for RestoreMotionBlocks (may not be any faster)
- Added Y, YV16 and YV24 support besides existing YV12 and planar-hacked-YUY2

* v0.9 (20050507)
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="100%"
|-
!!width="100px"| Version
!!width="300px"| Download
!!width="300px"| Mirror
!!width="500px"| Comments
!!width="500px"| Source code
|-
!v0.9
|[http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|[https://web.archive.org/web/20150405173333if_/http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|includes statically and dynamically linked [[SSE2]] binaries compiled with MSVC2010. Dynamically linked binaries requires the [http://www.microsoft.com/en-us/download/details.aspx?id=8328 Microsoft Visual C++ 2010 Redistributable Package (x86)] to be installed.
|Included with the binaries.
|-
!v0.9
|<strike>[https://web.archive.org/web/20140723074402if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.zip ReduceDirt.zip]</strike>
|
|includes 3 binaries: one statically linked (<tt>RemoveDirtS.dll</tt>) and two dynamically linked (<tt>RemoveDirt.dll, RemoveDirtSSE2.dll</tt>).
SSE2 version is recommended but unfortunately it requires the <tt>Msvcr71.dll</tt> runtime component from the very ancient Microsoft Visual C++ .NET 2003. For this reason this package is considered deprecated!
|[https://web.archive.org/web/20141121054131if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt-src.zip ReduceDirt-src.zip]
|-
!v0.6.1
|[https://web.archive.org/web/20050215121957if_/http://home.pages.at/kassandro/RemoveDirt/RemoveDirt.zip RemoveDirt.zip]
|
|Old archived documentation: [https://web.archive.org/web/20050311122626/http://www.removedirt.de.tf www.removedirt.de.tf]
|}
<br>
== External Links ==
*[https://web.archive.org/web/20160610102940/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.htm RemoveDirt.htm] - official v0.9 documentation.
*http://forum.doom9.org/showthread.php?p=641337#post641337
*http://forum.doom9.org/showthread.php?p=1560013&highlight=scselect#post1560013
*http://forum.doom9.org/showthread.php?p=1564754&highlight=scselect#post1564754
*http://forum.doom9.org/showthread.php?p=1518730&highlight=scselect#post1518730
*http://forum.doom9.org/showthread.php?p=1409324#post1409324
*http://forum.doom9.org/showthread.php?p=1483843&highlight=scselect#post1483843
*http://forum.doom9.org/showthread.php?p=1488392&highlight=scselect#post1488392
*http://forum.doom9.org/showthread.php?p=1479632&highlight=scselect#post1479632
*http://forum.doom9.org/showthread.php?t=145753&highlight=scselect&page=2
*http://forum.doom9.org/showthread.php?p=1206869&highlight=scselect#post1206869
*http://forum.doom9.org/showthread.php?p=1351709&highlight=scselect#post1351709
*http://forum.doom9.org/showthread.php?p=1405939&highlight=scselect#post1405939
*http://forum.doom9.org/showthread.php?p=1205317&highlight=scselect#post1205317
*http://forum.doom9.org/showthread.php?p=1507954&highlight=scselect#post1507954
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Luma_Equalization|External Filters]] ←'''

RemoveDirt

2025-01-09T07:11:57Z

Pinterf: /* Description */

{{FilterCat6|External_filters|Plugins|Plugins_x64|Restoration_filters|Luma_equalization|Deep_color_tools}}
{{Filter3
| {{Author/kassandro}}, {{Author/pinterf}}
| v0.9.2
| [http://github.com/pinterf/RemoveDirt/releases RemoveDirt-0.9.2.7z]
| Luma Equalization
| [http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[http://forum.doom9.org/showthread.php?t=70856 Doom9 Thread (original)], [http://forum.doom9.org/showthread.php?t=176199 Doom9 Thread (update)]}}

== Description ==
RemoveDirt is a temporal cleaner for AviSynth 2.6, [[AviSynth+]] and VapourSynth. It has now become a script function which involves RestoreMotionBlocks and various filters from the [[RgTools|RemoveGrain]] package.
<br>
<br>
The plugin contains 2 filters:
*[[#RestoreMotionBlocks|RestoreMotionBlocks]] which is the main function used in the [[#RemoveDirt Script|RemoveDirt script]].
*[[#SCSelect|SCSelect]] is a scence change detention filter meant to be use with RestoreMotionBlocks.
<br>

== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: All [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported. [[#SCSelect|SCSelect]] also supports 32-bit float and planar RGB.
<br>

== [[Script variables|Syntax and Parameters]] ==

===RestoreMotionBlocks===
:{{Template:FuncDef|RestoreMotionBlocks (clip filtered, clip restore, clip "neighbour", clip "neighbour2", clip "alternative", bool "planar", bool "show", bool "debug", int "gmthreshold", int "mthreshold", int "noise", int "noisy", int "dist", int "tolerance", int "dmode", int "pthreshold", int "cthreshold", bool "grey")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2|neighbour|clip| }}
::{{Par2|neighbour2|clip| }}
::{{Par2|alternative|clip| }}
:::The first five variables are clip variables. All clips must be of the same type (same width, height and color space). The number of frames is the minimum of the length of all these five clips. The first two variables are mandatory and are unnamed. "filtered" is usually an aggressively filtered clip, from which motion artifacts have to removed. If RestoreMotionBlocks identfies an 8x8 block as a motion block, it copies this block from the clip "restore" to the clip "filtered". This is the basic operation of RestoreMotionBlocks. To identify motion blocks RestoreMotionBlocks uses the clip "neighbour". The default value for neighbour is the "restore" clip. However, in the RemoveDirt script "neighbour" is different from "restore".
:::*The "neighbour2" is for using RemoveDirt in combination with motion compensation filters like [[MVTools]] (see RemoveDirtMC below). Finally, if the number of motion blocks exceeds the percentage specified in the "gmthreshold" variable, then RestoreMotionBlocks simply takes the frame from the clip "alternative". In this way, scene switches or global motion can be handled specifically. The clip "restore" is the default value for "alternative".
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value).
<br>
::{{Par2|show|bool|false}}
::{{Par2|debug|bool|false}}
:::The boolean variables "show" and "debug" are used for debugging (see section Debugging).
<br>
::{{Par2|gmthreshold|int|80}}
:::The default value for gmthreshold is 80, i.e. if 80% of the blocks are motion blocks, then the frame is taken from "alternative" clip.
<br>
::{{Par2|mthreshold|int|160}}
:::"mthreshold" is similar as in the old RemoveDirt. However, because we now use the ordinary SAD for block comparison, the values should be somewhat higher, especially if the value of noise is low. The default value for "mthreshold" is 160
<br>
::{{Par2|noise|int|0}}
::{{Par2|noisy|int|-1}}
:::With the variable "noise" one can specify a noise level, which should be ignored by the motion detection. The default value of "noise" is 0.
:::The variable "noisy" is used to specify the number of noisy pixels of an 8x8 block, which must be exceeded for a motion block. The default value of "noisy" is -1.
:::If noisy >= 0 and noise > 0, then the value of "mthreshold" is ignored.
<br>
::{{Par2|dist|int|1}}
::{{Par2|tolerance|int|12}}
:::dist and tolerance control basic motion detection. dist=1 and tolerance=12 are the default values. A block B is considered a neighbor of a block A by RestoreMotionBlocks, if both horizontally and vertically both blocks are only dist blocks apart. For dist=0 a block has only one neighbor, the block itself. If dist=1, then a block has 9 neighbors, if it is not located at the boundary. If dist=2, then each inner block has 25 neighbors and if dist= 3 then it has 49 neighbors etc.. Now for a given block RestoreMotionBlocks counts all the neighbor blocks which are marked as motion blocks. If the percentage of motion blocks among all neighbor blocks exceeds the value of tolerance, then the block is not cleaned. Thus in the default case of 9 neighbor blocks and tolerance=12 one motion block is allowed and cleaning will nevertheless be allowed. In particular, a motion block is cleaned, if it has no other motion blocks as neighbors. This is reasonable, because motion rarely occurs on one tiny block alone. On the other, if motion blocks have a certain density then also the neighbors should not be cleaned. This is the idea behind the variables dist and tolerance. A higher value of dist results in less cleaning. The higher the value of tolerance, the more cleaning. If tolerance >=100 then all blocks are cleaned.
<br>
::{{Par2|dmode|int|0}}
:::*If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit.
:::*If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is discarded if there exists no further phase 1 motion block with a distance less than 1.
:::*Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded.
<br>
::{{Par2|pthreshold|int|10}}
::{{Par2|cthreshold|int|pthreshold}}
:::Parameters "pthreshold" and "cthreshold" are thresholds for luma and chroma, respectively. For 10-16 bits (where actual pixel values and thus SAD values are larger) the parameter is automatically normalized internally. You can keep it the same across different formats for the same effect.<br>For postprocessing RestoreMotionBlocks uses the variable pthreshold and cthreshold. If the total luma difference of the two adjacent border line increases by more than pthreshold, then cleaning of the block is undone by RestoreMotionBlocks. Similarily cleaning is undone, if the chroma difference exceedes cthreshold. The maximal difference of 8 pixels is 8*255. If cthreshold is larger than this value, then chroma postprocessing is disabled. If both, pthreshold and cthreshold, are larger than the maximal value, then postprocessing is completely disabled. pthreshold=10 is the default value and if nothing else is specified cthreshold has the same value as pthreshold. Clearly luma postprocessing is much more important than chroma postprocessing. If cthreshold and especially pthreshold, then rather unpleasant blocky artifacts become visible. These are much more likely in areas with very flat contrast. Of course, there must be motion as well to get such artifacts. If you see these typical blocky artifacts, you should lower the thresholds. Postprocessing should only be disabled if all the cleaned frames are checked for artifacts. By the very nature of the algorithm no postprocessing will occur if all blocks were cleaned. There must be at least one block, which has not been cleaned to trigger postprocessing. The postprocessing algorithm loops through all the blocks as long as it can find blocks to be restored, nevertheless it is quite efficient. It is the basic philosophy of RestoreMotionBlocks, that motion detection needs only detect at least one but not all blocks of a moving object. The rest is then taken care by postprocessing.

:::Negative values are allowed for pthreshold and cthreshold, but are not very reasonable.
<br>
::{{Par2|grey|bool|false}}
:::If grey=true the chroma of the clip "filtered" is not touched by RestoreMotionBlocks. Also for postprocessing only the luma is used. This is slightly faster than grey=false. If you use grey=false for b&w clips, then it not only takes longer but also the quality may degrade, because chroma noise may trigger false postprocessing. Thus "grey=true" is highly recommended for b&w clips. <br>Greyscale (Y8..Y16) clips are automatically treated as grey=true.
<br>
====How RestoreMotionBlocks works====
To use the above variables properly, one has to understand how RestoreMotionBlocks works. It consists of three phases. For the first phase only the clip "neighbour" is used. Each frame is divided into a grid of 8x8 blocks. If n is the number of the current frame, then for each block of this grid RestoreMotionBlocks looks at the luma of this block in neighbour(n-1) and neighbour(n+1). Note that we don't use the frame neighbour(n). There are three comparison methods (the old RemoveDirt has only one).
#If noise= 0, then simply the SAD of each block in neighbour(n-1) and neighbour(n+1) is computed. If it is >= mthreshold, the block is identified as a motion block of frame n. This is the fasted method and a similar method was used in the old RemoveDirt. Its key disadvantage is that it may easily misled by noise.
#If noise >=0, then instead of SUM(|y-x|) RestoerMotionBlocks calculates SUM(| |y-x|-noise |). In particular, differences with absolute value <= noise are ignored. If it is >= mthreshold, then this block is identified as a motion block. We call this the noise adjusted SAD. From the way how the noise adjusted SAD is calculated, it is clear, that "mthreshold" should be decreased if "noise" is increased.
#If noise >= 0 and noisy >= 0, then RestoreMotionblocks counts the number of pixels of a block, for which the absolute difference between neighbour(n-1) and neighbour(n+1) is >= noise. If this number is >= value of "noisy", then the block is identified as a motion block. We call this the NPC (= noisy pixel counting) method. The value of mthreshold is ignored, if NPC is selected.
Note that a block has 64 pixels. Thus, if noisy > 64, then there can't be any motion blocks. In my view NPC is clearly the best method. It has likely about half the speed of SAD and about the same speed as NSAD. Noise=-1 and noisy=-1 are the default values. Thus SAD is the default method for the first phase. I ran most of my RemoveDirt tests with noise=8 or 10 and noisy= 12.

In the sequel the motion blocks found in the first phase are called phase 1 motion blocks. In the second phase, for each block all the motion blocks found in the first phase which have a distance <= dist are counted. If the result is >= (tolerance /100) * (the number of all first phase blocks with distance <= dist) , then this block is called a motion neighbour block. For instance, if dist = 1 and tolerance= 12 (the default values), then there are 9 blocks with a distance <= 1. Since 1 < (12/100)*9 < 2, there must be at least 2 phase 1 motion blocks among the 9 neighbour blocks such that the block is marked as a motion neighbour block. If dmode= 0, then all the motion neighbour blocks become phase 2 motion blocks. Thus if dmode=0 the number of motion blocks is increased quite a bit. If dmode= 2, then quite the opposite happens: a phase 1 motion block only becomes a phase 2 motion block, if it is also a motion neighbour block. In particular, there are less phase 2 motion blocks than phase1 motion blocks. For instance, if dist=1, tolerance= 2, dmode= 2, then a single phase 1 motion block is dicarded if there exists no further phase 1 motion block with a distance less than 1. Dmode=1 is just in the middle between dmode=0 and dmode= 2: the motion neighbour blocks become the phase 2 motion blocks. Thus, if dmode=1, the phase 1 motion blocks are only relevant for detecting motion neighbour blocks. After this task is completed the phase 1 information is discarded. If dist=0 or dmode=2 gmthreshold should be lowered to 60 or even 50.

The third phase, called the postprocessing phase, starts with restoring the phase 2 motion blocks by copying them from the clip "restore" to the clip "filtered". All phase 2 motion blocks become also phase 3 motion blocks. Then the edges between motion and non-motion blocks are inspected. To this end the SAD of the two adjacent border line segments is calculated twice (these line segments are either horizontal or vertical and are 8 pixels long). It is calculated first in the clip "restore" and then in the clip "filtered". In the clip "filtered" the two blocks are from two different sources, one block, the motion block was restored from the clip "restore" and the non-motion block is from the original clip "filtered". Since the frames of the clip "restore" are not changed at all, both blocks are from the same source and should therefore fit together. If the edge SAD in the clip "filtered" > (edge SAD in the clip restore) + pthreshold, then the block is marked as a new (additional) phase 3 motion block and the block is restored by copying it from "restore" to "filtered", because the two blocks in "filtered" don't fit together well enough compared with the two blocks in "restore". In other words, in this phase, it is checked whether a restored block fits to the yet unrestored blocks. If it doesn't, the not yet restored blocks, which do not fit well, are marked as phase 3 motion blocks and are restored as well. This procedure is repeated until there are no more blocks, which can be tested. If the value of the grey variable is false, then the same is done for the luma and the chroma (for the chroma the variable cthreshold is used instead of pthreshold). If grey= true, then postprocessing is only done for the luma.
Finally, if the percentage of all phase 3 motion blocks with respect to all blocks exceeds the value of gmthreshold, then the "filtered" frame is discarded and replaced by the corresponding frame in "alternative". In this way, we can give special treatments for sharp scene switches and scenes with a moving or zooming camera.
<br>
<br>
====Debugging====

The boolean variable debug and show are used for debugging. If show=true, then the blocks, which are marked as motion blocks in the first phase are colored red, those found in the second phase are colored green and finally the motion blocks marked by postprocessing are colored blue. In this way, one can easily check whether the above variables were selected appropriately. if debug=true, then RestoreMotionBlocks sends output of the following kind to the debugview utility:

<pre>
[348] [21495] RemoveDirt: motion blocks = 942(14%), 1652(25%), 635( 9%), loops = 31
[348] [21496] RemoveDirt: motion blocks = 1745(26%), 2330(35%), 64( 0%), loops = 3
[348] [21497] RemoveDirt: motion blocks = 1480(22%), 1973(30%), 45( 0%), loops = 4
[348] [21498] RemoveDirt: motion blocks = 1081(16%), 1915(29%), 65( 1%), loops = 2
[348] [21499] RemoveDirt: motion blocks = 1403(21%), 2380(36%), 235( 3%), loops = 10
[348] [21500] RemoveDirt: motion blocks = 2618(40%), 2204(34%), 59( 0%), loops = 5
[348] [21501] RemoveDirt: motion blocks = 986(15%), 2065(31%), 75( 1%), loops = 3
[348] [21502] RemoveDirt: motion blocks = 1214(18%), 2291(35%), 78( 1%), loops = 3
[348] [21503] RemoveDirt: motion blocks = 1348(20%), 2179(33%), 57( 0%), loops = 4
[348] [21504] RemoveDirt: motion blocks = 961(14%), 1957(30%), 71( 1%), loops = 3
[348] [21505] RemoveDirt: motion blocks = 1833(28%), 2201(33%), 38( 0%), loops = 3
[348] [21506] RemoveDirt: motion blocks = 1644(25%), 2183(33%), 53( 0%), loops = 5
[348] [21507] RemoveDirt: motion blocks = 1420(21%), 2541(39%), 132( 2%), loops = 5
[348] [21508] RemoveDirt: motion blocks = 2238(34%), 2229(34%), 104( 1%), loops = 4
[348] [21509] RemoveDirt: motion blocks = 1351(20%), 2294(35%), 181( 2%), loops = 6
[348] [21510] RemoveDirt: motion blocks = 931(14%), 1800(27%), 229( 3%), loops = 5
</pre>

The first number in brackets on the left hand side is the id of the process, which runs the script, the second number in brackets is the frame number. The first number (with percentages in brackets) after "motion blocks =" is the number of phase 1 motion blocks, the second is the difference between phase 2 and phase 1 motion blocks (always >=0 if dmode=0, always <= 0 if dmode= 2) and the third is the difference between phase 3 and phase 2 motion blocks (always >= 0). Finally the number after "loops =" is the number of postprocessing loops used for this frame. Debug=true can be used to monitor RestoreMotionBlocks in an encoding process. Of course, show=true can only be used before an encoding process to find the right values for the various variables.
<br>
<br>

----

===SCSelect===
SCSelect is a special filter, which distinguishes between scene begins, scene ends and global motion. The output of SCClense is used as an "alternative" clip for RestoreMotionBlocks. It can hardly used for other purposes, because it can only make proper decisions if there are a lot of motion blocks. Only if the percentage of motion blocks is > gmthreshold, then RestoreMotionBlocks chooses a frame from the clip specified with the alternative variable and then there are always a lot of motion blocks, if gmthreshold is not too small (gmthreshold >= 30 should be sufficiently large). SCSelect yields nonsense results if there are only few motion blocks. SCSelect is used as follows:

:{{Template:FuncDef|SCSelect (clip input, clip scene_begin, clip scene_end, clip global_motion, float "dfactor", bool "debug", bool "planar", int "cache", int "gcache")}}
<br>
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
::{{Par2| |clip| }}
:::The first four clip variables are mandatory and have no name. All four clips must have the same color space, width and height. The first clip is the clip, on which SCSelect bases its decision. Usually it should be the same clip, which was specified with the "neighbour" variable in RestoreMotionBlocks. If SCSelect realises a scene begin, it selects its output frame from the clip scene_begin. If SCSelect realises a scene end, it selects its output frame from the clip scene_end. If SCSelect realises a global motion, it selects its output frame from the clip global motion. Thus SCSelect doesn't produce any new frames. It only makes a selection from three different sources.
<br>
::{{Par2|dfactor|float|4.0}}
:::Dfactor is the key variable for scene switch sensitivity. The higher dfactor the less scene begins and scene ends and the more global motion frames are detected. Dfactor=4.0 is the default value.
<br>
::{{Par2|debug|bool|false}}
:::If debug=true, then SCSelect sends output of the following type to the [http://technet.microsoft.com/en-us/library/bb896647.aspx DebugView] utility:
<div style="margin-left: 6em; max-width: 47em">
<pre>
[3416] [67865] SCSelect: global motion
[3416] [67866] SCSelect: global motion
[3416] [67870] SCSelect: global motion
[3416] [67871] SCSelect: global motion
[3416] [67873] SCSelect: global motion
[3416] [67874] SCSelect: global motion
[3416] [67877] SCSelect: global motion
[3416] [68318] SCSelect: global motion
[3416] [68319] SCSelect: global motion
[3416] [68557] SCSelect: scene end
[3416] [68558] SCSelect: scene begin
[3416] [69481] SCSelect: scene end
[3416] [69482] SCSelect: scene begin
[3416] [70240] SCSelect: scene end
[3416] [70241] SCSelect: scene begin
[3416] [70406] SCSelect: global motion
[3416] [70407] SCSelect: global motion
[3416] [70408] SCSelect: global motion
[3416] [70409] SCSelect: global motion
[3416] [70410] SCSelect: global motion
[3416] [72032] SCSelect: global motion
[3416] [72164] SCSelect: global motion
[3416] [72165] SCSelect: global motion
</pre>
</div>
:::To describe the basic idea behind SCSelect let SAD(n) be the SAD difference between the frames input(n) and input(n+1). Now, if SAD(n) > dfactor * SAD(n-1), then SCSelect recognizes a scene end and pulls the frame from the clip scene_end. If SAD(n-1) > dfactor * SAD(n), then SCSelect recognizes a scene begin and pulls the frame from the clip scene_begin. If both SAD(n) <= dfactor * SAD(n-1) and SAD(n-1) <= dfactor * SAD(n), then SCSelect recognizes a global motion and pulls the frame from the clip global_motion. From this description it is clear that dfactor must be > 1 for getting reasonable results. The above algorithm is optimized such that often only one and not two SADs are calculated for one requested frame. However, there are certain shortcomings. If a scene ends with global motion, then SCSelect often can't detect the scene end. If a scene begins with global motion, then SCSelect often can't detect the scene begin. These two effects are usually responsible if lonely scene begins and scene ends are detected by SCSelected, otherwise each scene begin should be preceded by a scene end. By refining the above algorithm we could avoid lonely scene begins and scene ends, but there is one situation, where even such a refinement fails. Namely if the scene ends with global motion and the new scene starts with global motion. Then a sharp scene switch can only be detected reliably with a good motion analysis, which would result in an extreme slow down of the filter.
<br>
::{{Par2|planar|bool|false}}
:::If you use planar YUY2 then you have to set "planar=true" (false is the default value).
<br>
::{{Par2|cache|int|2}}
::{{Par2|gcache|int|0}}
:::Undocumented parameters.
<br>

== RemoveDirt Script ==
RemoveDirt has now become a script function, which involves RestoreMotionBlocks and various filters from [[RgTools|RemoveGrain]] package.

During the tests I used the following script:

<pre>
function RemoveDirt(clip input, bool "_grey", int "repmode")
{
_grey=default(_grey, false)
repmode=default(repmode, 16)
clmode=17
clensed=Clense(input, grey=_grey, cache=4)
sbegin = ForwardClense(input, grey=_grey, cache=-1)
send = BackwardClense(input, grey=_grey, cache=-1)
alt=Repair(SCSelect(input, sbegin, send, clensed, debug=true), input, mode=repmode, modeU = _grey ? -1 : repmode )
restore=Repair(clensed, input, mode=repmode, modeU = _grey ? -1 : repmode)
corrected=RestoreMotionBlocks(clensed, restore, neighbour=input, alternative=alt, gmthreshold=70, dist=1, dmode=2, debug=false, noise=10, noisy=12, grey=_grey)
return RemoveGrain(corrected, mode=clmode, modeU = _grey ? -1 : clmode )
}
</pre>

Let us discuss this script in some detail. Firstly, we apply the brutal temporal clenser from the RemoveGrain package to obtain the clip "clensed". Then we use the filters ForwardClense and BackwardClense from RemoveGrain to construct the clip "alt", which is then used as the "alternative" variable in the subsequent RestoreMotionBlocks. While Clense does a lot of cleaning it certainly creates a lot of artifacts in motion areas. In RemoveDirt this repair is only made in motion areas. The static areas are not repaired. Since the clip is used only for restoring motion areas, we can use the much stronger Repair mode 16, which restores thin lines destroyed by clense. Finally, because there may be some left over from temporal cleaning especially when grain is dense, we use the spatial denoiser RemoveGrain(mode=17) to remove these dirt or grain rests.

=== Optimal Usage ===

1. If possible, crop after RestoreMotionBlocks. Modern codecs divide the frames in the same way as RemoveDirt into a grid of 8x8 pixel blocks to perform the crucial discret cosine transform for such blocks. Now if the clip is cropped after RemoveDirt, then the grid of RemoveDirt and the codec are likely to be different resulting in inferior compression. There is one exception, though: cropping afterwards does not hurt, if all four sides are cropped by a multiple of 8. For instance, crop(8,64,0,-72) is ok. On the other hand, one should crop after RemoveGrain/Repair if possible, because this filters cannot process the boundary pixels. Thus the optimal solution is to crop afterwards and then only by multiples of 8, which unfortunately is not always possible.

2. Avisynth 2.6 hint: Crop only with "align=true". RestoreMotionBlocks uses SSE2 instructions. If you crop without "align= true" before RestoreMotionBlocks, then the data on the frames may not be properly aligned and RemoveDirt will execute substantially slower. As a consequence you should always crop with Avisynth and not with DVD2AVI or DGIndex.
For Avisynth+ there is no need for such precautions, Crop is always producing aligned frames.

3. Telecined movies must be inverse telecined before RemoveDirt. If a film is telecined some fields are doubled in order to increase the frame rate from 24fps to 30fps. Hence on such doubled fields the basic property of dirt, described above, is no more valid and no temporal cleaner can ever spot dirt on such doubled fields. On the other hand, after an inverse telecine usually every fourth frame is composed of fields, which originate from two different frames. Visually these two fields fit together well but both are from a different compression context, which can mislead RemoveDirt to false motion detection. In extreme cases, one field may be from an I- or P-frame, while the other is from a B-frame. But even if the fields are from from frames of identical type, the different compression context has a substantial effect. Consequently RemoveDirt performes less well on inverse telecined movies than on natively progressive movies. By the same reason also compression of inverse telcined movies is worse than of natively progressive movies. We in Europe should thank god every day that we are not getting telecined. However, here in Germany we have digital tv broadcasters, which like to comb progressive films (about 5% of all progressive movies from ARD and especially ZDF are combed). Fortunately these idiots are not able to double fields, so RemoveDirt should work, but on combed films the dirt is always split over two frames which clearly hurts RemoveDirt. On the other hand, if these combed films are uncombed, then we have the compression context problem for any frame and not only for any fourth frame. Stepping through the video with the builtin filter Bob() one can decide with near absolute certainty, whether the video is truely progressive, interlaced, telecined, field blended or progressive with a field shift.

4. Put other filters after RemoveDirt. Except those filters mentioned before, like crop and inverse telecine, all other filters should be put after RemoveDirt in the Avisynth script, because most filters have a negative rather than a positive impact on dirt detection.
<br>
<br>
== Change Log ==

* v0.9.2 (20190324)
- RestoreMotionBlocks: 10-16 bit support. Relevant threshold and noise parameters are bit depth independent.
- minor speedup
- SCSelect: add support for 10-16 bits and 32 bit float clips
- SCSelect: add support for planar RGB
- FIX: SCSelect: make it work properly for large frames (>8MPixel)
- FIX: SCSelect: Makes use the whole frame: now counts the rightmost non-mod32 pixels as well.
- Clang support (LLVM) with Visual Studio 2017
- update html docs
- add clang-built DLLs to the released version

* v0.9.1 (20190314)
- project moved to github: https://github.com/pinterf/RemoveDirt
- built using Visual Studio 2017
- x64 build for Avisynth+
- Added version resource to DLL
- Changed to AVS 2.6 plugin interface
- Fix: RestoreMotionBlocks: grey=false: it was copying 8x4 chroma pixels for YV12 and 8x8 for YUY2 instead of 4x4 and 8x4 blocks
- Fix: SCSelect: Old v0.9 SSE2 code omitted difference checking for every second 8 columns
- Removed MMX code, now requires SSE2
- Reports MT Modes for Avisynth+: [[MT_SERIALIZED]] for SCSelect
- Reports MT Modes for Avisynth+: [[MT_MULTI_INSTANCE]] for RestoreMotionBlocks (may not be any faster)
- Added Y, YV16 and YV24 support besides existing YV12 and planar-hacked-YUY2

* v0.9 (20050507)
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="100%"
|-
!!width="100px"| Version
!!width="300px"| Download
!!width="300px"| Mirror
!!width="500px"| Comments
!!width="500px"| Source code
|-
!v0.9
|[http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|[https://web.archive.org/web/20150405173333if_/http://xhmikosr.1f0.de/_old/avisynth/plugins/RemoveDirt_0.9.zip RemoveDirt_0.9.zip]
|includes statically and dynamically linked [[SSE2]] binaries compiled with MSVC2010. Dynamically linked binaries requires the [http://www.microsoft.com/en-us/download/details.aspx?id=8328 Microsoft Visual C++ 2010 Redistributable Package (x86)] to be installed.
|Included with the binaries.
|-
!v0.9
|<strike>[https://web.archive.org/web/20140723074402if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.zip ReduceDirt.zip]</strike>
|
|includes 3 binaries: one statically linked (<tt>RemoveDirtS.dll</tt>) and two dynamically linked (<tt>RemoveDirt.dll, RemoveDirtSSE2.dll</tt>).
SSE2 version is recommended but unfortunately it requires the <tt>Msvcr71.dll</tt> runtime component from the very ancient Microsoft Visual C++ .NET 2003. For this reason this package is considered deprecated!
|[https://web.archive.org/web/20141121054131if_/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt-src.zip ReduceDirt-src.zip]
|-
!v0.6.1
|[https://web.archive.org/web/20050215121957if_/http://home.pages.at/kassandro/RemoveDirt/RemoveDirt.zip RemoveDirt.zip]
|
|Old archived documentation: [https://web.archive.org/web/20050311122626/http://www.removedirt.de.tf www.removedirt.de.tf]
|}
<br>
== External Links ==
*[https://web.archive.org/web/20160610102940/http://home.arcor.de/kassandro/RemoveDirt/RemoveDirt.htm RemoveDirt.htm] - official v0.9 documentation.
*http://forum.doom9.org/showthread.php?p=641337#post641337
*http://forum.doom9.org/showthread.php?p=1560013&highlight=scselect#post1560013
*http://forum.doom9.org/showthread.php?p=1564754&highlight=scselect#post1564754
*http://forum.doom9.org/showthread.php?p=1518730&highlight=scselect#post1518730
*http://forum.doom9.org/showthread.php?p=1409324#post1409324
*http://forum.doom9.org/showthread.php?p=1483843&highlight=scselect#post1483843
*http://forum.doom9.org/showthread.php?p=1488392&highlight=scselect#post1488392
*http://forum.doom9.org/showthread.php?p=1479632&highlight=scselect#post1479632
*http://forum.doom9.org/showthread.php?t=145753&highlight=scselect&page=2
*http://forum.doom9.org/showthread.php?p=1206869&highlight=scselect#post1206869
*http://forum.doom9.org/showthread.php?p=1351709&highlight=scselect#post1351709
*http://forum.doom9.org/showthread.php?p=1405939&highlight=scselect#post1405939
*http://forum.doom9.org/showthread.php?p=1205317&highlight=scselect#post1205317
*http://forum.doom9.org/showthread.php?p=1507954&highlight=scselect#post1507954
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Luma_Equalization|External Filters]] ←'''

Convert

2024-12-19T12:04:31Z

Pinterf: Update ConvertToXXXX, 3.7.3 change log, mention param1,param2,param3, Add YUVA versions, PC601,PC709 related additions, link to avs+ docs

<div style="max-width:62em" >
<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/convert.html https://avisynthplus.readthedocs.io]
</div>

Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' or '''ConvertToYV16''' (and high bit depth variants) where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different, or the target placement is different from the source chroma placement read from _ChromaLocation frame property.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}<br>
{{FuncDef
|ConvertToYUVA444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', {{AvsPluscon}} <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}<br>
{{FuncDef
|ConvertToYUVA422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', <br>
     float param1, float param2, float param3 {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToYUVA420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 {{AvsPluscon}}] )
}} <br>
|ConvertToYUV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     float param1, float param2, float param3 ] ) {{AvsPluscon}}
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:l" means the same as the old "Rec709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited, except "PC.601" and "PC.709".

: For memo and the similar new string
:* "rec601" same as "470bg:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "470bg:f" but only if source has _ColorRange = 0 (full)
:* "pc.709" and "pc709" "709:f" but only if source has _ColorRange = 0 (full)
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f" but only if source has _ColorRange = 0 (full)

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss", "sinc", "sinpow", "sinclin2" and "userdefined2"). Default is "bicubic". Latter three is for {{AvsPluscon}}.

{{HiddenH5|Chroma resampler parameters}}
{{Par2|param1|float|default depends on resampler type}}
{{Par2|param2|float|default depends on resampler type}}
{{Par2|param3|float|default depends on resampler type}}

:These 'float' type parameters can be the additional parameters for the chroma resamplers. Some resizer algorithms would need and can be fine tuned with up to 3 parameters. Their default values depend on the selected chromaresample resizer kernel,

==== Notes ====
<div style="max-width:62em" >
===== Frame properties {{AvsPluscon}} =====

In Avisynth v3.7.1. frame property (_ChromaLocation) support appears in selected filters (e.g. ConvertToYUV422).
Property can be read and/or set.
A frame property can replace default behaviour of location parameters and is set (or deleted) upon finishing conversion.
Since a format without subsampling such as 4:4:4 (YV24) does not have chroma location, the property is deleted automatically when converting to 4:4:4 or RGB.

: "ChromaInLocation" rules:
::* if source has _ChromaLocation frame property it will be used else the default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaInLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: "ChromaOutLocation" rules:
::* default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaOutLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: Accepted values for "ChromaInLocation" and "ChromaOutLocation" (when source/target is a chroma subsampled format)
: (full list):
::* "left" or "mpeg2"
::* "center" or "jpeg" or "mpeg1"
::* "top_left"
::* "dv"
::* "top"
::* "bottom_left"
::* "bottom"

: _ChromaLocation constants - as seen in propShow()

::* AVS_CHROMA_LEFT = 0
::* AVS_CHROMA_CENTER = 1
::* AVS_CHROMA_TOP_LEFT = 2 (4:2:0 only)
::* AVS_CHROMA_TOP = 3 (4:2:0 only)
::* AVS_CHROMA_BOTTOM_LEFT = 4 (4:2:0 only)
::* AVS_CHROMA_BOTTOM = 5 (4:2:0 only)
::* AVS_CHROMA_DV = 6 Special to Avisynth

===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.3
| Added "sinpow", "sinclin2" and "userdefined2" to chromaresampler options<br>Add "param1", "param2" and "param3" to ConvertToXXXX where 'chromaresample' exists (b,c,s,taps and p parameters can be set, depending on the resizer.)<br>Add ConvertToYUVA420, ConvertToYUVA422, ConvertToYUVA444
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants<br>Added _ChromaLocation frame property
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

External filters

2024-12-11T12:13:07Z

Pinterf: /* Film Damage correction */ update Descratch authors and color formats

Rough classification of third-party filters for AviSynth - a perpetual work in progress.

This page lists both scripts (see [[Import]]) and plugins (see [[Plugins]]).

== Introduction ==

==== Download sites ====
A large list of filters can be downloaded from the following sites but be aware that some plugins listed '''may be outdated''', only recommended as a backup.

*[https://web.archive.org/web/20130803185015/http://www.64k.it:80/andres/dettaglio.php?sez=avisynth Andres' Filter Collection]
*[https://chaosking.de/repo/avsfilters/ AviSynth Filter DB by ChaosKing] | [https://web.archive.org/web/20140412062911/http://chaosking.de/avisynth-filter-db mirror]
*[http://www.avisynth.info/?plugin=attach&pcmd=list&refer=%E3%82%A2%E3%83%BC%E3%82%AB%E3%82%A4%E3%83%96 AviSynth.info Filter Archive]
*[http://xhmikosr.1f0.de/_old/avisynth/plugins/ XhmikosR's Builds]
*[http://www.avisynth.nl/users/warpenterprises/ Warp Enterprises' AviSynth Filter Collection]

====64-bit filters====
'''[[AviSynth%2B_x64_plugins|Comprehensive list of AviSynth+ 64-bit filters]] →'''

====Outdated AviSynth plugins====
[[External plugins old|External plugins (old)]] - these older plugins are not recommended, page is there mainly for historical purposes.

==== Using filters ====
Most scripts will apply filters in the following order:

# Create an AviSynth clip from a video file using a source filter.
# 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).



== Source Filters ==

{{FilterTable}}
| [https://forum.doom9.org/showthread.php?t=135855 BassAudio]
| [https://www.un4seen.com/ 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
| [https://forum.doom9.org/showthread.php?t=135855 Plugin]
| dimzon
|-
|[[BestAudioSource]]
|A new sample accurate but somewhat slow FFmpeg based audio source filter for AviSynth+. No indexing required and only available in 64-bit.
|N/A
|[[BestAudioSource|Plugin]]
|{{Author/Myrsloik}}
|-
| [[DGDecNV]]
| DGDecNV is a decoder/frameserver for AVC, HEVC, MPEG2, and VC1 streams that runs on the GPU of Nvidia graphics cards that support CUDA video decoding.
| [[I420]], [[YV12]], [[YUV420P16]]
| [[DGDecNV|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.
| [[RGB24]], [[YUY2]], [[YV12]], [[I420]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
|[http://forum.doom9.org/showthread.php?t=170107 DGMVCSource]
|MVC source filter for AviSynth.
| [[YV12]]
|[http://rationalqm.us/dgmvcsource/dgmvcsource100b26.zip Plugin]
|{{Author/Donald Graft}}
|-
| [[DSS2mod]]
| DirectShowSource2 mod, this version does not require Haali Media Splitter.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DSS2mod|Plugin]]
| forclip
|-
| [[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://github.com/FFMS/ffms2/releases Plugin]
| {{Author/Myrsloik}}, TheFluff, Plorkyeran, others
|-
|[http://forum.doom9.org/showthread.php?t=169651 FRIMSource]
|FRIMSource is an AviSynth plugin for sequential reading of elementary or transport streams (MPEG2, H.264 AVC/MVC-3D, VC1).
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=169651 Plugin]
|videofan3d
|-
| [[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]]
| [[ImageSequence|Plugin]]
| {{Author/WarpEnterprises}}
|-
| [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}}
|-
|[https://forum.doom9.org/showthread.php?t=184825 ImageSourceNV]
|CUDA accelerated plugin that uses the [https://docs.nvidia.com/cuda/nvjpeg/index.html nvJPEG API] to decode jpeg source files and convert their color space to YUV444.
|[[YUV444P8]]
|[https://forum.doom9.org/showthread.php?t=184825 Plugin]
|[https://github.com/ArturAlekseev Argaricolm]
|-
| [[JpegSource]]
| An advanced JPEG decoder for Avisynth 2.6. See [http://forum.doom9.org/showthread.php?t=170028 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/rjnt0y3ead2c6ef/JpegSource_20140419.7z Plugin]
| SEt
|-
| [[LSMASHSource]]
| A source plugin for audio and video, it uses Libav ([http://en.wikipedia.org/wiki/Libav#Contained_codecs libavcodec]) to decode all supported A/V formats. See [http://forum.doom9.org/showthread.php?t=167435 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[LSMASHSource|Plugin]]
| {{Author/VFR-maniac}}
|-
|[[MPEG2DecPlus]]
|MPEG2DecPlus is a MPEG-1/2 decoder plug-in. MPEG2DecPlus is a project to modernize "[[DGDecode]].dll" for AviSynth+.
|[[YV12]], [[YV16]]
|[[MPEG2DecPlus|Plugin]]
|{{Author/Chikuzen}}
|-
| [[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], [http://forum.doom9.org/showthread.php?t=135876 continued discussion].
| N/A
| [[NicAudio|Plugin]]
| {{Author/Nic}}
|-
| [[RawSource26]]
| Loads raw video data directly from files. Further modifications (most raw formats, YUV4MPEG2 compatible with latest spec).
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RawSource26|Plugin]]
| {{Author/Chikuzen}}
|-
| [[VapourSource]]
| VapourSynth script reader for AviSynth+ and AviSynth2.6x.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[VapourSource|Plugin]]
| {{Author/Chikuzen}}
|-
|[http://forum.doom9.org/showthread.php?t=170311 VideoInputSource]
| Capture video frames from video capture card or webcam in real-time.
|[[RGB24]]
|[http://github.com/fieliapm/himawari_avs_plugin/raw/master/VideoInputSource/VideoInputSource.dll Plugin]
|[http://github.com/fieliapm fieliapm]
|-
|[https://github.com/slavanap/ssifSource ssifSource]
| Open m2ts, ssif and mpls files located in decrypted Blu-ray and Blu-ray 3D discs. Supports horizontal of vertical stack of views as output, views selection and swap autodetection.
|[[YV12]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|}

== Restoration Filters ==

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

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

{{FilterTable}}
| [[DAA]]
| Anti-aliasing with contra-sharpening.
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| mcDAA3
| Motion-Compensated Anti-aliasing with contra-sharpening, can deal with ifade too, created because when applied daa3 to fixed scenes, it could damage some details and other issues. See [http://forum.doom9.org/showthread.php?p=1639679#post1639679 discussion]
| [[YV12]]
| [http://www.mediafire.com/?wqkob7zx1p119e0 Script]
| AmjadSONY
|-
| [[MAA2]]
| Updated version of the MAA antialising script.
| [[Y8]], [[YV12]], [[YV24]]
| [http://web.archive.org/web/20140624125132/https://raw.githubusercontent.com/AviSynth/avs-scripts/master/maa2.avsi Script]
| line0
|-
| [[santiag]]
| Simple anti-aliasing with independent horizontal and vertical anti-aliasing strength.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1393006 Script]
| {{Author/cretindesalpes}}
|-
| 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]
| [[YV12]]
| Script
| thetoof
|-
| [[TIsophote]]
| A level-set (isophote) smoothing filter.
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20070222162751/http://bengal.missouri.edu/~kes25c/TIsophotev091.zip Plugin]
| {{Author/tritical}}
|-
|[[xaa]]
|Versatile anti-aliasing script.
|[[Y8]], [[YV12]], [[YV24]]
|[http://www.mediafire.com/download/sygi04y47eknvc2/xaa_v1.1.1.avsi Script]
|Desbreko
|}

=== Chroma correction ===

{{FilterTable}}
|[[caf]]
|Chromatic Aberration Fixer.
| [[YV12]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| Torchlight
|-
| [[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. See [http://forum.doom9.org/showthread.php?t=33302 discussion.]
| [[YV12]], [[YUY2]], [[RGB32]]
| [http://web.archive.org/web/20091026153334/http://www.geocities.com/siwalters_uk/chromashift27.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChromaShiftSP]]
| This script can shift chroma in all directions with subpixel accuracy.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| IanB, McCauley
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[ColorMatrix|Plugin]]
| {{Author/Wilbert Dijkhof}}, {{Author/tritical}}
|-
| [[DeBlot]]
| Color bleed reduction plugin.
| [[YUY2]],[[YV12]]
| [[DeBlot|Plugin]]
| {{Author/minamina}}
|-
| [[FixChromaBleeding]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074 discussion]
| [[YV12]]
| [http://web.archive.org/web/20091026141730/http://www.geocities.com/alex_j_jordan/chroma.txt Script]
| {{Author/Alex Jordan}}
|-
| [[FixChromaBleedingMod]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074#post1673932 discussion]
| [[YV12]], [[YUY2]], [[YV411]]
| [[FixChromaBleedingMod_source|Script]]
| AmjadSONY
|-
| [[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. See [http://forum.doom9.org/showthread.php?p=1520786#post1520786 discussion.]
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/index.php/FixChromaticAberration Script]
| Martin Wagener
|-
| [[MoveChroma]]
| Chroma shifting filter; can be used to independently shift the U/V channels left or right.
| [[YUY2]], [[YV12]]
| [[MoveChroma|Plugin]]
| [http://noraneco.ddo.jp/apechironnup apechironnup]
|-
| [[PixelShiftPlus]]
| Set of functions to independently shift any RGB(A) or YUV(A) plane with subpixel precision.
| All colorspaces
| [[PixelShiftPlus|Script]]
| reel.deal
|-
| [[ReInterpolate411]]
| This is a fast and simple filter to correct the improper 4:1:1 => 4:2:2 conversion that seems to occur with some DV/4:1:1 codecs.
| [[YUY2]]
| [{{N2Archived}}/trbarry/ReInterpolate411.zip Plugin]
| {{Author/Tom Barry}}
|-
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420.html ReInterpolate420]
| Usually, DV decoders upsample [[PAL]] DV (which is YV12) to YUY2 using point sampling. This plugin re-interpolates the original chroma samples.
| [[YUY2]]
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420_v3.zip Plugin]
| {{Author/Wilbert Dijkhof}}
{{Author/Fizick}} (v3)
|}

=== Debanding ===

{{FilterTable}}
| AdaptDBMC
| Luma / Fade / Blue adaptive debanding script. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=512 discussion]
| [[YV12]]
| [https://web.archive.org/web/20131111114822/http://www.nmm-hd.org/upload/get~ikKt5ZZhD94/AdaptDBMC_beta.rar Script]
| {{Author/06_taro}}
|-
| [[GradFun2db]]
| A simple and fast debanding filter.
| [[YV12]]
| [[GradFun2db|Plugin]]
| Prunedtree
|-
| [[GradFun2DBmod]]
| An advanced debanding script based on GradFun2DB.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144537 Script]
| {{Author/LaTo}}
|-
| [[Dither_tools#GradFun3|GradFun3]]
| This debanding script, part of the [[Dither_tools|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]]
| [[Dither_tools|Script]]
| {{Author/cretindesalpes}}
|-
| [[f3kdb|flash3kyuu_deband]]
| Fast debanding plugin ported from AviUtl.
| [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[Y8]], [[YV411]]
| [[f3kdb|Plugin]]
| [http://github.com/SAPikachu/ SAPikachu]
|-
|[[avslibplacebo#Deband|libplacebo_Deband]]
|Tunable debanding. Based on flash3kyuu, expanded to provide high quality by combining multiple debanding passes.
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
| LumaDB
| Fast 8-bit 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://web.archive.org/web/20131111114932/http://www.nmm-hd.org/upload/get~3YK_B5TfcyI/LumaDB-0.7.rar Script]
| {{Author/06_taro}}
|-
| LumaDBL
| Fast 16-bit 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://web.archive.org/web/20131111114947/http://www.nmm-hd.org/upload/get~mQYIS9H6Qas/LumaDBL-0.7.rar Script]
| {{Author/06_taro}}
|-
| [[Neo_f3kdb]]
| Fast debanding plugin for AviSynth+.
| [[Y8]], [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[YV411]], 8-16bit [[planar]] Y/YUV
| [[Neo_f3kdb|Plugin]]
| [https://github.com/msg7086 MeteorRain]
|-
|}

=== Deblocking ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect BlockDetect]
|Determines blockiness of frames.
|All 8-32 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect/releases Plugin]
|{{Author/Asd-g}}
|-
| BlockKiller
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=1410479#post1410479 discussion].
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1410479&postcount=19 Script]
| Jawed
|-
| BlockTerminator
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=831936#post831936 discussion.]
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=831936&postcount=24 Script]
| foxyshadis
|-
| [[DeBlock]]
| Deblocking filter. DGDecode also uses DeBlock.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit Y/YUV [[planar]] colorspaces
| [[DeBlock|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." [http://forum.doom9.org/showpost.php?p=913365&postcount=4 Didée]. See [http://forum.doom9.org/showthread.php?p=944459 discussion.] For updated Deblock QED see this [http://forum.doom9.org/showthread.php?t=154777 discussion]
| [[YV12]]
| [http://avisynth.nl/images/Deblock_QED_MT2Mod.avsi Script]
| {{Author/Didée}}
|-
|[[DeblockPP7]]
| A port of the MPlayer PP7 deblocking filter.
|[[YUY2]], [[YV12]]
|[[DeblockPP7|Plugin]]
|John Doe
|-
| [[FunkyDeBlock]]
| Deblocking script based on BlindPP and high/low pass separation. See [http://forum.doom9.org/showthread.php?t=72431 discussion].
| [[YV12]]
| Script
| Mug Funky
|-
| [[MDeblock]]
| Plugin for removing block artifacts.
| [[YV12]]
| [[MDeblock|Plugin]]
| {{Author/kassandro}}
|-
| [[SmoothD]]
| Filter to deblock frames while keeping high frequency detail.
| [[YV12]]
| [[SmoothD|Plugin]]
| Tobias Bergmann
|-
| [[SmoothD2]]
| Deblocking filter. Rewrite of SmoothD. Faster, better detail preservation, optional chroma deblocking.
| [[YV12]]
| [[SmoothD2|Plugin]]
| Jim Conklin
|-
| SmoothDeblock
| 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]<br>[[SmoothDeblock_source|(alt source)]]
| redfordxx
|-
|[http://www.avisynth.nl/users/fizick/unblock/unblock.html Unblock]
|UnBlock is a filter that removes the "blockiness" of heavily or moderately compressed images with statistical approach. See [http://forum.doom9.org/showthread.php?t=133059 discussion].
|[[YV12]]
|[http://www.avisynth.nl/users/fizick/unblock/unblock11.zip Plugin]
|{{Author/Fizick}}
|-
|[[vsDeblockPP7]]
|A port of the MPlayer PP7 deblocking filter. Includes high bit-depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit [[planar]] colorspaces
|[[vsDeblockPP7|Plugin]]
|Asd-d
|}

=== Dehaloing ===

{{FilterTable}}
| [[abcxyz]]
| Filter to remove halos. See [http://forum.doom9.org/showthread.php?t=144982 discussion].
| [[YV12]]
| [[Media:abcxyz_MT2.avsi|Script]]
| {{Author/Didée}}
|-
| [[BlindDeHalo3]]
| Filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=622289#post622289 discussion].
| [[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=5599&d=1143030001 Script]
| {{Author/Didée}}
|-
| [[DeHalo_alpha]]
| Very powerful filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=777956#post777956 discussion].
| [[YV12]]
| [http://avisynth.nl/images/Dehalo_alpha_mt.avsi Script]
| {{Author/Didée}}
|-
|[[DeHaloHmod]]
| Another halo reducer, it includes lots of options to tweak for best performance. See [http://forum.doom9.org/showthread.php?p=1675762#post1675762 discussion]
|[[YV12]]
| [[DeHaloHmod|Script]]
|AmjadSONY
|-
|[[FineDehalo]]
|Halo removal script that uses DeHalo_alpha with a few masks and optional contra-sharpening to try remove halos without removing important details (like line edges).
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/images/FineDehalo.avsi Script]
|{{Author/cretindesalpes}}
|-
|[https://forum.doom9.org/showthread.php?t=172599 HaloBuster]
|Really slow high quality halo remover.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=172599 Script]
|feisty2
|-
| 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
|-
| [[VHSHaloremover]]
| Quick & dirty halo removal. Will introduce some blurriness, but the halos are so huge you can’t avoid it. See [http://forum.doom9.org/showthread.php?p=1758184#post1758184]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://pastebin.com/s24mSgJ5 Script]
| {{Author/cretindesalpes}}
|-
| [[YAHR]]
| Basic filter with no variables to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=1205653#post1205653]
| [[YV12]]
| [http://avisynth.nl/images/YAHR.avsi Script]
| {{Author/Didée}}
|-
| YAHRmod
| Basic filter used to reduce halos in modern DVD and other cases.
| [[YV12]]
| [[YAHRmod_source|Script]]
| AmjadSONY
|}

=== Deringing & Mosquito Noise ===

{{FilterTable}}
| [[aWarpSharpDering]]
| Tries to clean up slight ringing around edges by heavily aWarpSharp-ing the image and then applying it only to the areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://avisynth.nl/images/AWarpSharpDering.avsi Script]
| {{Author/Leak}}
|-
| [http://rationalqm.us/dgmpgdec/DGDecodeManual.html#BlindPP BlindPP]
| Deblocking & deringing filter; part of [[DGDecode]]. <br>Mosquito noise removal: <code>BlindPP(quant=16, cpu2="ooooxx")</code>
| [[YV12]], [[YUY2]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
| [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
|-
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Deemphasize]
|This AviSynth function deemphasizes ringing common to SD video signals resulting from a playback device in the transfer chain poorly compensating for pre-emphasis baked into the source signal.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Script]
|[https://github.com/acuozzo acuozzo]
|-
|[[Dering]]
|Deringing filter intended for deringing VHS captured video.
|[[YUY2]], [[YV12]]
|[[Dering|C-Plugin]]
|[https://sourceforge.net/u/alexrayne/profile/ alexrayne]
|-
| [[EdgeCleaner]]
| A simple edge cleaning and weak dehaloing function. See [http://forum.doom9.org/showthread.php?t=164592 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1568521&postcount=13 Script]
| [http://forum.doom9.org/member.php?u=80518 canuckerfan]
|-
| [[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}}
|-
| [[HQDering mod]]
| Applies deringing by using a smart smoother near edges (where ringing occurs) only.
| [[YV12]]
| [http://web.archive.org/web/20140711173345/http://www.nmm-hd.org/upload/get~08CusazVphU/HQDeringmod_v1.8.avsi Script]
| [http://www.nmm-hd.org/newbbs/memberlist.php?mode=viewprofile&u=479&sid=ff62d0f6c22fcfdbe97b53c8351429bc mawen1250]
|-
| [[LazyDering]]
| Tries to clean up slight ringing around edges by applying [[aWarpSharp2]] only to areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://web.archive.org/web/20131103155455/http://anime-addict.ani-x.com/files/avisynth/scripts/LazyDering_v0.1.avsi Script]
| {{Author/Leak}}, RazorbladeByte
|-
| [[MosquitoNR]]
| A noise reduction filter designed for mosquito noise, which is often caused by lossy compression.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]], [[YUY2]]
| [[MosquitoNR|Plugin]]
| {{Author/b_inary}}
|-
|ungibbs
|ungibbs, a gibbs artifact remover.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=134502 Script]
|*.mp4 guy
|-
|WarpDeRing
|Uses aWarpSharp2's flattening to clean out ringing/smaller halos, then runs some masks to preserve the edges and avoid the thinning.
|[[YV12]]
|[[WarpDeRing_source|Script]]
|mirkosp
|-
|WarpDeRing_faster
|Same as WarpDeRing but may be a bit faster.
|[[YV12]]
|[[WarpDeRing_faster_source|Script]]
|mirkosp
|-
|[[WDFPlus]]
|Faster version of mirkosp's warpdering_faster script for AviSynth+.
|All 8-16 bit Y/YUV colorspaces, except YV411
|[https://github.com/Reel-Deal/AviSynthPlus-Scripts/blob/main/wdfplus.avsi Script]
|reel.deal
|}

=== Deinterlacing ===

{{FilterTable}}
|[[BWDIF]]
|Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic interpolation algorithms.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all 8-32bit [[planar]] colorspaces
|[[BWDIF|Plugin]]
|Asd-g
|-
| [[Decomb]]
| The FieldDeinterlace filter provides functionality similar to the postprocessing function of 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.
| [[YUY2]], [[YUY2]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
| [[EEDI2]]
| EEDI2 resizes an image by 2x in the vertical direction by copying the existing image to 2*y(n) and interpolating the missing field. It is intended for edge-directed interpolation for deinterlacing (i.e. not really made for resizing a normal image, but can do that as well).
| [[YUY2]], [[YV12]]
| [[EEDI2|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI2CUDA]]
| EEDI2 filter using CUDA.
| All [[planar]] Y/YUV/RGB 8 to 16-bit colorspaces
| [[EEDI2CUDA|Plugin]]
| [https://github.com/misakikasumi misakikasumi], [https://github.com/WolframRhodium WolframRhodium]
|-
| [[eedi3|EEDI3]]
| Another edge directed interpolation filter. Works by minimizing a cost functional involving every pixel in a scan line. eedi3 is good for deinterlacing and enlarging images by the powers of 2.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[eedi3|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI3CL]]
| OpenCL implementation of eedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[EEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
|[[FieldHint]]
|FieldHint combines arbitrary fields from the input clip, and optionally adds Telecide-compatible postprocessing hints.
|[[YV12]]
|[http://web.archive.org/web/20120223025813/http://ivtc.org/yatta%20support/fieldhint-0.12.rar Plugin]
|{{Author/akupenguin}}
|-
| [[nnedi3]]
| nnedi3 is an intra-field only deinterlacer. It takes in a frame, throws away one field, and then interpolates the missing pixels using only information from the kept field. It also has same rate and double rate modes.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[nnedi3|Plugin]]
| {{Author/tritical}}
|-
| [[NNEDI3CL]]
| OpenCL implementation of nnedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[NNEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
| [[nnedi3ocl]]
| OpenCL rewrite of [[nnedi3]]. See [http://forum.doom9.org/showthread.php?t=169766 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/bmemjsu7jqnlk65/nnedi3ocl_20131208.7z Plugin]
| SEt
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[QTGMC|Script]]
| -Vit-
|-
| [[SangNom2]]
| Reimplementation of the old [[SangNom]] plugin.
| [[Y8]],[[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SangNom2|Plugin]]
| {{Author/tp7}}
|-
| [[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]]
| [[TDeint|Plugin]]
| {{Author/tritical}}
|-
| [[TelecideHints]]
| The filter process the stats file to get the usual progressive matches and identify VFR sections.
| [[YUY2]], [[YV12]]
| [http://mod16.org/fansub/Telecidehints11.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[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
| [[YV12]]
| [[TempGaussMC|Script]]
| {{Author/Didée}}
|-
| [[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]]
| [[yadifmod|Plugin]]
| {{Author/tritical}}
|-
| [[yadifmod2]]
| Yadif + yadifmod for avisynth2.6/avisynth+.
| [[YV24]], [[YV16]], [[YV12]], [[YV411]], [[Y8]]
| [[yadifmod2|Plugin]]
| {{Author/Chikuzen}}
|}

=== Duplicate Frame Detectors ===

{{FilterTable}}
| [[ApparentFPS]]
| Shows underlying framerate where a clip has had many duplicates inserted, easier than counting unique frames.
| (see [[ApparentFPS|docs]])
| [[ApparentFPS|Plugin]]
| StainlessS
|-
| [[DeDup]]
| Remove (drop) duplicate frames in the interest of compression quality and speed. Resulting clip will have a variable frame rate.
| [[YV12]], [[YUY2]]
| [[DeDup]]
| {{Author/akupenguin}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[Dup|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=175357 Duplicity2/DropDeadGorgeous]
|A two faced scheming and double dealing [on your behalf] dupe tool.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=175357 Script]
|StainlessS
|-
| [http://forum.doom9.org/showthread.php?t=134930 Dupped]
| Another frame duplication function, similar to Dup, but hopefully more accurate.
| [[YV12]]
| [http://web.archive.org/web/20140420181919/http://www.randomdestination.com/members/corran/misc/dupped/dupped.avsi Script]
| [https://github.com/eparsons Corran]
|-
| [[DupStep]]
| Duplicate frame detector/decimator filter for [[AviSynth+]], 64-bit version only.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|8-16 bits]]
| [[DupStep|Plugin]]
| [http://github.com/Orum Orum]
|-
|[[ExactDedup]]
| ExactDedup is a filter intended to remove frames that are exact duplicates of each other, leaving only the first and (optionally) last frames of a run intact, and generates a Matroska v2 timecodes file with timing information for the ensuing stream.
| [[RGB24]] [[RGB32]], [[Y8]], [[YV12]] [[YV16]], [[YV24]]
| [[ExactDedup|Plugin]]
|Steve Melenchuk, Arick Chan, StainlessS
|-
| [http://www.avisynth.nl/users/fizick/getdups/getdups.html GetDups]
| Selecting unique duplicate frames from clip, it return frames which have copies only, by one from the series (group). Made for 8mm films.
| [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.avisynth.nl/users/fizick/getdups/getdups096.zip Plugin]
| {{Author/Fizick}}
|-
| [http://forum.doom9.org/showthread.php?t=164372 MorphDups]
| Replace duplicate frames by interpolations.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=164372 Script]
| sven_x
|}

=== Fieldblending and Frameblending removal ===

{{FilterTable}}
| [[c_deblend]]
| c_deblend is a simple blend replacing function like unblend or removeblend. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[Cdeint]]
| Restores 24fps FILM out of a fieldblended FILM -> Telecine -> [[NTSC]] -> Blendconversion -> [[PAL]] - Video (alternative for Restore24).
| [[YV12]]
| Script
| MOmonster
|-
| [[Deblend]]
| See [http://forum.doom9.org/showthread.php?p=760375#post760375 discussion].
|
| Script
| actionman133
|-
| [[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.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[ExBlend|Plugin]]
| StainlessS
|-
| [[FixBlendIVTC]]
| A blend replacing/frame restoring function for doubleblends caused by blend-deinterlacing of telecined sources. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[mrestore]]
| Uses conditional frame evaluation to undo standard conversions with blends. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[RemoveBlend]]
| This filter is used to remove blended fields/frames. See [http://forum.doom9.org/showthread.php?t=75772 discussion.]
| [[YV12]]
| [//web.archive.org/web/20061113201230/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].
|[[YV12]]
| 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]]
| [http://wilbertdijkhof.com/mg262/Restorefps_v10.zip Plugin]
| {{Author/mg262}}
|-
| [[Srestore]]
| Replacement function for mrestore, c_deblend, FixBlendIVTC and DupHq.
| [[YV12]]
| [[Srestore|script]]
| MOmonster
|-
| Specials
| Helps restore video with blended fields/frames using a reference source. See [http://forum.doom9.org/showthread.php?t=165030 discussion] and much more information [http://horman.net/doctorwho/specials.php here] and [http://forum.doom9.org/showthread.php?t=168832 here].
| [[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
|}

=== Film Damage correction ===

{{FilterTable}}
|[[DePulse]]
|DePulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[DePulse|Plugin]]
|
|-
| [[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]], [[YV16]], [[YV24]]
| [[DeScratch|Plugin]]
| {{Author/Fizick}}, {{Author/Myrsloik}}
|-
| [[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]]
| [[DeSpot|Plugin]]
| {{Author/Fizick}}
|-
| [[deVCR]]
| deVCR eliminates (to a certain degree) the annoying horizontal lines that keep crawling around your VHS or Beta recorded video.
| 8-bit RGB/YUV
| [[DeVCR#Script|Script]]
| Ricardo Garcia
|-
|[[KillPulse]]
|KillPulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[KillPulse|Plugin]]
|-
|[http://forum.doom9.net/showthread.php?p=1402690 KillerSpots]
|Spot removal function based on Didée's idea from 2010 that makes use of MVTools analysis and RemoveDirt to detect and clean up spots with adiacent pixels.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|[https://github.com/FranceBB/KillerSpots Script]
|Didée, GMJCZP and John Meyer.
|
|-
| [[RemoveDirt]]
| RemoveDirt is a temporal cleaner for AviSynth 2.6 and AviSynth+.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[RemoveDirt|Plugin]]
| {{Author/kassandro}}, {{Author/pinterf}}
|-
|[http://forum.doom9.org/showthread.php?t=121197 RemoveLine]
|Script for removal of horizontal stripes.
|[[YV12]]
|Script
|Yup
|-
|[https://forum.doom9.org/showthread.php?t=181777 SpotLess]
|Script filter to remove spots and noise using mvTools2 and Medianblur2. Copes with spots on multiple consecutive frames, setting RadT accordingly.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182407 SpotRemover]
|This script is designed to clean video from spots. Based on SpotLess script by StainlessS.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://forum.doom9.org/showthread.php?t=144271 VideoFred's Film Restoring]
| A suite of scripts for film restoring.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144271 Script]
| videoFred
|}

=== Frequency Interference removal ===

{{FilterTable}}
| [http://www.avisynth.nl/users/fizick/defreq/defreq.html 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://www.avisynth.nl/users/fizick/defreq/defreq07.zip Plugin]
| {{Author/Fizick}}
|-
| [http://avisynth.nl/users/vcmohan/FanFilter/FanFilter.html FanFilter]
| Regular vertical frequency interference is filtered in spatial domain.
| [[YV12]], [[YUY2]], [[RGB32]], [[RGB24]]
| [http://www.avisynth.nl/users/vcmohan/FanFilter/FanFilter.zip 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] and See [http://forum.doom9.org/showthread.php?p=1673928] for mod version.
| [[YV12]]
| Script
| thetoof
|-
| [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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=158230 Script]
| jmac698
|-
| [[FDecimate]]
| The FDecimate() filter provides extended decimation capabilities not available from 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]]
| [[FDecimate|Plugin]]
| {{Author/Donald Graft}}
|-
| [[FDecimate2]]
| FDecimate2 is based on FDecimate v1.0.2. FDecimate2, fixes some problems with bugged metrics in FDecimate v1.0.2.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FDecimate2|Plugin]]
| {{Author/StainlessS}}
|-
| [[IT]]
| Inverse Telecine plugin.
| [[YUY2]], [[YV12]]
| [[IT|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[IVTC_txt60mc|ivtc_txt60mc]]
| Deinterlaces telecined footage with that has been overlayed scrolling text at 60i.
| [[YV12]]
| [[IVTC_txt60mc|Script]]
| {{Author/cretindesalpes}}
|-
|JIVTC
|JIVTC applies inverse telecine in a way to minimize artifacts often seen on Japanese TV broadcasts followed by recalculating the fields that might still contain some.
|[[YV12]]
|[http://raw.githubusercontent.com/lovesyk/avisynth-scripts/master/JIVTC.avsi Script]
|[http://github.com/lovesyk lovesyk]
|-
|[[MDec2]]
|MDec2 is a 2 pass decimating filter, acting much like the MultiDecimate filter.
|[[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[MDec2|Plugin]]
|StainlessS
|-
| 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]]
| [{{N2Moved}}/multidecimate/multidecimate.html Plugin]
| {{Author/Donald Graft}}
|-
| RePal
| [http://forum.doom9.org/showthread.php?t=48401 Discussion] / [http://forum.doom9.org/showthread.php?p=1092552#post1092552 repal_29.97Hz_mod]
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/repal_5F25_dll_20030523.zip Plugin] - [http://forum.doom9.org/attachment.php?attachmentid=8028&d=1201414683 Mod]
| Bach
|-
| [[Decomb]]
| The Telecide and Decimate filters can be combined to implement IVTC.
| [[YUY2]], [[YV12]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=182369 TelecineBob]
|If your source soffers from field blending, as long as no deinterlacing is made you will find out that conveniently the blended fields are often paired with a clean one. FieldDeBlend takes advantage of that and checks for frames whose fields don't match to replace the frame with a clean one as long there is one.
|[[YV12]]
|[https://www.mediafire.com/file/sa1oae96m63mkje/TelecineBob.zip/file Plugin]
|Ceppo
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[TIVTC|Plugin]]
| {{Author/tritical}}
|-
| TPRIVTC
| TPRIVTC stands for TMPEG InVerse Telecine, i.e. the process where an 29.97fps interlaced NTSC clip is converted to 23.976fps while removing interlaced frames. [http://web.archive.org/web/20030808191810/http://kurosu.inforezo.org/avs/TPRIVTC/index.html Readme]
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/tprivtc_5F25_dll_20040930.zip Plugin]
| daxab, {{Author/Kurosu}}
|-
| [http://forum.doom9.org/showthread.php?t=167875 WeaveMan]
| Remove arbitrary pulldown patterns manually; meant for perfectionists to undo non-standard 24->25 fps, 25->29.97 fps, etc. telecine conversions, along with other weird telecine anomalies created by broadcasters speeding up film-sourced content. See sample case [http://forum.doom9.org/showthread.php?p=1630931&highlight=weaveman#post1630931 here].
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20131208232913/http://chidragon.thedessie.com/Doom9/WeaveMan-v0.2.zip Plugin]
| ChiDragon
|-
| [[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
| FixVHSOversharp attempts to repair the light and dark halos that follow high contrast edges found in VHS sources. See [http://web.archive.org/web/20131014010552/http://www.videohelp.eu/forum/avisynth/2851-avisynth-fixvhsoversharp-beta.html discussion.]
| | [[YUY2]]
| [http://web.archive.org/web/20091026142456/http://www.geocities.com/mrtibsvideo/fixvhsoversharp.html Plugin]
| [http://web.archive.org/web/20091027001215/http://geocities.com/mrtibsvideo/ MrTibs]
|-
| [[GhostBuster|Ghostbuster]]
| A filter for the removal of ghosting.
| [[YUY2]]
| [[GhostBuster|Plugin]]
| {{Author/SansGrip}}
|-
| [[LGhost]]
| Plugin intended for ghost removal but can also reduce edge (ringing) artifacts.
| [[YV12]], [[YUY2]]
| [[LGhost|Plugin]]
| {{Author/minamina}}
|-
| [[vsLGhost]]
| Luminance Ghost reduction filter. Can be used for removing luminance ghost or edge ghost (ringing).
| All [[Planar]] colorspaces (8-32bit)
| [[vsLGhost|Plugin]]
| {{Author/Asd-g}}
|}

=== Logo Removal ===

{{FilterTable}}
| [[AvsInpaint]]
| This plugin comes with the intention to provide a suit for the removal of logos, whether opaque or transparent. It provides algorithms for these tasks: logo detection, deblending, and logo inpainting.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[AvsInpaint|C-Plugin]]
| AMSS0815, {{Author/pinterf}}
|-
| [[DeKafka]]
| This fairly simple filter washes away those annoying bugs from broadcast clips.
| Any
| Script
| poptone
|-
| 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.
| [[RGB32]]
| [{{N2Moved}}/delogo132/delogo.html Plugin] & [http://forum.doom9.org/showthread.php?t=119447 Script]
| Karel Suhajda
|-
|[[DelogoHD]]
|DelogoHD is an overhaul of the original delogo filter, which was originally written by MakKi many years ago.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], <br> 8-16bit planar YUV
|[[DelogoHD|Plugin]]
|MeteorRain
|-
| [https://forum.doom9.org/showthread.php?t=184881 DoomDelogo]
| DoomDelogo meant to be simpler and perform better than deKafka, s_ExLogo, x-Logo and similar.
| Any
| [https://forum.doom9.org/showthread.php?t=184881 Script]
| VoodooFX
|-
| [[ExInpaint]]
| Exemplar-Based Image Inpainting. See [http://forum.doom9.org/showthread.php?t=133773 discussion]
| [[RGB24]] [[RGB32]], [[YUY2]], [[YV12]]
| [[ExInpaint|Plugin]]
| {{Author/Fizick}}
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|InpaintDelogo is an advanced logo and watermark removal function using inpainting and deblending with an adjustable fine process to hide artifacts and get best delogo results.
Can remove opaque, transparent, semi-transparent and some dynamic logos from video.
Can be used to remove hardcoded subtitles or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
| [[InpaintFunc]]
| Script for logo removal using inpainting. Can remove alpha blended or opaque logos with a basic postprocessing to hide artifacts.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[InpaintFunc|Script]]
| Reuf Toc
|-
| LogoNR
| Post-denoise filter for EraseLogo or [[DelogoHD]]. See [https://web.archive.org/web/20210915185704/https://www.nmm-hd.org/newbbs/viewtopic.php?t=649 discussion]
| All [[planar]] colorspaces
| [https://web.archive.org/web/20220702130736/https://pastebin.com/raw/qZBU3NQA Script]
| {{Author/06_taro}}
|-
| [[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]
| [[YV12]]
| [http://avisynth.nl/images/Rm_logo.avs Script]
| Spuds
|-
|[http://forum.doom9.org/showthread.php?t=154559 s_ExLogo]
|De-logo function with clipping (Dekafka mod).
|[[YUY2]]
|[http://www.mediafire.com/download/40cpnnctd0uutpv/s_ExLogo_1.1.zip Script]
|{{Author/StainlessS}}
|-
| [[Uglarm]]
| Filter for blurring a logo, using LogoAway style Uglarm Interpolation method.
| [[RGB24]] [[RGB32]],[[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[Uglarm|Plugin]]
| {{Author/StainlessS}}
|-
| [[X-Logo]]
| X-Logo AviSynth plugin and VirtualDub filter. Removes opaque logos.
| [[RGB32]], [[YUY2]], [[YV12]]
| [[X-Logo|Plugin]]
| [http://web.archive.org/web/20041204210505/http://members.verizon.net/~vze3kkvm/filters.html Leuf]
|}

=== Luma Equalization ===

{{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://www.avisynth.nl/users/warpenterprises/files/antiflicker_5F25_dll_20030304.zip Plugin]
| {{Author/Donald Graft}}
|-
| [[DeFlicker]]
| Can remove old film intensity flicker by temporal mean luma smoothing. Can also correct blinding of automatic gain control after flashes.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]]
| [[DeFlicker|Plugin]]
| {{Author/Fizick}}, {{Author/pinterf}}
|-
| [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}}
|-
| [[EquLines]]
| Equalizes total luminosity in pairs of even and odd lines. Useful for removing inter-line differences from telecined films.
| [[YV12]], [[YUY2]]
| [[EquLines|Plugin]]
| {{Author/Fizick}}
|-
| [[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]]
| [[LMFlicker|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
|-
| [[ReduceFlicker]]
| Plugin to reduce temporal oscillations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[ReduceFlicker|Plugin]]
| {{Author/kassandro}}, {{Author/Chikuzen}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[TimeLapseDF|Plugin]]
| {{Author/Denis Zhitenev}}
|-
| [[Vinverse]]
| A simple but effective plugin to remove residual combing.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bit planar Y/YUV
| [[Vinverse|Plugin]]
| {{Author/Didée}}, {{Author/tritical}}, {{Author/tp7}}
|-
| [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
|}

=== [[:Category:Rainbow & Dot Crawl Removal|Rainbow & Dot Crawl Removal]] ===

{{FilterTable}}
| [[Bifrost]]
| Bifrost uses temporal blending to remove or at least reduce the effect of rainbows.
| [[YV12]]
| [[Bifrost|Plugin]]
| {{Author/Myrsloik}}, dubhater
|-
| [[CC]]
| Dot crawl and rainbow removal.
| [[YV12]], [[YUY2]]
| [http://www.chiyoclone.net/dl/cc_20040522.lzh Plugin]
| {{Author/chiyo-clone}}
|-
| [[Checkmate]]
| Spatial-temporal dot crawl removal.
| [[YV12]]
| [[Checkmate|Plugin]]
| {{Author/mf}} / prunedtree
|-
| [[ChubbyRain]]
| Spatial-temporal rainbow reducing script.
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain.avsi Script]
| Mug Funky
|-
| [[ChubbyRain2]]
| Spatial-temporal rainbow reducing script based on [[ChubbyRain]].
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain2.avsi Script]
| Lothar
|-
| [[DDCR]]
| A purely spatial dot crawl removal script for AviSynth+.
| all 8 bit Y/YUV colorspaces
| [[DDCR|Script]]
| Reel.Deal
|-
| [[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]]
| [[DeCross|Plugin]]
| {{Author/minamina}}
|-
| [[DeDot]]
| Removes dot crawl and may also be useful for rainbows.
| all planar Y, YUV, and YUVA (8-16 bit)
| [[DeDot|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[DeRainbow]]
| A simple script to reduce rainbows. See [http://forum.doom9.org/showthread.php?p=398106#post398106 discussion.]
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/images/DeRainbow.avsi 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]]
| [http://avisynth.nl/images/DFMDeRainbow-20140223.avsi Script]
| {{Author/Scintilla}}
|-
|[[DotKill]]
|Spatio-temporal dotcrawl and rainbow remover.
|[[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bits
|[[DotKill|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=170328 FadeDeRainbow]
|Another de-rainbowing script.
|[[YV12]]
|[https://forum.doom9.org/showthread.php?t=170328 Script]
|bxyhxyh
|-
| [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 spatial; only targets pixels for dot crawl removal if luma is fluctuating and (optionally) chroma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/http://www.aquilinestudios.org/scripts/LUTDeCrawl-20081003.avsi Script]
| {{Author/Scintilla}}
|-
| [[LUTDeRainbow]]
| Purely spatial; only targets pixels for derainbowing if chroma is fluctuating and (optionally) luma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/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.
| [[YV12]]
| [http://avisynth.nl/images/MfRainbow-v0.32.avsi Script]
| {{Author/mf}}
|-
| [[Rainbow_Smooth]]
| A small spatial derainbow function. It uses [[SmoothUV]] to smooth out chroma and edge masking to prevent color bleeding.
| [[YV12]]
| [http://avisynth.nl/images/Rainbow_smooth.avsi 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.
| [[YV12]]
| [http://avisynth.nl/images/SmartSSIQ.avsi 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}}
|-
| [[TComb]]
| A temporal comb filter (it reduces cross-luminance (rainbowing) and cross-chrominance (dot crawl) artifacts in static areas of the picture).
| [[YV12]], [[YUY2]]
| [[TComb|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]]
| [[YARK|Script]]
| jase99
|-
| [[ASTDR]]
| ASTDR uses mt_motion for motion and edge to deal with moving Rainbow and apply mask once more in the opposite way to keep around the lines as they are. It uses DeCross and other filters to remove Rainbow. ASTDRmc avoids chroma bleeding in moving scenes. See [http://forum.doom9.org/showpost.php?p=1665492&postcount=27 post on doom9.org].
| [[YV12]]
| [[ASTDR|Script]]
| AmjadSONY
|}

=== Stabilization ===

{{FilterTable}}
| [[CelStabilize]]
| Script which holds a fixed background steady. Doesn't work well with pans or fades.
| [[YV12]]
| [http://avisynth.nl/index.php/CelStabilize Script]
| mg262
|-
| [[DePan]]
| Tools for estimation and compensation of global motion (pan).
| [[YUY2]], [[YV12]]
| [[DePan|Plugin]]
| {{Author/Fizick}}
|-
|[[Depansafe]]
|Another DePan stabilization script.
|[[YV12]]
|[[DepanSafe|Script]]
|[http://pastebin.com/u/tophf tophf]
|-
| [[Deshaker3D]]
| Experimental 3D image stabilizer (VDub [http://www.guthspot.se/video/deshaker.htm Deshaker] required).
| [[RGB32]]
| [[Deshaker3D|Plugin]]
| {{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=172136 SpatialAlign]
|Fix spatial alignment between two clips containing similar scenes.
|Any?
|[http://forum.doom9.org/showthread.php?t=172136 Script]
|StainlessS
|-
|[https://github.com/arnean/PerfPan PerfPan]
|PerfPan is an AviSynth plugin to stabilize scanned film using perforation as a reference.
|All colorspaces
|[https://github.com/arnean/PerfPan/tree/master/windows Plugin]
|[https://github.com/arnean arnean]
|-
| [[Stab]]
| Simple but powerful script to remove small high frequency jitter that appears often on old/bad transfers.
| [[YV12]]
| [[Stab|Script]]
| g-force
|-
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Stabilization Tools Pack]
| A set of tools to work with common stabilization issues, mainly from telecine process.
|[[YV12]]
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Script]
|{{Author/Dogway}}
|-
|[https://forum.doom9.org/showthread.php?t=182532 Stab_Light]
|Another stabilization script; based on Stab3.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://web.archive.org/web/20151223052321/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)
| [[YV12]]
| [http://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|}

== Denoisers ==
Strength/Quality of Denoisers

(need subclassification)

{{FilterTable}}
| [[AdaptiveMedian]]
| This is an adaptive Median Filter for eliminating certain types of noise. It uses local statistics (minimum, maximum and median values) of a moving local grid, and changes grid size depending on local statistics.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AdaptiveMedian|Plugin]]
|{{Author/vcmohan}}
|-
|[[Deathray]]
|OpenCL GPU accelerated spatial/temporal non-local means de-noising.
|[[YV12]]
|[[Deathray|Plugin]]
|[http://github.com/JawedAshraf Jawed]
|-
| [[DeNoise]]
| This is an adaptive local noise reduction filter. It uses global variance of the noise, local mean and local variance in a moving grid of specified size. It tries to preserve edges as closely as possible. The global variance value can be specified or it can be computed from a window. The global variance can have one value for the entire clip or can vary frame to frame linearly or computed from a window with its coordinates linearly moving with frame numbers.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DeNoise|Plugin]]
| {{Author/vcmohan}}
|-
| [http://web.archive.org/web/20071105084352/http://www.geocities.com/fredthompson6/Kiraru2002/Kiraru2002sROOM.htm#dnr2 DNR2]
| Dynamic Noise Reduction 2 is based on the VirtualDub [http://www.shdon.com/vid/dnr DNR] filter by Steve Don and Avery Lee.
| [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/dnr2_5F25_dll_20021225.zip Plugin]
| {{Author/kiraru2002}}
|-
| [[DeSaltPepper]]
| Remove white and black noise.
| Any
| [[DeSaltPepper|Plugin]]
| {{Author/vcmohan}}
|-
| [[FFTQuiver]]
| Remove periodic noise. Useful for analog interference.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[FFTQuiver|Plugin]]
| {{Author/vcmohan}}
|-
| [[TNLMeans]]
| TNLMeans is an implementation of the NL-means denoising algorithm.
*[http://forum.doom9.org/showthread.php?t=171817 TfNLMeans] - an AviSynth 2.6 fork of TNLMeans 1.0.3
| [[YV12]], [[YUY2]]
| [[TNLMeans|Plugin]]
| {{Author/tritical}}
|-
| [[KNLMeansCL]]
| KNLMeans is an optimized OpenCL implementation of the Non-local means denoising algorithm.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[KNLMeansCL|Plugin]]
| [http://github.com/Khanattila Khanattila]
|-
|[http://forum.doom9.org/showthread.php?t=172966 xNLMeans]
|xNLMeans is an AviSynth plugin implementation of the Non Local Means denoising proposition. This implementation provides several optimizations and extensions over the original proposition and other implementations.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/4stpv24pvpfclzm/xNLMeans_0.03_20160324.zip Plugin] 
|martin53
|}

=== 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 [{{N2Moved}}/2dcleaner.html 2D Cleaner.]
| [[YV12]], [[YUY2]]
| [[_2DCleanYUY2|Plugin]]
| {{Author/kiraru2002}}, {{Author/xeon533}}
|-
| [[DctFilter]]
| An experimental filter that operates on DCT coefficients.
| [[YV12]], [[YUY2]]
| [[DctFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[frfun7]]
| Fractal denoising. See [http://forum.doom9.org/showthread.php?t=110200 discussion]
| [[YV12]]
| [[Frfun7|Plugin]]
| prunedtree
|-
| [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
|-
|Kuwahara
|This filter is an edge preserving spatial noise reduction filter. It applies spatial smoothing while preserving the edges. See [http://forum.doom9.org/showthread.php?p=1689773 discussion]
|[[RGB24]], [[RGB32]]
|[http://www.wilbertdijkhof.com/Kuwahara_v11.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
|[[MiniDeen]]
|MiniDeen is a spatial denoising filter. It replaces every pixel with the average of its neighbourhood. This is a port of the "a2d" method from the AviSynth plugin [[Deen]], version beta 2.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[MiniDeen|Plugin]]
|{{Author/dubhater}} / MeteorRain
|-
|[[Neo_VagueDenoiser]]
|Wavelet based Denoiser. Refactored version of the original VagueDenoiser; includes optimizations, additional colorspaces, and high bit depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[Neo_VagueDenoiser|Plugin]]
| HolyWu, [https://github.com/msg7086 MeteorRain]
|-
|[[sbr]]
|sbr is helper function to make a highpass on a blur's difference.
|All YUV [[planar]] 8 to 16-bit colorspaces
|[[sbr|Plugin]]
|{{Author/Asd-g}}
|-
| [[SmoothUV2]]
| SmoothUV2 is a spatial derainbow filter. This filter performs structure-preserving smoothing (blurring) on the U/V (chrominance or colour) information of the image, leaving Y (luminance) intact.
| All YUV, YUVA [[planar]] 8 to 16-bit colorspaces
| [[SmoothUV2|Plugin]]
| {{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[SPresso]]
|A fast script to make SD content compress better while keeping the "original look".
|[[YV12]]
|[[SPresso|Script]]
|{{Author/Didée}}
|-
| [[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]]
| [[TBilateral|Plugin]]
| {{Author/tritical}}
|-
| [[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.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[VagueDenoiser|Plugin]]
| {{Author/Lefungus}}, {{Author/Kurosu}}, {{Author/Fizick}}
|-
|[[vsMSmooth]]
|vsMSmooth is a spatial smoother that doesn't touch edges.
||[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSmooth|Plugin]]
|{{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[vsTBilateral]]
|vsTBilateral is a spatial smoothing filter that uses the bilateral filtering algorithm.
|All [[planar]] 8 to 16-bit colorspaces
|[[vsTBilateral |Plugin]]
|{{Author/Asd-g}}
|}

=== Temporal Denoisers ===

{{FilterTable}}
| [[Cnr2]]
| A fast chroma denoiser. Very effective against stationary rainbows and huge analogic chroma activity. Useful to filter VHS/TV caps.
| [[YV12]], [[YUY2]]
| [[Cnr2|Plugin]]
| {{Author/Marc FD}}, {{Author/tritical}}
|-
| [[FluxSmooth]]
| Examines each pixel and compares it to the corresponding pixel in the previous and last frame.
| [[YV12]], [[YUY2]]
| [[FluxSmooth|Plugin]]
| {{Author/SansGrip}}, {{Author/Sh0dan}}
|-
| MDegrain
| Strong and effective temporal denoiser. Part of the [[MVTools]] package.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| [[TTempSmooth]]
| TTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TTempSmoothv094.zip Plugin]
| {{Author/tritical}}
|-
| [[Temporal Degrain]]
| SLOW but very effective at removing most grain from video sources.
| [[YV12]]
| [http://avisynth.nl/images/TemporalDegrain.avs Script]
| Didée, Sagekilla
|-
| [[TemporalDegrain2]]
| Temporal Degrain enhanced with parts of QTGMC, potentially slower but more effective at removing grain from video sources while retaining more details.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]] (8-16 bit)
| [[TemporalDegrain2|Script]]
| Didée, Sagekilla, Vit, real.finder, ErazorTT
|-
|[[vsCnr2]]
|vsCnr2 is a temporal denoiser designed to denoise only the chroma.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-16 bit)
|[[vsCnr2|Plugin]]
|{{Author/Asd-g}}
|-
|[[vsTTempSmooth]]
|vsTTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-32 bit)
|[[vsTTempSmooth|Plugin]]
|HolyWu, {{Author/Asd-g}}
|}

=== Spatio-Temporal Denoisers ===

{{FilterTable}}
|[[BM3DCUDA]]
|BM3D denoising filter for AviSynth+, implemented in CUDA.
|32-bit [[planar]] colorspaces
|[[BM3DCUDA|Plugin]]
|[https://github.com/WolframRhodium WolframRhodium]
|-
| [[Convolution3D]]
| Convolution3D is a spatio-temporal smoother, it applies a 3D convolution filter to all pixels of consecutive frames.
| [[YV12]]
| [[Convolution3D|Plugin]]
| {{Author/Vlad59}}
|-
| [[Deen]]
| Deen is a set of assembly-optimised denoisers, like various 3d and 2d convolutions.
| [[YV12]]
| [[Deen|Plugin]]
| {{Author/Marc FD}}
|-
| 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].
| [[YV12]]
| [https://web.archive.org/web/20160604213634/http://forum.doom9.org/showthread.php?t=162603 Script]
| rean
|-
| [[dfttest]]
| A 2D/3D frequency domain denoiser.
| [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[dfttest|Plugin]]
| {{Author/tritical}}
|-
| dfttestMC
| A script that motion compensates dfttest. See [http://forum.doom9.org/showthread.php?t=147676 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=147676 Script]
| thewebchat
|-
| [[DeGrainMedian]]
| Two stage Spatio-Temporal Limited Median filter for grain removal.
| [[YV12]], [[YUY2]]
| [[DeGrainMedian|Plugin]]
| {{Author/Fizick}}
|-
| [[FFT3DFilter]]
| A 3D Frequency Domain filter - gives strong denoising and moderate sharpening.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], any Y, YUV and Planar RGB 8-32 bit
| [[FFT3DFilter|Plugin]]
| {{Author/Fizick}}, martin53, {{Author/pinterf}}
|-
| [[FFT3DGPU]]
| Similar algorithm to FFT3DFilter, but uses graphics hardware for increased speed.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], Planar RGB 8 bit
| [[FFT3DGPU|Plugin]]
| {{Author/tsp}}, {{Author/pinterf}}
|-
| [[hqdn3d]]
| High Quality DeNoise 3D is an Avisynth 2.5 port of the MPlayer filter of the same name. It performs a 3-way low-pass filter, which can completely remove high-frequency noise while minimizing blending artifacts.
| 8-16bit planar YUV
| [[hqdn3d|Plugin]]
| {{Author/akupenguin}}
|-
|[https://forum.doom9.org/showthread.php?t=174804 mclean]
|Typical spatial filters work by removing large variations in the image on a small scale, reducing noise but also making the image less sharp or temporally stable. mClean removes noise whilst retaining as much detail as possible, as well as provide optional image enhancement.
|[[YV12]], [[HBD]]
|[https://forum.doom9.org/showthread.php?t=174804 Script]
|burfadel
|-
| [[MC_Spuds]]
| Motion compensated noise removal with sharpening. Extremely slow, but extremely effective.
| [[YV12]]
| [[MC_Spuds|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]]
| [[MCTemporalDenoise|Script]]
| {{Author/LaTo}}
|-
| RemoveDirtMC
| See [http://forum.doom9.org/showthread.php?p=1485300#post1485300 discussion].
| [[YV12]]
| [https://github.com/realfinder/AVS-Stuff/raw/master/avs%202.5%20and%20up/RemoveDirtMC_SE.avsi Script]
| Nephilis/A.SONY
|-
| [[RemoveGrainHD]]
| RemoveGrainHD is like RemoveGrain but intended for high definition content. It includes various spatial and temporal functions. See [http://web.archive.org/web/20130412014246/http://www.removegrainhd.de.tf/ documentation.]
| [[YV12]], [[YUY2]]
| [[RemoveGrainHD|Plugin]]
| {{Author/kassandro}}
|-
|-
| 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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=110078 Script]
| Heini011
|-
| [[RgTools]]
| Modern rewrite of <tt>[[RgTools/RemoveGrain|RemoveGrain]]</tt>, <tt>[[RgTools/Repair|Repair]]</tt>, <tt>[[RgTools/BackwardClense|BackwardClense]]</tt>, <tt>[[RgTools/Clense|Clense]]</tt>, <tt>[[RgTools/ForwardClense|ForwardClense]]</tt> and <tt>[[RgTools/VerticalCleaner| VerticalCleaner]]</tt> all in a single plugin.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RgTools|Plugin]]
| {{Author/tp7}}, {{Author/pinterf}}
|-
|[[SMDegrain]]
|SMDegrain is a convenience function for using MDegrain, including 16bit and interlaced support, with extra capabilities for light sharpening and spatial filtering.
| [[YUY2]], [[YV12]]
|[[SMDegrain|Script]]
|{{Author/Dogway}}
|-
|[[STPresso]]
|A fast script to make SD/720p content compress better without losing detail and original grain structure.
|[[YV12]]
|[[STPresso|Script]]
|{{Author/Didée}}
|-
|[[vsDeGrainMedian]]
|vsDeGrainMedian is a spatio-temporal limited median denoiser.
|All [[planar]] 8 to 16bit colorspaces
|[[vsDeGrainMedian|Plugin]]
|{{Author/Asd-g}}
|-
| 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 ==

=== Averaging/Layering/Masking ===

{{FilterTable}}
| [[Average]]
| A simple plugin that calculates weighted frame-by-frame average from multiple clips.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Average|Plugin]]
| {{Author/tp7}}, {{Author/mg262}}
|-
|[[AviSynthGimpLayer]]
|AviSynth Gimp-style Layer merge plugin.
|[[RGB24]], [[RGB32]]
|[[AviSynthGimpLayer|Plugin]]
| [http://sourceforge.net/u/panzerboy66/profile/ panzerboy66]
|-
|[[AVS_SoftLight]]
|AviSynth+ plugin. It makes a softlight blend with a negative of average. Only x64 version available and with CUDA support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AVS_SoftLight|Plugin]]
|Argaricolm
|-
| BlockAverage
| A simple filter that just averages the Y values of each 2x2 pixel block in a YV12 image – U and V values are left alone as they already common to each 2x2 block in a progressive YV12 image. Just made to see if it satisfies the requirements in [http://forum.doom9.org/showthread.php?s=&threadid=91580&perpage=10&pagenumber=1 this thread].
| [[YV12]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/blockaverage01.zip Plugin]
| {{Author/Simon Walters}}
|-
|CheckMask
|A YV12 spatial dot finding filter for AviSynth.
|[[YV12]]
|[http://www.avisynth.nl/users/warpenterprises/files/checkmask_5F25_dll_20050310.zip Plugin]
|[http://web.archive.org/web/20090618112048/http://kawaii-shoujo.net/AntiAliased/index.html Dan Donovan]
|-
|[[ClipBlend]]
|Filter to blend consecutive frames in a clip.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[ClipBlend|Plugin]]
|StainlessS
|-
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe.html ColorKeyFrame]
| Linear interpolation of color correction with key frames.
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe03.zip Plugin]
| {{Author/Fizick}}
|-
|[[ColorScreenMask]]
|ColorScreenMask is a special effects plugin for processing chroma key (i.e., a green screen or blue screen) backgrounds. It uses color thresholds rather than absolute values as the criteria for setting the alpha channel transparency.
|[[RGB32]]
|[[ColorScreenMask|Plugin]]
|Grandpa Oddball
|-
|[[ColourMask]]
|Creates colour masks.
|[[YV12]]
|[[ColourMask|Plugin]]
|{{Author/mg262}}
|-
|[[CombMask]]
|A filter to create and process comb masks. These filters were written from scratch, but most of logic comes from tritical's [[TIVTC]] plugin.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CombMask|Plugin]]
|{{Author/Chikuzen}}
|-
|[[Fusion]]
|Pyramidal image processing for video, it uses image pyramids to blend clips together (more commonly used in the creation of HDR images and image stitching).
|[[RGB32]]
|[[Fusion|Plugin]]
|{{Author/David Horman}}
|-
| [[GraMaMa]]
| Gradient Mask Maker: Creates a mask (either a gradient or black/white) given a prescribed shape (such as circle, ellipse, line, square or rectangle).
| [[YV12]]
| [[GraMaMa|Plugin]]
| {{author/E-Male}},
{{author/Wilbert Dijkhof}}
|-
|[http://umezawa.dyndns.info/archive/imck/imck-2.3.0-readme.html ImasMultiColorKeying]
|Chroma keying filter (Japanese)
|[[RGB32]]
|[http://umezawa.dyndns.info/archive/imck/ Plugin]
|Umezawa Takeshi
|-
|MaskCrop
|Non-clip plugin and function to speed up filtering with a mask.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.dropbox.com/s/8c4rxlwbs020ib1/MaskCrop0.1.2.7z?dl=1 Plugin] 
|
|-
|[http://forum.videohelp.com/threads/369143-ResizersPack-MasksPack-PlaygroundPack-SmoothContrast-Logo-mod-functions?s=7811fcf9c429ffb99f2e0a4b8043832d&p=2364052&viewfull=1#post2364052 MasksPack]
|This is a set of functions related to masks, so localized filtering will be able, giving you finer control on how and where to filter or protect certain zones.
|[[YV12]]
|[http://www.mediafire.com/download/mch99c0z5957u9z/MasksPack2.3.zip Script]
|{{Author/Dogway}}
|-
|[[Median]]
|A filter plugin for AviSynth which generates a pixel-by-pixel median of several clips. This is particularly useful for filtering out noise and glitches from multiple VHS/SVHS/8mm/Hi8 tape captures, but can be used for other purposes also.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[Median|Plugin]]
|{{Author/ajk}}
|-
|[[MTCombMask]]
|This filter produces a mask showing areas that are combed, it uses 3-point sampling to determine combing in a pixel.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-32bit planar Y/YUV/YUVA
|[[MTCombMask|Plugin]]
|{{Author/Manao}}, [https://github.com/Asd-g Asd-g]
|-
|[[OverlayPlus]]
|Layering scrip similar to AviSynth's internal Overlay but includes more blending modes and some additional features.
|All 8-32bit colorspaces
|[[OverlayPlus|Script]]
|reel.deel
|-
| ParameterisedBlend
| ParameterisedBlend allows you to blend any number of frames within a clip, or blend any number of different clips together. You can use it as an extended, gamma-aware replacement for Merge().
| [[YV12]]
| [https://web.archive.org/web/20201020085042/https://sites.google.com/site/ourenthusiasmsasham/soft#TOC-ParameterisedBlendd Plugin]
| [https://web.archive.org/web/20201020085035/https://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
|[http://forum.doom9.org/showthread.php?t=172388 Polygon]
|The very raw beginning of a plugin for drawing high quality polygons (mainly to be used as masks) in AviSynth.
| [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=172388 Plugin]
| {{Author/David Horman}}
|-
|[[RedAverage]]
|Frame-by-frame averaging/merging of multiple clips. Includes a masked average, weighted average, and a merge filter.
|[[YV12]]
|[[RedAverage|Plugin]]
|redfordxx
|-
|[http://github.com/jojje/shapemask ShapeMask]
|A filter plugin for AviSynth that identifies bright areas such as projector screens at conferences and creates a mask out of them. The use case for which it was created is to deal with overly bright lectures, such as screen casts or talks where the speaker or producer hasn't followed presentation 101; Use light text on a dark background! See [http://forum.doom9.org/showthread.php?t=172308 discussion.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20150702103042/http://snarl.zapto.org/files/ShapeMask-1.0.zip Plugin]
|[http://github.com/jojje jojje]
|-
|[[TColorMask]]
|A simple color masking plugin for AviSynth.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8/16bit planar YUV
|[[TColorMask|Plugin]]
|{{Author/tp7}}
|-
|[[TCombMask]]
|TCombMask is a simple filter that creates a comb map that can (could) be used by other filters. It currently supports optional motion adaption, optional spatial adaption, optional luma <-> chroma linking, different thresholds for chroma and luma, and much more.
|[[YUY2]], [[YV12]]
|[[TCombMask|Plugin]]
|{{Author/tritical}}
|-
|[[TempLinearApproximate]]
|TempLinearApproximate takes several frames and for each pixel calculates linear approximation of its values through time, then returns its value in the middle (unless close to beginning or end of clip) of that line.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[TempLinearApproximate|Plugin]]
|Mystery Keeper
|-
|[[TMaskCleaner]]
|A really simple mask cleaning plugin for AviSynth based on mt_hysteresis.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[TMaskCleaner|Plugin]]
|{{Author/tp7}}
|-
| [[TMM]]
| TMM builds a motion-mask for TDeint, which TDeint uses via its 'emask' parameter.
| [[YUY2]], [[YV12]]
| [[TMM|Plugin]]
| {{Author/tritical}}
|-
| [[TMM2]]
| A rewrite of TMM
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[TMM2|Plugin]]
| {{Author/Chikuzen}}
|-
| [[Unpremultiply]]
| This plugin convert the input RGBA clip from premultiplied alpha to straight matted alpha.
| [[RGB32]]
| [[Unpremultiply|Plugin]]
| [http://web.archive.org/web/20160610124858/http://code.google.com/p/avisynth-unpremultiply/ Josh Sutinen]
|-
| [[uu_mt_blend]]
| ''Blend'' (''[[Overlay]], [[Layer]]'') two clips using [[MaskTools2|MaskTools]]. Wide selection of blend modes.
| [[YV12]],[[RGB24]],[[RGB32]]
| [[Media:UU_mt_blend.avs|Script]]
| rafriff42
|-
|[[Watermark2]]
|Creates a transparent deformation in the video akin to a watermark. The watermark is defined by a black and white image which may be a dynamic image. The intensity of the effect is controlled by several parameters.
|[[RGB32]]
|[[Watermark2|Plugin]]
|[http://sourceforge.net/u/phillvanleersum/profile/ DrPhill], {{Author/StainlessS}}
|-
| [[YRangeMask]]
| AviSynth script to create a mask by specifying the range of the brightness.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[YRangeMask|Script]]
| Chikuzen
|}

=== Blurring ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect BlurDetect]
|Determines blurriness of frames.
|All 8-16 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect/releases Plugin]
|{{Author/Asd-g}}
|-
|[https://www.animemusicvideos.org/forum/viewtopic.php?t=101724 BlurMod/ApplyOnAngle]
|BlurMod() shrinks, blurs, then resizes; resulting in a very strong blur. ApplyonAngle() rotates, filters, then rotates back; making any filter appear as if applied on an angle.
|[[YV12]]
|Script
|Phantasmagoriat
|-
| [[BucketMedian]]
| BucketMedian is an implementation of spatial median filter adapting bucket (counting) sort algorithm.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[BucketMedian|Plugin]]
| {{Author/Chikuzen}}
|-
| [[FastBlur]]
| Fast approximate Gaussian blurs.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FastBlur|Plugin]]
| {{Author/David Horman}}
|-
| [[GBlur]]
| Gaussian blur.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[GBlur|Plugin]]
| {{Author/vcmohan}}
|-
|[[MedianBlur]]
| A plugin with 5 different types of median blur filters.
| [[YV12]]
| [[MedianBlur|Plugin]]
| {{Author/tsp}}
|-
|[[MedianBlur2]]
| Implementation of [http://nomis80.org/ctmf.html constant time median filter] for AviSynth 2.6, similar to MedianBlur.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MedianBlur2|Plugin]]
| {{Author/tp7}}
|-
|[[neo_TMedian]]
|Temporal denoising filter that replaces every pixel with the median of its temporal neighbourhood.
|8-16 and 32-bit planar
|[[neo_TMedian|Plugin]]
|[https://github.com/msg7086 MeteorRain]
|-
| [[VariableBlur]]
| VariableBlur is a Gaussian, binomial or average blur filter with a variable radius (variance).
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]],
| [[VariableBlur|Plugin]]
| {{Author/tsp}}, {{Author/tritical}}
|-
| [[VariableMedian]]
| A simple median filter. See [http://forum.doom9.org/showthread.php?t=83985 discussion]
| [[RGB32]]
| [http://web.archive.org/web/20091027134543if_/http://www.geocities.com/siwalters_uk/variablemedian.zip Plugin]
| {{Author/Simon Walters}}
|}

=== Borders and Cropping ===

{{FilterTable}}
|[[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. See original [http://forum.doom9.org/showthread.php?t=37204 discussion] and updated AutoCrop [http://forum.doom9.org/showthread.php?t=87602 discussion]
| [[YUY2]], [[YV12]]
| [http://len0x.leffe.dnsalias.com/autocrop12.zip Plugin]
| [http://web.archive.org/web/20050404182221/http://www.videofringe.com/autocrop/ Glenn Bussell], len0x
|-
|[[BorderControl]]
| It's designed to allow you to manipulate the regions at the top, bottom and sides of a frame. Set a black border, set a border region to be faded out and you can "smear" the border to save having to crop and resize the whole frame for the sake of a few pixels. Each border (top,bottom.left and right) can be manipulated independently. See [http://forum.doom9.org/showthread.php?t=33479 discussion] and [http://avisynth.org.ru/docs/english/externalfilters/bordercontrol.htm documentation].
| [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20140709005736/http://www.geocities.com/siwalters_uk/bordercontrol14.zip Plugin]
|{{Author/Simon Walters}}
|-
|[https://github.com/slavanap/ssifSource CropDetect]
| Plugin to detect black bounding box in video and crop it easily. See [http://forum.doom9.org/showthread.php?p=1761842#post1761842 discussion]. Note, CropDetect small plugin merged within ssifSource project. Look for "CropDetect" function in Sub3D.dll
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|-
|CropEven
|Script to crop evenly based on the dimensions given. It will crop the extra pixels off the bottom and right sides if the target resolution is odd. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1739589#post1739589 Script]
|Desbreko
|-
|[[EdgeFixer]]
|EdgeFixer repairs bright and dark line artifacts near the border of an image.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[EdgeFixer]]
|[https://github.com/sekrit-twc sekrit-twc]
|-
|[[FillBorders]]
|This is a simple filter that fills the borders of a clip, without changing the clip's dimensions.
|All [[planar]] colorspaces
|[[FillBorders]]
|[http://github.com/dubhater dubhater] / Asd
|-
|Padding
|Duplicate edge pixels to the outside with [[PointResize]]. See [http://forum.doom9.org/showthread.php?t=165946 discussion.]
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showpost.php?p=1596804&postcount=5 Script]
|{{Author/Didée}}
|-
|PadFFT
|A simple plugin to add borders evenly on each side. See [https://forum.doom9.org/showthread.php?p=1769503#post1769503 discussion]
|[[Y8]], [[YV12]]
|[https://web.archive.org/web/20221113033752if_/https://files.videohelp.com/u/223002/PaddFFT_dll_v0.02_20160604.zip Plugin]
|StainlessS
|-
|PadToMod
|Script to pad to a specified mod. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1746579#post1746579 Script]
|Desbreko
|-
|[[RoboCrop]]
| RoboCrop is an automatic cropping solution to crop black borders from video clips, loosely based on (but using no code from) AutoCrop by Glenn Bussell. See [http://forum.doom9.org/showthread.php?t=168053 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
| [[RoboCrop|Plugin]]
| StainlessS
|}

=== Colourspace Conversion ===

{{FilterTable}}
|[https://forum.doom9.org/showthread.php?t=183453 ColorMatrixTransform]
|AviSynth+ plugin for applying a color matrix transform to 32 bit floating point clips.
|[[RGBPS]]
|[https://github.com/TomArrow/ColorMatrixTransform/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| 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
|-
|[https://forum.doom9.org/showthread.php?t=183990 LabConvert]
|AviSynth+ plugin to convert to LChab (derivative of LAB) color space and back for beautiful color manipulations.
|[[RGBPS]], [[YUV444PS]]
|[https://github.com/TomArrow/LabConvertAVS/releases/ Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| ManualColorMatrix
| Can perform any matrix-based color conversion. See [http://forum.doom9.org/showthread.php?t=161777 discussion.]
| [[RGB24]], [[RGB32]], [[YV24]]
| [http://forum.doom9.org/attachment.php?attachmentid=12346&d=1309522614 Plugin]
| xv
|-
|[[nnedi3_resize16]]
|An advanced script for high quality 16-bit image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
|[[PlanarTools]]
|This plugin is a set of filters that offers converting packed(interleaved) formats to planar formats and vice versa.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV16]]
|[[PlanarTools|Plugin]]
|{{Author/Chikuzen}}
|-
|[[YV12To422]]
|YV12 to YV16/YUY2 converter for AviSynth 2.6.
|[[YV12]]
|[[YV12To422|Plugin]]
|{{Author/Chikuzen}}
|}

=== Effects ===

{{FilterTable}}
| [[AddGrainC]]
| 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
| [[RGB24]], [[RGB32]], [[YUY2]],
[[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[AddGrainC|Plugin]]
|{{Author/Tom Barry}}, {{Author/Foxyshadis}}<br>
{{Author/LaTo}}, {{Author/cretindesalpes}}
|-
| AddStaticGrainM
| This function adds static grain in dark areas based on a mask.
| [[YV12]]
| [[AddStaticGrainM_source|Script]]
| [http://canihaziframe.wordpress.com/2011/02/23/addstaticgrainm/ Daiz]
|-
| [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://www.avisynth.nl/users/warpenterprises/files/blockbuster_5F25_src_20021229.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://www.avisynth.nl/users/warpenterprises/files/avishader_5F25_dll_20041228.zip Plugin]
| Antitorgo
|-
|[[AGM]]
|Uses an adaptive mask based on frame and pixels brightness to apply grain.
|All YUV [[planar]] colorspaces
|[[AGM|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=167217 Checker]
|Checkerboard combining filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://www.mediafire.com/?ewq8rc0aprzmk8r Plugin] /// [https://web.archive.org/web/20230206191644if_/https://files.videohelp.com/u/223002/checker.zip Archived]
|{{Author/Chikuzen}}
|-
|[https://forum.doom9.org/showthread.php?t=184052 ChickenDream]
|Realistic film-grain rendering for AviSynth+.
|[[Y32]], [[RGBPS]]
|[https://github.com/EleonoreMizo/chickendream/releases Plugin]
|{{Author/cretindesalpes}}
|-
| [[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]]
| [[ColorLooks|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
| [[crt_display]]
| CRT emulation with scanline and phosphor effects. crt_display emulates a CRT display using aperture grille (Trinitron) or Cromaclear technologies.
| [[RGB24]], [[RGB32]]
| [[crt_display|Script]]
|{{Author/cretindesalpes}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[EffectsMany|Plugin]]
| {{Author/vcmohan}}
|-
| [[EffectsPlus]]
| '''AviSynth+ only'''. Creates 26 types of special "animated" effects. Effects act on the input clip in the range of the frame numbers specified. The Audio is not affected.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]] colorspaces
| [[EffectsPlus|Plugin]]
| {{Author/vcmohan}}
|-
| [[f3kgrain]]
| Another 8/16-bit luma adaptive grain generator.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://web.archive.org/web/20131111114900/http://www.nmm-hd.org/upload/get~ElhZlazJbsQ/f3kgrain_v0.4.avsi Script]
| {{Author/06_taro}}
|-
| [[f3kgrainPlus]]
| Another 8/16-bit luma adaptive grain generator for AviSynth+.
| All 8-16 bit Y/YUV colorspaces, except YV411
| [[f3kgrainPlus|Script]]
| {{Author/06_taro}}
|-
|[[Fingerprint]]
|Video fingerprint filter.
|[[RGB32]]
|[[Fingerprint|Plugin]]
|{{Author/David Horman}}
|-
| [[GrainFactory3]]
| Noise generator that tries to simulate the behavior of silver grain on film. See [http://forum.doom9.org/showthread.php?t=141303 discussion.]
| [[YV12]]
| [[GrainFactory3|Script]]
| {{Author/Didée}}
|-
| [[GrainFactory3mod]]
| Luma adaptive grain generating filter in 8-bit precision. Based on Didée's [[GrainFactory3]] script.
| [[YV12]]
| [http://web.archive.org/web/20140722190952/http://www.nmm-hd.org/upload/get~kvNvGpuyxfc/GrainFactory3mod_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [[GrainFactoryLite]]
| Luma adaptive grain generating filter with stacked 16-bit input/output support. Based on Didée's [[GrainFactory3]] script, processing in 16-bit precision, and some commonly unused parameters removed.
| [[YV12]]
| [http://web.archive.org/web/20140722185917/http://www.nmm-hd.org/upload/get~FaqsQaMom9s/GrainFactoryLite_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [http://www.avisynth.nl/users/vcmohan/HollywoodSq/HollywoodSq.html HollywoodSQ]
| Creates popup album, akin to Hollywood squares TV show
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [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
|-
| [[Scanlines]]
| Add Scanlines (black horizontal bars) to a video. see [http://en.wikipedia.org/wiki/Scan_line wikipedia:Scan Line]
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/scanlines_5F25_dll_20031103.zip Plugin]
| turulo
|-
|[[ShufflessS]]
|Shuffle spacial columns or rows (1D), or blocks(2D) of frames, or temporal shuffle (frame order), all shuffles Inversable, ie undoable.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[HBD]] formats in AviSynth+
|[[ShufflessS|Plugin]]
|{{Author/StainlessS}}
|-
|[https://github.com/sorayuki/TawawaFilter TawawaFilter]
|An AviSynth plugin to make video in blue color.
|[[RGB24]]
|[https://github.com/sorayuki/TawawaFilter/releases/ Plugin]
|[https://github.com/sorayuki sorayuki]
|-
| [[TurnsTile]]
| Applies mosaic and/or palette effects to a clip.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[TurnsTile|Plugin]]
| {{Author/Robert Martens}}
|}

=== Field Order ===

{{FilterTable}}
| PFR
| Tries to restore the original progressive field order of a movie (or any predominantly filmed material transferred to video) where the field order changes at scene changes in a seemingly random fashion! See [http://forum.doom9.org/showthread.php?t=49815 discussion.]
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/pfravs.html Plugin]
| {{Author/Simon Walters}}
|-
| ReverseFieldDominance
| This filter is intended to reverse the field dominance of [[PAL]] DV video. See [http://forum.doom9.org/showthread.php?t=46765 discussion.]
| [[YUY2]], [[RGB24]], [[RGB32]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/reversefielddominance.html Plugin]
| {{Author/Simon Walters}}
|}

=== 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.
| Any
| Script
| actionman133
|-
| [[convert60ito24p]]
| convert60ito24p converts a 60fps interlaced NTSC Video into a 24fps progressive Video using different blending techniques.
| [[RGB32]], [[RGB24]], [[YUY2]]
| Script
| scharfis_brain
|-
|[[FixFPS]]
|Fix the frames to a more consistent pattern with the help of Matroska Version 2 Timecodes. Mostly useful for fixing weird framerate from using a third party program to capture (ex. .kkapture with Mupen). Generally used with the plugin ExactDedup. It should be noted that FixFPS would try it's best not to lose any frames from the source. It does this by pushing frames to the next available spot, if possible, but it can cause side effects. See [http://tasvideos.org/forum/viewtopic.php?t=18914 discussion].
|Any
|[https://www.mediafire.com/?7bip52hu7v1pps2 Plugin]
|Aktan
|-
| [http://github.com/arkeet/fpsdown/blob/master/README.md 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]]
| [http://github.com/arkeet/fpsdown/blob/master/README.md Plugin]
| [http://github.com/arkeet/ arkeet]
|-
| [[FrameRateConverter]]
| FrameRateConverter uses motion interpolation with fine artifact removal.
| [[YV24]], [[YV16]], [[YV12]], [[Y8]]
| [[FrameRateConverter|Plugin]]
| [https://github.com/mysteryx93 MysteryX]
|-
| [http://www.spirton.com/uploads/InterFrame/InterFrame2.html InterFrame]
| Frame rate conversion script. Interframe works very well at converting 24FPS to 60FPS; converts videos to higher frame rates like newer TVs do. Common names are frame doubling, smooth motion, among others. See [http://forum.doom9.org/showthread.php?t=160226 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1486831&postcount=1 Script]
|{{Author/SubJunk}}
|-
|[[JohnFPS]]
|Frame Rate Converter based on the example from the MVTools documentation with some modifications. This script is also known as "jm_fps".
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[JohnFPS|Script]]
|johnmeyer, StainlessS
|-
| NTSC tools
| Automatic [[NTSC]] to [[PAL]] conversion with 24p, 30p, 60i detection. See [http://forum.doom9.org/showthread.php?t=114054 discussion].
| [[YV12]]
| [http://avisynth.nl/images/NTSC_tools.avsi Script]
| Mug Funky
|-
|[[RIFE]]
|Real-Time Intermediate Flow Estimation for Video Frame Interpolation.
|[[RGBPS]]
|[[RIFE|Plugin]]
|{{Author/Asd-g}}
|-
| [[SickJumps]]
| Speed ramping, aka time-remapping (smooth speed changes). Processes both video and audio.
| [[RGB]], [[YUV]]
| [[SickJumps|Plugin]]
| {{Author/Robert Martens}}
|-
| [[SVPflow]]
| SVPflow provides fast and high quality GPU accelerated frame rate interpolation.
| [[YV12]]
| [[SVPflow|Plugin]]
| [http://www.svp-team.com/wiki/Credits SVP Team]
|-
| [http://github.com/gnaggnoyil/tc2cfr tc2cfr]
| This plugin that can read a timecode file and convert a given video clip in to one with a constant framerate by adding duplicate frames. Note: only supports Matroska V1 timecodes.
| [[YV12]]
| [http://github.com/gnaggnoyil/tc2cfr/releases Plugin]
| [http://github.com/gnaggnoyil gnaggnoyil]
|-
| [[TimecodeFPS]]
| Converts clip from VFR to CFR. Timing information from clip is discarded, and matroska v2 timecodes from the timecodes file are used instead.
| Any
| [[TimecodeFPS|C-Plugin]]
| natt
|-
| [[VFRtoCFR]]
| Converts a variable frame rate (VFR) video to a constant frame rate (CFR) video with the help of Matroska Version 2 Timecodes.
| [[YV12]]
| [[VFRtoCFR|Plugin]]
| Aktan
|-
| [[VfrToCfr]]
| This plugin converts variable frame rate clips to constant frame rate by introducing null frames.
| [[YV12]]
| [[VfrToCfr|Plugin]]
| joyje
|-
|[[YFRC]]
| Yushko Frame Rate Converter - doubles the frame rate with strong artifact detection and scene change detection.
|[[YV12]]
|[http://avisynth.nl/images/YFRC-01dd-10mm-2015yyyy.avsi Script]
| Oleg Yushko
|}

=== Frame Replacement/Range Processing ===

{{FilterTable}}
|[[ApplyEvery]]
|A collection of AviSynth functions that operate at regular intervals in a clip.
|
|[[ApplyEvery|Plugin]]
|{{Author/stickboy}}
|-
|[http://www.avisynth.nl/users/fizick/badframes/badframes.html BadFrames]
|Replaces given bad frames by neighbors or blend (interpolation). Useful for frames with very large defects.
|
|[http://www.avisynth.nl/users/fizick/badframes/badframes20.zip Plugin]
|{{Author/Fizick}}
|-
|[[ClipClop]]
|Clipclop is a simple plugin to replace ranges in a source clip with the same range, from a replacement clip. Supports up to 255 replacement clips, with unlimited number of replacements into output clip.
|
|[[ClipClop|Plugin]]
|StainlessS
|-
|[[FrameRepeat]]
|FrameRepeat() is a simple plugin to select frames to repeat. Requires AviSynth 2.6.
|
|[[FrameRepeat|Plugin]]
|StainlessS
|-
|[[FrameSel|FrameSel/FrameRep]]
|FrameSel() is a simple plugin to select individual frames from a clip. Can select frames numbers by direct arguments to filter, or in a string, or in a command file.
|
|[[FrameSel|Plugin]]
|StainlessS
|-
|[http://forum.doom9.org/showthread.php?t=164766 MatchFrames/LocateFrames]
|MatchFrames, intended for matched frames extraction,LocateFrames, intended to be usable by other scripts to identify matches.
|
|[http://www.mediafire.com/folder/hb26mthbjz7z6/StainlessS Script]
|StainlessS
|-
|[[Prune]]
|Prune is a simple plugin to trim() multiple source clips and splice the results into a new clip. Supports up to 256 source clips, with unlimited number of trims/splices into output clip. Prune can fade Audio (to reduce clicks between splices) for supported audio formats. The plugin will do [[AlignedSplice]] only.
|
|[[Prune|Plugin]]
|StainlessS
|-
|[[RemapFrames]]
|A collection of functions to rearrange frames between clips. Remaps the frame indices in a clip or from a second clip as specified by an input text file or by an input string. Efficient alternatives to long chains of <tt>FreezeFrame, DeleteFrame, or ApplyRange</tt>.
|
|[[RemapFrames|Plugin]]
|{{Author/stickboy}}, {{Author/cretindesalpes}}
|-
|[https://github.com/TomArrow/SelectRangeEveryReversing SelectRangeEveryReversing]
|Modified version of the internal [[SelectRangeEvery]] filter, except every second range is reversed in direction. See [https://forum.doom9.org/showthread.php?t=183239 discussion] for more information.
|
|[https://github.com/TomArrow/SelectRangeEveryReversing/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|}

=== Levels and Chroma ===

{{FilterTable}}
| [[AutoAdjust]]
| A high quality automatic adjustement filter. It calculates statistics of clip, averages them temporally to stabilize data and uses them to adjust luminance gain & color balance.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AutoAdjust|Plugin]]
| {{Author/LaTo}}
|-
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 AutoContrast]
|Auto contrast adjustment.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 Script]
|{{Author/StainlessS}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Autolevels|Plugin]]
| {{Author/frustum}} & Theodor Anschütz & StainlessS
|-
|[[AVSCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs].
|[[Avisynthplus_color_formats|RGBP16]]
|[[AVSCube|Plugin]]
|{{Author/Donald Graft}}
|-
| [https://forum.doom9.org/showthread.php?t=168062 AWB]
| Automatic white balance for real world footage, similar to the known function in digital cameras.
| [[YV12]]
| [https://forum.doom9.org/showthread.php?t=168062 Script]
| martin53
|-
|Brightness
|Restore dark and bright zones.
|8-16 planar Y/YUV
|[https://forum.doom9.org/showthread.php?t=182411 Script]
|Arx1meD
|-
| ChangeColour
| Simple plugin to replace one specified color to another, see [https://forum.doom9.org/showthread.php?t=88727 discussion] for additional information.
| [[RGB32]]
| [https://web.archive.org/web/20220322043620/https://files.videohelp.com/u/223002/changecolour01.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChanMix]]
| Creates a grayscale image from an RGB24 source, it has 3 parameters to specify how much of each color-channel is used.
| [[RGB24]]
| [[ChanMix|Plugin]]
| E-Male
|-
| [[ChannelMixer]]
| Very similar to the ChannelMixer function found in Photoshop. 9 Adjustments are possible, 3 for each color channel.
| [[RGB24]], [[RGB32]]
| [[ChannelMixer|Plugin]]
| Gustaf Ullberg
|-
| [https://forum.doom9.org/showthread.php?t=173364 ChromaJig]
| Automatic Colorization.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1775733#post1775733 Script]
| MWilson
|-
| [[ColorBalance]]
| Same tool that is found in Gimp & Cinepaint.
| [[RGB24]], [[RGB32]]
| [[ColorBalance|Plugin]]
| Gavino & mikeytown2
|-
|[[ColorLooks]]
| The plugin contains the following filters: Technicolor, Colorize, Sepia and Posterize.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[ColorLooks|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[ColorYUV2]]
|YUV color adjustment plugin with a graffer.
|[[YV12]]
|[[ColorYUV2|Plugin]]
|{{Author/StainlessS}}
|-
| [[ColourLike]]
| Makes a clip look like a 'reference' clip by adjusting each colour mask.
| [[RGB32]], [[YV12]]
| [[ColourLike|Plugin]]
| {{Author/mg262}}
|-
| [[ColourWarp]]
| Smooth remapping of UV colour values using control points for colour correction.
| [[YV12]], [[YV16]], [[YV24]]
| [[ColourWarp|Plugin]]
| {{Author/David Horman}}
|-
|[[DGCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs]. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|RGBP16]]
|[[DGCube|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGHDRtoSDR]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 to SDR. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGHDRtoSDR|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGPQtoHLG]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 PQ to HDR10 HLG. GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGPQtoHLG|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGTonemap]]
|[[AviSynth+]] plugin for basic Reinhard tonemapping for HDR->SDR.
|[[Avisynthplus_color_formats|RGBPS]]
|[[DGTonemap|Plugin]]
|{{Author/Donald Graft}}
|-
|[https://github.com/erazortt/DoViBaker DoViBaker]
|This plugin reads the Base Layer, Enhancement Layer and RPU data from a profile 7 DolbyVision stream to create a clip with the DolbyVision data baked in. Additionally it provides static and dynamic tonemapping of HDR PQ sources to lower dynamic range targets. Conversions from PQ to HLG and SDR (BT.2020 and BT.709) are also supported.
|[[Avisynthplus_color_formats|YUV420P10-16, YUV444P10-16]]
|[https://github.com/erazortt/DoViBaker/releases Plugin]
|[https://github.com/erazortt erazortt]
|-
| [[ExpLabo]]
| ExpLabo is a multi-filters plugin, focused on the non-linear transformation of image color space.
| [[RGB24]], [[RGB32]]
| [[ExpLabo|Plugin]]
| brabbudu
|-
|[https://web.archive.org/web/20180916224719/http://mpierce.pie2k.com/pages/211.php Exposure]
|Exposure function for AviSynth.
|[[RGB24]]
|[https://web.archive.org/web/20171023011558if_/http://mpierce.pie2k.com/downloads/exposure.zip Plugin]
|Matt Pierce
|-
| [[FlimsYlevels]]
| Luma adjustment function to give a more "film-ish" look. (Based on {{Author/Didée}}'s [[Ylevels]]).
| [[YV12]]
| Script
| FlimsyFeet
|-
|[[GamMac]]
|Useful to correct color cast on old 8mm films.
|[[RGB32]], [[RGB24]]
|[[GamMac|Plugin]]
|{{Author/StainlessS}}
|-
|[[GamMatch]]
|Gamma Matcher; useful to correct bad color clip where there is a better color source of perhaps lower rez available.
|[[RGB32]], [[RGB24]]
|[[GamMatch|Plugin]]
|{{Author/StainlessS}}
|-
| [[GiCocu]]
| Use GIMP/Photoshop curve files.
| [[RGB24]], [[RGB32]]
| [[GiCocu|Plugin]]
| E-Male
|-
|[https://github.com/magiblot/gradation Gradation]
|Gradation Curves filter for VirtualDub and AviSynth+
|[[RGB32]]
|[https://github.com/magiblot/gradation/releases Plugin]
|[https://github.com/magiblot magiblot]
|-
|[[GradationCurve]]
|[[AviSynth+]] plugin that loads Photoshop ACV and GIMP crv curve files. Also can compute the gradation curve through given anchor points. Like what Photoshop and Gimp do in the Curves setting.
|[[Avisynthplus_color_formats|PlanarRGB, PlanarYUV]]
|[[GradationCurve|Plugin+Script]]
|ErazorTT
|-
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Gray_Balance]
|A gray balance script, which is based on Black/White/Gray balance picker.
|[[RGB24]], [[YUY2]], [[YV12]]
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Script]
|Kisa_AG
|-
|[https://github.com/Asd-g/AviSynthPlus-grayworld grayworld]
|Port of [https://ffmpeg.org/ffmpeg-filters.html#grayworld FFmpeg's grayworld] filter to AviSynth+. See [https://forum.doom9.org/showthread.php?t=183750 discussion]
|[[RGBPS]], [[RGBAPS]]
|[https://github.com/Asd-g/AviSynthPlus-grayworld/releases Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[HDRAGC|Plugin]]
| {{Author/paviko}}
|-
|[[HDRTools]]
|HDR color conversion plugin for AviSynth+.
|[[RGB32]], [[RGB64]], Planar YUV/RGB (8-16 and 32bit)
|[[HDRTools|Plugin]]
|[https://github.com/jpsdr jpsdr]
|-
| [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
|-
| [[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]]
| [[HistogramAdjust|Plugin]]
| {{Author/vcmohan}}
|-
| [[Histograms in RGB & CMY]]
| Similar to Histogram("levels") but for RGB and CMY instead of YUV. It also includes a RGB parade color scope.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Histograms in RGB & CMY|Script]]
| -Vit-
|-
|[https://github.com/magiblot/HSLTint HSLTint]
|An [[AviSynth+]] filter for creating monochromatic tints with user-defined hue and saturation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]] - all bit-depths
|[https://github.com/magiblot/HSLTint/blob/master/HSLTint.avsi Script]
|magiblot
|-
|[[HSVAdjust]]
|HSVAdjust/HSLAdjust/HSIAdjust let's you rotate hues, control the strength of color (saturation), or modify the brightness of a clip. The type of brightness depends on the filter. It's value for HSVAdjust, lightness for HSLAdjust or intensity for HSIAdjust.
|[[RGB24]], [[RGB32]]
|[[HSVAdjust|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[Hue]]
|This plugin is a port of Donald Graft's VirtualDub [http://rationalqm.us/hue.html Hue] filter.
|[[RGB24]], [[RGB32]]
|[[Hue|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[avslibplacebo#Tonemap|libplacebo_Tonemap]]
|Dynamic HDR tone mapping, includes peak and scene-change detection, chroma-preserving (luma-only) tone mapping, highlight desaturation, dynamic exposure control and a variety of industry-standard EETFs including BT.2390.
|16-bit planar RGB or YUV444P16
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=176091 LinearTransformation]
|This script performs Linear Transformations based on a matrix conversion. Matrices are made by Francesco Bucciantini (FranceBB).
|[[YV12]], [[YV16]], [[YV24]], [[RGB24]], [[RGB32]], [[RGB32]], [[RGB48]],[[RGBPS]]
|[https://github.com/FranceBB/LinearTransformation Linear Transformation]
|[https://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[MatchHistogram]]
| Tries to modify the histogram of the input clip to match that of a reference clip. Should be used for analysis only, not for production.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MatchHistogram|Plugin]]
| {{Author/LaTo}}
|-
| [[OutRange]]
| A simple function to scan the whole video and output a log file, in which out-of-tv-range frames are logged.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[OutRange|Script]]
| 06_taro
|-
|[[RGBAdapt]]
|Another RGB color correction plugin, it also also includes a graffer.
|[[RGB24]], [[RGB32]]
|[[RGBAdapt|Plugin]]
|{{Author/StainlessS}}
|-
|[[RgbAmplifier]]
|An AviSynth forensic plugin to amplify color shifts.
|[[RGB24]], [[RGB32]]
|[[RgbAmplifier|Plugin]]
|{{Author/StainlessS}}
|-
| [https://forum.doom9.org/showthread.php?t=181857 SafeColorLimiter]
| Automatic Clipping to get a broadcast safe output in Limited TV Range.
| [[Y8]], [[Y10]], [[Y12]], [[Y14]], [[Y16]], [[Y32]], [[YV12]], [[YV411]], [[YUY2]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/SafeColorLimiter Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[SelectiveColour]]
|AviSynth implementation of Photoshop's selective colour adjustment.
|[[RGB32]]
|[[SelectiveColour|Plugin]]
|{{Author/David Horman}}
|-
| [[SGradation]]
| SGradation is much like a gamma function, but '2nd order'.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| Script
| martin53
|-
|[[ShowChannels]]
|Simple plugin whose only function is to display the average Y,U and V values for a YUV frame or R,G, and B for an RGB frame. Also shows accumulated average for all frames visited so far.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[ShowChannels|Plugin]]
|{{Author/StainlessS}}
|-
| [[ShowOverRange]]
| Shows illegal "TV range" by painting pixels blue for anything less than 16 and red for anything greater than 235.
| [[YUY2]], [[YV12]]
| [[ShowOverRange|Plugin]]
| {{Author/SAPikachu}}
|-
| [[SmoothAdjust]]
| SmoothAdjust is a set of 5 plugins to make YUV adjustments. These 5 plugins have a smoothing & dithering algorithm to avoid banding issue. SmoothAdjust is [[SmoothLevels|SmoothLevels']] successor.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SmoothAdjust|Plugin]]
| {{Author/LaTo}}
|-
| [[Tint]]
| Tints the image toward a specified colour.
| [[YUY2]], [[YV12]]
| Script
| actionman133
|-
| [[TweakColor]]
| Target specific hue and saturation ranges for hue and saturation adjustments.
| [[YV12]], [[YUY2]]
| [[TweakColor|Plugin]]
| {{Author/Trevlac}}
|-
| [[VideoScope]]
| Similar to Histogram("classic") but with additional features, it shows waveform monitors and a vectorscope.
| [[YUY2]]
| [[VideoScope|Plugin]]
| {{Author/Randy French}}
|-
| [http://forum.doom9.org/showthread.php?p=1832763#post1832763 VideoTek]
| VideoTek is a Tektronix-like waveform monitor for AviSynth.
| [[YV12]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/VideoTek/blob/master/VideoTek.avsi Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
| [[WhiteBalance]]
| Correct the white balance of a clip with a large degree of control and accuracy over other methods of correcting white balance.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[WhiteBalance|Plugin]]
| SomeJoe
|-
| [[Ylevels]]
| A simple replacement for Avisynth's internal [[Levels]] command, with a few neat differences.
| [[YV12]]
| Script
| {{Author/Didée}}
|}

=== Line Darkening ===

{{FilterTable}}
| 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]]
| [http://forum.doom9.org/showthread.php?p=1060081#post1060081 Script]
| Vectrangle / {{Author/Didée}}
|-
|[[Hysteria]]
|Hysteria, a line darkening script by Scintilla.
|[[YV12]]
|[http://pastebin.com/raw/fvDdiV6m Script]
|Scintilla
|-
|[http://forum.doom9.org/showpost.php?p=993939&postcount=2 LineDarkenToon]
| LineDarkenToon use the idea of mf_toon (0.5) for linedarken. I wanted a really small fast code like FastLineDarken but with similar output like mf_toon and this is the result.
|[[YV12]]
| [http://forum.doom9.org/showpost.php?p=993939&postcount=2 Script]
| MOmonster
|-
| [[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}}
|-
|[[proToon]]
|Line darkening script, used to be known as vmToon and before that mfToon.
|[[YV12]]
|[http://pastebin.com/raw/Aw9En26L Script]
|TheProfileth
|-
| [[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 line darkener.
| [[YV12]]
| [http://dl.dropbox.com/s/guk5plphkthdy2f/Toon-v1.1.7z Plugin]
| {{Author/mf}}
|-
| [[ToonLite]]
| It's the same as [[Toon]], just without the warpsharp processing..
| [[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}}
|[https://forum.doom9.org/showthread.php?t=181665 AiUpscale]
|An AviSynth+ implementation of some Super-Resolution Convolutional Neural Networks.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://github.com/Alexkral/AviSynthAiUpscale Script]
|[https://github.com/Alexkral Alexkral]
|-
|[[Anime4KCPP]]
|Anime4K is a simple high-quality anime upscale algorithm with GPU acceleration support. [[AviSynth+]] x64 only.
|[[RGB24]], [[YV24]], [[YV16]], [[YV12]]
|[[Anime4KCPP|Plugin]]
|TianZerL
|-
| [[avsresize]]
| [http://github.com/sekrit-twc/zimg z.lib] resizers for [[AviSynth+]]. avsresize provides resizing, colorspace and bit depth conversation.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
| [[avsresize|Plugin]]
| [http://github.com/sekrit-twc sekrit-twc]
|-
| [[AreaResize]]
| An area-average resizer plugin; only use to downscale.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AreaResize|Plugin]]
| {{Author/Chikuzen}}, Aktanusa
|-
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Desample]
|Desampling functions for AviSynth+, replaces DebilinearM and lineart_rpow2. Also includes DeCrossConversionMT which is a replacement for ccc, ccc_720.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Script]
|[https://github.com/kgrabs kgrabs]
|-
|[[Descale]]
|AviSynth+ filter to undo upscaling.
|All planar Y/YUV/RGB color formats
|[[Descale|Plugin]]
|[https://github.com/Frechdachs Frechdachs]
|-
|[[DPID]]
|DPID is an algorithm that preserves visually important details in downscaled images and is especially suited for large downscaling factors.
|All [[planar]] colorspaces
|[[DPID|Plugin]]
|{{Author/Asd-g}}
|-
|[http://forum.doom9.org/showthread.php?p=1738351#post1738351 edi_rpow2]
|An improved rpow2 function for nnedi3, nnedi3ocl, eedi3, and eedi2. Requires [http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi ResizeX]
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/view/pcmkxaauku375xd/edi_rpow2_v1.0.avsi Script]
|Desbreko
|-
|[[FCBI]]
|Fast Curvature Based Interpolation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar clips
|[[FCBI|Plugin]]
|{{Author/Chikuzen}}
|-
| [[fmtconv]]
| fmtconv is a format-conversion plug-in, it provides resizing, colorspace and bitdepth conversation.
| All [[planar]] 8 to 32-bit colorspaces
| [[fmtconv|Plugin]]
| {{Author/cretindesalpes}}
|-
| [[JincResize]]
| Jinc (EWA Lanczos) Resampler Plugin for AviSynth/AviSynth+.
| All 8-32bit [[planar]] colorspaces
| [[JincResize|Plugin]]
| innocenat
|-
|[[avslibplacebo#Resample|libplacebo_Resample]]
|High-quality, optimized upscaling and downscaling including support for polar filters ("Jinc"), anti-aliasing, anti-ringing and gamma correct scaling
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[[nnedi3/nnedi3_rpow2|nnedi3_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3_rpow2 is a function included in [[nnedi3]].
|[[RGB24]], [[YUY2]], [[YV12]]
|[[nnedi3|Plugin]]
|{{Author/tritical}}
|-
|[[nnedi3ocl/nnedi3x_rpow2|nnedi3x_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3x_rpow2 is a script function included in [[nnedi3ocl]].
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[nnedi3ocl|Script and Plugin]]
|SeT
|-
|[[nnedi3_resize16]]
|An advanced script for high quality image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
| [[PointSize]]
| A set of [http://en.wikipedia.org/wiki/Image_scaling pixel art resizers]; Includes Scale2x/3x, LQ2x/3x/4x, HQ2x/3x/4x, xBRZ (2x to 6x).
| [[RGB32]]
| [[PointSize|Plugin]]
| `Orum
|-
| [[ResampleHQ]]
| ResampleHQ provides gamma-aware resizing and colorspace conversion.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[ResampleHQ|Plugin]]
| Cory Nelson
|-
|[[ResampleMT]]
|Internaly multi-threaded resampling functions, also includes desampling functions (DeBilinear, DeBicubic,...).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[[ResampleMT|Plugin]]
|[http://github.com/jpsdr jpsdr]
|-
|[[Resize8]]
|<tt>Resize8()</tt> works just like AviSynth's internal resizers but with some extra features. It had correct chroma placement, optional adaptive anti-ringing algorithm and few other features.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://web.archive.org/web/20150911013350/http://www.nmm-hd.org/upload/get~8y1IjaaqvoI/Resize8_v1.2.avsi Script]
|mawen1250
|-
|ResizeX
|ResizeX is a wrapper function for AviSynth's internal resizers and Dither_resize16 that corrects for the chroma shift caused by the internal resizers when they're used on horizontally subsampled chroma with MPEG2 placement.
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi Script]
|Desbreko
|-
| [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}}
|-
|SincResize
|SincResize is an experimental plugin that uses DCT to perform resizing. See [http://forum.doom9.org/showthread.php?p=953002#post953002 discussion], read on for more information.
|[[YV12]]
|[http://cafxx.strayorange.com/files/SincResize4.7z Plugin]
|[http://cafxx.strayorange.com/ CAFxX]
|-
| [[SimpleResize]]
| Resizing plugin with 4 filters: SimpleResize, WarpResize, InterlacedResize and InterlacedWarpedResize.
| [[YV12]], [[YUY2]]
| [[SimpleResize|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}}
|-
|[http://forum.doom9.org/showthread.php?t=175945 Unwiden/Widen]
|Resize filters to unwiden/widen, see discussion.
|[[RGB32]], [[YV24]]
|[http://forum.doom9.org/showthread.php?t=175945 Plugin]
|{{Author/David Horman}}
|-
|[[w2xncnnvk]]
|[https://en.wikipedia.org/wiki/Waifu2x waifu2x] implemented in Vulkan.
|[[RGBPS]]
|[[w2xncnnvk|Plugin]]
|{{Author/Asd-g}}
|-
|[http://github.com/sunnyone/Waifu2xAvisynth waifu2x]
|Single-Image Super-Resolution for anime/fan-art using Deep Convolutional Neural Networks.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://github.com/sunnyone/Waifu2xAvisynth/releases Plugin]
|[http://github.com/sunnyone sunnyone]
|-
| [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
| mikeytown2
|}

=== Sharpeners ===

{{FilterTable}}
| [[aSharp]]
| Simple unsharp mask filter with optional adaptive sharpening.
| [[YV12]]
| [[aSharp|Plugin]]
| {{Author/Marc FD}}
|-
|[[AVSShock]]
|This Shock Filter sharpens edges of images by applying erosions or dilations depending on the sign of the Laplacian (or the so called Haralick-Canny edge detector).
|[[YUY2]], [[YV12]]
|[[AVSShock|C-Plugin]]
|AMSS0815
|-
| [[aWarpSharp2]]
| A modern rewrite of aWarpSharp with several bugfixes and optimizations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV formats, 8 to 16-bit
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
| [[blah]]
| Sharpening. See [http://forum.doom9.org/showthread.php?t=155030 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1406843 Script]
| *.mp4 guy
|-
|[[CAS]]
|Contrast Adaptive Sharpening.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV(A), RGB(A) formats, 8 to 32-bit
|[[CAS|Plugin]]
|Asd-g
|-
| [[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}}
|-
| [[LimitedSharpen]]
| LimitedSharpen can be used like a traditional sharpener, but producing much less artifacts. 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.
| [[YV12]]
| [http://avisynth.nl/images/LimitedSharpenFaster.avsi 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}}
|-
|[http://forum.doom9.org/showthread.php?t=173515 MCLS_16]
|Motion Compensate Limited Sharpen 16bit
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=173515 Script]
|Motenai Yoda
|-
|[http://forum.doom9.org/showthread.php?t=153201 MedSharp]
|Soft thresholded median sharpening function. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=153201 Script]
|*.mp4 guy
|-
| [[MSharpen]]
| <tt>MSharpen</tt> is a very simple masked sharpening plugin for AviSynth. This version is a reimplementation of neuron2's old <tt>MSharpen</tt> plugin.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MSharpen|Plugin]]
| {{Author/tp7}}
|-
| [[NonlinUSM]]
| Non-linear Unsharp Masking.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1555234&postcount=46 Script]
| {{Author/Didée}}
|-
| [[pSharpen]]
| Performs two-point sharpening to avoid overshoot. See [http://forum.doom9.org/showthread.php?t=172422 discussion].
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=172422#post1732663 Script]
| ilpippo80, colours
|-
|[[ReCon]]
|'''ReCon'''volution - makes things sharp by mixing pixels together. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1409582#post1409582 Script]
|*.mp4 guy
|-
| [[SeeSaw]]
| SeeSaw uses a balance of denoising and sharpening to enhance a clip. The aim is to enhance weak detail without over-sharpening or creating jaggies on strong detail, and produce a result that is temporally stable without detail shimmering.
| [[YV12]]
| [http://avisynth.nl/images/SeeSaw.avs Script]
| {{Author/Didée}}
|-
| SharpenComplex2
| Port of MPC-HC's Sharpen Complex 2 to AviSynth. Despite the name, this script is very simple, see [http://forum.doom9.org/showthread.php?t=158385 discussion.]
| [[YV12]]
| [[SharpenComplex2_source|Script]]
|
|-
| SSXSharpen
| Included in SharpTools. Sharpens the picture using [[supersampling]] techniques.
| [[YV12]]
| [http://web.archive.org/web/20100120201434/http://mf.creations.nl/avs/functions/SharpTools-v0.3.avs Script]
| {{Author/mf}}, {{Author/Didée}}
|-
| [[SSSharp]]
| Also known as Super Slow Sharpen - a very slow, but high quality sharpener. See [http://forum.doom9.org/showthread.php?t=132330 discussion]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1071731 Script]
| *.mp4 guy
|-
| [[TUnsharp]]
| TUnsharp is a basic sharpening filter that uses a couple different variations of unsharp masking and allows for controlled sharpening based on edge magnitude and min/max neighborhood value clipping.
| [[YUY2]], [[YV12]]
| [[TUnsharp|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.
| [[YUY2]], [[YV12]]
| [[UnFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[UnsharpHQ]]
| A strong and fast unsharp mask with some new features.
| [[YV12]]
| [[UnsharpHQ|Plugin]]
| list
|-
|[[vsMSharpen]]
|vsMSharpen is a sharpener that tries to sharpen only edges. This plugin is a port of the VapourSynth plugin MSharpen.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSharpen|Plugin]]
|Dubhater, Asd-g
|-
| [[WarpSharp]]
| WarpSharp contains these sharpeners: <tt>UnsharpMask, WarpSharp, Xsharpen</tt>.
| [[YUY2]], [[YV12]]
| [[WarpSharp|Plugin]]
|???, {{Author/seraphy}}
|}

=== Rotation/Shear/Skew/Perspective ===

{{FilterTable}}
| [[DeBarrel]]
| Remove barrel and pincushion distortion, where straight lines appear curved.
| [[RGB24]], [[RGB32]], [[Y8]]
| [[DeBarrel|Plugin]]
| {{Author/vcmohan}}
|-
|[[Defish]]
|Barrel and pincushion distortion correction filter.
|[[RGB32]]
|[[Defish|Plugin]]
|{{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=171922 Defish Different Projections]
|Defish with different map projections, like Lambert Cylindrical Equal Area, Mercator and Miller projections.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=171922 Script]
|Kisa_AG
|-
| [[FTurn]]
| Fast implementation of [[TurnLeft]](), [[TurnRight]]() and [[Turn180]]() AviSynth functions.
| [[Y8]], [[YV12]],[[YV24]]
| [[FTurn|Plugin]]
| {{Author/tp7}}
|-
|[http://forum.doom9.org/showthread.php?t=165978 Quad]
|An Avisynth plugin to perform quadrilateral transformations. Quad is now superseded by [[warp]].
|[[RGB32]]
|[http://horman.net/quad.zip Plugin] -- [http://forum.doom9.org/showpost.php?p=1602709&postcount=22 no SSE]
|{{Author/David Horman}}
|-
| [[Reform]]
| Skewed images are corrected or vice versa, useful if video is recorded with slightly incorrectly located camera. Sometimes referred to as perspective correction.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Reform|Plugin]]
| {{Author/vcmohan}}
|-
| [[Reformer]]
| Perspective correction and warping.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Reformer|Plugin]]
| {{Author/vcmohan}}
|-
| [[Rotate]]
| Rotate or shear on any given angle.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Rotate|Plugin]]
| {{Author/Fizick}}
|-
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner.html Spinner]
| Spinner plugin rotates a frame or selected part of it about the given axis coordinates in floating point precision.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[[warp]]
|A collection of geometry correction filters (also includes new version of Quad).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[warp|Plugin]]
|{{Author/David Horman}}
|-
|[[xyremap]]
|xyremap is a filter for remapping pixels using formulae written in [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation].
|[[RGB32]]
|[[xyremap|Plugin]]
|{{Author/David Horman}}
|-
| [[Zoom]]
| Zoom, Pan & Rotate Clip. Adds alpha layer to clip.
| [[RGB32]]
| [[Zoom|Plugin]]
| {{Author/WarpEnterprises}}
|}

=== Subtitling ===

{{FilterTable}}
| [[AssRender]]
| Libass-based subtitle renderer.
| [[RGB32]], [[RGB24]], [[YV24]], [[YV12]], [[Y8]]
| [[AssRender|C-Plugin]]
| lachs0r, TheFluff
|-
|[https://forum.doom9.org/showthread.php?t=183148 DetSub]
|Can be used to remove hardcoded subtitles with halo from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=183148 Script]
|{{Author/StainlessS}}
|-
|[[FreeSub]]
|Subtitle with bdf fonts.
|[[RGB24]], [[RGB32]], [[YV24]]
|[[FreeSub|C-Plugin]]
|Natt
|-
|[[FreeSubPlus]]
|Script that adds support for additional colorspaces to the FreeSub plugin.
|All colorspaces
|[[FreeSubPlus|Script]]
|reel.deel
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|Can be used to remove hardcoded subtitles from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
|[https://github.com/slavanap/ssifSource sub3d]
|Plugin for rendering subtitles on 3D video with correct depth.
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/tree/master/Sub3D Sources] [https://github.com/slavanap/ssifSource/releases Binaries][http://forum.doom9.org/showthread.php?t=173143 Discussion]
|slavanap
|-
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile SubImageFile]
|AviSynth+ plugin that renders image-based subtitles such as VOBSUB and PGS.
|[[RGB24]], [[Y8]]
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile/releases/ Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[SubtitleEx|Plugin]]
|[http://web.archive.org/web/20070821222318/http://mvideo.ddpp.net/eng/index.htm basilik]
|-
|[http://forum.doom9.org/showthread.php?t=119390 SUPtext]
|Overlays SUP-subtitles on a video clip.
|[[RGB32]], [[YV12]]
|[http://forum.doom9.org/attachment.php?attachmentid=7846&d=1196858433 Plugin]
|emmel
|-
| [[SupTitle]]
| Blu-ray PGS .SUP Subtitle Renderer Plugin for AviSynth. See [http://forum.doom9.org/showthread.php?t=148167 discussion]
| [[YV12]]
| [[SupTitle|Plugin]]
| {{Author/ZachSaw}}
|-
|[[tcasFilter]]
|Renders TCAS subtitle effects.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[tcasFilter|Plugin]]
|milkyjing
|-
| [http://avisynth.org.ru/docs/english/externalfilters/vsfilter.htm 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]
|
|-
| [[VSFilterMod]]
| VSFilterMod is modification of original VSFilter subtitle renderer by Gabest. This mod brings up new features and some minor bugfixes.
|[[RGB24]], [[RGB32]], [[YV12]]
| [[VSFilterMod|Plugin]]
|
|-
|[[xy-VSFilter]]
|High performance VSFilter compatible subtitle filters.
|[[RGB24]], [[RGB32]], [[YV12]]
|[[xy-VSFilter|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}}
|-
| [[TransAll]]
| Around 150 distinct transitions can be created with this plugin.
| [[RGB]], [[YUY2]], [[YV12]]
| [[TransAll|Plugin]]
| {{Author/vcmohan}}
|-
| [[Transition_AlbertGasset|Transition (Albert Gasset)]]
| Various wipe and random block modes. Has 19 built in patterns or it can use an external file.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_AlbertGasset|C-Plugin]]
| {{Author/Albert Gasset}}
|-
| [[Transition_Shubin|Transition (Shubin)]]
| Contains 2 transition modes: circle and line.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_Shubin|Plugin]]
| {{Author/shubin}}
|}

== Other Filters ==

=== Debugging/Diagnostic Filters ===

{{FilterTable}}
| AVInfo
| AVIInfo gives information about the streams in the clip without loading any frames. filename can be a WAV file or an AVI file with several audio streams (it won't open AVI files with embedded subtitles though). It will return the info as a string.
|
| [http://www.avisynth.nl/users/warpenterprises/files/avinfo_5F25_dll_20050417.zip Plugin]
| trevlac, wilbert
|-
| [http://forum.doom9.org/showthread.php?t=174797 AVSMeter]
| AVSMeter is a CLI (command line interface) tool which measures the speed/efficiency of Avisynth scripts and checks if Avisynth and its plugin sub-system are set up and working correctly. Documentation for usage and features is included in the distribution package.
|
| Command line executable
| Groucho2004
|-
| [http://forum.doom9.org/showthread.php?t=176079 Avisynth Info Tool]
| This program performs a thorough test of your Avisynth installation and associated plugins, checking if external dependencies are installed, etc.
|
| Windows application with graphical user interface
| Groucho2004
|-
|[http://forum.doom9.org/showthread.php?t=173259 avsr]
|CLI (command line interface) tool which simply executes an Avisynth script. This is useful when, for example, you want to write an image sequence to the disk by using "ImageWriter".
|
| Command line executable
| Groucho2004
|-
|[[Butteraugli]]
|Butteraugli is an estimating filter for the psychovisual similarity of two images.
|8-32bit planar RGB/RGBA
|[[Butteraugli|Plugin]]
|{{Author/Asd-g}}
|-
|[[ColorDiff]]
|ColorDiff makes a greyscale (Y8) frame according to the input frame's pixels' "distance" from a specified color. The diff is calculated by simply getting the diff of the individual color components from the desired color's components and summing them up. Also, weights can be set for the individual diffs.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[ColorDiff|C-Plugin]]
|Ignus2
|-
|[https://forum.doom9.org/showthread.php?t=182817 DebugColourSpaces]
|Debugging filter which applies a specified filter to multiple Avisynth+ colourspaces and displays a labelled grid of the results.
|Any
|[http://horman.net/avisynth/download/DebugColourSpaces.zip Plugin]
|{{Author/David Horman}}
|-
| [[DumpPixelValues]]
| Samples the colors from selected pixels for every frame in a video source and outputs the data to a text or binary file. See [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.zip Plugin]
| [http://www.theneitherworld.com/mcpoodle/Tools/index.html McPoodle]
|-
|[[FFTSpectrum]]
|FFTSpectrum is a filter that displays the FFT frequency spectrum of a given clip.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[FFTSpectrum|Plugin]]
|{{Author/Asd-g}}
|-
|[[GrainEvaluate]]
| A script to analyze and log the strength of grain for each frame. See [http://forum.doom9.org/showthread.php?t=167455 discussion.]
| [[YV12]]
|[http://www.nmm-hd.org/upload/get~-eJfUjEXJY4/GrainEvaluate.avsi Script]
|{{Author/06_taro}}
|-
| [http://forum.doom9.org/showpost.php?p=1462931&postcount=81 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]
| jmac698
|-
| [[Grid]]
| Overlays a grid, useful for pixel counting.
| Any
| [http://www.avisynth.nl/users/vcmohan/Grid/Grid.zip Plugin]
| {{Author/vcmohan}}
|-
|[[Info2]]
| A faster, prettier alternative to info().
|Any
|[[Info2|Plugin]]
|{{Author/David Horman}}
|-
|[[KPassFilterCL]]
|KPassFilterCL is a set of tools in the frequency domain.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[KPassFilterCL|Plugin]]
|[http://github.com/Khanattila Khanattila ]
|-
|[[LinesLumaDiff]]
|AviSynth+ plugin to check if luma difference between lines are below or above given threshold and writes frame number in text file.
|[[Planar]] YUV
|[[LinesLumaDiff|Plugin]]
|{{Author/Asd-g}}
|-
|[[MaxCLLFind]]
| PQ HDR Analyzer plugin for [[AviSynth+]], analyzes MaxCLL and MaxFALL and writes it to a text file.
|[[RGB64]]
|[[MaxCLLFind|Plugin]]
|Tom Arrow
|-
| [http://web.archive.org/web/20160610124531/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
|[[Pixelscope]]
|This debugging filter displays individual pixel values.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=175688 Plugin]
|{{Author/David Horman}}
|-
|[https://github.com/EmiyaSyahriel/RollCompare RollCompare]
|AviSynth Plugin to create rolling comparison between videos.
|[[RGB24]], [[RGB32]]
|[https://github.com/EmiyaSyahriel/RollCompare/releases Plugin]
|EmiyaSyahriel
|-
|[http://github.com/lcferrum/segment-display-ocr SegmentDisplayOCR]
|SegmentDisplayOCR is a seven-segment display recognition filter for AviSynth. It has built in logging functionality (it will log frame recognition results) and also can be used in AviSynth conditional filters. The main purpose of this filter is to process readings of various digital instruments (e.g. digital multimeters) captured on video. So if your favourite instrument lacks interface for connecting it to PC you can capture it's readings on cam and convert them to computer readable format with SegmentDisplayOCR filter.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://sourceforge.net/projects/segmentdisplayocr/files/SegmentDisplayOCR/ Plugin]
|[http://github.com/lcferrum lcferrum]
|-
|[[SSIM]]
|A filter that compute an objective video quality metric between two videos. Based on SSIM work from [http://web.archive.org/web/20060515090025/http://www.cns.nyu.edu/~zwang/files/research/ssim/index.html Zhou Wang]. It has been created with the help of Mfa.
|[[YV12]]
|[[SSIM|Plugin]]
|[http://web.archive.org/web/20060507012947/http://perso.wanadoo.fr/reservoir/ Lefungus]
|-
| [[ShowPixelValues]]
| This filter displays the actual Y U and V (or R G and B) values from pixels within a frame. See [http://forum.doom9.org/showthread.php?t=64192 discussion] and [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/showpixelvalues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://web.archive.org/web/20091028122947/http://geocities.com/siwalters_uk/showpixelvalues1.4c.zip Plugin]
| {{Author/Simon Walters}}
|-
|[https://forum.doom9.org/showthread.php?t=176131 SysInfo]
|This plugin returns info about OS/CPU*/Memory/Screen/AviSynth.
|Any
|[https://forum.doom9.org/showthread.php?t=176131 Plugin]
|Groucho2004
|-
|[https://forum.doom9.org/showthread.php?t=168241 Timer]
|AviSynth script to add a highly customizable timer to your video.
|Any
|[https://forum.doom9.org/showthread.php?t=168241 Script]
|djcj
|-
| [http://web.archive.org/web/20151223052321/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
| [http://avisynth.org.ru/docs/english/externalfilters/tmonitor.htm TMonitor]
| TMonitor is a filter very similar to AVSMon. It enables monitoring of an Avisynth clip via previewing the video, viewing clip information (such as video width, height, colorspace, number of frames, audio samples, sample rate, number of audio channels, and more), and adjusting the audio delay. It also supports multiple instances per script, allowing viewing of differences between different parts of a processing chain.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TMonitorv094.zip Plugin]
|{{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?t=53238 ViewFields/UnViewFields]
| [http://web.archive.org/web/20140709004333/http://www.geocities.com/siwalters_uk/unviewfields.html UnViewFields], [http://web.archive.org/web/20140708181324/http://www.geocities.com/siwalters_uk/viewfields.html ViewFields]
|
| Plugin
| {{Author/Simon Walters}}
|-
|[[VMAF]]
|VMAF is a perceptual video quality assessment algorithm developed by Netflix.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]],<br> 8-10bit planar YUV
|[[VMAF|Plugin]]
|{{Author/Asd-g}}
|-
| [[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
|
|}

=== Edge Detection ===

{{FilterTable}}
| [[aWarpsharp2/aSobel|aSobel]]
| Sobel edge dectecion filter included in [[aWarpSharp2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
|[[MaskTools2/Mt edge| mt_edge]]
| Edge detection filter included in [[MaskTools2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}
|-
|[[scharr]]
|Edge detection using the [https://en.wikipedia.org/wiki/Sobel_operator#Alternative_operators Scharr operator].
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[scharr|Script]]
|zorr
|-
| [[tcanny]]
| Contains a canny edge detection filter and distance transform filter.
| [[YUY2]], [[YV12]]
| [[tcanny|Plugin]]
| {{Author/tritical}}
|-
| [[TCannyMod]]
| Canny edge detection filter for Avisynth 2.6. Reimplementation of tcanny. See [http://forum.doom9.org/showthread.php?t=168449 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TCannyMod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[TEdgeMask]]
| TEdgeMask creates an edge mask based off gradient vector magnitude.
| [[YUY2]], [[YV12]]
| [[TEdgeMask|Plugin]]
| {{Author/tritical}}
|-
| [[TEMmod]]
| TEdgeMask modified for Avisynth 2.6. It creates an edge mask using gradient vector magnitude. See [http://forum.doom9.org/showthread.php?t=168390 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TEMmod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[vsTCanny]]
| Builds an edge map using canny edge detection.
| All 8-32bit [[planar]] colorspaces
| [[vsTCanny|Plugin]]
| {{Author/Asd-g}}
|-
| [[vsTEdgeMask]]
| vsTEdgeMask is an edge detection filter. This is a port of the TEdgeMask/TEMmod AviSynth plugins.
| All 8-16bit [[planar]] colorspaces
| [[vsTEdgeMask|Plugin]]
| {{Author/Asd-g}}
|}

=== Export Filters ===

These filters can write directly to media files.

{{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?t=172837 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://forum.doom9.org/showthread.php?t=172761 Update for AviSynth 2.6]. [http://forum.doom9.org/showthread.php?p=1750415#post1750415 Usage]. [http://forum.doom9.org/showthread.php?p=1073371#post1073371 Old mod by squid_80].
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [https://github.com/Asd-g/AviSynth-TWriteAVI/releases Plugin]
| {{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?p=1403600 Sashimi]
(function "RawWriter")
| Sashimi writes (and reads) almost any regular raw uncompressed data format you can define. You'll find a fuller description under [[#Source_Filters|Source Filters]].
| [[RGB]], [[YUY2]],[[YV12]]
| [http://sites.google.com/site/ourenthusiasmsasham/soft Plugin with scripts]
| [http://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
| [[SoundOut]]
| SoundOut is a GUI driven sound file output module for AviSynth (it exports audio to several compressors).
| All audio.
| [[SoundOut|Plugin]]
| {{Author/Sh0dan}}
|}

=== 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://www.avisynth.nl/users/warpenterprises/files/freeframe_5F25_dll_20050426.zip Plugin]
| {{Author/Myrsloik}}
|}

=== Meta-Filters ===

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

{{FilterTable}}
|[[AVSTP]]
|A library for multithreaded plug-in development
|Any
|[[AVSTP|Plugin]]
|{{Author/cretindesalpes}}
|-
|[[MP_Pipeline]]
|Run parts of an AviSynth script in external processes.
|Any
|[[MP_Pipeline|Plugin]]
|[http://github.com/SAPikachu/ SAPikachu]
|-
| [[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
| [http://www.avisynth.nl/users/warpenterprises/files/mt_20070301.zip 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]
| [[YUY2]], [[YV12]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
|[http://forum.doom9.org/showthread.php?t=164073 SoraThread]
|Sora's avs multi-process/multi-thread plugin package
|Any
|[http://forum.doom9.org/showthread.php?t=164073 Plugin]
|leiming2006
|-
|[http://forum.doom9.org/showthread.php?t=154886 ThreadRequest]
|Yet another plugin for multithread processing. [http://web.archive.org/web/20130124045626/http://lantis.homeunix.org/avisynth.shtml Archive homepage (Japanese)]
|Any
|[http://www.mediafire.com/download/4xux7d7l1u3toy8/ThreadRequest+102a.rar Plugin]
|lantis
|}

=== Multipurpose Filters ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=174433 amDCT]
|amDCT() is an adaptive video filter providing deblocking, sharpening, local range expansion, smoothing, and bright noise removal in a single filter that can be used on video of any level of quality. These four operations work synergistically to drastically reduce block artifacts while maintaining detail and increasing local contrast.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[https://github.com/pinterf/amDCT Plugin]
|jconklin, [https://github.com/pinterf pinterf]
|-
|[[AVExtensions]]
|Audio-video extensions is a collection of various AviSynth filters used to modify audio or video.
|[[RGB24]], [[RGB32]]
|[[AVExtensions|Plugin]]
|nutbread
|-
|[[AviSynthShader]]
|This plugin allows running HLSL pixel shaders within AviSynth. This gives access to various HLSL filters that haven't been programmed in AviSynth.
|[[RGB32]], [[YV24]], [[YV12]]
|[[AviSynthShader|Plugin]]
|[http://github.com/mysteryx93 MysteryX]
|-
|[[avs-mlrt]]
|This project provides AviSynth+ ML filter runtimes for variety of platforms.
|Y32, RGPS
|[[avs-mlrt|Plugin]]
|{{Author/Asd-g}}
|-
|[[CLExpr]]
|AviSynth Expr filter implemented in OpenCL for runtime calculation of expressions on 8 and 16-bit depths clips. Makes mt_lutxy and mt_lutxyz possible on 16-bit.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CLExpr|Plugin]]
|{{Author/tp7}}
|-
|[https://forum.doom9.org/showthread.php?t=183823 CTools]
|Includes various filters for IVTC, deinterlacing, denoising, dehalo and duplicate frames.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://github.com/CeppoTools/CTools/releases Plugin]
|Ceppo
|-
| [http://forum.doom9.org/showthread.php?t=166061 HybridFuPP]
| An adaptive processor, allowing picture cleaning and compressibility gain. Original [http://forum.doom9.org/showthread.php?t=146632 discussion.]
| [[YV12]]
| [http://www.mediafire.com/download/6g09aazs4z7m11a/HybridFuPP_0.992b.zip Script]
| Fupp
|-
| [[MaskTools2]]
| This plugin provides tools for the creation, enhancement and manipulation of masks for each [[YUV]] component.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}, {{Author/tp7}}
|-
| [[MVTools]]
| This plugin provides a collection of functions for motion estimation and compensation.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| Various
|-
|[[avslibplacebo#Shader|Shader]]
|Loads GLSL shaders written in mpv's .hook syntax.
|16-bit planar YUV
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|}

=== Scene Change Detection ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=171624 DBSC]
|A scene change detection tool set/kit/box (work-in-progress).
|All
|[http://forum.doom9.org/showthread.php?t=171624 Script]
|{{Author/StainlessS}}
|-
| [http://forum.doom9.org/showthread.php?t=145143 EDLmaker]
| Simple scenechange detector that writes to EDL file.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=145143 Script]
| Mug Funky
|-
| [[MVTools2/MSCDetection|MSCDetection]]
| Part of MVTools2; MSCDetection creates a scene detection mask clip from motion vectors data.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| SCDetect
| Detect scene change and output scene change frames to a file.
| [[YV12]]
| [http://web.archive.org/web/20140614152525/http://www.nmm-hd.org/upload/get~TfPm2QO4jbk/SCDetect_v0.3.rar Script]
| {{Author/06_taro}}
|-
| [http://akuvian.org/src/avisynth/sclavc/readme.txt SceneChangeLavc]
| SClavc is an AviSynth plugin intended to allow access to libavcodec's scene-change metrics. See [http://akuvian.org/src/avisynth/sclavc/ homepage.]
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/scenechangelavc_5F25_dll_20041201.zip Plugin]
| {{Author/akupenguin}}
|-
| [[SCXvid]]
| SCXvid produces first pass Xvid logs from AviSynth at the equivalent of the default VFW preset. These logs are primarily intended to get scene change information from but may have other uses.
| [[YV12]]
| [http://dl.dropbox.com/s/402hlckyn669p9n/SCXvid-1.1.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[SCXvidMask]]
| A tiny AviSynth plugin that reads an SCXvid log and creates a binary mask based on it.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://github.com/tp7/SCXvidMask/releases Plugin]
| {{Author/tp7}}
|}

=== Support filters ===

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

{{FilterTable}}
| [[ApplyInterlacedFilter]]
| ApplyInterlacedFilter safely processes interlaced video with spatial and temporal filters.
|
| Script
|
|-
|[http://forum.doom9.org/showthread.php?t=162874 ArcFuns]
|This plugin expands the available numerical functions with missing inverse trig functions.
|N/A
|[http://forum.doom9.org/attachment.php?attachmentid=12494&d=1319627190 Plugin]
|{{Author/Gavino}}
|-
|[[AvsFilterNet]]
|The main objective of AvsFilterNet is to provide a wrapper for AviSynth, making it possible to write simple filter in any .Net languages.
|N/A
|[[AvsFilterNet|Plugin]]
|SAPikachu
|-
|[[AvsMotion]]
|AviSynth plugin for animating clips with AAE motion tracking data.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AvsMotion|Plugin]]
|{{Author/tp7}}
|-
| [http://forum.doom9.org/showthread.php?t=46506 Call]
| Call an external program from the script.
| N/A
| [http://avisynth.nl/users/warpenterprises/files/call_5F25_dll_20030310.zip Plugin]
| Nic, DDogg
|-
|[[CallCmd]]
|Plugin to execute command on selectable frames or at startup or closedown. Based on [http://forum.doom9.org/showthread.php?t=46506 Call by Nic].
|N/A
|[[CallCmd|Plugin]]
|StainlessS
|-
|[[ClipBoard]]
|Get text from Clipboard.
|N/A
|[[ClipBoard|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182910 Feedback]
|A filter that lets you use a filter chain's output as its own input.
|Any
|[http://horman.net/avisynth/download/feedback.zip Plugin]
|{{Author/David Horman}}
|-
|[[FileSize]]
|Plugin to get filesize.
|N/A
|[[FileSize|Plugin]]
|pureexe
|-
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.html GetProgramName]
|An AviSynth plug-in to retrieve the name of the calling application.
|N/A
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.zip Plugin]
|[http://www.roelofs-coaching.nl/J.M. Roelofs]
|-
|[[GetProgramName2]]
|GetProgramName2 is similar to GetProgramName by JM Roelofs, but this plugin is a newly written.
|N/A
|[[GetProgramName2|Plugin]]
|[https://github.com/enccc enccc]
|-
| GetSystemEnv
| An AviSynth plug-in to retrieve information from the system.
| N/A
| [http://www.avisynth.nl/users/stickboy/GetSystemEnv.zip Plugin]
| {{Author/stickboy}}
|-
| [[GRunT]]
| Extends AviSynth's [[Runtime_environment|Runtime Environment]], making it easier to use, especially inside script functions.
| Any
| [[GRunT|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
| [[GScript|Plugin]]
| {{Author/Gavino}}
|-
|[[LoadDLL]]
| Used to manually load dll files in AviSynth. Useful if a filter relies on an external dll that is not in the system PATH.
| N/A
| [[LoadDLL|Plugin]]
|{{Author/tsp}}
|-
|[https://forum.doom9.org/showthread.php?t=162790 MinMax]
|Finds the min or max value in each line or column and then sets the entire line or column to that value. Only processes the luma (Y) plane.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[https://web.archive.org/web/20160610142230if_/http://latoninf.free.fr/div/minmax.7z Plugin]
|{{Author/LaTo}}
|-
| [http://forum.doom9.org/showthread.php?t=97748 PlaneMinMax]
| Frame-based YV12 plane Min/Max/Avg functions without [[ConditionalFilter]].
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/planeminmax_5F25_dll_20050727.zip Plugin]
| Bart Silverstein
|-
|[http://forum.doom9.org/showthread.php?t=83451 pop]
|A filter to get values from variables that may not yet be initialized.
|Any
|[https://web.archive.org/web/20160606142540if_/http://www.tsp.person.dk/pop.zip Plugin]
|{{Author/tsp}}
|-
| [[RT_Stats]]
| Compile-time/Runtime Functions.
| N/A
| [[RT_Stats|Plugin]]
| StainlessS
|-
|[[StrFmt]]
|Simple plugin to produce formatted string, and additional function to string replace with another string.
|Any
|[[StrFmt|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=174387 StrResolve]
|String Variables Resolving Plugin (for masktools expressions)
|Any
|[http://www.mediafire.com/file/wu6zexhssd0y77i/170310_StrResolve_v050.zip Plugin]
|martin53
|}

=== Deepcolor Filters ===
(also check the [[High_bit-depth_Support_with_Avisynth#Processing_High_Bit-depth_Video_with_AviSynth|High Bit-Depth]] page and the [[:Category:Deep_color_tools|Deep Color Tools]] category)

{{FilterTable}}
| [[Dither_tools|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 color banding 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
| [[Dither_tools|Plugin + scripts]]
| {{Author/cretindesalpes}}
|}

=== 3D Filters ===

{{FilterTable}}
|[https://sourceforge.net/projects/voix/files/2d3/ 2Dto3D]
|2Dto3D is a collection of scripts for 2D to 3D conversion. Conversion is good but not perfect.
|[[YV12]]
|[https://sourceforge.net/projects/voix/files/2d3/ Script]
|[https://sourceforge.net/u/brankoj/profile/ brankoj]
|-
| [http://web.archive.org/web/20110809073332/http://arenafilm.hu/alsog/anaglyph/ Analglyph]
| 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://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z Plugin] / [http://web.archive.org/web/20140412062911/http://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z mirror]
| {{Author/Kertai Gábor}}
|-
| Anaglypher
| A plugin for combining stereopairs into single anaglyph image.
| [[RGB32]], [[RGB24]]
| [http://shura.luberetsky.ru/anaglypher/Anaglypher.zip Plugin]
| [http://shura.luberetsky.ru/ Shura Luberetsky]
|-
|[http://forum.doom9.org/showthread.php?t=162616 Displace / McM_2D_to_3D]
|Plugin and script that enables you to convert 2d to 3d stereo with bidirectional pulfrich effect + add depth to stationary objects.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=162616#post1539121 Plugin/Script]
|Mcmount
|-
|[http://forum.doom9.org/showthread.php?t=143855 fauxD]
|2D to stereo-3D conversion in real-time.
|[[RGB24]], [[RGB32]]
|[http://forum.doom9.org/attachment.php?attachmentid=9278&d=1232092731 Plugin]
|eslave
|-
| [http://www.pantarheon.org/AviSynth3DToolbox/ Pantarheon 3D AviSynth Toolbox]
| The Toolbox contains a number of basic functions which allow you to multiplex the left and right views found in two separate videos into one video, using several of the common methods currently in use.
| [[YUY2]], [[YV12]]
| [http://www.pantarheon.org/AviSynth3DToolbox/zip/ Script]
| [http://www.pantarheon.org/ G. Adam Stanislav]
|}

=== 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}}
| [[AddAudio]]
| A function that adds silent audio to a clip. Needed for CCE 2.50 users.
| N/A
| Script
|
|-
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Audiofix]
|Plugin to fix a specific audio problem, see [http://forum.doom9.org/showthread.php?t=175991 discussion].
|
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Plugin]
|{{Author/David Horman}}
|-
| [[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.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV24]], 8-bit [[Planar]] RGB
| [[AudioGraph|Plugin]]
| Richard Ling, {{author/Sh0dan}}
|-
|[[AudioLimiter]]
| To increase volume for silent sounds a lot, to increase volume for middle-volume sounds a little and to keep hi-volume sounds untoched.
| N/A
|[[AudioLimiter|Plugin]]
|dimzon
|-
|[[AudioTimeline]]
|Displays a audio timeline track under the frame. It is especially suited for thumbsheets, where it allows to estimate the audio track of the thumbnailed clip.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[[AudioTimeline|Plugin]]
|martin53
|-
| [[BeFa]]
| Band Eliminate Filter for Audio.
| N/A
| [[BeFa|Plugin]]
| {{Author/kiraru2002}}
|-
| [[FindAudioSyncScript]]
| FindAudioSyncScript helps you to find the appropriate audio delays, if you have desync'ed audio.
| N/A
| Script
| IanB
|-
| [[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 float. It's a conditional audio filter, so the computation is done framewise.
| N/A
| [[MinMaxAudio|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
|[[Normalize2]]
|Audio normalizing plugin. The main difference between this plugin and the built-in normalizing plugin [[Normalize]]() is that this plugin can store the peak level value in an external file and uses a lookup table to do the actual normalizing (for speed).
|N/A
|[[Normalize2|Plugin]]
|[http://sourceforge.net/u/jcsston/profile/ jcsston]
|-
| [[SoxFilter]]
| Use [http://sox.sourceforge.net/ SOX] audio effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
| N/A
| [[SoxFilter|Plugin]]
| {{author/Sh0dan}}, [https://github.com/pinterf pinterf]
|-
|[[Spectrogram]]
|Linear [http://en.wikipedia.org/wiki/Spectrogram spectrogram] for AviSynth 2.6.
|Any
|[[Spectrogram|Plugin]]
|[http://github.com/innocenat innocenat]
|-
|SwitchByAudio
|Plugin to switch video source based on audio. See [http://forum.doom9.org/showthread.php?t=167011 discussion]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://www.avisynth.nl/users/vcmohan/SwitchByAudio/SwitchByAudio.zip Plugin]
|{{Author/vcmohan}}
|-
|[http://forum.doom9.org/showpost.php?p=1722472&postcount=20 TimeStretchPlugin]
|[[TimeStretch]] with multichannel support and updated SoundTouch library.
|N/A
|[http://www.wilbertdijkhof.com/TimeStretch_v258.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
| [[ViewAudio]]
| Includes two filters: ViewAudio and CacheAudio.
| [[YUY2]], [[YV12]]
| [[ViewAudio|Plugin]]
| {{Author/minamina}}
|-
| VUmeter
| Classic analog-style VU meter; see [https://forum.doom9.org/showthread.php?t=175370 discussion]. Uses MinMaxAudio.
| Any
| [https://github.com/raffriff42/AvisynthPlusUtilities script]
| raffriff42
|-
| [[Waveform]]
| Displays audio waveforms superimposed on the video, similar to AudioGraph below but with multi-channel support and consistent support for all colourspaces.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Waveform|Plugin]]
| {{Author/David Horman}}
|}

== 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. See [http://forum.doom9.org/showthread.php?p=397426 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/adjust_5F25_dll_20031110.zip Plugin]
| [http://avisynth.nl/users/warpenterprises/ WarpEnterprises]
|-
|[http://forum.doom9.org/showthread.php?t=166588 Adaptive Lens Blur Repair]
|This function adaptively repairs video damaged by lens blur, using a frame-adaptive repair mask, a selection of sharpeners and multi-stage motion-compensated artifact removal.
|[[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=13154&stc=1&d=1354907363 Script]
| fvisagie
|-
|[[amp]]
|Inspired by [http://forum.doom9.org/showthread.php?t=168293 RgbAmplifier], it performs temporal smoothing, then (optionally) enhances the difference between the windowed average and the current frame.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[amp|Plugin]]
| {{Author/David Horman}}
|-
|[[AutoOverlay]]
|Auto-aligned optimal overlay of one video clip onto another with color adjustment.
| [[RGB32]], [[YV24]], [[YV12]]
| [https://github.com/introspected/AutoOverlay/releases Plugin]
| [https://github.com/introspected introspected]
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace AutoTraceFilter]
|An intentionally useless plugin that uses [http://autotrace.sourceforge.net/ AutoTrace] to trace and then resize a source video, rendering the result using GDI+.
|[[RGB24]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|-
| [http://forum.doom9.org/showthread.php?p=675275#post675275 BeforeAfter]
| See the difference before and after; similar discussion [http://forum.doom9.org/showthread.php?t=98876 here]. (missing [http://www.animemusicvideos.org/forum/viewtopic.php?f=11&t=45223 BeforeAfterDiff] and BeforeAfterLine scripts.)
| any
| Script
| Corran
|-
|[http://forum.doom9.org/showthread.php?t=158696 ccc]
|A plugin specifically designed for Cross-Conversion Correction.
|[[YV12]]
|[http://web.archive.org/web/20150403181720/http://japland.org/ccc/ccc_v0.4a_avs.zip Plugin]
|Daemon404
|-
| [http://www.avisynth.nl/users/vcmohan/ColorIt/ColorIt.html Colorit]
| Color a black and white image or recolor a color image. See [http://forum.doom9.org/showthread.php?t=93990 discussion.]
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/ColorIt/Colorit.zip Plugin]
| {{Author/vcmohan}}
|-
| 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]
| mikeytown2
|-
| DCT
| Plugin with the following functions: IDCT, IDCT2, FDCT, FDCT2. See [http://forum.doom9.org/showthread.php?p=667382#post667382 discussion]
| [[YUY2]]
| [http://alainmuchembled.free.fr/DCT.zip Plugin]
| lcld
|-
| [http://forum.doom9.org/showthread.php?p=1444027#post1444027 DDigit]
| DDigit Plugin Text Rendering Pack for Plugin writers. See [http://forum.doom9.org/showthread.php?t=156888 discussion.]
|
| [http://www.mediafire.com/download/bfhj5crwaxbupeh/DDigitTest_25%2626_v1-06_dll_20150330-RECOMPILE.zip Plugin]
| {{Author/StainlessS}}
|-
|[http://forum.doom9.org/showthread.php?t=95193 DeJump]
| This is a specific filter which might be used to stabilize some "jumpy" video sources captured from VHS.
|[[YUY2]]
| [http://forum.doom9.org/attachment.php?attachmentid=3988&d=1117479069 Plugin]
| dinstun
|-
|[[FFAvisynth]]
| A plugin which lets you directly use [http://en.wikipedia.org/wiki/Ffdshow ffdshow] video and audio filters from AviSynth scripts.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://sourceforge.net/projects/ffdshow-tryout/ Plugin]
| Milan Cutka
|-
|[http://github.com/Youka/FLuaG FLuaG]
| FLuaG (Floating Lua Graphics) is an AviSynth plugin for video/audio data editing via Lua scripting. See [http://forum.doom9.org/showthread.php?t=161852 discussion]
| [[RGB32]]
| [http://github.com/Youka/FLuaG/archive/master.zip Plugin]
| [http://github.com/Youka Youka]
|-
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
| Use Avisynth to process still images.
|
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
|
|-
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 FSubstitute]
|Tries to automate the task of replacing bad frames using adjacent or close-by frames.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 Script]
|martin53
|-
|[http://forum.doom9.org/showthread.php?t=130611 GrainOptimizer]
|The only temporal-only grain reducer! See discussion for more information. Related topics: [http://forum.doom9.org/showthread.php?t=137117 x264: Film Grain Optimization], [http://web.archive.org/web/20090916181521/http://x264dev.blogspot.com/2008/05/film-grain-optimization.html]
|[[YV12]]
|[http://web.archive.org/web/20081228144846/http://mirror05.x264.nl/Dark/force.php?file=./GrainOptimizer_2.02.zip Plugin]
|Dark Shikari
|-
|[http://github.com/Youka/LVS LVS]
| LVS (Lua Video Sync) is a video frameserver plugin to edit video frames with the capability of scripting language Lua + 2D image processing functionality. See [http://forum.doom9.org/showthread.php?t=167716 discussion]. [https://github.com/Youka/LVS GitHub]
| [[RGB32]], [[RGB24]]
| [http://sourceforge.net/projects/lua-video-sync/files/ Plugin]
| [http://github.com/Youka Youka]
|-
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.html NeuralNet]
| Neural networks through back propagation learn and filter some types of noise. Classification and linear type networks are included.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.zip Plugin]
| {{Author/vcmohan}}
|-
| PseudoColor
| This filter first converts clip to b/w, then colors it to pseudorandom colors according to brightness. See [http://forum.doom9.org/showthread.php?t=61570 discussion.]
| [[RGB32]], [[RGB24]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/pseudocolor_5F25_dll_20030919.zip Plugin]
| Shubin
|-
|[http://github.com/jeremypoulter/QRCodeSource QRCodeSource]
|AviSynth plugin to provide a means to embed QR codes in video.
|[[RGB32]]
|[http://github.com/jeremypoulter/QRCodeSource/releases Plugin]
|[http://github.com/jeremypoulter jeremypoulter]
|-
|RemoveDeadPixels
|See [http://forum.doom9.org/showthread.php?p=699915#post699915 here] and [http://videoprocessing.fr.yuku.com/topic/27/Removedeadpixels here].
|[[YUY2]]
|[http://web.archive.org/web/20160610103945/http://home.arcor.de/kassandro/RemoveDeadPixels.rar Plugin]
|{{Author/kassandro}}
|-
|[http://forum.doom9.org/showthread.php?t=172601 rgba_rpn]
|A filter for manipulating the pixels of [[RGB]] (and also [[YUV]]) clips using [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://horman.net/avisynth/downloads/rgba_rpn0.1.zip Plugin]
|{{Author/David Horman}}
|-
| [[SegmentedAmp]]
| Image is segmented with watershed algorithm for smoothing and/or sharpening.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/index.php/SegmentedAmp Plugin]
| {{Author/vcmohan}}
|-
|[http://forum.doom9.org/showthread.php?t=172377 SmoothSkip]
|In tribute to tritical's awesome filter, this one tackles the inverse problem of [[TIVTC/TDecimate|TDecimate]]; allowing for addressing frames that have non-smooth, skippy motion. For source code see [http://github.com/jojje/SmoothSkip GitHub repository].
|[[YUY2]], [[YV12]]
|[http://github.com/jojje/SmoothSkip/releases/download/v1.0.2/SmoothSkip-1.0.2.zip Plugin]
|[http://github.com/jojje jojje]
|-
| [[Soothe]]
| Lessens the temporal instability and aliasing caused by sharpening, by comparing the original and sharpened clip, leaving a smoother and slightly softer output. See [http://forum.doom9.org/showthread.php?t=99679 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=99679 Script]
| {{Author/Didée}}
|-
|[https://sourceforge.net/projects/ssbrenderer/ SSBRenderer]
|SSBRenderer is a plugin for AviSynth to render 2D graphics and subtitles by SSB (Substation Beta) data on frames of video streams. [https://forum.doom9.org/showthread.php?t=169951 Doom9 Forum discussion], [https://github.com/Youka/SSBRenderer GitHub]
|[[RGB24]], [[RGB32]]
|[https://sourceforge.net/projects/ssbrenderer/files/ C-Plugin]
|[https://github.com/Youka Youka ]
|-
| [http://sourceforge.net/projects/avisynthtrackin/ Tracking]
| Use computer vision to track objects in the video, and produce ConditionalReader input. Demo at [http://www.youtube.com/watch?v=SQ-JtJs7US0 Youtube].
| [[RGB24]]
| [http://sourceforge.net/projects/avisynthtrackin/files/1.1/AvisynthTrackin.1.1.binary.zip/download Plugin]
| [http://avisynthtrackin.sourceforge.net/ Shlomo Matichin]
|-
| UnSmooth
| What does it do. It amplifies noise, small detail, and artifacts. Doesn't sound very attractive, but there can still be some detail left in over smoothed encodes. See [http://forum.doom9.org/showthread.php?t=63361 discussion.]
| [[YV12]]
| [http://web.archive.org/web/20090821183550/http://mf.creations.nl/avs/functions/UnSmooth-v0.1.avs Script]
| {{Author/mf}}
|-
| [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.html WaterShed]
| Assuming image grey values to be elevations, it is segmented into basins and watershed lines. Useful in certain medical image analysis and recoloring work.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| AviSynth 2.5.8: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.zip Plugin]
AviSynth 2.6.0: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins xvplugins]
|This is simply a bunch of AviSynth stuff that isn't (really) possible using plain AviSynth and instead required a plugin.
|[[RGB32]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|}
<br/>

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

External filters

2024-12-11T12:07:58Z

Pinterf: /* Multipurpose Filters */ amDCT version update

Rough classification of third-party filters for AviSynth - a perpetual work in progress.

This page lists both scripts (see [[Import]]) and plugins (see [[Plugins]]).

== Introduction ==

==== Download sites ====
A large list of filters can be downloaded from the following sites but be aware that some plugins listed '''may be outdated''', only recommended as a backup.

*[https://web.archive.org/web/20130803185015/http://www.64k.it:80/andres/dettaglio.php?sez=avisynth Andres' Filter Collection]
*[https://chaosking.de/repo/avsfilters/ AviSynth Filter DB by ChaosKing] | [https://web.archive.org/web/20140412062911/http://chaosking.de/avisynth-filter-db mirror]
*[http://www.avisynth.info/?plugin=attach&pcmd=list&refer=%E3%82%A2%E3%83%BC%E3%82%AB%E3%82%A4%E3%83%96 AviSynth.info Filter Archive]
*[http://xhmikosr.1f0.de/_old/avisynth/plugins/ XhmikosR's Builds]
*[http://www.avisynth.nl/users/warpenterprises/ Warp Enterprises' AviSynth Filter Collection]

====64-bit filters====
'''[[AviSynth%2B_x64_plugins|Comprehensive list of AviSynth+ 64-bit filters]] →'''

====Outdated AviSynth plugins====
[[External plugins old|External plugins (old)]] - these older plugins are not recommended, page is there mainly for historical purposes.

==== Using filters ====
Most scripts will apply filters in the following order:

# Create an AviSynth clip from a video file using a source filter.
# 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).



== Source Filters ==

{{FilterTable}}
| [https://forum.doom9.org/showthread.php?t=135855 BassAudio]
| [https://www.un4seen.com/ 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
| [https://forum.doom9.org/showthread.php?t=135855 Plugin]
| dimzon
|-
|[[BestAudioSource]]
|A new sample accurate but somewhat slow FFmpeg based audio source filter for AviSynth+. No indexing required and only available in 64-bit.
|N/A
|[[BestAudioSource|Plugin]]
|{{Author/Myrsloik}}
|-
| [[DGDecNV]]
| DGDecNV is a decoder/frameserver for AVC, HEVC, MPEG2, and VC1 streams that runs on the GPU of Nvidia graphics cards that support CUDA video decoding.
| [[I420]], [[YV12]], [[YUV420P16]]
| [[DGDecNV|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.
| [[RGB24]], [[YUY2]], [[YV12]], [[I420]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
|[http://forum.doom9.org/showthread.php?t=170107 DGMVCSource]
|MVC source filter for AviSynth.
| [[YV12]]
|[http://rationalqm.us/dgmvcsource/dgmvcsource100b26.zip Plugin]
|{{Author/Donald Graft}}
|-
| [[DSS2mod]]
| DirectShowSource2 mod, this version does not require Haali Media Splitter.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DSS2mod|Plugin]]
| forclip
|-
| [[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://github.com/FFMS/ffms2/releases Plugin]
| {{Author/Myrsloik}}, TheFluff, Plorkyeran, others
|-
|[http://forum.doom9.org/showthread.php?t=169651 FRIMSource]
|FRIMSource is an AviSynth plugin for sequential reading of elementary or transport streams (MPEG2, H.264 AVC/MVC-3D, VC1).
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=169651 Plugin]
|videofan3d
|-
| [[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]]
| [[ImageSequence|Plugin]]
| {{Author/WarpEnterprises}}
|-
| [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}}
|-
|[https://forum.doom9.org/showthread.php?t=184825 ImageSourceNV]
|CUDA accelerated plugin that uses the [https://docs.nvidia.com/cuda/nvjpeg/index.html nvJPEG API] to decode jpeg source files and convert their color space to YUV444.
|[[YUV444P8]]
|[https://forum.doom9.org/showthread.php?t=184825 Plugin]
|[https://github.com/ArturAlekseev Argaricolm]
|-
| [[JpegSource]]
| An advanced JPEG decoder for Avisynth 2.6. See [http://forum.doom9.org/showthread.php?t=170028 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/rjnt0y3ead2c6ef/JpegSource_20140419.7z Plugin]
| SEt
|-
| [[LSMASHSource]]
| A source plugin for audio and video, it uses Libav ([http://en.wikipedia.org/wiki/Libav#Contained_codecs libavcodec]) to decode all supported A/V formats. See [http://forum.doom9.org/showthread.php?t=167435 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[LSMASHSource|Plugin]]
| {{Author/VFR-maniac}}
|-
|[[MPEG2DecPlus]]
|MPEG2DecPlus is a MPEG-1/2 decoder plug-in. MPEG2DecPlus is a project to modernize "[[DGDecode]].dll" for AviSynth+.
|[[YV12]], [[YV16]]
|[[MPEG2DecPlus|Plugin]]
|{{Author/Chikuzen}}
|-
| [[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], [http://forum.doom9.org/showthread.php?t=135876 continued discussion].
| N/A
| [[NicAudio|Plugin]]
| {{Author/Nic}}
|-
| [[RawSource26]]
| Loads raw video data directly from files. Further modifications (most raw formats, YUV4MPEG2 compatible with latest spec).
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RawSource26|Plugin]]
| {{Author/Chikuzen}}
|-
| [[VapourSource]]
| VapourSynth script reader for AviSynth+ and AviSynth2.6x.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[VapourSource|Plugin]]
| {{Author/Chikuzen}}
|-
|[http://forum.doom9.org/showthread.php?t=170311 VideoInputSource]
| Capture video frames from video capture card or webcam in real-time.
|[[RGB24]]
|[http://github.com/fieliapm/himawari_avs_plugin/raw/master/VideoInputSource/VideoInputSource.dll Plugin]
|[http://github.com/fieliapm fieliapm]
|-
|[https://github.com/slavanap/ssifSource ssifSource]
| Open m2ts, ssif and mpls files located in decrypted Blu-ray and Blu-ray 3D discs. Supports horizontal of vertical stack of views as output, views selection and swap autodetection.
|[[YV12]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|}

== Restoration Filters ==

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

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

{{FilterTable}}
| [[DAA]]
| Anti-aliasing with contra-sharpening.
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| mcDAA3
| Motion-Compensated Anti-aliasing with contra-sharpening, can deal with ifade too, created because when applied daa3 to fixed scenes, it could damage some details and other issues. See [http://forum.doom9.org/showthread.php?p=1639679#post1639679 discussion]
| [[YV12]]
| [http://www.mediafire.com/?wqkob7zx1p119e0 Script]
| AmjadSONY
|-
| [[MAA2]]
| Updated version of the MAA antialising script.
| [[Y8]], [[YV12]], [[YV24]]
| [http://web.archive.org/web/20140624125132/https://raw.githubusercontent.com/AviSynth/avs-scripts/master/maa2.avsi Script]
| line0
|-
| [[santiag]]
| Simple anti-aliasing with independent horizontal and vertical anti-aliasing strength.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1393006 Script]
| {{Author/cretindesalpes}}
|-
| 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]
| [[YV12]]
| Script
| thetoof
|-
| [[TIsophote]]
| A level-set (isophote) smoothing filter.
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20070222162751/http://bengal.missouri.edu/~kes25c/TIsophotev091.zip Plugin]
| {{Author/tritical}}
|-
|[[xaa]]
|Versatile anti-aliasing script.
|[[Y8]], [[YV12]], [[YV24]]
|[http://www.mediafire.com/download/sygi04y47eknvc2/xaa_v1.1.1.avsi Script]
|Desbreko
|}

=== Chroma correction ===

{{FilterTable}}
|[[caf]]
|Chromatic Aberration Fixer.
| [[YV12]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| Torchlight
|-
| [[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. See [http://forum.doom9.org/showthread.php?t=33302 discussion.]
| [[YV12]], [[YUY2]], [[RGB32]]
| [http://web.archive.org/web/20091026153334/http://www.geocities.com/siwalters_uk/chromashift27.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChromaShiftSP]]
| This script can shift chroma in all directions with subpixel accuracy.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| IanB, McCauley
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[ColorMatrix|Plugin]]
| {{Author/Wilbert Dijkhof}}, {{Author/tritical}}
|-
| [[DeBlot]]
| Color bleed reduction plugin.
| [[YUY2]],[[YV12]]
| [[DeBlot|Plugin]]
| {{Author/minamina}}
|-
| [[FixChromaBleeding]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074 discussion]
| [[YV12]]
| [http://web.archive.org/web/20091026141730/http://www.geocities.com/alex_j_jordan/chroma.txt Script]
| {{Author/Alex Jordan}}
|-
| [[FixChromaBleedingMod]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074#post1673932 discussion]
| [[YV12]], [[YUY2]], [[YV411]]
| [[FixChromaBleedingMod_source|Script]]
| AmjadSONY
|-
| [[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. See [http://forum.doom9.org/showthread.php?p=1520786#post1520786 discussion.]
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/index.php/FixChromaticAberration Script]
| Martin Wagener
|-
| [[MoveChroma]]
| Chroma shifting filter; can be used to independently shift the U/V channels left or right.
| [[YUY2]], [[YV12]]
| [[MoveChroma|Plugin]]
| [http://noraneco.ddo.jp/apechironnup apechironnup]
|-
| [[PixelShiftPlus]]
| Set of functions to independently shift any RGB(A) or YUV(A) plane with subpixel precision.
| All colorspaces
| [[PixelShiftPlus|Script]]
| reel.deal
|-
| [[ReInterpolate411]]
| This is a fast and simple filter to correct the improper 4:1:1 => 4:2:2 conversion that seems to occur with some DV/4:1:1 codecs.
| [[YUY2]]
| [{{N2Archived}}/trbarry/ReInterpolate411.zip Plugin]
| {{Author/Tom Barry}}
|-
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420.html ReInterpolate420]
| Usually, DV decoders upsample [[PAL]] DV (which is YV12) to YUY2 using point sampling. This plugin re-interpolates the original chroma samples.
| [[YUY2]]
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420_v3.zip Plugin]
| {{Author/Wilbert Dijkhof}}
{{Author/Fizick}} (v3)
|}

=== Debanding ===

{{FilterTable}}
| AdaptDBMC
| Luma / Fade / Blue adaptive debanding script. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=512 discussion]
| [[YV12]]
| [https://web.archive.org/web/20131111114822/http://www.nmm-hd.org/upload/get~ikKt5ZZhD94/AdaptDBMC_beta.rar Script]
| {{Author/06_taro}}
|-
| [[GradFun2db]]
| A simple and fast debanding filter.
| [[YV12]]
| [[GradFun2db|Plugin]]
| Prunedtree
|-
| [[GradFun2DBmod]]
| An advanced debanding script based on GradFun2DB.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144537 Script]
| {{Author/LaTo}}
|-
| [[Dither_tools#GradFun3|GradFun3]]
| This debanding script, part of the [[Dither_tools|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]]
| [[Dither_tools|Script]]
| {{Author/cretindesalpes}}
|-
| [[f3kdb|flash3kyuu_deband]]
| Fast debanding plugin ported from AviUtl.
| [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[Y8]], [[YV411]]
| [[f3kdb|Plugin]]
| [http://github.com/SAPikachu/ SAPikachu]
|-
|[[avslibplacebo#Deband|libplacebo_Deband]]
|Tunable debanding. Based on flash3kyuu, expanded to provide high quality by combining multiple debanding passes.
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
| LumaDB
| Fast 8-bit 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://web.archive.org/web/20131111114932/http://www.nmm-hd.org/upload/get~3YK_B5TfcyI/LumaDB-0.7.rar Script]
| {{Author/06_taro}}
|-
| LumaDBL
| Fast 16-bit 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://web.archive.org/web/20131111114947/http://www.nmm-hd.org/upload/get~mQYIS9H6Qas/LumaDBL-0.7.rar Script]
| {{Author/06_taro}}
|-
| [[Neo_f3kdb]]
| Fast debanding plugin for AviSynth+.
| [[Y8]], [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[YV411]], 8-16bit [[planar]] Y/YUV
| [[Neo_f3kdb|Plugin]]
| [https://github.com/msg7086 MeteorRain]
|-
|}

=== Deblocking ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect BlockDetect]
|Determines blockiness of frames.
|All 8-32 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect/releases Plugin]
|{{Author/Asd-g}}
|-
| BlockKiller
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=1410479#post1410479 discussion].
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1410479&postcount=19 Script]
| Jawed
|-
| BlockTerminator
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=831936#post831936 discussion.]
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=831936&postcount=24 Script]
| foxyshadis
|-
| [[DeBlock]]
| Deblocking filter. DGDecode also uses DeBlock.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit Y/YUV [[planar]] colorspaces
| [[DeBlock|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." [http://forum.doom9.org/showpost.php?p=913365&postcount=4 Didée]. See [http://forum.doom9.org/showthread.php?p=944459 discussion.] For updated Deblock QED see this [http://forum.doom9.org/showthread.php?t=154777 discussion]
| [[YV12]]
| [http://avisynth.nl/images/Deblock_QED_MT2Mod.avsi Script]
| {{Author/Didée}}
|-
|[[DeblockPP7]]
| A port of the MPlayer PP7 deblocking filter.
|[[YUY2]], [[YV12]]
|[[DeblockPP7|Plugin]]
|John Doe
|-
| [[FunkyDeBlock]]
| Deblocking script based on BlindPP and high/low pass separation. See [http://forum.doom9.org/showthread.php?t=72431 discussion].
| [[YV12]]
| Script
| Mug Funky
|-
| [[MDeblock]]
| Plugin for removing block artifacts.
| [[YV12]]
| [[MDeblock|Plugin]]
| {{Author/kassandro}}
|-
| [[SmoothD]]
| Filter to deblock frames while keeping high frequency detail.
| [[YV12]]
| [[SmoothD|Plugin]]
| Tobias Bergmann
|-
| [[SmoothD2]]
| Deblocking filter. Rewrite of SmoothD. Faster, better detail preservation, optional chroma deblocking.
| [[YV12]]
| [[SmoothD2|Plugin]]
| Jim Conklin
|-
| SmoothDeblock
| 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]<br>[[SmoothDeblock_source|(alt source)]]
| redfordxx
|-
|[http://www.avisynth.nl/users/fizick/unblock/unblock.html Unblock]
|UnBlock is a filter that removes the "blockiness" of heavily or moderately compressed images with statistical approach. See [http://forum.doom9.org/showthread.php?t=133059 discussion].
|[[YV12]]
|[http://www.avisynth.nl/users/fizick/unblock/unblock11.zip Plugin]
|{{Author/Fizick}}
|-
|[[vsDeblockPP7]]
|A port of the MPlayer PP7 deblocking filter. Includes high bit-depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit [[planar]] colorspaces
|[[vsDeblockPP7|Plugin]]
|Asd-d
|}

=== Dehaloing ===

{{FilterTable}}
| [[abcxyz]]
| Filter to remove halos. See [http://forum.doom9.org/showthread.php?t=144982 discussion].
| [[YV12]]
| [[Media:abcxyz_MT2.avsi|Script]]
| {{Author/Didée}}
|-
| [[BlindDeHalo3]]
| Filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=622289#post622289 discussion].
| [[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=5599&d=1143030001 Script]
| {{Author/Didée}}
|-
| [[DeHalo_alpha]]
| Very powerful filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=777956#post777956 discussion].
| [[YV12]]
| [http://avisynth.nl/images/Dehalo_alpha_mt.avsi Script]
| {{Author/Didée}}
|-
|[[DeHaloHmod]]
| Another halo reducer, it includes lots of options to tweak for best performance. See [http://forum.doom9.org/showthread.php?p=1675762#post1675762 discussion]
|[[YV12]]
| [[DeHaloHmod|Script]]
|AmjadSONY
|-
|[[FineDehalo]]
|Halo removal script that uses DeHalo_alpha with a few masks and optional contra-sharpening to try remove halos without removing important details (like line edges).
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/images/FineDehalo.avsi Script]
|{{Author/cretindesalpes}}
|-
|[https://forum.doom9.org/showthread.php?t=172599 HaloBuster]
|Really slow high quality halo remover.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=172599 Script]
|feisty2
|-
| 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
|-
| [[VHSHaloremover]]
| Quick & dirty halo removal. Will introduce some blurriness, but the halos are so huge you can’t avoid it. See [http://forum.doom9.org/showthread.php?p=1758184#post1758184]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://pastebin.com/s24mSgJ5 Script]
| {{Author/cretindesalpes}}
|-
| [[YAHR]]
| Basic filter with no variables to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=1205653#post1205653]
| [[YV12]]
| [http://avisynth.nl/images/YAHR.avsi Script]
| {{Author/Didée}}
|-
| YAHRmod
| Basic filter used to reduce halos in modern DVD and other cases.
| [[YV12]]
| [[YAHRmod_source|Script]]
| AmjadSONY
|}

=== Deringing & Mosquito Noise ===

{{FilterTable}}
| [[aWarpSharpDering]]
| Tries to clean up slight ringing around edges by heavily aWarpSharp-ing the image and then applying it only to the areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://avisynth.nl/images/AWarpSharpDering.avsi Script]
| {{Author/Leak}}
|-
| [http://rationalqm.us/dgmpgdec/DGDecodeManual.html#BlindPP BlindPP]
| Deblocking & deringing filter; part of [[DGDecode]]. <br>Mosquito noise removal: <code>BlindPP(quant=16, cpu2="ooooxx")</code>
| [[YV12]], [[YUY2]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
| [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
|-
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Deemphasize]
|This AviSynth function deemphasizes ringing common to SD video signals resulting from a playback device in the transfer chain poorly compensating for pre-emphasis baked into the source signal.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Script]
|[https://github.com/acuozzo acuozzo]
|-
|[[Dering]]
|Deringing filter intended for deringing VHS captured video.
|[[YUY2]], [[YV12]]
|[[Dering|C-Plugin]]
|[https://sourceforge.net/u/alexrayne/profile/ alexrayne]
|-
| [[EdgeCleaner]]
| A simple edge cleaning and weak dehaloing function. See [http://forum.doom9.org/showthread.php?t=164592 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1568521&postcount=13 Script]
| [http://forum.doom9.org/member.php?u=80518 canuckerfan]
|-
| [[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}}
|-
| [[HQDering mod]]
| Applies deringing by using a smart smoother near edges (where ringing occurs) only.
| [[YV12]]
| [http://web.archive.org/web/20140711173345/http://www.nmm-hd.org/upload/get~08CusazVphU/HQDeringmod_v1.8.avsi Script]
| [http://www.nmm-hd.org/newbbs/memberlist.php?mode=viewprofile&u=479&sid=ff62d0f6c22fcfdbe97b53c8351429bc mawen1250]
|-
| [[LazyDering]]
| Tries to clean up slight ringing around edges by applying [[aWarpSharp2]] only to areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://web.archive.org/web/20131103155455/http://anime-addict.ani-x.com/files/avisynth/scripts/LazyDering_v0.1.avsi Script]
| {{Author/Leak}}, RazorbladeByte
|-
| [[MosquitoNR]]
| A noise reduction filter designed for mosquito noise, which is often caused by lossy compression.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]], [[YUY2]]
| [[MosquitoNR|Plugin]]
| {{Author/b_inary}}
|-
|ungibbs
|ungibbs, a gibbs artifact remover.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=134502 Script]
|*.mp4 guy
|-
|WarpDeRing
|Uses aWarpSharp2's flattening to clean out ringing/smaller halos, then runs some masks to preserve the edges and avoid the thinning.
|[[YV12]]
|[[WarpDeRing_source|Script]]
|mirkosp
|-
|WarpDeRing_faster
|Same as WarpDeRing but may be a bit faster.
|[[YV12]]
|[[WarpDeRing_faster_source|Script]]
|mirkosp
|-
|[[WDFPlus]]
|Faster version of mirkosp's warpdering_faster script for AviSynth+.
|All 8-16 bit Y/YUV colorspaces, except YV411
|[https://github.com/Reel-Deal/AviSynthPlus-Scripts/blob/main/wdfplus.avsi Script]
|reel.deal
|}

=== Deinterlacing ===

{{FilterTable}}
|[[BWDIF]]
|Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic interpolation algorithms.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all 8-32bit [[planar]] colorspaces
|[[BWDIF|Plugin]]
|Asd-g
|-
| [[Decomb]]
| The FieldDeinterlace filter provides functionality similar to the postprocessing function of 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.
| [[YUY2]], [[YUY2]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
| [[EEDI2]]
| EEDI2 resizes an image by 2x in the vertical direction by copying the existing image to 2*y(n) and interpolating the missing field. It is intended for edge-directed interpolation for deinterlacing (i.e. not really made for resizing a normal image, but can do that as well).
| [[YUY2]], [[YV12]]
| [[EEDI2|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI2CUDA]]
| EEDI2 filter using CUDA.
| All [[planar]] Y/YUV/RGB 8 to 16-bit colorspaces
| [[EEDI2CUDA|Plugin]]
| [https://github.com/misakikasumi misakikasumi], [https://github.com/WolframRhodium WolframRhodium]
|-
| [[eedi3|EEDI3]]
| Another edge directed interpolation filter. Works by minimizing a cost functional involving every pixel in a scan line. eedi3 is good for deinterlacing and enlarging images by the powers of 2.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[eedi3|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI3CL]]
| OpenCL implementation of eedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[EEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
|[[FieldHint]]
|FieldHint combines arbitrary fields from the input clip, and optionally adds Telecide-compatible postprocessing hints.
|[[YV12]]
|[http://web.archive.org/web/20120223025813/http://ivtc.org/yatta%20support/fieldhint-0.12.rar Plugin]
|{{Author/akupenguin}}
|-
| [[nnedi3]]
| nnedi3 is an intra-field only deinterlacer. It takes in a frame, throws away one field, and then interpolates the missing pixels using only information from the kept field. It also has same rate and double rate modes.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[nnedi3|Plugin]]
| {{Author/tritical}}
|-
| [[NNEDI3CL]]
| OpenCL implementation of nnedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[NNEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
| [[nnedi3ocl]]
| OpenCL rewrite of [[nnedi3]]. See [http://forum.doom9.org/showthread.php?t=169766 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/bmemjsu7jqnlk65/nnedi3ocl_20131208.7z Plugin]
| SEt
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[QTGMC|Script]]
| -Vit-
|-
| [[SangNom2]]
| Reimplementation of the old [[SangNom]] plugin.
| [[Y8]],[[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SangNom2|Plugin]]
| {{Author/tp7}}
|-
| [[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]]
| [[TDeint|Plugin]]
| {{Author/tritical}}
|-
| [[TelecideHints]]
| The filter process the stats file to get the usual progressive matches and identify VFR sections.
| [[YUY2]], [[YV12]]
| [http://mod16.org/fansub/Telecidehints11.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[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
| [[YV12]]
| [[TempGaussMC|Script]]
| {{Author/Didée}}
|-
| [[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]]
| [[yadifmod|Plugin]]
| {{Author/tritical}}
|-
| [[yadifmod2]]
| Yadif + yadifmod for avisynth2.6/avisynth+.
| [[YV24]], [[YV16]], [[YV12]], [[YV411]], [[Y8]]
| [[yadifmod2|Plugin]]
| {{Author/Chikuzen}}
|}

=== Duplicate Frame Detectors ===

{{FilterTable}}
| [[ApparentFPS]]
| Shows underlying framerate where a clip has had many duplicates inserted, easier than counting unique frames.
| (see [[ApparentFPS|docs]])
| [[ApparentFPS|Plugin]]
| StainlessS
|-
| [[DeDup]]
| Remove (drop) duplicate frames in the interest of compression quality and speed. Resulting clip will have a variable frame rate.
| [[YV12]], [[YUY2]]
| [[DeDup]]
| {{Author/akupenguin}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[Dup|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=175357 Duplicity2/DropDeadGorgeous]
|A two faced scheming and double dealing [on your behalf] dupe tool.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=175357 Script]
|StainlessS
|-
| [http://forum.doom9.org/showthread.php?t=134930 Dupped]
| Another frame duplication function, similar to Dup, but hopefully more accurate.
| [[YV12]]
| [http://web.archive.org/web/20140420181919/http://www.randomdestination.com/members/corran/misc/dupped/dupped.avsi Script]
| [https://github.com/eparsons Corran]
|-
| [[DupStep]]
| Duplicate frame detector/decimator filter for [[AviSynth+]], 64-bit version only.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|8-16 bits]]
| [[DupStep|Plugin]]
| [http://github.com/Orum Orum]
|-
|[[ExactDedup]]
| ExactDedup is a filter intended to remove frames that are exact duplicates of each other, leaving only the first and (optionally) last frames of a run intact, and generates a Matroska v2 timecodes file with timing information for the ensuing stream.
| [[RGB24]] [[RGB32]], [[Y8]], [[YV12]] [[YV16]], [[YV24]]
| [[ExactDedup|Plugin]]
|Steve Melenchuk, Arick Chan, StainlessS
|-
| [http://www.avisynth.nl/users/fizick/getdups/getdups.html GetDups]
| Selecting unique duplicate frames from clip, it return frames which have copies only, by one from the series (group). Made for 8mm films.
| [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.avisynth.nl/users/fizick/getdups/getdups096.zip Plugin]
| {{Author/Fizick}}
|-
| [http://forum.doom9.org/showthread.php?t=164372 MorphDups]
| Replace duplicate frames by interpolations.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=164372 Script]
| sven_x
|}

=== Fieldblending and Frameblending removal ===

{{FilterTable}}
| [[c_deblend]]
| c_deblend is a simple blend replacing function like unblend or removeblend. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[Cdeint]]
| Restores 24fps FILM out of a fieldblended FILM -> Telecine -> [[NTSC]] -> Blendconversion -> [[PAL]] - Video (alternative for Restore24).
| [[YV12]]
| Script
| MOmonster
|-
| [[Deblend]]
| See [http://forum.doom9.org/showthread.php?p=760375#post760375 discussion].
|
| Script
| actionman133
|-
| [[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.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[ExBlend|Plugin]]
| StainlessS
|-
| [[FixBlendIVTC]]
| A blend replacing/frame restoring function for doubleblends caused by blend-deinterlacing of telecined sources. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[mrestore]]
| Uses conditional frame evaluation to undo standard conversions with blends. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[RemoveBlend]]
| This filter is used to remove blended fields/frames. See [http://forum.doom9.org/showthread.php?t=75772 discussion.]
| [[YV12]]
| [//web.archive.org/web/20061113201230/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].
|[[YV12]]
| 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]]
| [http://wilbertdijkhof.com/mg262/Restorefps_v10.zip Plugin]
| {{Author/mg262}}
|-
| [[Srestore]]
| Replacement function for mrestore, c_deblend, FixBlendIVTC and DupHq.
| [[YV12]]
| [[Srestore|script]]
| MOmonster
|-
| Specials
| Helps restore video with blended fields/frames using a reference source. See [http://forum.doom9.org/showthread.php?t=165030 discussion] and much more information [http://horman.net/doctorwho/specials.php here] and [http://forum.doom9.org/showthread.php?t=168832 here].
| [[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
|}

=== Film Damage correction ===

{{FilterTable}}
|[[DePulse]]
|DePulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[DePulse|Plugin]]
|
|-
| [[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]]
| [[DeScratch|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]]
| [[DeSpot|Plugin]]
| {{Author/Fizick}}
|-
| [[deVCR]]
| deVCR eliminates (to a certain degree) the annoying horizontal lines that keep crawling around your VHS or Beta recorded video.
| 8-bit RGB/YUV
| [[DeVCR#Script|Script]]
| Ricardo Garcia
|-
|[[KillPulse]]
|KillPulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[KillPulse|Plugin]]
|-
|[http://forum.doom9.net/showthread.php?p=1402690 KillerSpots]
|Spot removal function based on Didée's idea from 2010 that makes use of MVTools analysis and RemoveDirt to detect and clean up spots with adiacent pixels.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|[https://github.com/FranceBB/KillerSpots Script]
|Didée, GMJCZP and John Meyer.
|
|-
| [[RemoveDirt]]
| RemoveDirt is a temporal cleaner for AviSynth 2.6 and AviSynth+.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[RemoveDirt|Plugin]]
| {{Author/kassandro}}, {{Author/pinterf}}
|-
|[http://forum.doom9.org/showthread.php?t=121197 RemoveLine]
|Script for removal of horizontal stripes.
|[[YV12]]
|Script
|Yup
|-
|[https://forum.doom9.org/showthread.php?t=181777 SpotLess]
|Script filter to remove spots and noise using mvTools2 and Medianblur2. Copes with spots on multiple consecutive frames, setting RadT accordingly.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182407 SpotRemover]
|This script is designed to clean video from spots. Based on SpotLess script by StainlessS.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://forum.doom9.org/showthread.php?t=144271 VideoFred's Film Restoring]
| A suite of scripts for film restoring.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144271 Script]
| videoFred
|}

=== Frequency Interference removal ===

{{FilterTable}}
| [http://www.avisynth.nl/users/fizick/defreq/defreq.html 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://www.avisynth.nl/users/fizick/defreq/defreq07.zip Plugin]
| {{Author/Fizick}}
|-
| [http://avisynth.nl/users/vcmohan/FanFilter/FanFilter.html FanFilter]
| Regular vertical frequency interference is filtered in spatial domain.
| [[YV12]], [[YUY2]], [[RGB32]], [[RGB24]]
| [http://www.avisynth.nl/users/vcmohan/FanFilter/FanFilter.zip 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] and See [http://forum.doom9.org/showthread.php?p=1673928] for mod version.
| [[YV12]]
| Script
| thetoof
|-
| [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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=158230 Script]
| jmac698
|-
| [[FDecimate]]
| The FDecimate() filter provides extended decimation capabilities not available from 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]]
| [[FDecimate|Plugin]]
| {{Author/Donald Graft}}
|-
| [[FDecimate2]]
| FDecimate2 is based on FDecimate v1.0.2. FDecimate2, fixes some problems with bugged metrics in FDecimate v1.0.2.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FDecimate2|Plugin]]
| {{Author/StainlessS}}
|-
| [[IT]]
| Inverse Telecine plugin.
| [[YUY2]], [[YV12]]
| [[IT|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[IVTC_txt60mc|ivtc_txt60mc]]
| Deinterlaces telecined footage with that has been overlayed scrolling text at 60i.
| [[YV12]]
| [[IVTC_txt60mc|Script]]
| {{Author/cretindesalpes}}
|-
|JIVTC
|JIVTC applies inverse telecine in a way to minimize artifacts often seen on Japanese TV broadcasts followed by recalculating the fields that might still contain some.
|[[YV12]]
|[http://raw.githubusercontent.com/lovesyk/avisynth-scripts/master/JIVTC.avsi Script]
|[http://github.com/lovesyk lovesyk]
|-
|[[MDec2]]
|MDec2 is a 2 pass decimating filter, acting much like the MultiDecimate filter.
|[[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[MDec2|Plugin]]
|StainlessS
|-
| 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]]
| [{{N2Moved}}/multidecimate/multidecimate.html Plugin]
| {{Author/Donald Graft}}
|-
| RePal
| [http://forum.doom9.org/showthread.php?t=48401 Discussion] / [http://forum.doom9.org/showthread.php?p=1092552#post1092552 repal_29.97Hz_mod]
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/repal_5F25_dll_20030523.zip Plugin] - [http://forum.doom9.org/attachment.php?attachmentid=8028&d=1201414683 Mod]
| Bach
|-
| [[Decomb]]
| The Telecide and Decimate filters can be combined to implement IVTC.
| [[YUY2]], [[YV12]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=182369 TelecineBob]
|If your source soffers from field blending, as long as no deinterlacing is made you will find out that conveniently the blended fields are often paired with a clean one. FieldDeBlend takes advantage of that and checks for frames whose fields don't match to replace the frame with a clean one as long there is one.
|[[YV12]]
|[https://www.mediafire.com/file/sa1oae96m63mkje/TelecineBob.zip/file Plugin]
|Ceppo
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[TIVTC|Plugin]]
| {{Author/tritical}}
|-
| TPRIVTC
| TPRIVTC stands for TMPEG InVerse Telecine, i.e. the process where an 29.97fps interlaced NTSC clip is converted to 23.976fps while removing interlaced frames. [http://web.archive.org/web/20030808191810/http://kurosu.inforezo.org/avs/TPRIVTC/index.html Readme]
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/tprivtc_5F25_dll_20040930.zip Plugin]
| daxab, {{Author/Kurosu}}
|-
| [http://forum.doom9.org/showthread.php?t=167875 WeaveMan]
| Remove arbitrary pulldown patterns manually; meant for perfectionists to undo non-standard 24->25 fps, 25->29.97 fps, etc. telecine conversions, along with other weird telecine anomalies created by broadcasters speeding up film-sourced content. See sample case [http://forum.doom9.org/showthread.php?p=1630931&highlight=weaveman#post1630931 here].
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20131208232913/http://chidragon.thedessie.com/Doom9/WeaveMan-v0.2.zip Plugin]
| ChiDragon
|-
| [[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
| FixVHSOversharp attempts to repair the light and dark halos that follow high contrast edges found in VHS sources. See [http://web.archive.org/web/20131014010552/http://www.videohelp.eu/forum/avisynth/2851-avisynth-fixvhsoversharp-beta.html discussion.]
| | [[YUY2]]
| [http://web.archive.org/web/20091026142456/http://www.geocities.com/mrtibsvideo/fixvhsoversharp.html Plugin]
| [http://web.archive.org/web/20091027001215/http://geocities.com/mrtibsvideo/ MrTibs]
|-
| [[GhostBuster|Ghostbuster]]
| A filter for the removal of ghosting.
| [[YUY2]]
| [[GhostBuster|Plugin]]
| {{Author/SansGrip}}
|-
| [[LGhost]]
| Plugin intended for ghost removal but can also reduce edge (ringing) artifacts.
| [[YV12]], [[YUY2]]
| [[LGhost|Plugin]]
| {{Author/minamina}}
|-
| [[vsLGhost]]
| Luminance Ghost reduction filter. Can be used for removing luminance ghost or edge ghost (ringing).
| All [[Planar]] colorspaces (8-32bit)
| [[vsLGhost|Plugin]]
| {{Author/Asd-g}}
|}

=== Logo Removal ===

{{FilterTable}}
| [[AvsInpaint]]
| This plugin comes with the intention to provide a suit for the removal of logos, whether opaque or transparent. It provides algorithms for these tasks: logo detection, deblending, and logo inpainting.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[AvsInpaint|C-Plugin]]
| AMSS0815, {{Author/pinterf}}
|-
| [[DeKafka]]
| This fairly simple filter washes away those annoying bugs from broadcast clips.
| Any
| Script
| poptone
|-
| 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.
| [[RGB32]]
| [{{N2Moved}}/delogo132/delogo.html Plugin] & [http://forum.doom9.org/showthread.php?t=119447 Script]
| Karel Suhajda
|-
|[[DelogoHD]]
|DelogoHD is an overhaul of the original delogo filter, which was originally written by MakKi many years ago.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], <br> 8-16bit planar YUV
|[[DelogoHD|Plugin]]
|MeteorRain
|-
| [https://forum.doom9.org/showthread.php?t=184881 DoomDelogo]
| DoomDelogo meant to be simpler and perform better than deKafka, s_ExLogo, x-Logo and similar.
| Any
| [https://forum.doom9.org/showthread.php?t=184881 Script]
| VoodooFX
|-
| [[ExInpaint]]
| Exemplar-Based Image Inpainting. See [http://forum.doom9.org/showthread.php?t=133773 discussion]
| [[RGB24]] [[RGB32]], [[YUY2]], [[YV12]]
| [[ExInpaint|Plugin]]
| {{Author/Fizick}}
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|InpaintDelogo is an advanced logo and watermark removal function using inpainting and deblending with an adjustable fine process to hide artifacts and get best delogo results.
Can remove opaque, transparent, semi-transparent and some dynamic logos from video.
Can be used to remove hardcoded subtitles or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
| [[InpaintFunc]]
| Script for logo removal using inpainting. Can remove alpha blended or opaque logos with a basic postprocessing to hide artifacts.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[InpaintFunc|Script]]
| Reuf Toc
|-
| LogoNR
| Post-denoise filter for EraseLogo or [[DelogoHD]]. See [https://web.archive.org/web/20210915185704/https://www.nmm-hd.org/newbbs/viewtopic.php?t=649 discussion]
| All [[planar]] colorspaces
| [https://web.archive.org/web/20220702130736/https://pastebin.com/raw/qZBU3NQA Script]
| {{Author/06_taro}}
|-
| [[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]
| [[YV12]]
| [http://avisynth.nl/images/Rm_logo.avs Script]
| Spuds
|-
|[http://forum.doom9.org/showthread.php?t=154559 s_ExLogo]
|De-logo function with clipping (Dekafka mod).
|[[YUY2]]
|[http://www.mediafire.com/download/40cpnnctd0uutpv/s_ExLogo_1.1.zip Script]
|{{Author/StainlessS}}
|-
| [[Uglarm]]
| Filter for blurring a logo, using LogoAway style Uglarm Interpolation method.
| [[RGB24]] [[RGB32]],[[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[Uglarm|Plugin]]
| {{Author/StainlessS}}
|-
| [[X-Logo]]
| X-Logo AviSynth plugin and VirtualDub filter. Removes opaque logos.
| [[RGB32]], [[YUY2]], [[YV12]]
| [[X-Logo|Plugin]]
| [http://web.archive.org/web/20041204210505/http://members.verizon.net/~vze3kkvm/filters.html Leuf]
|}

=== Luma Equalization ===

{{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://www.avisynth.nl/users/warpenterprises/files/antiflicker_5F25_dll_20030304.zip Plugin]
| {{Author/Donald Graft}}
|-
| [[DeFlicker]]
| Can remove old film intensity flicker by temporal mean luma smoothing. Can also correct blinding of automatic gain control after flashes.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]]
| [[DeFlicker|Plugin]]
| {{Author/Fizick}}, {{Author/pinterf}}
|-
| [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}}
|-
| [[EquLines]]
| Equalizes total luminosity in pairs of even and odd lines. Useful for removing inter-line differences from telecined films.
| [[YV12]], [[YUY2]]
| [[EquLines|Plugin]]
| {{Author/Fizick}}
|-
| [[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]]
| [[LMFlicker|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
|-
| [[ReduceFlicker]]
| Plugin to reduce temporal oscillations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[ReduceFlicker|Plugin]]
| {{Author/kassandro}}, {{Author/Chikuzen}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[TimeLapseDF|Plugin]]
| {{Author/Denis Zhitenev}}
|-
| [[Vinverse]]
| A simple but effective plugin to remove residual combing.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bit planar Y/YUV
| [[Vinverse|Plugin]]
| {{Author/Didée}}, {{Author/tritical}}, {{Author/tp7}}
|-
| [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
|}

=== [[:Category:Rainbow & Dot Crawl Removal|Rainbow & Dot Crawl Removal]] ===

{{FilterTable}}
| [[Bifrost]]
| Bifrost uses temporal blending to remove or at least reduce the effect of rainbows.
| [[YV12]]
| [[Bifrost|Plugin]]
| {{Author/Myrsloik}}, dubhater
|-
| [[CC]]
| Dot crawl and rainbow removal.
| [[YV12]], [[YUY2]]
| [http://www.chiyoclone.net/dl/cc_20040522.lzh Plugin]
| {{Author/chiyo-clone}}
|-
| [[Checkmate]]
| Spatial-temporal dot crawl removal.
| [[YV12]]
| [[Checkmate|Plugin]]
| {{Author/mf}} / prunedtree
|-
| [[ChubbyRain]]
| Spatial-temporal rainbow reducing script.
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain.avsi Script]
| Mug Funky
|-
| [[ChubbyRain2]]
| Spatial-temporal rainbow reducing script based on [[ChubbyRain]].
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain2.avsi Script]
| Lothar
|-
| [[DDCR]]
| A purely spatial dot crawl removal script for AviSynth+.
| all 8 bit Y/YUV colorspaces
| [[DDCR|Script]]
| Reel.Deal
|-
| [[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]]
| [[DeCross|Plugin]]
| {{Author/minamina}}
|-
| [[DeDot]]
| Removes dot crawl and may also be useful for rainbows.
| all planar Y, YUV, and YUVA (8-16 bit)
| [[DeDot|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[DeRainbow]]
| A simple script to reduce rainbows. See [http://forum.doom9.org/showthread.php?p=398106#post398106 discussion.]
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/images/DeRainbow.avsi 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]]
| [http://avisynth.nl/images/DFMDeRainbow-20140223.avsi Script]
| {{Author/Scintilla}}
|-
|[[DotKill]]
|Spatio-temporal dotcrawl and rainbow remover.
|[[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bits
|[[DotKill|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=170328 FadeDeRainbow]
|Another de-rainbowing script.
|[[YV12]]
|[https://forum.doom9.org/showthread.php?t=170328 Script]
|bxyhxyh
|-
| [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 spatial; only targets pixels for dot crawl removal if luma is fluctuating and (optionally) chroma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/http://www.aquilinestudios.org/scripts/LUTDeCrawl-20081003.avsi Script]
| {{Author/Scintilla}}
|-
| [[LUTDeRainbow]]
| Purely spatial; only targets pixels for derainbowing if chroma is fluctuating and (optionally) luma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/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.
| [[YV12]]
| [http://avisynth.nl/images/MfRainbow-v0.32.avsi Script]
| {{Author/mf}}
|-
| [[Rainbow_Smooth]]
| A small spatial derainbow function. It uses [[SmoothUV]] to smooth out chroma and edge masking to prevent color bleeding.
| [[YV12]]
| [http://avisynth.nl/images/Rainbow_smooth.avsi 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.
| [[YV12]]
| [http://avisynth.nl/images/SmartSSIQ.avsi 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}}
|-
| [[TComb]]
| A temporal comb filter (it reduces cross-luminance (rainbowing) and cross-chrominance (dot crawl) artifacts in static areas of the picture).
| [[YV12]], [[YUY2]]
| [[TComb|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]]
| [[YARK|Script]]
| jase99
|-
| [[ASTDR]]
| ASTDR uses mt_motion for motion and edge to deal with moving Rainbow and apply mask once more in the opposite way to keep around the lines as they are. It uses DeCross and other filters to remove Rainbow. ASTDRmc avoids chroma bleeding in moving scenes. See [http://forum.doom9.org/showpost.php?p=1665492&postcount=27 post on doom9.org].
| [[YV12]]
| [[ASTDR|Script]]
| AmjadSONY
|}

=== Stabilization ===

{{FilterTable}}
| [[CelStabilize]]
| Script which holds a fixed background steady. Doesn't work well with pans or fades.
| [[YV12]]
| [http://avisynth.nl/index.php/CelStabilize Script]
| mg262
|-
| [[DePan]]
| Tools for estimation and compensation of global motion (pan).
| [[YUY2]], [[YV12]]
| [[DePan|Plugin]]
| {{Author/Fizick}}
|-
|[[Depansafe]]
|Another DePan stabilization script.
|[[YV12]]
|[[DepanSafe|Script]]
|[http://pastebin.com/u/tophf tophf]
|-
| [[Deshaker3D]]
| Experimental 3D image stabilizer (VDub [http://www.guthspot.se/video/deshaker.htm Deshaker] required).
| [[RGB32]]
| [[Deshaker3D|Plugin]]
| {{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=172136 SpatialAlign]
|Fix spatial alignment between two clips containing similar scenes.
|Any?
|[http://forum.doom9.org/showthread.php?t=172136 Script]
|StainlessS
|-
|[https://github.com/arnean/PerfPan PerfPan]
|PerfPan is an AviSynth plugin to stabilize scanned film using perforation as a reference.
|All colorspaces
|[https://github.com/arnean/PerfPan/tree/master/windows Plugin]
|[https://github.com/arnean arnean]
|-
| [[Stab]]
| Simple but powerful script to remove small high frequency jitter that appears often on old/bad transfers.
| [[YV12]]
| [[Stab|Script]]
| g-force
|-
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Stabilization Tools Pack]
| A set of tools to work with common stabilization issues, mainly from telecine process.
|[[YV12]]
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Script]
|{{Author/Dogway}}
|-
|[https://forum.doom9.org/showthread.php?t=182532 Stab_Light]
|Another stabilization script; based on Stab3.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://web.archive.org/web/20151223052321/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)
| [[YV12]]
| [http://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|}

== Denoisers ==
Strength/Quality of Denoisers

(need subclassification)

{{FilterTable}}
| [[AdaptiveMedian]]
| This is an adaptive Median Filter for eliminating certain types of noise. It uses local statistics (minimum, maximum and median values) of a moving local grid, and changes grid size depending on local statistics.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AdaptiveMedian|Plugin]]
|{{Author/vcmohan}}
|-
|[[Deathray]]
|OpenCL GPU accelerated spatial/temporal non-local means de-noising.
|[[YV12]]
|[[Deathray|Plugin]]
|[http://github.com/JawedAshraf Jawed]
|-
| [[DeNoise]]
| This is an adaptive local noise reduction filter. It uses global variance of the noise, local mean and local variance in a moving grid of specified size. It tries to preserve edges as closely as possible. The global variance value can be specified or it can be computed from a window. The global variance can have one value for the entire clip or can vary frame to frame linearly or computed from a window with its coordinates linearly moving with frame numbers.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DeNoise|Plugin]]
| {{Author/vcmohan}}
|-
| [http://web.archive.org/web/20071105084352/http://www.geocities.com/fredthompson6/Kiraru2002/Kiraru2002sROOM.htm#dnr2 DNR2]
| Dynamic Noise Reduction 2 is based on the VirtualDub [http://www.shdon.com/vid/dnr DNR] filter by Steve Don and Avery Lee.
| [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/dnr2_5F25_dll_20021225.zip Plugin]
| {{Author/kiraru2002}}
|-
| [[DeSaltPepper]]
| Remove white and black noise.
| Any
| [[DeSaltPepper|Plugin]]
| {{Author/vcmohan}}
|-
| [[FFTQuiver]]
| Remove periodic noise. Useful for analog interference.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[FFTQuiver|Plugin]]
| {{Author/vcmohan}}
|-
| [[TNLMeans]]
| TNLMeans is an implementation of the NL-means denoising algorithm.
*[http://forum.doom9.org/showthread.php?t=171817 TfNLMeans] - an AviSynth 2.6 fork of TNLMeans 1.0.3
| [[YV12]], [[YUY2]]
| [[TNLMeans|Plugin]]
| {{Author/tritical}}
|-
| [[KNLMeansCL]]
| KNLMeans is an optimized OpenCL implementation of the Non-local means denoising algorithm.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[KNLMeansCL|Plugin]]
| [http://github.com/Khanattila Khanattila]
|-
|[http://forum.doom9.org/showthread.php?t=172966 xNLMeans]
|xNLMeans is an AviSynth plugin implementation of the Non Local Means denoising proposition. This implementation provides several optimizations and extensions over the original proposition and other implementations.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/4stpv24pvpfclzm/xNLMeans_0.03_20160324.zip Plugin] 
|martin53
|}

=== 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 [{{N2Moved}}/2dcleaner.html 2D Cleaner.]
| [[YV12]], [[YUY2]]
| [[_2DCleanYUY2|Plugin]]
| {{Author/kiraru2002}}, {{Author/xeon533}}
|-
| [[DctFilter]]
| An experimental filter that operates on DCT coefficients.
| [[YV12]], [[YUY2]]
| [[DctFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[frfun7]]
| Fractal denoising. See [http://forum.doom9.org/showthread.php?t=110200 discussion]
| [[YV12]]
| [[Frfun7|Plugin]]
| prunedtree
|-
| [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
|-
|Kuwahara
|This filter is an edge preserving spatial noise reduction filter. It applies spatial smoothing while preserving the edges. See [http://forum.doom9.org/showthread.php?p=1689773 discussion]
|[[RGB24]], [[RGB32]]
|[http://www.wilbertdijkhof.com/Kuwahara_v11.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
|[[MiniDeen]]
|MiniDeen is a spatial denoising filter. It replaces every pixel with the average of its neighbourhood. This is a port of the "a2d" method from the AviSynth plugin [[Deen]], version beta 2.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[MiniDeen|Plugin]]
|{{Author/dubhater}} / MeteorRain
|-
|[[Neo_VagueDenoiser]]
|Wavelet based Denoiser. Refactored version of the original VagueDenoiser; includes optimizations, additional colorspaces, and high bit depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[Neo_VagueDenoiser|Plugin]]
| HolyWu, [https://github.com/msg7086 MeteorRain]
|-
|[[sbr]]
|sbr is helper function to make a highpass on a blur's difference.
|All YUV [[planar]] 8 to 16-bit colorspaces
|[[sbr|Plugin]]
|{{Author/Asd-g}}
|-
| [[SmoothUV2]]
| SmoothUV2 is a spatial derainbow filter. This filter performs structure-preserving smoothing (blurring) on the U/V (chrominance or colour) information of the image, leaving Y (luminance) intact.
| All YUV, YUVA [[planar]] 8 to 16-bit colorspaces
| [[SmoothUV2|Plugin]]
| {{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[SPresso]]
|A fast script to make SD content compress better while keeping the "original look".
|[[YV12]]
|[[SPresso|Script]]
|{{Author/Didée}}
|-
| [[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]]
| [[TBilateral|Plugin]]
| {{Author/tritical}}
|-
| [[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.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[VagueDenoiser|Plugin]]
| {{Author/Lefungus}}, {{Author/Kurosu}}, {{Author/Fizick}}
|-
|[[vsMSmooth]]
|vsMSmooth is a spatial smoother that doesn't touch edges.
||[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSmooth|Plugin]]
|{{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[vsTBilateral]]
|vsTBilateral is a spatial smoothing filter that uses the bilateral filtering algorithm.
|All [[planar]] 8 to 16-bit colorspaces
|[[vsTBilateral |Plugin]]
|{{Author/Asd-g}}
|}

=== Temporal Denoisers ===

{{FilterTable}}
| [[Cnr2]]
| A fast chroma denoiser. Very effective against stationary rainbows and huge analogic chroma activity. Useful to filter VHS/TV caps.
| [[YV12]], [[YUY2]]
| [[Cnr2|Plugin]]
| {{Author/Marc FD}}, {{Author/tritical}}
|-
| [[FluxSmooth]]
| Examines each pixel and compares it to the corresponding pixel in the previous and last frame.
| [[YV12]], [[YUY2]]
| [[FluxSmooth|Plugin]]
| {{Author/SansGrip}}, {{Author/Sh0dan}}
|-
| MDegrain
| Strong and effective temporal denoiser. Part of the [[MVTools]] package.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| [[TTempSmooth]]
| TTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TTempSmoothv094.zip Plugin]
| {{Author/tritical}}
|-
| [[Temporal Degrain]]
| SLOW but very effective at removing most grain from video sources.
| [[YV12]]
| [http://avisynth.nl/images/TemporalDegrain.avs Script]
| Didée, Sagekilla
|-
| [[TemporalDegrain2]]
| Temporal Degrain enhanced with parts of QTGMC, potentially slower but more effective at removing grain from video sources while retaining more details.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]] (8-16 bit)
| [[TemporalDegrain2|Script]]
| Didée, Sagekilla, Vit, real.finder, ErazorTT
|-
|[[vsCnr2]]
|vsCnr2 is a temporal denoiser designed to denoise only the chroma.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-16 bit)
|[[vsCnr2|Plugin]]
|{{Author/Asd-g}}
|-
|[[vsTTempSmooth]]
|vsTTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-32 bit)
|[[vsTTempSmooth|Plugin]]
|HolyWu, {{Author/Asd-g}}
|}

=== Spatio-Temporal Denoisers ===

{{FilterTable}}
|[[BM3DCUDA]]
|BM3D denoising filter for AviSynth+, implemented in CUDA.
|32-bit [[planar]] colorspaces
|[[BM3DCUDA|Plugin]]
|[https://github.com/WolframRhodium WolframRhodium]
|-
| [[Convolution3D]]
| Convolution3D is a spatio-temporal smoother, it applies a 3D convolution filter to all pixels of consecutive frames.
| [[YV12]]
| [[Convolution3D|Plugin]]
| {{Author/Vlad59}}
|-
| [[Deen]]
| Deen is a set of assembly-optimised denoisers, like various 3d and 2d convolutions.
| [[YV12]]
| [[Deen|Plugin]]
| {{Author/Marc FD}}
|-
| 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].
| [[YV12]]
| [https://web.archive.org/web/20160604213634/http://forum.doom9.org/showthread.php?t=162603 Script]
| rean
|-
| [[dfttest]]
| A 2D/3D frequency domain denoiser.
| [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[dfttest|Plugin]]
| {{Author/tritical}}
|-
| dfttestMC
| A script that motion compensates dfttest. See [http://forum.doom9.org/showthread.php?t=147676 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=147676 Script]
| thewebchat
|-
| [[DeGrainMedian]]
| Two stage Spatio-Temporal Limited Median filter for grain removal.
| [[YV12]], [[YUY2]]
| [[DeGrainMedian|Plugin]]
| {{Author/Fizick}}
|-
| [[FFT3DFilter]]
| A 3D Frequency Domain filter - gives strong denoising and moderate sharpening.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], any Y, YUV and Planar RGB 8-32 bit
| [[FFT3DFilter|Plugin]]
| {{Author/Fizick}}, martin53, {{Author/pinterf}}
|-
| [[FFT3DGPU]]
| Similar algorithm to FFT3DFilter, but uses graphics hardware for increased speed.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], Planar RGB 8 bit
| [[FFT3DGPU|Plugin]]
| {{Author/tsp}}, {{Author/pinterf}}
|-
| [[hqdn3d]]
| High Quality DeNoise 3D is an Avisynth 2.5 port of the MPlayer filter of the same name. It performs a 3-way low-pass filter, which can completely remove high-frequency noise while minimizing blending artifacts.
| 8-16bit planar YUV
| [[hqdn3d|Plugin]]
| {{Author/akupenguin}}
|-
|[https://forum.doom9.org/showthread.php?t=174804 mclean]
|Typical spatial filters work by removing large variations in the image on a small scale, reducing noise but also making the image less sharp or temporally stable. mClean removes noise whilst retaining as much detail as possible, as well as provide optional image enhancement.
|[[YV12]], [[HBD]]
|[https://forum.doom9.org/showthread.php?t=174804 Script]
|burfadel
|-
| [[MC_Spuds]]
| Motion compensated noise removal with sharpening. Extremely slow, but extremely effective.
| [[YV12]]
| [[MC_Spuds|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]]
| [[MCTemporalDenoise|Script]]
| {{Author/LaTo}}
|-
| RemoveDirtMC
| See [http://forum.doom9.org/showthread.php?p=1485300#post1485300 discussion].
| [[YV12]]
| [https://github.com/realfinder/AVS-Stuff/raw/master/avs%202.5%20and%20up/RemoveDirtMC_SE.avsi Script]
| Nephilis/A.SONY
|-
| [[RemoveGrainHD]]
| RemoveGrainHD is like RemoveGrain but intended for high definition content. It includes various spatial and temporal functions. See [http://web.archive.org/web/20130412014246/http://www.removegrainhd.de.tf/ documentation.]
| [[YV12]], [[YUY2]]
| [[RemoveGrainHD|Plugin]]
| {{Author/kassandro}}
|-
|-
| 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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=110078 Script]
| Heini011
|-
| [[RgTools]]
| Modern rewrite of <tt>[[RgTools/RemoveGrain|RemoveGrain]]</tt>, <tt>[[RgTools/Repair|Repair]]</tt>, <tt>[[RgTools/BackwardClense|BackwardClense]]</tt>, <tt>[[RgTools/Clense|Clense]]</tt>, <tt>[[RgTools/ForwardClense|ForwardClense]]</tt> and <tt>[[RgTools/VerticalCleaner| VerticalCleaner]]</tt> all in a single plugin.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RgTools|Plugin]]
| {{Author/tp7}}, {{Author/pinterf}}
|-
|[[SMDegrain]]
|SMDegrain is a convenience function for using MDegrain, including 16bit and interlaced support, with extra capabilities for light sharpening and spatial filtering.
| [[YUY2]], [[YV12]]
|[[SMDegrain|Script]]
|{{Author/Dogway}}
|-
|[[STPresso]]
|A fast script to make SD/720p content compress better without losing detail and original grain structure.
|[[YV12]]
|[[STPresso|Script]]
|{{Author/Didée}}
|-
|[[vsDeGrainMedian]]
|vsDeGrainMedian is a spatio-temporal limited median denoiser.
|All [[planar]] 8 to 16bit colorspaces
|[[vsDeGrainMedian|Plugin]]
|{{Author/Asd-g}}
|-
| 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 ==

=== Averaging/Layering/Masking ===

{{FilterTable}}
| [[Average]]
| A simple plugin that calculates weighted frame-by-frame average from multiple clips.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Average|Plugin]]
| {{Author/tp7}}, {{Author/mg262}}
|-
|[[AviSynthGimpLayer]]
|AviSynth Gimp-style Layer merge plugin.
|[[RGB24]], [[RGB32]]
|[[AviSynthGimpLayer|Plugin]]
| [http://sourceforge.net/u/panzerboy66/profile/ panzerboy66]
|-
|[[AVS_SoftLight]]
|AviSynth+ plugin. It makes a softlight blend with a negative of average. Only x64 version available and with CUDA support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AVS_SoftLight|Plugin]]
|Argaricolm
|-
| BlockAverage
| A simple filter that just averages the Y values of each 2x2 pixel block in a YV12 image – U and V values are left alone as they already common to each 2x2 block in a progressive YV12 image. Just made to see if it satisfies the requirements in [http://forum.doom9.org/showthread.php?s=&threadid=91580&perpage=10&pagenumber=1 this thread].
| [[YV12]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/blockaverage01.zip Plugin]
| {{Author/Simon Walters}}
|-
|CheckMask
|A YV12 spatial dot finding filter for AviSynth.
|[[YV12]]
|[http://www.avisynth.nl/users/warpenterprises/files/checkmask_5F25_dll_20050310.zip Plugin]
|[http://web.archive.org/web/20090618112048/http://kawaii-shoujo.net/AntiAliased/index.html Dan Donovan]
|-
|[[ClipBlend]]
|Filter to blend consecutive frames in a clip.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[ClipBlend|Plugin]]
|StainlessS
|-
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe.html ColorKeyFrame]
| Linear interpolation of color correction with key frames.
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe03.zip Plugin]
| {{Author/Fizick}}
|-
|[[ColorScreenMask]]
|ColorScreenMask is a special effects plugin for processing chroma key (i.e., a green screen or blue screen) backgrounds. It uses color thresholds rather than absolute values as the criteria for setting the alpha channel transparency.
|[[RGB32]]
|[[ColorScreenMask|Plugin]]
|Grandpa Oddball
|-
|[[ColourMask]]
|Creates colour masks.
|[[YV12]]
|[[ColourMask|Plugin]]
|{{Author/mg262}}
|-
|[[CombMask]]
|A filter to create and process comb masks. These filters were written from scratch, but most of logic comes from tritical's [[TIVTC]] plugin.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CombMask|Plugin]]
|{{Author/Chikuzen}}
|-
|[[Fusion]]
|Pyramidal image processing for video, it uses image pyramids to blend clips together (more commonly used in the creation of HDR images and image stitching).
|[[RGB32]]
|[[Fusion|Plugin]]
|{{Author/David Horman}}
|-
| [[GraMaMa]]
| Gradient Mask Maker: Creates a mask (either a gradient or black/white) given a prescribed shape (such as circle, ellipse, line, square or rectangle).
| [[YV12]]
| [[GraMaMa|Plugin]]
| {{author/E-Male}},
{{author/Wilbert Dijkhof}}
|-
|[http://umezawa.dyndns.info/archive/imck/imck-2.3.0-readme.html ImasMultiColorKeying]
|Chroma keying filter (Japanese)
|[[RGB32]]
|[http://umezawa.dyndns.info/archive/imck/ Plugin]
|Umezawa Takeshi
|-
|MaskCrop
|Non-clip plugin and function to speed up filtering with a mask.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.dropbox.com/s/8c4rxlwbs020ib1/MaskCrop0.1.2.7z?dl=1 Plugin] 
|
|-
|[http://forum.videohelp.com/threads/369143-ResizersPack-MasksPack-PlaygroundPack-SmoothContrast-Logo-mod-functions?s=7811fcf9c429ffb99f2e0a4b8043832d&p=2364052&viewfull=1#post2364052 MasksPack]
|This is a set of functions related to masks, so localized filtering will be able, giving you finer control on how and where to filter or protect certain zones.
|[[YV12]]
|[http://www.mediafire.com/download/mch99c0z5957u9z/MasksPack2.3.zip Script]
|{{Author/Dogway}}
|-
|[[Median]]
|A filter plugin for AviSynth which generates a pixel-by-pixel median of several clips. This is particularly useful for filtering out noise and glitches from multiple VHS/SVHS/8mm/Hi8 tape captures, but can be used for other purposes also.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[Median|Plugin]]
|{{Author/ajk}}
|-
|[[MTCombMask]]
|This filter produces a mask showing areas that are combed, it uses 3-point sampling to determine combing in a pixel.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-32bit planar Y/YUV/YUVA
|[[MTCombMask|Plugin]]
|{{Author/Manao}}, [https://github.com/Asd-g Asd-g]
|-
|[[OverlayPlus]]
|Layering scrip similar to AviSynth's internal Overlay but includes more blending modes and some additional features.
|All 8-32bit colorspaces
|[[OverlayPlus|Script]]
|reel.deel
|-
| ParameterisedBlend
| ParameterisedBlend allows you to blend any number of frames within a clip, or blend any number of different clips together. You can use it as an extended, gamma-aware replacement for Merge().
| [[YV12]]
| [https://web.archive.org/web/20201020085042/https://sites.google.com/site/ourenthusiasmsasham/soft#TOC-ParameterisedBlendd Plugin]
| [https://web.archive.org/web/20201020085035/https://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
|[http://forum.doom9.org/showthread.php?t=172388 Polygon]
|The very raw beginning of a plugin for drawing high quality polygons (mainly to be used as masks) in AviSynth.
| [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=172388 Plugin]
| {{Author/David Horman}}
|-
|[[RedAverage]]
|Frame-by-frame averaging/merging of multiple clips. Includes a masked average, weighted average, and a merge filter.
|[[YV12]]
|[[RedAverage|Plugin]]
|redfordxx
|-
|[http://github.com/jojje/shapemask ShapeMask]
|A filter plugin for AviSynth that identifies bright areas such as projector screens at conferences and creates a mask out of them. The use case for which it was created is to deal with overly bright lectures, such as screen casts or talks where the speaker or producer hasn't followed presentation 101; Use light text on a dark background! See [http://forum.doom9.org/showthread.php?t=172308 discussion.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20150702103042/http://snarl.zapto.org/files/ShapeMask-1.0.zip Plugin]
|[http://github.com/jojje jojje]
|-
|[[TColorMask]]
|A simple color masking plugin for AviSynth.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8/16bit planar YUV
|[[TColorMask|Plugin]]
|{{Author/tp7}}
|-
|[[TCombMask]]
|TCombMask is a simple filter that creates a comb map that can (could) be used by other filters. It currently supports optional motion adaption, optional spatial adaption, optional luma <-> chroma linking, different thresholds for chroma and luma, and much more.
|[[YUY2]], [[YV12]]
|[[TCombMask|Plugin]]
|{{Author/tritical}}
|-
|[[TempLinearApproximate]]
|TempLinearApproximate takes several frames and for each pixel calculates linear approximation of its values through time, then returns its value in the middle (unless close to beginning or end of clip) of that line.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[TempLinearApproximate|Plugin]]
|Mystery Keeper
|-
|[[TMaskCleaner]]
|A really simple mask cleaning plugin for AviSynth based on mt_hysteresis.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[TMaskCleaner|Plugin]]
|{{Author/tp7}}
|-
| [[TMM]]
| TMM builds a motion-mask for TDeint, which TDeint uses via its 'emask' parameter.
| [[YUY2]], [[YV12]]
| [[TMM|Plugin]]
| {{Author/tritical}}
|-
| [[TMM2]]
| A rewrite of TMM
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[TMM2|Plugin]]
| {{Author/Chikuzen}}
|-
| [[Unpremultiply]]
| This plugin convert the input RGBA clip from premultiplied alpha to straight matted alpha.
| [[RGB32]]
| [[Unpremultiply|Plugin]]
| [http://web.archive.org/web/20160610124858/http://code.google.com/p/avisynth-unpremultiply/ Josh Sutinen]
|-
| [[uu_mt_blend]]
| ''Blend'' (''[[Overlay]], [[Layer]]'') two clips using [[MaskTools2|MaskTools]]. Wide selection of blend modes.
| [[YV12]],[[RGB24]],[[RGB32]]
| [[Media:UU_mt_blend.avs|Script]]
| rafriff42
|-
|[[Watermark2]]
|Creates a transparent deformation in the video akin to a watermark. The watermark is defined by a black and white image which may be a dynamic image. The intensity of the effect is controlled by several parameters.
|[[RGB32]]
|[[Watermark2|Plugin]]
|[http://sourceforge.net/u/phillvanleersum/profile/ DrPhill], {{Author/StainlessS}}
|-
| [[YRangeMask]]
| AviSynth script to create a mask by specifying the range of the brightness.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[YRangeMask|Script]]
| Chikuzen
|}

=== Blurring ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect BlurDetect]
|Determines blurriness of frames.
|All 8-16 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect/releases Plugin]
|{{Author/Asd-g}}
|-
|[https://www.animemusicvideos.org/forum/viewtopic.php?t=101724 BlurMod/ApplyOnAngle]
|BlurMod() shrinks, blurs, then resizes; resulting in a very strong blur. ApplyonAngle() rotates, filters, then rotates back; making any filter appear as if applied on an angle.
|[[YV12]]
|Script
|Phantasmagoriat
|-
| [[BucketMedian]]
| BucketMedian is an implementation of spatial median filter adapting bucket (counting) sort algorithm.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[BucketMedian|Plugin]]
| {{Author/Chikuzen}}
|-
| [[FastBlur]]
| Fast approximate Gaussian blurs.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FastBlur|Plugin]]
| {{Author/David Horman}}
|-
| [[GBlur]]
| Gaussian blur.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[GBlur|Plugin]]
| {{Author/vcmohan}}
|-
|[[MedianBlur]]
| A plugin with 5 different types of median blur filters.
| [[YV12]]
| [[MedianBlur|Plugin]]
| {{Author/tsp}}
|-
|[[MedianBlur2]]
| Implementation of [http://nomis80.org/ctmf.html constant time median filter] for AviSynth 2.6, similar to MedianBlur.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MedianBlur2|Plugin]]
| {{Author/tp7}}
|-
|[[neo_TMedian]]
|Temporal denoising filter that replaces every pixel with the median of its temporal neighbourhood.
|8-16 and 32-bit planar
|[[neo_TMedian|Plugin]]
|[https://github.com/msg7086 MeteorRain]
|-
| [[VariableBlur]]
| VariableBlur is a Gaussian, binomial or average blur filter with a variable radius (variance).
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]],
| [[VariableBlur|Plugin]]
| {{Author/tsp}}, {{Author/tritical}}
|-
| [[VariableMedian]]
| A simple median filter. See [http://forum.doom9.org/showthread.php?t=83985 discussion]
| [[RGB32]]
| [http://web.archive.org/web/20091027134543if_/http://www.geocities.com/siwalters_uk/variablemedian.zip Plugin]
| {{Author/Simon Walters}}
|}

=== Borders and Cropping ===

{{FilterTable}}
|[[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. See original [http://forum.doom9.org/showthread.php?t=37204 discussion] and updated AutoCrop [http://forum.doom9.org/showthread.php?t=87602 discussion]
| [[YUY2]], [[YV12]]
| [http://len0x.leffe.dnsalias.com/autocrop12.zip Plugin]
| [http://web.archive.org/web/20050404182221/http://www.videofringe.com/autocrop/ Glenn Bussell], len0x
|-
|[[BorderControl]]
| It's designed to allow you to manipulate the regions at the top, bottom and sides of a frame. Set a black border, set a border region to be faded out and you can "smear" the border to save having to crop and resize the whole frame for the sake of a few pixels. Each border (top,bottom.left and right) can be manipulated independently. See [http://forum.doom9.org/showthread.php?t=33479 discussion] and [http://avisynth.org.ru/docs/english/externalfilters/bordercontrol.htm documentation].
| [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20140709005736/http://www.geocities.com/siwalters_uk/bordercontrol14.zip Plugin]
|{{Author/Simon Walters}}
|-
|[https://github.com/slavanap/ssifSource CropDetect]
| Plugin to detect black bounding box in video and crop it easily. See [http://forum.doom9.org/showthread.php?p=1761842#post1761842 discussion]. Note, CropDetect small plugin merged within ssifSource project. Look for "CropDetect" function in Sub3D.dll
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|-
|CropEven
|Script to crop evenly based on the dimensions given. It will crop the extra pixels off the bottom and right sides if the target resolution is odd. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1739589#post1739589 Script]
|Desbreko
|-
|[[EdgeFixer]]
|EdgeFixer repairs bright and dark line artifacts near the border of an image.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[EdgeFixer]]
|[https://github.com/sekrit-twc sekrit-twc]
|-
|[[FillBorders]]
|This is a simple filter that fills the borders of a clip, without changing the clip's dimensions.
|All [[planar]] colorspaces
|[[FillBorders]]
|[http://github.com/dubhater dubhater] / Asd
|-
|Padding
|Duplicate edge pixels to the outside with [[PointResize]]. See [http://forum.doom9.org/showthread.php?t=165946 discussion.]
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showpost.php?p=1596804&postcount=5 Script]
|{{Author/Didée}}
|-
|PadFFT
|A simple plugin to add borders evenly on each side. See [https://forum.doom9.org/showthread.php?p=1769503#post1769503 discussion]
|[[Y8]], [[YV12]]
|[https://web.archive.org/web/20221113033752if_/https://files.videohelp.com/u/223002/PaddFFT_dll_v0.02_20160604.zip Plugin]
|StainlessS
|-
|PadToMod
|Script to pad to a specified mod. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1746579#post1746579 Script]
|Desbreko
|-
|[[RoboCrop]]
| RoboCrop is an automatic cropping solution to crop black borders from video clips, loosely based on (but using no code from) AutoCrop by Glenn Bussell. See [http://forum.doom9.org/showthread.php?t=168053 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
| [[RoboCrop|Plugin]]
| StainlessS
|}

=== Colourspace Conversion ===

{{FilterTable}}
|[https://forum.doom9.org/showthread.php?t=183453 ColorMatrixTransform]
|AviSynth+ plugin for applying a color matrix transform to 32 bit floating point clips.
|[[RGBPS]]
|[https://github.com/TomArrow/ColorMatrixTransform/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| 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
|-
|[https://forum.doom9.org/showthread.php?t=183990 LabConvert]
|AviSynth+ plugin to convert to LChab (derivative of LAB) color space and back for beautiful color manipulations.
|[[RGBPS]], [[YUV444PS]]
|[https://github.com/TomArrow/LabConvertAVS/releases/ Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| ManualColorMatrix
| Can perform any matrix-based color conversion. See [http://forum.doom9.org/showthread.php?t=161777 discussion.]
| [[RGB24]], [[RGB32]], [[YV24]]
| [http://forum.doom9.org/attachment.php?attachmentid=12346&d=1309522614 Plugin]
| xv
|-
|[[nnedi3_resize16]]
|An advanced script for high quality 16-bit image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
|[[PlanarTools]]
|This plugin is a set of filters that offers converting packed(interleaved) formats to planar formats and vice versa.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV16]]
|[[PlanarTools|Plugin]]
|{{Author/Chikuzen}}
|-
|[[YV12To422]]
|YV12 to YV16/YUY2 converter for AviSynth 2.6.
|[[YV12]]
|[[YV12To422|Plugin]]
|{{Author/Chikuzen}}
|}

=== Effects ===

{{FilterTable}}
| [[AddGrainC]]
| 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
| [[RGB24]], [[RGB32]], [[YUY2]],
[[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[AddGrainC|Plugin]]
|{{Author/Tom Barry}}, {{Author/Foxyshadis}}<br>
{{Author/LaTo}}, {{Author/cretindesalpes}}
|-
| AddStaticGrainM
| This function adds static grain in dark areas based on a mask.
| [[YV12]]
| [[AddStaticGrainM_source|Script]]
| [http://canihaziframe.wordpress.com/2011/02/23/addstaticgrainm/ Daiz]
|-
| [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://www.avisynth.nl/users/warpenterprises/files/blockbuster_5F25_src_20021229.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://www.avisynth.nl/users/warpenterprises/files/avishader_5F25_dll_20041228.zip Plugin]
| Antitorgo
|-
|[[AGM]]
|Uses an adaptive mask based on frame and pixels brightness to apply grain.
|All YUV [[planar]] colorspaces
|[[AGM|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=167217 Checker]
|Checkerboard combining filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://www.mediafire.com/?ewq8rc0aprzmk8r Plugin] /// [https://web.archive.org/web/20230206191644if_/https://files.videohelp.com/u/223002/checker.zip Archived]
|{{Author/Chikuzen}}
|-
|[https://forum.doom9.org/showthread.php?t=184052 ChickenDream]
|Realistic film-grain rendering for AviSynth+.
|[[Y32]], [[RGBPS]]
|[https://github.com/EleonoreMizo/chickendream/releases Plugin]
|{{Author/cretindesalpes}}
|-
| [[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]]
| [[ColorLooks|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
| [[crt_display]]
| CRT emulation with scanline and phosphor effects. crt_display emulates a CRT display using aperture grille (Trinitron) or Cromaclear technologies.
| [[RGB24]], [[RGB32]]
| [[crt_display|Script]]
|{{Author/cretindesalpes}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[EffectsMany|Plugin]]
| {{Author/vcmohan}}
|-
| [[EffectsPlus]]
| '''AviSynth+ only'''. Creates 26 types of special "animated" effects. Effects act on the input clip in the range of the frame numbers specified. The Audio is not affected.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]] colorspaces
| [[EffectsPlus|Plugin]]
| {{Author/vcmohan}}
|-
| [[f3kgrain]]
| Another 8/16-bit luma adaptive grain generator.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://web.archive.org/web/20131111114900/http://www.nmm-hd.org/upload/get~ElhZlazJbsQ/f3kgrain_v0.4.avsi Script]
| {{Author/06_taro}}
|-
| [[f3kgrainPlus]]
| Another 8/16-bit luma adaptive grain generator for AviSynth+.
| All 8-16 bit Y/YUV colorspaces, except YV411
| [[f3kgrainPlus|Script]]
| {{Author/06_taro}}
|-
|[[Fingerprint]]
|Video fingerprint filter.
|[[RGB32]]
|[[Fingerprint|Plugin]]
|{{Author/David Horman}}
|-
| [[GrainFactory3]]
| Noise generator that tries to simulate the behavior of silver grain on film. See [http://forum.doom9.org/showthread.php?t=141303 discussion.]
| [[YV12]]
| [[GrainFactory3|Script]]
| {{Author/Didée}}
|-
| [[GrainFactory3mod]]
| Luma adaptive grain generating filter in 8-bit precision. Based on Didée's [[GrainFactory3]] script.
| [[YV12]]
| [http://web.archive.org/web/20140722190952/http://www.nmm-hd.org/upload/get~kvNvGpuyxfc/GrainFactory3mod_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [[GrainFactoryLite]]
| Luma adaptive grain generating filter with stacked 16-bit input/output support. Based on Didée's [[GrainFactory3]] script, processing in 16-bit precision, and some commonly unused parameters removed.
| [[YV12]]
| [http://web.archive.org/web/20140722185917/http://www.nmm-hd.org/upload/get~FaqsQaMom9s/GrainFactoryLite_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [http://www.avisynth.nl/users/vcmohan/HollywoodSq/HollywoodSq.html HollywoodSQ]
| Creates popup album, akin to Hollywood squares TV show
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [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
|-
| [[Scanlines]]
| Add Scanlines (black horizontal bars) to a video. see [http://en.wikipedia.org/wiki/Scan_line wikipedia:Scan Line]
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/scanlines_5F25_dll_20031103.zip Plugin]
| turulo
|-
|[[ShufflessS]]
|Shuffle spacial columns or rows (1D), or blocks(2D) of frames, or temporal shuffle (frame order), all shuffles Inversable, ie undoable.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[HBD]] formats in AviSynth+
|[[ShufflessS|Plugin]]
|{{Author/StainlessS}}
|-
|[https://github.com/sorayuki/TawawaFilter TawawaFilter]
|An AviSynth plugin to make video in blue color.
|[[RGB24]]
|[https://github.com/sorayuki/TawawaFilter/releases/ Plugin]
|[https://github.com/sorayuki sorayuki]
|-
| [[TurnsTile]]
| Applies mosaic and/or palette effects to a clip.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[TurnsTile|Plugin]]
| {{Author/Robert Martens}}
|}

=== Field Order ===

{{FilterTable}}
| PFR
| Tries to restore the original progressive field order of a movie (or any predominantly filmed material transferred to video) where the field order changes at scene changes in a seemingly random fashion! See [http://forum.doom9.org/showthread.php?t=49815 discussion.]
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/pfravs.html Plugin]
| {{Author/Simon Walters}}
|-
| ReverseFieldDominance
| This filter is intended to reverse the field dominance of [[PAL]] DV video. See [http://forum.doom9.org/showthread.php?t=46765 discussion.]
| [[YUY2]], [[RGB24]], [[RGB32]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/reversefielddominance.html Plugin]
| {{Author/Simon Walters}}
|}

=== 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.
| Any
| Script
| actionman133
|-
| [[convert60ito24p]]
| convert60ito24p converts a 60fps interlaced NTSC Video into a 24fps progressive Video using different blending techniques.
| [[RGB32]], [[RGB24]], [[YUY2]]
| Script
| scharfis_brain
|-
|[[FixFPS]]
|Fix the frames to a more consistent pattern with the help of Matroska Version 2 Timecodes. Mostly useful for fixing weird framerate from using a third party program to capture (ex. .kkapture with Mupen). Generally used with the plugin ExactDedup. It should be noted that FixFPS would try it's best not to lose any frames from the source. It does this by pushing frames to the next available spot, if possible, but it can cause side effects. See [http://tasvideos.org/forum/viewtopic.php?t=18914 discussion].
|Any
|[https://www.mediafire.com/?7bip52hu7v1pps2 Plugin]
|Aktan
|-
| [http://github.com/arkeet/fpsdown/blob/master/README.md 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]]
| [http://github.com/arkeet/fpsdown/blob/master/README.md Plugin]
| [http://github.com/arkeet/ arkeet]
|-
| [[FrameRateConverter]]
| FrameRateConverter uses motion interpolation with fine artifact removal.
| [[YV24]], [[YV16]], [[YV12]], [[Y8]]
| [[FrameRateConverter|Plugin]]
| [https://github.com/mysteryx93 MysteryX]
|-
| [http://www.spirton.com/uploads/InterFrame/InterFrame2.html InterFrame]
| Frame rate conversion script. Interframe works very well at converting 24FPS to 60FPS; converts videos to higher frame rates like newer TVs do. Common names are frame doubling, smooth motion, among others. See [http://forum.doom9.org/showthread.php?t=160226 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1486831&postcount=1 Script]
|{{Author/SubJunk}}
|-
|[[JohnFPS]]
|Frame Rate Converter based on the example from the MVTools documentation with some modifications. This script is also known as "jm_fps".
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[JohnFPS|Script]]
|johnmeyer, StainlessS
|-
| NTSC tools
| Automatic [[NTSC]] to [[PAL]] conversion with 24p, 30p, 60i detection. See [http://forum.doom9.org/showthread.php?t=114054 discussion].
| [[YV12]]
| [http://avisynth.nl/images/NTSC_tools.avsi Script]
| Mug Funky
|-
|[[RIFE]]
|Real-Time Intermediate Flow Estimation for Video Frame Interpolation.
|[[RGBPS]]
|[[RIFE|Plugin]]
|{{Author/Asd-g}}
|-
| [[SickJumps]]
| Speed ramping, aka time-remapping (smooth speed changes). Processes both video and audio.
| [[RGB]], [[YUV]]
| [[SickJumps|Plugin]]
| {{Author/Robert Martens}}
|-
| [[SVPflow]]
| SVPflow provides fast and high quality GPU accelerated frame rate interpolation.
| [[YV12]]
| [[SVPflow|Plugin]]
| [http://www.svp-team.com/wiki/Credits SVP Team]
|-
| [http://github.com/gnaggnoyil/tc2cfr tc2cfr]
| This plugin that can read a timecode file and convert a given video clip in to one with a constant framerate by adding duplicate frames. Note: only supports Matroska V1 timecodes.
| [[YV12]]
| [http://github.com/gnaggnoyil/tc2cfr/releases Plugin]
| [http://github.com/gnaggnoyil gnaggnoyil]
|-
| [[TimecodeFPS]]
| Converts clip from VFR to CFR. Timing information from clip is discarded, and matroska v2 timecodes from the timecodes file are used instead.
| Any
| [[TimecodeFPS|C-Plugin]]
| natt
|-
| [[VFRtoCFR]]
| Converts a variable frame rate (VFR) video to a constant frame rate (CFR) video with the help of Matroska Version 2 Timecodes.
| [[YV12]]
| [[VFRtoCFR|Plugin]]
| Aktan
|-
| [[VfrToCfr]]
| This plugin converts variable frame rate clips to constant frame rate by introducing null frames.
| [[YV12]]
| [[VfrToCfr|Plugin]]
| joyje
|-
|[[YFRC]]
| Yushko Frame Rate Converter - doubles the frame rate with strong artifact detection and scene change detection.
|[[YV12]]
|[http://avisynth.nl/images/YFRC-01dd-10mm-2015yyyy.avsi Script]
| Oleg Yushko
|}

=== Frame Replacement/Range Processing ===

{{FilterTable}}
|[[ApplyEvery]]
|A collection of AviSynth functions that operate at regular intervals in a clip.
|
|[[ApplyEvery|Plugin]]
|{{Author/stickboy}}
|-
|[http://www.avisynth.nl/users/fizick/badframes/badframes.html BadFrames]
|Replaces given bad frames by neighbors or blend (interpolation). Useful for frames with very large defects.
|
|[http://www.avisynth.nl/users/fizick/badframes/badframes20.zip Plugin]
|{{Author/Fizick}}
|-
|[[ClipClop]]
|Clipclop is a simple plugin to replace ranges in a source clip with the same range, from a replacement clip. Supports up to 255 replacement clips, with unlimited number of replacements into output clip.
|
|[[ClipClop|Plugin]]
|StainlessS
|-
|[[FrameRepeat]]
|FrameRepeat() is a simple plugin to select frames to repeat. Requires AviSynth 2.6.
|
|[[FrameRepeat|Plugin]]
|StainlessS
|-
|[[FrameSel|FrameSel/FrameRep]]
|FrameSel() is a simple plugin to select individual frames from a clip. Can select frames numbers by direct arguments to filter, or in a string, or in a command file.
|
|[[FrameSel|Plugin]]
|StainlessS
|-
|[http://forum.doom9.org/showthread.php?t=164766 MatchFrames/LocateFrames]
|MatchFrames, intended for matched frames extraction,LocateFrames, intended to be usable by other scripts to identify matches.
|
|[http://www.mediafire.com/folder/hb26mthbjz7z6/StainlessS Script]
|StainlessS
|-
|[[Prune]]
|Prune is a simple plugin to trim() multiple source clips and splice the results into a new clip. Supports up to 256 source clips, with unlimited number of trims/splices into output clip. Prune can fade Audio (to reduce clicks between splices) for supported audio formats. The plugin will do [[AlignedSplice]] only.
|
|[[Prune|Plugin]]
|StainlessS
|-
|[[RemapFrames]]
|A collection of functions to rearrange frames between clips. Remaps the frame indices in a clip or from a second clip as specified by an input text file or by an input string. Efficient alternatives to long chains of <tt>FreezeFrame, DeleteFrame, or ApplyRange</tt>.
|
|[[RemapFrames|Plugin]]
|{{Author/stickboy}}, {{Author/cretindesalpes}}
|-
|[https://github.com/TomArrow/SelectRangeEveryReversing SelectRangeEveryReversing]
|Modified version of the internal [[SelectRangeEvery]] filter, except every second range is reversed in direction. See [https://forum.doom9.org/showthread.php?t=183239 discussion] for more information.
|
|[https://github.com/TomArrow/SelectRangeEveryReversing/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|}

=== Levels and Chroma ===

{{FilterTable}}
| [[AutoAdjust]]
| A high quality automatic adjustement filter. It calculates statistics of clip, averages them temporally to stabilize data and uses them to adjust luminance gain & color balance.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AutoAdjust|Plugin]]
| {{Author/LaTo}}
|-
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 AutoContrast]
|Auto contrast adjustment.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 Script]
|{{Author/StainlessS}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Autolevels|Plugin]]
| {{Author/frustum}} & Theodor Anschütz & StainlessS
|-
|[[AVSCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs].
|[[Avisynthplus_color_formats|RGBP16]]
|[[AVSCube|Plugin]]
|{{Author/Donald Graft}}
|-
| [https://forum.doom9.org/showthread.php?t=168062 AWB]
| Automatic white balance for real world footage, similar to the known function in digital cameras.
| [[YV12]]
| [https://forum.doom9.org/showthread.php?t=168062 Script]
| martin53
|-
|Brightness
|Restore dark and bright zones.
|8-16 planar Y/YUV
|[https://forum.doom9.org/showthread.php?t=182411 Script]
|Arx1meD
|-
| ChangeColour
| Simple plugin to replace one specified color to another, see [https://forum.doom9.org/showthread.php?t=88727 discussion] for additional information.
| [[RGB32]]
| [https://web.archive.org/web/20220322043620/https://files.videohelp.com/u/223002/changecolour01.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChanMix]]
| Creates a grayscale image from an RGB24 source, it has 3 parameters to specify how much of each color-channel is used.
| [[RGB24]]
| [[ChanMix|Plugin]]
| E-Male
|-
| [[ChannelMixer]]
| Very similar to the ChannelMixer function found in Photoshop. 9 Adjustments are possible, 3 for each color channel.
| [[RGB24]], [[RGB32]]
| [[ChannelMixer|Plugin]]
| Gustaf Ullberg
|-
| [https://forum.doom9.org/showthread.php?t=173364 ChromaJig]
| Automatic Colorization.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1775733#post1775733 Script]
| MWilson
|-
| [[ColorBalance]]
| Same tool that is found in Gimp & Cinepaint.
| [[RGB24]], [[RGB32]]
| [[ColorBalance|Plugin]]
| Gavino & mikeytown2
|-
|[[ColorLooks]]
| The plugin contains the following filters: Technicolor, Colorize, Sepia and Posterize.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[ColorLooks|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[ColorYUV2]]
|YUV color adjustment plugin with a graffer.
|[[YV12]]
|[[ColorYUV2|Plugin]]
|{{Author/StainlessS}}
|-
| [[ColourLike]]
| Makes a clip look like a 'reference' clip by adjusting each colour mask.
| [[RGB32]], [[YV12]]
| [[ColourLike|Plugin]]
| {{Author/mg262}}
|-
| [[ColourWarp]]
| Smooth remapping of UV colour values using control points for colour correction.
| [[YV12]], [[YV16]], [[YV24]]
| [[ColourWarp|Plugin]]
| {{Author/David Horman}}
|-
|[[DGCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs]. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|RGBP16]]
|[[DGCube|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGHDRtoSDR]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 to SDR. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGHDRtoSDR|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGPQtoHLG]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 PQ to HDR10 HLG. GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGPQtoHLG|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGTonemap]]
|[[AviSynth+]] plugin for basic Reinhard tonemapping for HDR->SDR.
|[[Avisynthplus_color_formats|RGBPS]]
|[[DGTonemap|Plugin]]
|{{Author/Donald Graft}}
|-
|[https://github.com/erazortt/DoViBaker DoViBaker]
|This plugin reads the Base Layer, Enhancement Layer and RPU data from a profile 7 DolbyVision stream to create a clip with the DolbyVision data baked in. Additionally it provides static and dynamic tonemapping of HDR PQ sources to lower dynamic range targets. Conversions from PQ to HLG and SDR (BT.2020 and BT.709) are also supported.
|[[Avisynthplus_color_formats|YUV420P10-16, YUV444P10-16]]
|[https://github.com/erazortt/DoViBaker/releases Plugin]
|[https://github.com/erazortt erazortt]
|-
| [[ExpLabo]]
| ExpLabo is a multi-filters plugin, focused on the non-linear transformation of image color space.
| [[RGB24]], [[RGB32]]
| [[ExpLabo|Plugin]]
| brabbudu
|-
|[https://web.archive.org/web/20180916224719/http://mpierce.pie2k.com/pages/211.php Exposure]
|Exposure function for AviSynth.
|[[RGB24]]
|[https://web.archive.org/web/20171023011558if_/http://mpierce.pie2k.com/downloads/exposure.zip Plugin]
|Matt Pierce
|-
| [[FlimsYlevels]]
| Luma adjustment function to give a more "film-ish" look. (Based on {{Author/Didée}}'s [[Ylevels]]).
| [[YV12]]
| Script
| FlimsyFeet
|-
|[[GamMac]]
|Useful to correct color cast on old 8mm films.
|[[RGB32]], [[RGB24]]
|[[GamMac|Plugin]]
|{{Author/StainlessS}}
|-
|[[GamMatch]]
|Gamma Matcher; useful to correct bad color clip where there is a better color source of perhaps lower rez available.
|[[RGB32]], [[RGB24]]
|[[GamMatch|Plugin]]
|{{Author/StainlessS}}
|-
| [[GiCocu]]
| Use GIMP/Photoshop curve files.
| [[RGB24]], [[RGB32]]
| [[GiCocu|Plugin]]
| E-Male
|-
|[https://github.com/magiblot/gradation Gradation]
|Gradation Curves filter for VirtualDub and AviSynth+
|[[RGB32]]
|[https://github.com/magiblot/gradation/releases Plugin]
|[https://github.com/magiblot magiblot]
|-
|[[GradationCurve]]
|[[AviSynth+]] plugin that loads Photoshop ACV and GIMP crv curve files. Also can compute the gradation curve through given anchor points. Like what Photoshop and Gimp do in the Curves setting.
|[[Avisynthplus_color_formats|PlanarRGB, PlanarYUV]]
|[[GradationCurve|Plugin+Script]]
|ErazorTT
|-
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Gray_Balance]
|A gray balance script, which is based on Black/White/Gray balance picker.
|[[RGB24]], [[YUY2]], [[YV12]]
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Script]
|Kisa_AG
|-
|[https://github.com/Asd-g/AviSynthPlus-grayworld grayworld]
|Port of [https://ffmpeg.org/ffmpeg-filters.html#grayworld FFmpeg's grayworld] filter to AviSynth+. See [https://forum.doom9.org/showthread.php?t=183750 discussion]
|[[RGBPS]], [[RGBAPS]]
|[https://github.com/Asd-g/AviSynthPlus-grayworld/releases Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[HDRAGC|Plugin]]
| {{Author/paviko}}
|-
|[[HDRTools]]
|HDR color conversion plugin for AviSynth+.
|[[RGB32]], [[RGB64]], Planar YUV/RGB (8-16 and 32bit)
|[[HDRTools|Plugin]]
|[https://github.com/jpsdr jpsdr]
|-
| [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
|-
| [[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]]
| [[HistogramAdjust|Plugin]]
| {{Author/vcmohan}}
|-
| [[Histograms in RGB & CMY]]
| Similar to Histogram("levels") but for RGB and CMY instead of YUV. It also includes a RGB parade color scope.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Histograms in RGB & CMY|Script]]
| -Vit-
|-
|[https://github.com/magiblot/HSLTint HSLTint]
|An [[AviSynth+]] filter for creating monochromatic tints with user-defined hue and saturation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]] - all bit-depths
|[https://github.com/magiblot/HSLTint/blob/master/HSLTint.avsi Script]
|magiblot
|-
|[[HSVAdjust]]
|HSVAdjust/HSLAdjust/HSIAdjust let's you rotate hues, control the strength of color (saturation), or modify the brightness of a clip. The type of brightness depends on the filter. It's value for HSVAdjust, lightness for HSLAdjust or intensity for HSIAdjust.
|[[RGB24]], [[RGB32]]
|[[HSVAdjust|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[Hue]]
|This plugin is a port of Donald Graft's VirtualDub [http://rationalqm.us/hue.html Hue] filter.
|[[RGB24]], [[RGB32]]
|[[Hue|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[avslibplacebo#Tonemap|libplacebo_Tonemap]]
|Dynamic HDR tone mapping, includes peak and scene-change detection, chroma-preserving (luma-only) tone mapping, highlight desaturation, dynamic exposure control and a variety of industry-standard EETFs including BT.2390.
|16-bit planar RGB or YUV444P16
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=176091 LinearTransformation]
|This script performs Linear Transformations based on a matrix conversion. Matrices are made by Francesco Bucciantini (FranceBB).
|[[YV12]], [[YV16]], [[YV24]], [[RGB24]], [[RGB32]], [[RGB32]], [[RGB48]],[[RGBPS]]
|[https://github.com/FranceBB/LinearTransformation Linear Transformation]
|[https://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[MatchHistogram]]
| Tries to modify the histogram of the input clip to match that of a reference clip. Should be used for analysis only, not for production.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MatchHistogram|Plugin]]
| {{Author/LaTo}}
|-
| [[OutRange]]
| A simple function to scan the whole video and output a log file, in which out-of-tv-range frames are logged.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[OutRange|Script]]
| 06_taro
|-
|[[RGBAdapt]]
|Another RGB color correction plugin, it also also includes a graffer.
|[[RGB24]], [[RGB32]]
|[[RGBAdapt|Plugin]]
|{{Author/StainlessS}}
|-
|[[RgbAmplifier]]
|An AviSynth forensic plugin to amplify color shifts.
|[[RGB24]], [[RGB32]]
|[[RgbAmplifier|Plugin]]
|{{Author/StainlessS}}
|-
| [https://forum.doom9.org/showthread.php?t=181857 SafeColorLimiter]
| Automatic Clipping to get a broadcast safe output in Limited TV Range.
| [[Y8]], [[Y10]], [[Y12]], [[Y14]], [[Y16]], [[Y32]], [[YV12]], [[YV411]], [[YUY2]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/SafeColorLimiter Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[SelectiveColour]]
|AviSynth implementation of Photoshop's selective colour adjustment.
|[[RGB32]]
|[[SelectiveColour|Plugin]]
|{{Author/David Horman}}
|-
| [[SGradation]]
| SGradation is much like a gamma function, but '2nd order'.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| Script
| martin53
|-
|[[ShowChannels]]
|Simple plugin whose only function is to display the average Y,U and V values for a YUV frame or R,G, and B for an RGB frame. Also shows accumulated average for all frames visited so far.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[ShowChannels|Plugin]]
|{{Author/StainlessS}}
|-
| [[ShowOverRange]]
| Shows illegal "TV range" by painting pixels blue for anything less than 16 and red for anything greater than 235.
| [[YUY2]], [[YV12]]
| [[ShowOverRange|Plugin]]
| {{Author/SAPikachu}}
|-
| [[SmoothAdjust]]
| SmoothAdjust is a set of 5 plugins to make YUV adjustments. These 5 plugins have a smoothing & dithering algorithm to avoid banding issue. SmoothAdjust is [[SmoothLevels|SmoothLevels']] successor.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SmoothAdjust|Plugin]]
| {{Author/LaTo}}
|-
| [[Tint]]
| Tints the image toward a specified colour.
| [[YUY2]], [[YV12]]
| Script
| actionman133
|-
| [[TweakColor]]
| Target specific hue and saturation ranges for hue and saturation adjustments.
| [[YV12]], [[YUY2]]
| [[TweakColor|Plugin]]
| {{Author/Trevlac}}
|-
| [[VideoScope]]
| Similar to Histogram("classic") but with additional features, it shows waveform monitors and a vectorscope.
| [[YUY2]]
| [[VideoScope|Plugin]]
| {{Author/Randy French}}
|-
| [http://forum.doom9.org/showthread.php?p=1832763#post1832763 VideoTek]
| VideoTek is a Tektronix-like waveform monitor for AviSynth.
| [[YV12]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/VideoTek/blob/master/VideoTek.avsi Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
| [[WhiteBalance]]
| Correct the white balance of a clip with a large degree of control and accuracy over other methods of correcting white balance.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[WhiteBalance|Plugin]]
| SomeJoe
|-
| [[Ylevels]]
| A simple replacement for Avisynth's internal [[Levels]] command, with a few neat differences.
| [[YV12]]
| Script
| {{Author/Didée}}
|}

=== Line Darkening ===

{{FilterTable}}
| 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]]
| [http://forum.doom9.org/showthread.php?p=1060081#post1060081 Script]
| Vectrangle / {{Author/Didée}}
|-
|[[Hysteria]]
|Hysteria, a line darkening script by Scintilla.
|[[YV12]]
|[http://pastebin.com/raw/fvDdiV6m Script]
|Scintilla
|-
|[http://forum.doom9.org/showpost.php?p=993939&postcount=2 LineDarkenToon]
| LineDarkenToon use the idea of mf_toon (0.5) for linedarken. I wanted a really small fast code like FastLineDarken but with similar output like mf_toon and this is the result.
|[[YV12]]
| [http://forum.doom9.org/showpost.php?p=993939&postcount=2 Script]
| MOmonster
|-
| [[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}}
|-
|[[proToon]]
|Line darkening script, used to be known as vmToon and before that mfToon.
|[[YV12]]
|[http://pastebin.com/raw/Aw9En26L Script]
|TheProfileth
|-
| [[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 line darkener.
| [[YV12]]
| [http://dl.dropbox.com/s/guk5plphkthdy2f/Toon-v1.1.7z Plugin]
| {{Author/mf}}
|-
| [[ToonLite]]
| It's the same as [[Toon]], just without the warpsharp processing..
| [[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}}
|[https://forum.doom9.org/showthread.php?t=181665 AiUpscale]
|An AviSynth+ implementation of some Super-Resolution Convolutional Neural Networks.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://github.com/Alexkral/AviSynthAiUpscale Script]
|[https://github.com/Alexkral Alexkral]
|-
|[[Anime4KCPP]]
|Anime4K is a simple high-quality anime upscale algorithm with GPU acceleration support. [[AviSynth+]] x64 only.
|[[RGB24]], [[YV24]], [[YV16]], [[YV12]]
|[[Anime4KCPP|Plugin]]
|TianZerL
|-
| [[avsresize]]
| [http://github.com/sekrit-twc/zimg z.lib] resizers for [[AviSynth+]]. avsresize provides resizing, colorspace and bit depth conversation.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
| [[avsresize|Plugin]]
| [http://github.com/sekrit-twc sekrit-twc]
|-
| [[AreaResize]]
| An area-average resizer plugin; only use to downscale.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AreaResize|Plugin]]
| {{Author/Chikuzen}}, Aktanusa
|-
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Desample]
|Desampling functions for AviSynth+, replaces DebilinearM and lineart_rpow2. Also includes DeCrossConversionMT which is a replacement for ccc, ccc_720.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Script]
|[https://github.com/kgrabs kgrabs]
|-
|[[Descale]]
|AviSynth+ filter to undo upscaling.
|All planar Y/YUV/RGB color formats
|[[Descale|Plugin]]
|[https://github.com/Frechdachs Frechdachs]
|-
|[[DPID]]
|DPID is an algorithm that preserves visually important details in downscaled images and is especially suited for large downscaling factors.
|All [[planar]] colorspaces
|[[DPID|Plugin]]
|{{Author/Asd-g}}
|-
|[http://forum.doom9.org/showthread.php?p=1738351#post1738351 edi_rpow2]
|An improved rpow2 function for nnedi3, nnedi3ocl, eedi3, and eedi2. Requires [http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi ResizeX]
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/view/pcmkxaauku375xd/edi_rpow2_v1.0.avsi Script]
|Desbreko
|-
|[[FCBI]]
|Fast Curvature Based Interpolation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar clips
|[[FCBI|Plugin]]
|{{Author/Chikuzen}}
|-
| [[fmtconv]]
| fmtconv is a format-conversion plug-in, it provides resizing, colorspace and bitdepth conversation.
| All [[planar]] 8 to 32-bit colorspaces
| [[fmtconv|Plugin]]
| {{Author/cretindesalpes}}
|-
| [[JincResize]]
| Jinc (EWA Lanczos) Resampler Plugin for AviSynth/AviSynth+.
| All 8-32bit [[planar]] colorspaces
| [[JincResize|Plugin]]
| innocenat
|-
|[[avslibplacebo#Resample|libplacebo_Resample]]
|High-quality, optimized upscaling and downscaling including support for polar filters ("Jinc"), anti-aliasing, anti-ringing and gamma correct scaling
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[[nnedi3/nnedi3_rpow2|nnedi3_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3_rpow2 is a function included in [[nnedi3]].
|[[RGB24]], [[YUY2]], [[YV12]]
|[[nnedi3|Plugin]]
|{{Author/tritical}}
|-
|[[nnedi3ocl/nnedi3x_rpow2|nnedi3x_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3x_rpow2 is a script function included in [[nnedi3ocl]].
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[nnedi3ocl|Script and Plugin]]
|SeT
|-
|[[nnedi3_resize16]]
|An advanced script for high quality image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
| [[PointSize]]
| A set of [http://en.wikipedia.org/wiki/Image_scaling pixel art resizers]; Includes Scale2x/3x, LQ2x/3x/4x, HQ2x/3x/4x, xBRZ (2x to 6x).
| [[RGB32]]
| [[PointSize|Plugin]]
| `Orum
|-
| [[ResampleHQ]]
| ResampleHQ provides gamma-aware resizing and colorspace conversion.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[ResampleHQ|Plugin]]
| Cory Nelson
|-
|[[ResampleMT]]
|Internaly multi-threaded resampling functions, also includes desampling functions (DeBilinear, DeBicubic,...).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[[ResampleMT|Plugin]]
|[http://github.com/jpsdr jpsdr]
|-
|[[Resize8]]
|<tt>Resize8()</tt> works just like AviSynth's internal resizers but with some extra features. It had correct chroma placement, optional adaptive anti-ringing algorithm and few other features.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://web.archive.org/web/20150911013350/http://www.nmm-hd.org/upload/get~8y1IjaaqvoI/Resize8_v1.2.avsi Script]
|mawen1250
|-
|ResizeX
|ResizeX is a wrapper function for AviSynth's internal resizers and Dither_resize16 that corrects for the chroma shift caused by the internal resizers when they're used on horizontally subsampled chroma with MPEG2 placement.
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi Script]
|Desbreko
|-
| [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}}
|-
|SincResize
|SincResize is an experimental plugin that uses DCT to perform resizing. See [http://forum.doom9.org/showthread.php?p=953002#post953002 discussion], read on for more information.
|[[YV12]]
|[http://cafxx.strayorange.com/files/SincResize4.7z Plugin]
|[http://cafxx.strayorange.com/ CAFxX]
|-
| [[SimpleResize]]
| Resizing plugin with 4 filters: SimpleResize, WarpResize, InterlacedResize and InterlacedWarpedResize.
| [[YV12]], [[YUY2]]
| [[SimpleResize|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}}
|-
|[http://forum.doom9.org/showthread.php?t=175945 Unwiden/Widen]
|Resize filters to unwiden/widen, see discussion.
|[[RGB32]], [[YV24]]
|[http://forum.doom9.org/showthread.php?t=175945 Plugin]
|{{Author/David Horman}}
|-
|[[w2xncnnvk]]
|[https://en.wikipedia.org/wiki/Waifu2x waifu2x] implemented in Vulkan.
|[[RGBPS]]
|[[w2xncnnvk|Plugin]]
|{{Author/Asd-g}}
|-
|[http://github.com/sunnyone/Waifu2xAvisynth waifu2x]
|Single-Image Super-Resolution for anime/fan-art using Deep Convolutional Neural Networks.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://github.com/sunnyone/Waifu2xAvisynth/releases Plugin]
|[http://github.com/sunnyone sunnyone]
|-
| [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
| mikeytown2
|}

=== Sharpeners ===

{{FilterTable}}
| [[aSharp]]
| Simple unsharp mask filter with optional adaptive sharpening.
| [[YV12]]
| [[aSharp|Plugin]]
| {{Author/Marc FD}}
|-
|[[AVSShock]]
|This Shock Filter sharpens edges of images by applying erosions or dilations depending on the sign of the Laplacian (or the so called Haralick-Canny edge detector).
|[[YUY2]], [[YV12]]
|[[AVSShock|C-Plugin]]
|AMSS0815
|-
| [[aWarpSharp2]]
| A modern rewrite of aWarpSharp with several bugfixes and optimizations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV formats, 8 to 16-bit
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
| [[blah]]
| Sharpening. See [http://forum.doom9.org/showthread.php?t=155030 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1406843 Script]
| *.mp4 guy
|-
|[[CAS]]
|Contrast Adaptive Sharpening.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV(A), RGB(A) formats, 8 to 32-bit
|[[CAS|Plugin]]
|Asd-g
|-
| [[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}}
|-
| [[LimitedSharpen]]
| LimitedSharpen can be used like a traditional sharpener, but producing much less artifacts. 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.
| [[YV12]]
| [http://avisynth.nl/images/LimitedSharpenFaster.avsi 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}}
|-
|[http://forum.doom9.org/showthread.php?t=173515 MCLS_16]
|Motion Compensate Limited Sharpen 16bit
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=173515 Script]
|Motenai Yoda
|-
|[http://forum.doom9.org/showthread.php?t=153201 MedSharp]
|Soft thresholded median sharpening function. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=153201 Script]
|*.mp4 guy
|-
| [[MSharpen]]
| <tt>MSharpen</tt> is a very simple masked sharpening plugin for AviSynth. This version is a reimplementation of neuron2's old <tt>MSharpen</tt> plugin.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MSharpen|Plugin]]
| {{Author/tp7}}
|-
| [[NonlinUSM]]
| Non-linear Unsharp Masking.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1555234&postcount=46 Script]
| {{Author/Didée}}
|-
| [[pSharpen]]
| Performs two-point sharpening to avoid overshoot. See [http://forum.doom9.org/showthread.php?t=172422 discussion].
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=172422#post1732663 Script]
| ilpippo80, colours
|-
|[[ReCon]]
|'''ReCon'''volution - makes things sharp by mixing pixels together. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1409582#post1409582 Script]
|*.mp4 guy
|-
| [[SeeSaw]]
| SeeSaw uses a balance of denoising and sharpening to enhance a clip. The aim is to enhance weak detail without over-sharpening or creating jaggies on strong detail, and produce a result that is temporally stable without detail shimmering.
| [[YV12]]
| [http://avisynth.nl/images/SeeSaw.avs Script]
| {{Author/Didée}}
|-
| SharpenComplex2
| Port of MPC-HC's Sharpen Complex 2 to AviSynth. Despite the name, this script is very simple, see [http://forum.doom9.org/showthread.php?t=158385 discussion.]
| [[YV12]]
| [[SharpenComplex2_source|Script]]
|
|-
| SSXSharpen
| Included in SharpTools. Sharpens the picture using [[supersampling]] techniques.
| [[YV12]]
| [http://web.archive.org/web/20100120201434/http://mf.creations.nl/avs/functions/SharpTools-v0.3.avs Script]
| {{Author/mf}}, {{Author/Didée}}
|-
| [[SSSharp]]
| Also known as Super Slow Sharpen - a very slow, but high quality sharpener. See [http://forum.doom9.org/showthread.php?t=132330 discussion]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1071731 Script]
| *.mp4 guy
|-
| [[TUnsharp]]
| TUnsharp is a basic sharpening filter that uses a couple different variations of unsharp masking and allows for controlled sharpening based on edge magnitude and min/max neighborhood value clipping.
| [[YUY2]], [[YV12]]
| [[TUnsharp|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.
| [[YUY2]], [[YV12]]
| [[UnFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[UnsharpHQ]]
| A strong and fast unsharp mask with some new features.
| [[YV12]]
| [[UnsharpHQ|Plugin]]
| list
|-
|[[vsMSharpen]]
|vsMSharpen is a sharpener that tries to sharpen only edges. This plugin is a port of the VapourSynth plugin MSharpen.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSharpen|Plugin]]
|Dubhater, Asd-g
|-
| [[WarpSharp]]
| WarpSharp contains these sharpeners: <tt>UnsharpMask, WarpSharp, Xsharpen</tt>.
| [[YUY2]], [[YV12]]
| [[WarpSharp|Plugin]]
|???, {{Author/seraphy}}
|}

=== Rotation/Shear/Skew/Perspective ===

{{FilterTable}}
| [[DeBarrel]]
| Remove barrel and pincushion distortion, where straight lines appear curved.
| [[RGB24]], [[RGB32]], [[Y8]]
| [[DeBarrel|Plugin]]
| {{Author/vcmohan}}
|-
|[[Defish]]
|Barrel and pincushion distortion correction filter.
|[[RGB32]]
|[[Defish|Plugin]]
|{{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=171922 Defish Different Projections]
|Defish with different map projections, like Lambert Cylindrical Equal Area, Mercator and Miller projections.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=171922 Script]
|Kisa_AG
|-
| [[FTurn]]
| Fast implementation of [[TurnLeft]](), [[TurnRight]]() and [[Turn180]]() AviSynth functions.
| [[Y8]], [[YV12]],[[YV24]]
| [[FTurn|Plugin]]
| {{Author/tp7}}
|-
|[http://forum.doom9.org/showthread.php?t=165978 Quad]
|An Avisynth plugin to perform quadrilateral transformations. Quad is now superseded by [[warp]].
|[[RGB32]]
|[http://horman.net/quad.zip Plugin] -- [http://forum.doom9.org/showpost.php?p=1602709&postcount=22 no SSE]
|{{Author/David Horman}}
|-
| [[Reform]]
| Skewed images are corrected or vice versa, useful if video is recorded with slightly incorrectly located camera. Sometimes referred to as perspective correction.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Reform|Plugin]]
| {{Author/vcmohan}}
|-
| [[Reformer]]
| Perspective correction and warping.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Reformer|Plugin]]
| {{Author/vcmohan}}
|-
| [[Rotate]]
| Rotate or shear on any given angle.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Rotate|Plugin]]
| {{Author/Fizick}}
|-
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner.html Spinner]
| Spinner plugin rotates a frame or selected part of it about the given axis coordinates in floating point precision.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[[warp]]
|A collection of geometry correction filters (also includes new version of Quad).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[warp|Plugin]]
|{{Author/David Horman}}
|-
|[[xyremap]]
|xyremap is a filter for remapping pixels using formulae written in [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation].
|[[RGB32]]
|[[xyremap|Plugin]]
|{{Author/David Horman}}
|-
| [[Zoom]]
| Zoom, Pan & Rotate Clip. Adds alpha layer to clip.
| [[RGB32]]
| [[Zoom|Plugin]]
| {{Author/WarpEnterprises}}
|}

=== Subtitling ===

{{FilterTable}}
| [[AssRender]]
| Libass-based subtitle renderer.
| [[RGB32]], [[RGB24]], [[YV24]], [[YV12]], [[Y8]]
| [[AssRender|C-Plugin]]
| lachs0r, TheFluff
|-
|[https://forum.doom9.org/showthread.php?t=183148 DetSub]
|Can be used to remove hardcoded subtitles with halo from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=183148 Script]
|{{Author/StainlessS}}
|-
|[[FreeSub]]
|Subtitle with bdf fonts.
|[[RGB24]], [[RGB32]], [[YV24]]
|[[FreeSub|C-Plugin]]
|Natt
|-
|[[FreeSubPlus]]
|Script that adds support for additional colorspaces to the FreeSub plugin.
|All colorspaces
|[[FreeSubPlus|Script]]
|reel.deel
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|Can be used to remove hardcoded subtitles from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
|[https://github.com/slavanap/ssifSource sub3d]
|Plugin for rendering subtitles on 3D video with correct depth.
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/tree/master/Sub3D Sources] [https://github.com/slavanap/ssifSource/releases Binaries][http://forum.doom9.org/showthread.php?t=173143 Discussion]
|slavanap
|-
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile SubImageFile]
|AviSynth+ plugin that renders image-based subtitles such as VOBSUB and PGS.
|[[RGB24]], [[Y8]]
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile/releases/ Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[SubtitleEx|Plugin]]
|[http://web.archive.org/web/20070821222318/http://mvideo.ddpp.net/eng/index.htm basilik]
|-
|[http://forum.doom9.org/showthread.php?t=119390 SUPtext]
|Overlays SUP-subtitles on a video clip.
|[[RGB32]], [[YV12]]
|[http://forum.doom9.org/attachment.php?attachmentid=7846&d=1196858433 Plugin]
|emmel
|-
| [[SupTitle]]
| Blu-ray PGS .SUP Subtitle Renderer Plugin for AviSynth. See [http://forum.doom9.org/showthread.php?t=148167 discussion]
| [[YV12]]
| [[SupTitle|Plugin]]
| {{Author/ZachSaw}}
|-
|[[tcasFilter]]
|Renders TCAS subtitle effects.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[tcasFilter|Plugin]]
|milkyjing
|-
| [http://avisynth.org.ru/docs/english/externalfilters/vsfilter.htm 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]
|
|-
| [[VSFilterMod]]
| VSFilterMod is modification of original VSFilter subtitle renderer by Gabest. This mod brings up new features and some minor bugfixes.
|[[RGB24]], [[RGB32]], [[YV12]]
| [[VSFilterMod|Plugin]]
|
|-
|[[xy-VSFilter]]
|High performance VSFilter compatible subtitle filters.
|[[RGB24]], [[RGB32]], [[YV12]]
|[[xy-VSFilter|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}}
|-
| [[TransAll]]
| Around 150 distinct transitions can be created with this plugin.
| [[RGB]], [[YUY2]], [[YV12]]
| [[TransAll|Plugin]]
| {{Author/vcmohan}}
|-
| [[Transition_AlbertGasset|Transition (Albert Gasset)]]
| Various wipe and random block modes. Has 19 built in patterns or it can use an external file.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_AlbertGasset|C-Plugin]]
| {{Author/Albert Gasset}}
|-
| [[Transition_Shubin|Transition (Shubin)]]
| Contains 2 transition modes: circle and line.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_Shubin|Plugin]]
| {{Author/shubin}}
|}

== Other Filters ==

=== Debugging/Diagnostic Filters ===

{{FilterTable}}
| AVInfo
| AVIInfo gives information about the streams in the clip without loading any frames. filename can be a WAV file or an AVI file with several audio streams (it won't open AVI files with embedded subtitles though). It will return the info as a string.
|
| [http://www.avisynth.nl/users/warpenterprises/files/avinfo_5F25_dll_20050417.zip Plugin]
| trevlac, wilbert
|-
| [http://forum.doom9.org/showthread.php?t=174797 AVSMeter]
| AVSMeter is a CLI (command line interface) tool which measures the speed/efficiency of Avisynth scripts and checks if Avisynth and its plugin sub-system are set up and working correctly. Documentation for usage and features is included in the distribution package.
|
| Command line executable
| Groucho2004
|-
| [http://forum.doom9.org/showthread.php?t=176079 Avisynth Info Tool]
| This program performs a thorough test of your Avisynth installation and associated plugins, checking if external dependencies are installed, etc.
|
| Windows application with graphical user interface
| Groucho2004
|-
|[http://forum.doom9.org/showthread.php?t=173259 avsr]
|CLI (command line interface) tool which simply executes an Avisynth script. This is useful when, for example, you want to write an image sequence to the disk by using "ImageWriter".
|
| Command line executable
| Groucho2004
|-
|[[Butteraugli]]
|Butteraugli is an estimating filter for the psychovisual similarity of two images.
|8-32bit planar RGB/RGBA
|[[Butteraugli|Plugin]]
|{{Author/Asd-g}}
|-
|[[ColorDiff]]
|ColorDiff makes a greyscale (Y8) frame according to the input frame's pixels' "distance" from a specified color. The diff is calculated by simply getting the diff of the individual color components from the desired color's components and summing them up. Also, weights can be set for the individual diffs.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[ColorDiff|C-Plugin]]
|Ignus2
|-
|[https://forum.doom9.org/showthread.php?t=182817 DebugColourSpaces]
|Debugging filter which applies a specified filter to multiple Avisynth+ colourspaces and displays a labelled grid of the results.
|Any
|[http://horman.net/avisynth/download/DebugColourSpaces.zip Plugin]
|{{Author/David Horman}}
|-
| [[DumpPixelValues]]
| Samples the colors from selected pixels for every frame in a video source and outputs the data to a text or binary file. See [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.zip Plugin]
| [http://www.theneitherworld.com/mcpoodle/Tools/index.html McPoodle]
|-
|[[FFTSpectrum]]
|FFTSpectrum is a filter that displays the FFT frequency spectrum of a given clip.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[FFTSpectrum|Plugin]]
|{{Author/Asd-g}}
|-
|[[GrainEvaluate]]
| A script to analyze and log the strength of grain for each frame. See [http://forum.doom9.org/showthread.php?t=167455 discussion.]
| [[YV12]]
|[http://www.nmm-hd.org/upload/get~-eJfUjEXJY4/GrainEvaluate.avsi Script]
|{{Author/06_taro}}
|-
| [http://forum.doom9.org/showpost.php?p=1462931&postcount=81 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]
| jmac698
|-
| [[Grid]]
| Overlays a grid, useful for pixel counting.
| Any
| [http://www.avisynth.nl/users/vcmohan/Grid/Grid.zip Plugin]
| {{Author/vcmohan}}
|-
|[[Info2]]
| A faster, prettier alternative to info().
|Any
|[[Info2|Plugin]]
|{{Author/David Horman}}
|-
|[[KPassFilterCL]]
|KPassFilterCL is a set of tools in the frequency domain.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[KPassFilterCL|Plugin]]
|[http://github.com/Khanattila Khanattila ]
|-
|[[LinesLumaDiff]]
|AviSynth+ plugin to check if luma difference between lines are below or above given threshold and writes frame number in text file.
|[[Planar]] YUV
|[[LinesLumaDiff|Plugin]]
|{{Author/Asd-g}}
|-
|[[MaxCLLFind]]
| PQ HDR Analyzer plugin for [[AviSynth+]], analyzes MaxCLL and MaxFALL and writes it to a text file.
|[[RGB64]]
|[[MaxCLLFind|Plugin]]
|Tom Arrow
|-
| [http://web.archive.org/web/20160610124531/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
|[[Pixelscope]]
|This debugging filter displays individual pixel values.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=175688 Plugin]
|{{Author/David Horman}}
|-
|[https://github.com/EmiyaSyahriel/RollCompare RollCompare]
|AviSynth Plugin to create rolling comparison between videos.
|[[RGB24]], [[RGB32]]
|[https://github.com/EmiyaSyahriel/RollCompare/releases Plugin]
|EmiyaSyahriel
|-
|[http://github.com/lcferrum/segment-display-ocr SegmentDisplayOCR]
|SegmentDisplayOCR is a seven-segment display recognition filter for AviSynth. It has built in logging functionality (it will log frame recognition results) and also can be used in AviSynth conditional filters. The main purpose of this filter is to process readings of various digital instruments (e.g. digital multimeters) captured on video. So if your favourite instrument lacks interface for connecting it to PC you can capture it's readings on cam and convert them to computer readable format with SegmentDisplayOCR filter.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://sourceforge.net/projects/segmentdisplayocr/files/SegmentDisplayOCR/ Plugin]
|[http://github.com/lcferrum lcferrum]
|-
|[[SSIM]]
|A filter that compute an objective video quality metric between two videos. Based on SSIM work from [http://web.archive.org/web/20060515090025/http://www.cns.nyu.edu/~zwang/files/research/ssim/index.html Zhou Wang]. It has been created with the help of Mfa.
|[[YV12]]
|[[SSIM|Plugin]]
|[http://web.archive.org/web/20060507012947/http://perso.wanadoo.fr/reservoir/ Lefungus]
|-
| [[ShowPixelValues]]
| This filter displays the actual Y U and V (or R G and B) values from pixels within a frame. See [http://forum.doom9.org/showthread.php?t=64192 discussion] and [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/showpixelvalues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://web.archive.org/web/20091028122947/http://geocities.com/siwalters_uk/showpixelvalues1.4c.zip Plugin]
| {{Author/Simon Walters}}
|-
|[https://forum.doom9.org/showthread.php?t=176131 SysInfo]
|This plugin returns info about OS/CPU*/Memory/Screen/AviSynth.
|Any
|[https://forum.doom9.org/showthread.php?t=176131 Plugin]
|Groucho2004
|-
|[https://forum.doom9.org/showthread.php?t=168241 Timer]
|AviSynth script to add a highly customizable timer to your video.
|Any
|[https://forum.doom9.org/showthread.php?t=168241 Script]
|djcj
|-
| [http://web.archive.org/web/20151223052321/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
| [http://avisynth.org.ru/docs/english/externalfilters/tmonitor.htm TMonitor]
| TMonitor is a filter very similar to AVSMon. It enables monitoring of an Avisynth clip via previewing the video, viewing clip information (such as video width, height, colorspace, number of frames, audio samples, sample rate, number of audio channels, and more), and adjusting the audio delay. It also supports multiple instances per script, allowing viewing of differences between different parts of a processing chain.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TMonitorv094.zip Plugin]
|{{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?t=53238 ViewFields/UnViewFields]
| [http://web.archive.org/web/20140709004333/http://www.geocities.com/siwalters_uk/unviewfields.html UnViewFields], [http://web.archive.org/web/20140708181324/http://www.geocities.com/siwalters_uk/viewfields.html ViewFields]
|
| Plugin
| {{Author/Simon Walters}}
|-
|[[VMAF]]
|VMAF is a perceptual video quality assessment algorithm developed by Netflix.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]],<br> 8-10bit planar YUV
|[[VMAF|Plugin]]
|{{Author/Asd-g}}
|-
| [[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
|
|}

=== Edge Detection ===

{{FilterTable}}
| [[aWarpsharp2/aSobel|aSobel]]
| Sobel edge dectecion filter included in [[aWarpSharp2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
|[[MaskTools2/Mt edge| mt_edge]]
| Edge detection filter included in [[MaskTools2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}
|-
|[[scharr]]
|Edge detection using the [https://en.wikipedia.org/wiki/Sobel_operator#Alternative_operators Scharr operator].
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[scharr|Script]]
|zorr
|-
| [[tcanny]]
| Contains a canny edge detection filter and distance transform filter.
| [[YUY2]], [[YV12]]
| [[tcanny|Plugin]]
| {{Author/tritical}}
|-
| [[TCannyMod]]
| Canny edge detection filter for Avisynth 2.6. Reimplementation of tcanny. See [http://forum.doom9.org/showthread.php?t=168449 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TCannyMod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[TEdgeMask]]
| TEdgeMask creates an edge mask based off gradient vector magnitude.
| [[YUY2]], [[YV12]]
| [[TEdgeMask|Plugin]]
| {{Author/tritical}}
|-
| [[TEMmod]]
| TEdgeMask modified for Avisynth 2.6. It creates an edge mask using gradient vector magnitude. See [http://forum.doom9.org/showthread.php?t=168390 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TEMmod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[vsTCanny]]
| Builds an edge map using canny edge detection.
| All 8-32bit [[planar]] colorspaces
| [[vsTCanny|Plugin]]
| {{Author/Asd-g}}
|-
| [[vsTEdgeMask]]
| vsTEdgeMask is an edge detection filter. This is a port of the TEdgeMask/TEMmod AviSynth plugins.
| All 8-16bit [[planar]] colorspaces
| [[vsTEdgeMask|Plugin]]
| {{Author/Asd-g}}
|}

=== Export Filters ===

These filters can write directly to media files.

{{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?t=172837 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://forum.doom9.org/showthread.php?t=172761 Update for AviSynth 2.6]. [http://forum.doom9.org/showthread.php?p=1750415#post1750415 Usage]. [http://forum.doom9.org/showthread.php?p=1073371#post1073371 Old mod by squid_80].
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [https://github.com/Asd-g/AviSynth-TWriteAVI/releases Plugin]
| {{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?p=1403600 Sashimi]
(function "RawWriter")
| Sashimi writes (and reads) almost any regular raw uncompressed data format you can define. You'll find a fuller description under [[#Source_Filters|Source Filters]].
| [[RGB]], [[YUY2]],[[YV12]]
| [http://sites.google.com/site/ourenthusiasmsasham/soft Plugin with scripts]
| [http://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
| [[SoundOut]]
| SoundOut is a GUI driven sound file output module for AviSynth (it exports audio to several compressors).
| All audio.
| [[SoundOut|Plugin]]
| {{Author/Sh0dan}}
|}

=== 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://www.avisynth.nl/users/warpenterprises/files/freeframe_5F25_dll_20050426.zip Plugin]
| {{Author/Myrsloik}}
|}

=== Meta-Filters ===

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

{{FilterTable}}
|[[AVSTP]]
|A library for multithreaded plug-in development
|Any
|[[AVSTP|Plugin]]
|{{Author/cretindesalpes}}
|-
|[[MP_Pipeline]]
|Run parts of an AviSynth script in external processes.
|Any
|[[MP_Pipeline|Plugin]]
|[http://github.com/SAPikachu/ SAPikachu]
|-
| [[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
| [http://www.avisynth.nl/users/warpenterprises/files/mt_20070301.zip 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]
| [[YUY2]], [[YV12]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
|[http://forum.doom9.org/showthread.php?t=164073 SoraThread]
|Sora's avs multi-process/multi-thread plugin package
|Any
|[http://forum.doom9.org/showthread.php?t=164073 Plugin]
|leiming2006
|-
|[http://forum.doom9.org/showthread.php?t=154886 ThreadRequest]
|Yet another plugin for multithread processing. [http://web.archive.org/web/20130124045626/http://lantis.homeunix.org/avisynth.shtml Archive homepage (Japanese)]
|Any
|[http://www.mediafire.com/download/4xux7d7l1u3toy8/ThreadRequest+102a.rar Plugin]
|lantis
|}

=== Multipurpose Filters ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=174433 amDCT]
|amDCT() is an adaptive video filter providing deblocking, sharpening, local range expansion, smoothing, and bright noise removal in a single filter that can be used on video of any level of quality. These four operations work synergistically to drastically reduce block artifacts while maintaining detail and increasing local contrast.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[https://github.com/pinterf/amDCT Plugin]
|jconklin, [https://github.com/pinterf pinterf]
|-
|[[AVExtensions]]
|Audio-video extensions is a collection of various AviSynth filters used to modify audio or video.
|[[RGB24]], [[RGB32]]
|[[AVExtensions|Plugin]]
|nutbread
|-
|[[AviSynthShader]]
|This plugin allows running HLSL pixel shaders within AviSynth. This gives access to various HLSL filters that haven't been programmed in AviSynth.
|[[RGB32]], [[YV24]], [[YV12]]
|[[AviSynthShader|Plugin]]
|[http://github.com/mysteryx93 MysteryX]
|-
|[[avs-mlrt]]
|This project provides AviSynth+ ML filter runtimes for variety of platforms.
|Y32, RGPS
|[[avs-mlrt|Plugin]]
|{{Author/Asd-g}}
|-
|[[CLExpr]]
|AviSynth Expr filter implemented in OpenCL for runtime calculation of expressions on 8 and 16-bit depths clips. Makes mt_lutxy and mt_lutxyz possible on 16-bit.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CLExpr|Plugin]]
|{{Author/tp7}}
|-
|[https://forum.doom9.org/showthread.php?t=183823 CTools]
|Includes various filters for IVTC, deinterlacing, denoising, dehalo and duplicate frames.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://github.com/CeppoTools/CTools/releases Plugin]
|Ceppo
|-
| [http://forum.doom9.org/showthread.php?t=166061 HybridFuPP]
| An adaptive processor, allowing picture cleaning and compressibility gain. Original [http://forum.doom9.org/showthread.php?t=146632 discussion.]
| [[YV12]]
| [http://www.mediafire.com/download/6g09aazs4z7m11a/HybridFuPP_0.992b.zip Script]
| Fupp
|-
| [[MaskTools2]]
| This plugin provides tools for the creation, enhancement and manipulation of masks for each [[YUV]] component.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}, {{Author/tp7}}
|-
| [[MVTools]]
| This plugin provides a collection of functions for motion estimation and compensation.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| Various
|-
|[[avslibplacebo#Shader|Shader]]
|Loads GLSL shaders written in mpv's .hook syntax.
|16-bit planar YUV
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|}

=== Scene Change Detection ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=171624 DBSC]
|A scene change detection tool set/kit/box (work-in-progress).
|All
|[http://forum.doom9.org/showthread.php?t=171624 Script]
|{{Author/StainlessS}}
|-
| [http://forum.doom9.org/showthread.php?t=145143 EDLmaker]
| Simple scenechange detector that writes to EDL file.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=145143 Script]
| Mug Funky
|-
| [[MVTools2/MSCDetection|MSCDetection]]
| Part of MVTools2; MSCDetection creates a scene detection mask clip from motion vectors data.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| SCDetect
| Detect scene change and output scene change frames to a file.
| [[YV12]]
| [http://web.archive.org/web/20140614152525/http://www.nmm-hd.org/upload/get~TfPm2QO4jbk/SCDetect_v0.3.rar Script]
| {{Author/06_taro}}
|-
| [http://akuvian.org/src/avisynth/sclavc/readme.txt SceneChangeLavc]
| SClavc is an AviSynth plugin intended to allow access to libavcodec's scene-change metrics. See [http://akuvian.org/src/avisynth/sclavc/ homepage.]
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/scenechangelavc_5F25_dll_20041201.zip Plugin]
| {{Author/akupenguin}}
|-
| [[SCXvid]]
| SCXvid produces first pass Xvid logs from AviSynth at the equivalent of the default VFW preset. These logs are primarily intended to get scene change information from but may have other uses.
| [[YV12]]
| [http://dl.dropbox.com/s/402hlckyn669p9n/SCXvid-1.1.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[SCXvidMask]]
| A tiny AviSynth plugin that reads an SCXvid log and creates a binary mask based on it.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://github.com/tp7/SCXvidMask/releases Plugin]
| {{Author/tp7}}
|}

=== Support filters ===

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

{{FilterTable}}
| [[ApplyInterlacedFilter]]
| ApplyInterlacedFilter safely processes interlaced video with spatial and temporal filters.
|
| Script
|
|-
|[http://forum.doom9.org/showthread.php?t=162874 ArcFuns]
|This plugin expands the available numerical functions with missing inverse trig functions.
|N/A
|[http://forum.doom9.org/attachment.php?attachmentid=12494&d=1319627190 Plugin]
|{{Author/Gavino}}
|-
|[[AvsFilterNet]]
|The main objective of AvsFilterNet is to provide a wrapper for AviSynth, making it possible to write simple filter in any .Net languages.
|N/A
|[[AvsFilterNet|Plugin]]
|SAPikachu
|-
|[[AvsMotion]]
|AviSynth plugin for animating clips with AAE motion tracking data.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AvsMotion|Plugin]]
|{{Author/tp7}}
|-
| [http://forum.doom9.org/showthread.php?t=46506 Call]
| Call an external program from the script.
| N/A
| [http://avisynth.nl/users/warpenterprises/files/call_5F25_dll_20030310.zip Plugin]
| Nic, DDogg
|-
|[[CallCmd]]
|Plugin to execute command on selectable frames or at startup or closedown. Based on [http://forum.doom9.org/showthread.php?t=46506 Call by Nic].
|N/A
|[[CallCmd|Plugin]]
|StainlessS
|-
|[[ClipBoard]]
|Get text from Clipboard.
|N/A
|[[ClipBoard|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182910 Feedback]
|A filter that lets you use a filter chain's output as its own input.
|Any
|[http://horman.net/avisynth/download/feedback.zip Plugin]
|{{Author/David Horman}}
|-
|[[FileSize]]
|Plugin to get filesize.
|N/A
|[[FileSize|Plugin]]
|pureexe
|-
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.html GetProgramName]
|An AviSynth plug-in to retrieve the name of the calling application.
|N/A
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.zip Plugin]
|[http://www.roelofs-coaching.nl/J.M. Roelofs]
|-
|[[GetProgramName2]]
|GetProgramName2 is similar to GetProgramName by JM Roelofs, but this plugin is a newly written.
|N/A
|[[GetProgramName2|Plugin]]
|[https://github.com/enccc enccc]
|-
| GetSystemEnv
| An AviSynth plug-in to retrieve information from the system.
| N/A
| [http://www.avisynth.nl/users/stickboy/GetSystemEnv.zip Plugin]
| {{Author/stickboy}}
|-
| [[GRunT]]
| Extends AviSynth's [[Runtime_environment|Runtime Environment]], making it easier to use, especially inside script functions.
| Any
| [[GRunT|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
| [[GScript|Plugin]]
| {{Author/Gavino}}
|-
|[[LoadDLL]]
| Used to manually load dll files in AviSynth. Useful if a filter relies on an external dll that is not in the system PATH.
| N/A
| [[LoadDLL|Plugin]]
|{{Author/tsp}}
|-
|[https://forum.doom9.org/showthread.php?t=162790 MinMax]
|Finds the min or max value in each line or column and then sets the entire line or column to that value. Only processes the luma (Y) plane.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[https://web.archive.org/web/20160610142230if_/http://latoninf.free.fr/div/minmax.7z Plugin]
|{{Author/LaTo}}
|-
| [http://forum.doom9.org/showthread.php?t=97748 PlaneMinMax]
| Frame-based YV12 plane Min/Max/Avg functions without [[ConditionalFilter]].
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/planeminmax_5F25_dll_20050727.zip Plugin]
| Bart Silverstein
|-
|[http://forum.doom9.org/showthread.php?t=83451 pop]
|A filter to get values from variables that may not yet be initialized.
|Any
|[https://web.archive.org/web/20160606142540if_/http://www.tsp.person.dk/pop.zip Plugin]
|{{Author/tsp}}
|-
| [[RT_Stats]]
| Compile-time/Runtime Functions.
| N/A
| [[RT_Stats|Plugin]]
| StainlessS
|-
|[[StrFmt]]
|Simple plugin to produce formatted string, and additional function to string replace with another string.
|Any
|[[StrFmt|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=174387 StrResolve]
|String Variables Resolving Plugin (for masktools expressions)
|Any
|[http://www.mediafire.com/file/wu6zexhssd0y77i/170310_StrResolve_v050.zip Plugin]
|martin53
|}

=== Deepcolor Filters ===
(also check the [[High_bit-depth_Support_with_Avisynth#Processing_High_Bit-depth_Video_with_AviSynth|High Bit-Depth]] page and the [[:Category:Deep_color_tools|Deep Color Tools]] category)

{{FilterTable}}
| [[Dither_tools|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 color banding 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
| [[Dither_tools|Plugin + scripts]]
| {{Author/cretindesalpes}}
|}

=== 3D Filters ===

{{FilterTable}}
|[https://sourceforge.net/projects/voix/files/2d3/ 2Dto3D]
|2Dto3D is a collection of scripts for 2D to 3D conversion. Conversion is good but not perfect.
|[[YV12]]
|[https://sourceforge.net/projects/voix/files/2d3/ Script]
|[https://sourceforge.net/u/brankoj/profile/ brankoj]
|-
| [http://web.archive.org/web/20110809073332/http://arenafilm.hu/alsog/anaglyph/ Analglyph]
| 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://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z Plugin] / [http://web.archive.org/web/20140412062911/http://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z mirror]
| {{Author/Kertai Gábor}}
|-
| Anaglypher
| A plugin for combining stereopairs into single anaglyph image.
| [[RGB32]], [[RGB24]]
| [http://shura.luberetsky.ru/anaglypher/Anaglypher.zip Plugin]
| [http://shura.luberetsky.ru/ Shura Luberetsky]
|-
|[http://forum.doom9.org/showthread.php?t=162616 Displace / McM_2D_to_3D]
|Plugin and script that enables you to convert 2d to 3d stereo with bidirectional pulfrich effect + add depth to stationary objects.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=162616#post1539121 Plugin/Script]
|Mcmount
|-
|[http://forum.doom9.org/showthread.php?t=143855 fauxD]
|2D to stereo-3D conversion in real-time.
|[[RGB24]], [[RGB32]]
|[http://forum.doom9.org/attachment.php?attachmentid=9278&d=1232092731 Plugin]
|eslave
|-
| [http://www.pantarheon.org/AviSynth3DToolbox/ Pantarheon 3D AviSynth Toolbox]
| The Toolbox contains a number of basic functions which allow you to multiplex the left and right views found in two separate videos into one video, using several of the common methods currently in use.
| [[YUY2]], [[YV12]]
| [http://www.pantarheon.org/AviSynth3DToolbox/zip/ Script]
| [http://www.pantarheon.org/ G. Adam Stanislav]
|}

=== 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}}
| [[AddAudio]]
| A function that adds silent audio to a clip. Needed for CCE 2.50 users.
| N/A
| Script
|
|-
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Audiofix]
|Plugin to fix a specific audio problem, see [http://forum.doom9.org/showthread.php?t=175991 discussion].
|
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Plugin]
|{{Author/David Horman}}
|-
| [[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.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV24]], 8-bit [[Planar]] RGB
| [[AudioGraph|Plugin]]
| Richard Ling, {{author/Sh0dan}}
|-
|[[AudioLimiter]]
| To increase volume for silent sounds a lot, to increase volume for middle-volume sounds a little and to keep hi-volume sounds untoched.
| N/A
|[[AudioLimiter|Plugin]]
|dimzon
|-
|[[AudioTimeline]]
|Displays a audio timeline track under the frame. It is especially suited for thumbsheets, where it allows to estimate the audio track of the thumbnailed clip.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[[AudioTimeline|Plugin]]
|martin53
|-
| [[BeFa]]
| Band Eliminate Filter for Audio.
| N/A
| [[BeFa|Plugin]]
| {{Author/kiraru2002}}
|-
| [[FindAudioSyncScript]]
| FindAudioSyncScript helps you to find the appropriate audio delays, if you have desync'ed audio.
| N/A
| Script
| IanB
|-
| [[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 float. It's a conditional audio filter, so the computation is done framewise.
| N/A
| [[MinMaxAudio|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
|[[Normalize2]]
|Audio normalizing plugin. The main difference between this plugin and the built-in normalizing plugin [[Normalize]]() is that this plugin can store the peak level value in an external file and uses a lookup table to do the actual normalizing (for speed).
|N/A
|[[Normalize2|Plugin]]
|[http://sourceforge.net/u/jcsston/profile/ jcsston]
|-
| [[SoxFilter]]
| Use [http://sox.sourceforge.net/ SOX] audio effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
| N/A
| [[SoxFilter|Plugin]]
| {{author/Sh0dan}}, [https://github.com/pinterf pinterf]
|-
|[[Spectrogram]]
|Linear [http://en.wikipedia.org/wiki/Spectrogram spectrogram] for AviSynth 2.6.
|Any
|[[Spectrogram|Plugin]]
|[http://github.com/innocenat innocenat]
|-
|SwitchByAudio
|Plugin to switch video source based on audio. See [http://forum.doom9.org/showthread.php?t=167011 discussion]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://www.avisynth.nl/users/vcmohan/SwitchByAudio/SwitchByAudio.zip Plugin]
|{{Author/vcmohan}}
|-
|[http://forum.doom9.org/showpost.php?p=1722472&postcount=20 TimeStretchPlugin]
|[[TimeStretch]] with multichannel support and updated SoundTouch library.
|N/A
|[http://www.wilbertdijkhof.com/TimeStretch_v258.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
| [[ViewAudio]]
| Includes two filters: ViewAudio and CacheAudio.
| [[YUY2]], [[YV12]]
| [[ViewAudio|Plugin]]
| {{Author/minamina}}
|-
| VUmeter
| Classic analog-style VU meter; see [https://forum.doom9.org/showthread.php?t=175370 discussion]. Uses MinMaxAudio.
| Any
| [https://github.com/raffriff42/AvisynthPlusUtilities script]
| raffriff42
|-
| [[Waveform]]
| Displays audio waveforms superimposed on the video, similar to AudioGraph below but with multi-channel support and consistent support for all colourspaces.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Waveform|Plugin]]
| {{Author/David Horman}}
|}

== 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. See [http://forum.doom9.org/showthread.php?p=397426 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/adjust_5F25_dll_20031110.zip Plugin]
| [http://avisynth.nl/users/warpenterprises/ WarpEnterprises]
|-
|[http://forum.doom9.org/showthread.php?t=166588 Adaptive Lens Blur Repair]
|This function adaptively repairs video damaged by lens blur, using a frame-adaptive repair mask, a selection of sharpeners and multi-stage motion-compensated artifact removal.
|[[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=13154&stc=1&d=1354907363 Script]
| fvisagie
|-
|[[amp]]
|Inspired by [http://forum.doom9.org/showthread.php?t=168293 RgbAmplifier], it performs temporal smoothing, then (optionally) enhances the difference between the windowed average and the current frame.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[amp|Plugin]]
| {{Author/David Horman}}
|-
|[[AutoOverlay]]
|Auto-aligned optimal overlay of one video clip onto another with color adjustment.
| [[RGB32]], [[YV24]], [[YV12]]
| [https://github.com/introspected/AutoOverlay/releases Plugin]
| [https://github.com/introspected introspected]
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace AutoTraceFilter]
|An intentionally useless plugin that uses [http://autotrace.sourceforge.net/ AutoTrace] to trace and then resize a source video, rendering the result using GDI+.
|[[RGB24]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|-
| [http://forum.doom9.org/showthread.php?p=675275#post675275 BeforeAfter]
| See the difference before and after; similar discussion [http://forum.doom9.org/showthread.php?t=98876 here]. (missing [http://www.animemusicvideos.org/forum/viewtopic.php?f=11&t=45223 BeforeAfterDiff] and BeforeAfterLine scripts.)
| any
| Script
| Corran
|-
|[http://forum.doom9.org/showthread.php?t=158696 ccc]
|A plugin specifically designed for Cross-Conversion Correction.
|[[YV12]]
|[http://web.archive.org/web/20150403181720/http://japland.org/ccc/ccc_v0.4a_avs.zip Plugin]
|Daemon404
|-
| [http://www.avisynth.nl/users/vcmohan/ColorIt/ColorIt.html Colorit]
| Color a black and white image or recolor a color image. See [http://forum.doom9.org/showthread.php?t=93990 discussion.]
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/ColorIt/Colorit.zip Plugin]
| {{Author/vcmohan}}
|-
| 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]
| mikeytown2
|-
| DCT
| Plugin with the following functions: IDCT, IDCT2, FDCT, FDCT2. See [http://forum.doom9.org/showthread.php?p=667382#post667382 discussion]
| [[YUY2]]
| [http://alainmuchembled.free.fr/DCT.zip Plugin]
| lcld
|-
| [http://forum.doom9.org/showthread.php?p=1444027#post1444027 DDigit]
| DDigit Plugin Text Rendering Pack for Plugin writers. See [http://forum.doom9.org/showthread.php?t=156888 discussion.]
|
| [http://www.mediafire.com/download/bfhj5crwaxbupeh/DDigitTest_25%2626_v1-06_dll_20150330-RECOMPILE.zip Plugin]
| {{Author/StainlessS}}
|-
|[http://forum.doom9.org/showthread.php?t=95193 DeJump]
| This is a specific filter which might be used to stabilize some "jumpy" video sources captured from VHS.
|[[YUY2]]
| [http://forum.doom9.org/attachment.php?attachmentid=3988&d=1117479069 Plugin]
| dinstun
|-
|[[FFAvisynth]]
| A plugin which lets you directly use [http://en.wikipedia.org/wiki/Ffdshow ffdshow] video and audio filters from AviSynth scripts.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://sourceforge.net/projects/ffdshow-tryout/ Plugin]
| Milan Cutka
|-
|[http://github.com/Youka/FLuaG FLuaG]
| FLuaG (Floating Lua Graphics) is an AviSynth plugin for video/audio data editing via Lua scripting. See [http://forum.doom9.org/showthread.php?t=161852 discussion]
| [[RGB32]]
| [http://github.com/Youka/FLuaG/archive/master.zip Plugin]
| [http://github.com/Youka Youka]
|-
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
| Use Avisynth to process still images.
|
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
|
|-
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 FSubstitute]
|Tries to automate the task of replacing bad frames using adjacent or close-by frames.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 Script]
|martin53
|-
|[http://forum.doom9.org/showthread.php?t=130611 GrainOptimizer]
|The only temporal-only grain reducer! See discussion for more information. Related topics: [http://forum.doom9.org/showthread.php?t=137117 x264: Film Grain Optimization], [http://web.archive.org/web/20090916181521/http://x264dev.blogspot.com/2008/05/film-grain-optimization.html]
|[[YV12]]
|[http://web.archive.org/web/20081228144846/http://mirror05.x264.nl/Dark/force.php?file=./GrainOptimizer_2.02.zip Plugin]
|Dark Shikari
|-
|[http://github.com/Youka/LVS LVS]
| LVS (Lua Video Sync) is a video frameserver plugin to edit video frames with the capability of scripting language Lua + 2D image processing functionality. See [http://forum.doom9.org/showthread.php?t=167716 discussion]. [https://github.com/Youka/LVS GitHub]
| [[RGB32]], [[RGB24]]
| [http://sourceforge.net/projects/lua-video-sync/files/ Plugin]
| [http://github.com/Youka Youka]
|-
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.html NeuralNet]
| Neural networks through back propagation learn and filter some types of noise. Classification and linear type networks are included.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.zip Plugin]
| {{Author/vcmohan}}
|-
| PseudoColor
| This filter first converts clip to b/w, then colors it to pseudorandom colors according to brightness. See [http://forum.doom9.org/showthread.php?t=61570 discussion.]
| [[RGB32]], [[RGB24]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/pseudocolor_5F25_dll_20030919.zip Plugin]
| Shubin
|-
|[http://github.com/jeremypoulter/QRCodeSource QRCodeSource]
|AviSynth plugin to provide a means to embed QR codes in video.
|[[RGB32]]
|[http://github.com/jeremypoulter/QRCodeSource/releases Plugin]
|[http://github.com/jeremypoulter jeremypoulter]
|-
|RemoveDeadPixels
|See [http://forum.doom9.org/showthread.php?p=699915#post699915 here] and [http://videoprocessing.fr.yuku.com/topic/27/Removedeadpixels here].
|[[YUY2]]
|[http://web.archive.org/web/20160610103945/http://home.arcor.de/kassandro/RemoveDeadPixels.rar Plugin]
|{{Author/kassandro}}
|-
|[http://forum.doom9.org/showthread.php?t=172601 rgba_rpn]
|A filter for manipulating the pixels of [[RGB]] (and also [[YUV]]) clips using [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://horman.net/avisynth/downloads/rgba_rpn0.1.zip Plugin]
|{{Author/David Horman}}
|-
| [[SegmentedAmp]]
| Image is segmented with watershed algorithm for smoothing and/or sharpening.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/index.php/SegmentedAmp Plugin]
| {{Author/vcmohan}}
|-
|[http://forum.doom9.org/showthread.php?t=172377 SmoothSkip]
|In tribute to tritical's awesome filter, this one tackles the inverse problem of [[TIVTC/TDecimate|TDecimate]]; allowing for addressing frames that have non-smooth, skippy motion. For source code see [http://github.com/jojje/SmoothSkip GitHub repository].
|[[YUY2]], [[YV12]]
|[http://github.com/jojje/SmoothSkip/releases/download/v1.0.2/SmoothSkip-1.0.2.zip Plugin]
|[http://github.com/jojje jojje]
|-
| [[Soothe]]
| Lessens the temporal instability and aliasing caused by sharpening, by comparing the original and sharpened clip, leaving a smoother and slightly softer output. See [http://forum.doom9.org/showthread.php?t=99679 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=99679 Script]
| {{Author/Didée}}
|-
|[https://sourceforge.net/projects/ssbrenderer/ SSBRenderer]
|SSBRenderer is a plugin for AviSynth to render 2D graphics and subtitles by SSB (Substation Beta) data on frames of video streams. [https://forum.doom9.org/showthread.php?t=169951 Doom9 Forum discussion], [https://github.com/Youka/SSBRenderer GitHub]
|[[RGB24]], [[RGB32]]
|[https://sourceforge.net/projects/ssbrenderer/files/ C-Plugin]
|[https://github.com/Youka Youka ]
|-
| [http://sourceforge.net/projects/avisynthtrackin/ Tracking]
| Use computer vision to track objects in the video, and produce ConditionalReader input. Demo at [http://www.youtube.com/watch?v=SQ-JtJs7US0 Youtube].
| [[RGB24]]
| [http://sourceforge.net/projects/avisynthtrackin/files/1.1/AvisynthTrackin.1.1.binary.zip/download Plugin]
| [http://avisynthtrackin.sourceforge.net/ Shlomo Matichin]
|-
| UnSmooth
| What does it do. It amplifies noise, small detail, and artifacts. Doesn't sound very attractive, but there can still be some detail left in over smoothed encodes. See [http://forum.doom9.org/showthread.php?t=63361 discussion.]
| [[YV12]]
| [http://web.archive.org/web/20090821183550/http://mf.creations.nl/avs/functions/UnSmooth-v0.1.avs Script]
| {{Author/mf}}
|-
| [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.html WaterShed]
| Assuming image grey values to be elevations, it is segmented into basins and watershed lines. Useful in certain medical image analysis and recoloring work.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| AviSynth 2.5.8: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.zip Plugin]
AviSynth 2.6.0: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins xvplugins]
|This is simply a bunch of AviSynth stuff that isn't (really) possible using plain AviSynth and instead required a plugin.
|[[RGB32]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|}
<br/>

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

MVTools

2024-05-03T12:20:24Z

Pinterf: Update version

{{FilterCat5|External_filters|Plugins|Plugins_x64|Other_filters|Support_filters}}
[[Category:Deep_color_tools]]
{{Filter
|Manao, Fizick, Tsp, TSchniede, SEt, cretindesalpes, pinterf
|v2.7.46
|'''[https://github.com/pinterf/mvtools/releases mvtools-2.7.46-with-depans.7z]'''
(8-16(32) bits, 420,422,444 support, x86/x64)
|[[:Category:Support_filters|Support filters]], [[:Category:Deep_color_tools|Deep color tools]]
|
* [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6.0]
* AviSynth+ for x64 and native 10+ bits
* YV12
* YUY2
* YV16, YV24 (2.7.1-)
* YUV 4:2:0, 4:2:2, 4:4:4 10-16 bits (32 bits in selected filters)
|[https://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|7=[https://forum.doom9.org/showthread.php?t=84770 Doom9], [https://forum.doom9.org/showthread.php?t=131033 continued]
------
[https://forum.doom9.org/showthread.php?p=1386559#post1386559 Doom9 v2.6 mod], [https://forum.doom9.org/showthread.php?t=173356 v2.7mod]}}

== About MVTools ==
MVTools plugin for AviSynth 2.6 is a collection of functions 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.

The plugin contains the motion estimation server-function MAnalyse to find the motion vectors and several motion compensation client-functions (MCompensate, MMask and others) which use these vectors.

Plugin uses block-matching method of motion estimation (similar methods are used in MPEG2, MPEG4, etc). At analysis stage plugin divides frames by small blocks and try to find for every block in current frame the most similar (matching) block in second frame (previous or next). The relative shift of these blocks is motion vector. The main measure of block similarity is sum of absolute differences (SAD) of all pixels of these two blocks compared. SAD is a value which says how good the motion estimation was.

The output of MAnalyse (server) is special clip with motion vector information in some format.

At compensation stage the plugin client functions read the motion vectors and use them to move blocks and form motion compensated frame (or realize some other full or partial motion compensation or interpolation function). Every object (block) in this (fully) compensated frame is placed in the same position as this object in current frame. So, we may (for example) use strong temporal denoising even for quite fast moving objects without producing annoying artifacts and ghosting (object's features and edges are coincide if compensation is perfect). Plugin can create compensated neighbor frames for every current frame, and denoise it by internal function. Alternatively, you can use compensated and original frames to create interleaved clip, denoise it by any external temporal filter, and select central cleaned original frames for output (see examples).

Of course, the motion estimation and compensation is not ideal and precise. In some complex cases (video with fading, ultra-fast motion, or periodic structures) the motion estimation may be completely wrong, and compensated frame will be blocky and (or) ugly. Severe difficulty is also due to objects mutual screening (occlusion) or reverse opening. Complex Avisynth scripts with many motion compensation functions may eat huge amount of memory and result in very slow processing. It is not simple but quite advanced plugin. Use it for appropriate cases only, and try to tune its parameters. There are many discussions about motion compensation using at doom9 Avisynth forum. In particular see [https://forum.doom9.org/showthread.php?t=76041 old MVTools thread], [https://forum.doom9.org/showthread.php?t=102071 true motion thread], [https://forum.doom9.org/showthread.php?t=84770 new MVTools thread] and some other. Try to read the postings in addition to this documentation and ask for support there. If you really interested in motion estimation and compensation topics, you can easy find numerous scientific publications (use WWW search).

Notes 1: Try to use a smart deinterlacer for interlaced video (SeparateFields may works too with or without SelectEven/SelectOdd). Some complex scripts (MVBOB, MCBOB, TempGaussMC) use MVTools for motion compensated deinterlacing.
Alternatively you can try to use Motion plugin by mg262.

Notes 2: Stacked 16 bit output for MDegrain1-6 and MDegrainN are also supported in general.
Native 10-16 bit colorspaces (and 32 bit float in MDegrain) are available when using MVTools with AviSynth+ r2294-.

'''<span style="color:red">Latest documentation:</span> https://htmlpreview.github.io/?https://github.com/pinterf/mvtools/blob/mvtools-pfmod/Documentation/mvtools2.html'''

== Common parameters ==
Filters that use motion vectors have common parameters. Those are the scene-change detection thresholds, and the isse MMX flag. They also use one or several vectors stream, which are produced by MAnalyse.

*{{Template:FuncDef2|thSCD1}} (int, 400): threshold which decides whether a block has changed between the previous frame and the current one. When a block has changed, it means that motion estimation for it isn't relevant. It occurs for example at scene changes. So it is one of the thresholds used to tweak the scene changes detection engine. Raising it will lower the number of blocks detected as changed. It may be useful for noisy or flickered video. The threshold is compared to the SAD (Sum of Absolute Differences, a value which says how bad the motion estimation was ) value. For exactly identical blocks we have SAD=0. But real blocks are always different because of objects complex movement (zoom, rotation, deformation), discrete pixels sampling, and noise. Suppose we have two compared 8x8 blocks with every pixel different by 5. It this case SAD will be 8x8x5 = 320 (block will not detected as changed for thSCD1=400). If you use 4x4 blocks, SAD will be 320/4. If you use 16x16 blocks, SAD will be 320*4. Really this parameter is scaled internally in MVTools, and you must always use reduced to block size 8x8 value. Default is 400 (since v.1.4.1).

*{{Template:FuncDef2|thSCD2}} (int, 130): Threshold which sets how many blocks have to change for the frame to be considered as a scene change. It is ranged from 0 to 255, 0 meaning 0 %, 255 meaning 100 %. Default is 130 (which means 51 %).

*{{Template:FuncDef2|isse}} (bool, true): Flag which allows to enable (if set to true) or disable ISSE, MMX and other CPU optimizations (for debugging). If your processor doesn't support CPU optimizations, it will be disabled anyway (and you won't be able to activate them).

*{{Template:FuncDef2|planar}} (bool, false): Legacy flag to use a hack planar color format for YUY2 clips, both for input and output of functions. It uses a hack to store frames with planar data (separate Y, U, V planes in memory) in normal interleaved YUY2 frames format as a container. This way we can avoid numerous internal interleaved to planar conversions and increase speed. You can convert a normal interleaved YUY2 source clip to planar with Interleaved2planar from SSETools and convert back with Planar2interleaved. This special planar YUY2 format is also supported by Removegrain, MaskTools2 and some others. This trick is not needed in Avisynth 2.6 with native support of planar YV16 format. This parameter is ignored for YV12 clips. Note: super clip is always planar.

*{{Template:FuncDef2|mt}} (bool, true): When true, enables internal multi-threading via AVSTP. Only available in some functions, like [[MVTools2/MSuper]] and [[MVTools2/MSuper]].<br>'''Might''' be better to disable when using AVS+ 3.6 and leting the frameserver do its thing ([http://publishwith.me/ep/pad/view/ro.rDkwcdWn4k9/latest MTmodes.avsi], if loaded, sets the number of AVSTP threads to 1, which should give the same result as mt=false)

== Filters ==
{{PluginFilterTable}}
|-
{{PluginFilterRow|MVTools2|MSuper|
Get source clip and prepare special "super" clip with multilevel (hierarchical scaled) frames data.
| [[YV12]], [[YUY2]],<br>any 8-32 bits 4:2:0, 4:2:2, 4:4:4, Planar RGB
}}
{{PluginFilterRow|MVTools2|MAnalyse|
Get prepared multilevel super clip, estimate motion by block-matching method and produce special output clip with motion vectors data (used by other functions).
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
|-
{{PluginFilterRow|MVTools2|MCompensate|
Do a full motion compensation of the frame.
| [[YV12]], [[YUY2]],<br>any 8-32 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MMask|
Creates mask clip from source clip with motion vectors data.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MSCDetection|
Creates scene detection mask clip from motion vectors data.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MShow|
Shows the motion vectors on padded source by super clip opening.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
|-
{{PluginFilterRow|MVTools2|MDepan|
Get the motion vectors, estimate global motion and put data to output frame in special format for [[DePan]] plugin.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
|-
{{PluginFilterRow|MVTools2|MFlow|
Do a motion compensation of the frame not by blocks (like MCompensate), but by pixels.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MFlowInter|
Motion interpolation function. It is not the same (but similar) as MVInterpolate function of older MVTools version.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MFlowFps|
Will change the frame rate (fps) of the clip. The function can be used for frame rate conversion, slow-motion effect, etc.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MBlockFps|
The function uses block-based partial motion compensation to change the framerate (fps) of the clip (and number of frames).
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
|-
{{PluginFilterRow|MVTools2|MFlowBlur|
Experimental simple motion blur function. It may be used for FILM-effect (to simulate finite shutter time).
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MDegrain''X''|
Temporal denoising with motion compensation. MDeGrain''X'' has a temporal radius of ''X'', up to 6.<br>
| [[YV12]], [[YUY2]],<br>any 8-32 bits 4:2:0, 4:2:2, 4:4:4, planar RGB
}}
{{PluginFilterRow|MVTools2|MDegrainN|
Temporal denoising with motion compensation. MDeGrainN has a temporal radius given by the tr parameter, and uses a special motion vector clip.<br>
| [[YV12]], [[YUY2]],<br>any 8-32 bits 4:2:0, 4:2:2, 4:4:4, planar RGB
}}
{{PluginFilterRow|MVTools2|MRecalculate|
Refines and recalculates motion data of previously estimated (by MAnalyse) motion vectors with different super clip or new parameters set (e.g. lesser block size), after divide, etc.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
{{PluginFilterRow|MVTools2|MScaleVect|
Rescales motion vectors / blocksize. Main purpose is to allows vectors to be used on a differently sized clip or on a clip having different bit depth than they were analyzed from.
| ?
}}
{{PluginFilterRow|MVTools2|MStoreVect|
Stores (multiple) motion vectors in a encodable clip. Allows you to encode vectors to a file (must use a lossless format). Convenient for splitting up very slow scripts. Can also use to process the same footage in multiple ways. Use MRestoreVect to get the motion vectors back out of the clip.
| ?
}}
{{PluginFilterRow|MVTools2|MRestoreVect|
Fetches a single motion vector clip from a special clip prepared earlier by MStoreVect. Call multiple times if there are several clips stored. The function returns a single motion vectors clip.
| ?
}}
{{PluginFilterRow|MVTools2|MShow|
Shows the motion vectors on padded source by super clip opening.
| [[YV12]], [[YUY2]],<br>any 8-16 bits 4:2:0, 4:2:2, 4:4:4
}}
|}

Note1: native 10-16 bits and 4:2:0 and 8-16 bits 4:2:2, 4:4:4 color spaces are supported in 2.7.x branch
Note2: native 10+ bits only work with Avisynth+
Note3: MDegrain supports 32 bit float input clips (Super and Input) but motion vectors should be calculated from 8-16 bits

== Changelog ==
{| class="wikitable" style="border: 1px solid darkgray"
!Version
!Date
!Author
!Changes
|-
|2.7.31- 46
|20180409-20240503
|pinterf
|see documentation<br>
|-
|2.7.30
|20180405
|pinterf
|Fix: crash in MFlowInter (and possibly other MFlow...). v2.7.29 revealed this additional bug (which was not even 100% reproducible), this fix is basically the 2nd part of the solution.<br>
|-
|2.7.29
|20180403
|pinterf
|Fix: MFlowInter (and possibly other MFlow...) crash with specific combination of analyze parameters (e.g. blkSize=16,overlapv=4,divide=1). Bug existed since at least 2.5.11.22<br>
|-
|2.7.28
|20180323
|pinterf
|Fix: in MDegrain1-6/N allow Y8 input for out16 parameter<br>
|-
|2.7.27
|20180318
|pinterf
|Fix: MDepan: use zerow parameter. The parameter had no effect probably since it had been introduced.<br>
MDepan: report MT mode for Avisynth+. MT_MULTI_INSTANCE, except for logfile writing output mode when it reports MT_SERIALIZED. (other filters already have proper registration, MDepan was missed)<br>
|-
|2.7.26
|20180314
|pinterf
|New: MDegrain1-6 and N: new parameter bool "out16" = false. If set, 8 bit input results in native 16bit output (like lsb=true hack but this is native, faster).<br>
Faster: special 10 bit SAD functions instead of the generic 10-16bit one.<br>
|-
|2.7.25
|20180227
|pinterf
|Fix: x64: not-cleared mmx state in MSuper assembly code would cause crash later, e.g. in x264 encoding, depending on following filters.<br>
Fix: MSCDetection SC value parameter name to Ysc from Yth (must be an ancient typo), docs are OK, but the fix is mentioned in docs<br>
MSuper: import 8 bit sse2 interpolators from mvtools-vs. Extend them for 10-16bits (faster super clip). Some filters are still todo.<br>
MSuper: support 32bit float clips, which can be used later by MDegrains (but not for MAnalyse)<br>
MDegrains: allow degraining clip with different bit depth from vectors. Clip and Super must be the same bit depth<br>
MDegrains: consistently use limit and limitC, 255 do nothing, otherwise scale 0-254 value to the current bit-depth range<br>
Overlaps: more correct internal rounding for 8 bits<br>
Overlaps: round for 16bits<br>
Overlaps: 32bit float (but still use the original 11 bit window constants)<br>
Project: change from yasm to nasm.<br>
|-
|2.7.24
|20171205
|pinterf
|Fix: MFlowBlur: possible access violation crash when nPel>1<br>
New: MScaleVect parameter 'bits'. e.g. Analyze 8 bit clips, use their vectors for 16 bits<br>
Move project to VS2017<br>
|-
|2.7.23
|20171012
|pinterf
|Fix: MScaleVect wrong rounding of scaled motion vectors with negative components. e.g. proper scaling (-1;-2) to (-2;-4) instead of (-1,-3)<br>
|-
|2.7.22
|20170830
|pinterf
|Misc: Stop using version suffix .22<br>
Fix: [DCT 8x8@8bit] garbage on x64: internal assembly code did not save xmm6/xmm7<br>
Fix: [DCT 8x8@8bit] safe multithreading for integer DCT (8x8 block size, 8 bit video): assembly had a single working buffer.<br>
Fix: [MDegrain] did not release input motion vector clips in destructor, possible hang at script closing. Bug since 2.7.1.22 (introducing MDegrain4/5)<br>
Mod: fftw conversion constant of sqrt(2)/2 is more accurate (was:0.707), 16 bit formats may benefit (by feisty2)<br>
Fix: SSE4 assembly instructions in x64, broke on non-SSE4 processors<br>
|-
|2.7.21.22
|20170629
|pinterf
|Mod: [MMask] Faster: request source frame only for kind=5.<br>
|-
|2.7.20.22
|2017.05.26
|pinterf
|Fix: [MMask] greyscale input resulted in AV when filter exiting<br>
|-
|2.7.19.22
|2017.05.25
|pinterf
|New: [MMask] Support any planar input video formats e.g. greyscale, Planar RGB. Input clip can even be of different bit depth or format from vector's original format. For kind==5 where U and V is filled, the greyscale option is not allowed<br>
Mod: [MMask] Faster: request source frame only for kind=5.<br>
Fix: [MxxxxFPS,MMask]: MakeVectorOcclusionMaskTime garbage in bottom blocks<br>
Fix: [MMask] bottom padding garbage for padded frame dimension<br>
Fix: [MMask] proper 10+ bits scene change values (for default: 1023, 4095, 16383, 65535. Was: 65535). Parameter is still in 8-bit range<br>
Fix: [MRecalculate] prevent overflow during thSAD scaling in 16 bits or large block sizes (32, 48...)<br>
Fix: [DepanEstimate] Sometimes giving wrong motion instead of scene change detection. Bug only existed in previous pfmod builds.<br>
Fix: [MAnalyze] Possible overflow in MAnalyze 8 bit, block size 48x48 and above. Overflow-safe predictor recalc for big block sizes.<br>
New: [General] Add block size 12x3 for SAD, allow 6x24<br>
List of available block sizes<br>
- 64x64, 64x48, 64x32, 64x16<br>
- 48x64, 48x48, 48x24, 48x12<br>
- 32x64, 32x32, 32x24, 32x16, 32x8<br>
- 24x48, 24x24, 24x32, 24x12, 24x6<br>
- 16x64, 16x32, 16x16, 16x12, 16x8, 16x4, 16x2<br>
- 12x48, 12x24, 12x16, 12x12, 12x6, 12x3<br>
- 8x32, 8x16, 8x8, 8x4, 8x2, 8x1<br>
- 6x24, 6x12, 6x6, 6x3<br>
- 4x8, 4x4, 4x2<br>
- 3x6, 3x3<br>
- 2x4, 2x2<br>
Mod: [Internal] Reorganized 10-16 bit SAD simd intrinsics, faster 8-12% for BlkSize 12-32<br>
|-
|2.7.18.22
|2017.05.12
|pinterf
|Fix: 10-16 bit: DCT buffer possible overflow<br>
Fix: DCT is fast again for non 8x8 blocksizes. Regression since 2.7.5.22.<br>
New: Chroma SAD is now always half of luma SAD, regardless of video format. Without this: YV24's luma:chroma SAD ratio is 4:8 instead of 4:2 (of YV12)<br>
New: MAnalyze, MRecalculate new parameter: "scaleCSAD" integer, default 0.<br>
Fine tune chroma SAD weight relative to luma SAD.<br>
ScaleCSAD values for luma:chroma SAD ratio<br>
* -2: 4:0.5<br>
* -1: 4:1<br>
* 0: 4:2 (default, same as the native ratio for YV12)<br>
* 1: 4:4<br>
* 2: 4:8<br>
New: Block sizes 64, 48, 24, 12, 6.<br>
MAnalyze/MRecalculate new block sizes (SATD support mod4 sizes)<br>
Note: some smaller block sizes can only be available in 4:4:4 formats, due to block size division (chroma subsampling)<br>
New: All block sizes are supported in MDegrain1-6, MDegrainN, and MScaleVect<br>
New: Changed to 2017 version of asm files for 8 bit SAD/SATD functions from x265 project. Added not implemented asm code for 12, 24, 48 sizes<br>
For some block sizes AVX2 and SSE4 is supported (AVX2 if reported under AviSynth+) e.g. BlkSize 32 is faster now.<br>
New: MMask SAD Mask to give identical weights for other-than-YV12 formats, e.g. for YV24<br>
|-
|2.7.17.22
|2017.04.26
|pinterf
|Fix: Regression in 2.7.16.22: MDegrain right pixel artifacts on non-modulo 16 widths<br>
Misc: MMask, mode SADMask output is normalized further by video subsampling (YV16/YV24 has larger SAD value due to bigger chroma part that classic YV12)<br>
|-
|2.7.16.22
|2017.04.23
|pinterf
|Fix: MMask 10-16 bits<br>
Fix: MRecalculate 14-16 bits passed nSCD1=999999 internally which caused overflow (scene change problems later)<br>
Fix is done by clamping SCD1 to 8*8*(255-0) (maximum value of sum of SADs on a 8x8 block)<br>
Misc: MDegrainX 8 bits: internal 16 bit buffer to 8 bits: SSE2<br>
Fix: MFlow access violation in internal mv resizer when resizing factor was big (MCaWarpSharp3 4x supersampling case) (bug possibly introduced in upstream 2.5.11.22)<br>
|-
|2.7.15.22
|2017.03.16
|pinterf
|Fix: 16 bit SAD for non-AVX code path<br>
Misc: MDegrain1-6: add error on lsb_flag=true for non-8 bit sources<br>
|-
|2.7.14.22
|2017.02.06
|pinterf
|Fix: MAnalyze divide=2 showed "vector clip is too small" (inherited from 2.6.0.5, sanity check was done but length was not filled for divideextra data)<br>
Fix: MFlow access violation in internal mv resizer when resizing factor was big (MCaWarpSharp3 4x supersampling case) (bug possibly introduced in upstream 2.5.11.22)<br>
|-
|2.7.13.22
|2017.02.01
|pinterf
|Fix: MDegrain1-6,N 10-16 bit thSCD scaling<br>
Fix: MVShow: tolerance scaling for 10-16 bits<br>
|-
|2.7.12.22
|2017.01.20
|pinterf
|New: Faster SATD (dct=5..10) 8 bit: updated x264 function selectors, SSE2/4/AVX/AVX2; +10% speed for a whole typical MDegrain3 process on i7-3770<br>
New: Much Faster SATD (dct=5..10) 10-16 bit: SSE2/SSE4 instead of C +50% speed for a whole typical MDegrain3 process (which is approx half speed of 8 bit)<br>
|-
|2.7.11.22
|2017.01.16
|pinterf
|New: MDegrain6<br>
Mod: MDegrain1-6 SSE4 for 10-16 bit (was: C. 3-5% gain, wasn't bottleneck)<br>
|-
|2.7.10.22
|2016.12.28
|pinterf
|Fix: for YV12 the debug info text chroma part was positioned at wrong place<br>
|-
|2.7.9.22
|2016.12.20
|pinterf
|Apply 2.5.11.9-svp analysis speedup, mainly when chroma is involved<br>
|-
|2.7.8.22
|2016.12.18
|pinterf
|Fix: YUY2 input access violation (regression after 2.7.0.22d) - Fixed also in Depan.dll<br>
Fix: MDegrain: free up YUY2 planes only if not planar input (bug inherited from 2.5.11.22 MDegrain3) resulting in freeze at script exit<br>
|-
|2.7.7.22
|2016.12.14
|pinterf
|Optimizing 8 bits<br>
speed: change some 8 bit SAD functions for the better<br>
speed: separating bottleneck 8 bit/16 bit code paths in order not to use slower int64 calculations for 8 bit, where there are no integer overflow problems<br>
speed: more __forceinlines for helping the compiler<br>
info: general speed gain of 5-15% compared to 2.7.6.22, much reduced speed gap compared to the "classic" YV12 8 bit mvtools2 versions<br>
|-
|2.7.6.22
|2016.12.04
|pinterf
|fix: sumLumaChange underflow (used for dct=2,6,9) (regression during 16 bit support)<br>
fix: MeanLumaChange scale for 10-16 bits (used for dct=2,6,9)<br>
fix: Mask fix: 8 bit mask resizer bug in SIMD intrinsics (regression on inline asm -> SIMD transition)<br>
Fix: dctmode=1,2: pixel distance was not corrected for 16 bit pixel sizes<br>
speed: Let's help VS2015 with some __forceinline directives to recognize the truth.<br>
speed: Misc optimizations throughout the code (bit shifts instead of div or mul)<br>
speed: FFTW DCT: C code replaced with SIMD SSE2/SSE4 (FloatToBytes, BytesToFloat)<br>
speed: 16 bit SAD: a few optimizations in SSE2, AVX-coded SSE2 and AVX2 codepath<br>
VS2015 compiler: /MT -> /MD (from static to dynamic dlls - now it reallys need VS2015 redistributables)<br>
|-
|2.7.5.22
|2016.11.19
|pinterf
|Milestone release:
General support of 10-16 bit formats with Avisynth Plus (r2294 or newer recommended) with new MDegrain4 and MDegrain5 filters.<br>
Fix for MSCDetection: scene change filler pixel default value was always 0 (2.7.1.22 regression)<br>
MCompensate: possible bugfix bottom padding UV<br>
Fix SAD for 10-16 bit depths for horizontal block sizes >= 16<br>
Fix nSCD2 (Scene change threshold block count %) (2.7.1.22 regression)<br>
MBlockFPS: overlap fixes (right columns and bottom lines)<br>
MBlockFPS: overlap fix: missing copy buffer to output<br>
|-
|2.7.1.22
|2016.10.20
|pinterf
|YV16 and YV24 avaliable<br>
dct modes >= 5 now use SATD again (so far it was in dead code, contrary to 2.5.13.1 remarks)<br>
New: MDegrain4, MDegrain5<br>
Experimental native 10-16 bit support (MSuper, MAnalyze, MDegrain1-5, MDegrainN) including 16 bit SATD (slow C) and SSE2 optimized regular SAD for 8+ (for 10+ bits you need at least Avisynth+ r2290)<br>
Inline assembly rewritten to intrinsics -> 64 bit build is possible in VS2015 (External assembly untouched)<br>
|-
|2.7.0.22
|2016.04.29
|pinterf
|Integrate Fizick's upstream changes of 2.5.11.22<br>
|-
|2.7.0.1
|2016.03.31
|pinterf
|MVTools-pfmod<br>
2.6.0.5 x64 capable version ported under AviSynth 2.6 API<br>
Fixed access violation in MDepan<br>
Fixed access violation in x64 asm code<br>
Built with Visual Studio 2015 Community Edition, v140_xp toolset<br>
Compiler: Intel C++ 16 (because of inline 64 bit asm code)<br>
See [https://forum.doom9.org/showthread.php?t=173356 discussion] and [https://github.com/pinterf/mvtools/tree/mvtools-pfmod GitHub page] for more information.<br/>
|-
|2.6.0.5
|2012.07.17
|Firesledge
|MCompensate, MDegrainN: fixed a bug causing occasionally horizontal magenta stripes in multithreading mode.
|-
|2.6.0.4
|2012.06.14
|Firesledge
|MCompensate: fixed artifacts related to overlap with tr > 3 in multithreading mode.
|-
|2.6.0.3
|2012.05.13
|Firesledge
|MDegrainN: fixed artifacts related to overlap with tr > 3 in multithreading mode.
|-
|2.6.0.2
|2012.05.01
|Firesledge
|MAnalyse: fixed a threading issue when using FFTW.
|-
|2.6.0.1
|2012.03.12
|Firesledge
|
MAnalyse: fixed potential crash in multithreading mode.<br/>
MDegrainN: fixed systematic crash in multithreading mode.<br/>
All MDegrain functions: fixed potential crash when thSAD is set to 0.
|-
|2.6.0.0
|2012.03.11
|Firesledge
|
MDegrainN: internally uses MDegrain1/2/3 when tr ≤ 3, for optimal speed.<br/>
MCompensate: added multi-compensation mode for easy use with temporal filters.<br/>
MAnalyse, MSuper, MCompensate, MDegrainN: added multithreading (but partially, not for all code paths) using AVSTP.<br/>
MAnalyse: fixed a corruption of the global motion vector.<br/>
Improved page setting for this documentation.
|-
|2.5.14.2
|2012.01.10
|Firesledge
|Fixed MScaleVect with multi-vector clips.
|-
|2.5.14.1
|2011.12.13
|Firesledge
|Fixed crashes in the MDegrain functions when using both planar=true and lsb=true.
|-
|2.5.14.0
|2011.11.28
|Firesledge and Vit
|Added MStoreVect, MRestoreVect and MScaleVect from the Vit's [https://forum.doom9.org/showthread.php?t=84770&page=76#post1538821 MVExtras plugin].
|-
|2.5.13.1
|2011.11.09
|Firesledge
|
MAnalyse, MRecalculate: added an SATD approximation for blksize > 16 and dct ≥ 5. Previously, the SATD calculation was silently bypassed and always returned a null SAD value.<br/>
Functions now check that the pel setting is the same in the superclip and the motion vectors, instead of crashing if not.
|-
|2.5.13.0 beta
|2011.09.11
|Firesledge
|
MRecalculate: Can now process multi-vector clips.<br/>
All functions: Added the -Vit-'s fix that could improve the multithreading stability.
|-
|2.5.12.1 beta
|2011.09.10
|Firesledge
|MAnalyse: Fixed the ghosting bug introduced in the previous version.
|-
|2.5.12.0 beta
|2011.09.10
|Firesledge
|
MDegrainN added.<br/>
MAnalyse: Added the "multi" mode for MDegrainN.<br/>
MAnalyse: Documented the negative delta values and fixed some functions accordingly.<br/>
MFlowInter: Fixed the YUY2 planar mode.
|-
|2.5.11.2 beta mod16b
|2011.05.11
|Firesledge
|Fixed a regression in MDegrain1/2/3, related to the mod16 versions. thSADC is now taken into account correctly (instead of using thSAD).
|-
|2.5.11.2 beta mod16a
|2011.04.10
|Firesledge
|Merged 2.5.11.2 and 2.5.11 mod16a versions.
|}
[http://www.avisynth.nl/users/fizick/mvtools/mvtools2.html#revisions Changelog up to v2.5.11.22]
<br>
<br>
== Archived Downloads ==
{| class="wikitable" border="1"; width="500px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v2.6.0.5 (x64)
|[http://www.dropbox.com/s/swk97z4q834vugk/mvtools_2.6.0.5_x64.zip?dl=1 mvtools_2.6.0.5_x64.zip]
|[https://web.archive.org/web/20200608154645if_/https://files.videohelp.com/u/223002/mvtools_2.6.0.5_x64.zip mvtools_2.6.0.5_x64.zip]
|-
!v2.6.0.5
|[http://ldesoras.free.fr/src/avs/mvtools-2.6.0.5.zip mvtools-2.6.0.5.zip]
|[https://web.archive.org/web/20160604063048if_/http://ldesoras.free.fr/src/avs/mvtools-2.6.0.5.zip mvtools-2.6.0.5.zip]
|-
!v2.5.11.22
|[http://www.avisynth.nl/users/fizick/mvtools/mvtools-v2.5.11.22.zip mvtools-v2.5.11.22.zip]
|[https://web.archive.org/web/20170716135124if_/http://www.avisynth.nl/users/fizick/mvtools/mvtools-v2.5.11.22.zip mvtools-v2.5.11.22.zip]
|}
* Note: MVTools v2.6.0.5 (x64) was compiled with Intel Parallel Studio XE 2015 Composer Edition for C++.
<br>
==External Links ==
*[https://forum.doom9.org/showthread.php?t=84770 Doom9 Forum] - MVTools discussion.
*[http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=1918 NMM-HD Forum] - MVTools documentation in Chinese.
<br>

SetFilterMTMode

2024-01-16T14:54:26Z

Pinterf: Add avs+ readthedocs link

<div {{BlueBox2|40|0|3px solid purple}} >
{{AvsPlusFullname}}<br>
Up-to-date documentation on multithreading: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/syntax/syntax_internal_functions_multithreading_new.html https://avisynthplus.readthedocs.io]
</div>

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__TOC__
</div>

<div style="max-width:62em; min-width:42em;" >
By default, AviSynth+ is single-threaded. This page documents how to enable multi-threading.
</div>

=== Syntax and Parameters ===
<div style="max-width:62em; min-width:42em;" >
==== SetFilterMTMode ====
:{{FuncDef|SetFilterMTMode (string filter, int mode, bool "force")}}<br>

::{{Par2||string|}}
:::<code>filter</code>: name of the filter you want to set an MT Mode for. You cannot set the MT mode on script function calls, only on binary filters.
:::<code>"DEFAULT_MT_MODE"</code>, sets the default MT mode for all filters that do not have an MT mode explicitly set. Does not affect for source filters and filters that self-register their own MT mode.
<br>
::{{Par2||int|}}
:::Sets MT Mode, there are three basic MT modes (1,2,3) and an experimental workaround mode (4). Instead of the numbers, you can also use symbolic names for MT modes:
:::*1 : MT_NICE_FILTER
:::*2 : MT_MULTI_INSTANCE
:::*3 : MT_SERIALIZED
:::*4 : MT_SPECIAL_MT
<br>
::{{Par2|force|bool|false}}
:::Force MT mode. Default is false
<br>
==== Prefetch ====
:{{FuncDef|Prefetch (clip, int “threads”, int “frames”)}}
<br>
:{{Par2||clip|}}
::Input clip.
<br>
::{{Par2|threads|int|}}
:::Number of threads to use. If it is 0, it passes without doing anything.
:::default: (number of logical cores in the system) +1
<br>
::{{Par2|frames|int|}}
:::Number of frames to prefetch. Again, if it is 0, it passes without doing anything.
:::default: threads * 2
<br>

In the original Avisynth+ (before v3.6), you could only use one Prefetch, but started from Neo fork you can use as many as you like.
Also, a "frames" argument has been added to specify the number of frames to prefetch.
Neo's multithreading enhancements were backported to classic Avisynth+ and are available since v3.6

'''Example: Pipeline parallelization'''

Filtering A
Prefetch(1,4)
Filtering B
Prefetch(1,4)
Filtering C
Prefetch(1,4)

Prefetch (1,4) makes one thread stand and read four frames ahead.
In the above example, the filtering processes A, B, and C are executed in parallel in a pipeline.
Since the number of threads of each Prefetch is arbitrary, for example, filter processing B is heavy,
so if you want to increase the number of parallels by that amount, you can increase the number of threads as follows:

Filtering A
Prefetch(1,4)
Filtering B
Prefetch(4)
Filtering C
Prefetch(1,4)

==== OnCPU ====
OnCPU/OnCUDA (collectively called OnDevice)

Since 3.6 AvisynthNeo features were backported to Avisynth+.
Such as supporting "devices", like CPU and CUDA (CUDA support needs special build, still experimental after v3.7).
And the data transfer between them.

If all are valid, the chain will be as follows.

Upstream → Upstream cache → Thread → Transfer → Downstream cache → Downstream
→ is the flow of frame data (reverse of GetFrame call direction)

Number of prefetch frames

* 0: Synchronous call without all cache
* 1: Synchronous call, but only transfer is read ahead and executed asynchronously. Downstream cache is enabled.
* 2 or more: Pre-read upstream processing using threads. Both upstream and downstream caches are valid.

The number of upstream threads is fixed at 1 thread when prefetch = 2 or more, and the number of prefetches is fixed at 2.
The downstream look-ahead number is set to the specified prefetch sheet.

:{{FuncDef|OnCPU(clip, int “num_prefetch”)}}
<br>
::{{Par2||clip|}}
::This clip is processed by the CPU. In other words, the processing before this is processed by the CPU.
<br>
::{{Par2|num_prefetch|int|}}
:::Here you specify the number of frames to prefetch. About 2 will give you enough performance. Unlike Prefetch, it has only one thread because it is a prefetch for parallelizing processing on the GPU and CPU.
:::default: 0
<br>
If 0 is specified, it will be a synchronous call without using threads.

==== OnCUDA ====
:{{FuncDef|OnCUDA(clip, int “num_prefetch”, int “device_index”)}}
<br>
::{{Par2||clip|}}
::This clip is processed by CUDA. In other words, the processing before this is processed by CUDA. A filter that does not support CUDA processing will result in an error. Currently, internal filters are rarely supported, so you can only use external filters that are specially made.
<br>
::{{Par2|num_prefetch|int|}}
:::Same as OnCPU prefetch. Here you specify the number of frames to prefetch. About 2 will give you enough performance. Unlike Prefetch, it has only one thread because it is a prefetch for parallelizing processing on the GPU and CPU.
:::default: 0
<br>
::{{Par2|device_index|int|}}
:::Specifies the GPU to run. If you have only one GPU, you can only use 0. If you have two GPUs, you can specify 0 or 1. There is no limit on the number.
:::default: 0
<br>

Of course, valid only on Avisynth+ built with CUDA option and works if the system has proper device and driver combination.

=== Usage ===
<div style="max-width:62em; min-width:42em;">
*Source: [http://forum.doom9.org/showthread.php?p=1666371#post1666371 Doom9 Forum]<br>
So, how to use MT in AviSynth+?<br>
By default, your script will run in single-threaded mode, just like with SEt's build. Also, just like in SEt's build, you'll have to make sure that filters use the correct MT mode, or else they might wreak havoc. There are three basic MT modes (1,2,3) and an experimental workaround mode (4) since r2440, and modes 1-3 are the same modes as in (yeah you guessed correctly) SEt's build. Which means you can use the same modes that you have used with AviSynth-MT.
There are some things though that are different and/or new in AviSynth+. The first difference is *how* you set the MT mode. In AviSynth-MT, you had to use SetMTMode(X), which caused all filters following that line to use mode X (until the next call to SetMTMode()). This meant if you needed to use multiple MT modes, you had to insert all those calls in the middle of your script, littered over many places.
</div>
<br>
<div style="max-width:62em; min-width:42em;" >
=== Setting MT Modes ===
AviSynth+ does it differently. In AviSynth+, you specify the MT-mode for only specific filters, and those filters will then automatically use their own mode, even if there were other MT-modes in between. This means you can specify all the MT modes at the beginning without polluting your script. You can even make a SetMTMode.avsi if you wish and let it autoload for all of your scripts, or import() it from their top. This is much cleaner, and it allows you to maintain all your MT-modes centrally at a single place. To make this distinction clear from AviSynth+, SetMTMode() is called SetFilterMTMode() in AviSynth+.
</div>
<br>
<div style="max-width:62em; min-width:42em;" >
=== Enabling MT ===
The other difference is how you actually enable multithreading. Calling SetFilterMTMode() is not enough, it sets the MT mode, but the MT mode only has an effect if MT is enabled at all. Note this means you can safely include/import/autoload your SetFilterMTMode() calls in even single-threaded scripts, and they will not be messed up. Uhm, onto the point: You enable MT by placing a single call to Prefetch(X) at the '''end''' of your script, where X is the number of threads to use. If there is a return statement in your script it must be placed '''after''' Prefetch().
</div>
<br>
<div style="max-width:76em; min-width:42em;" >
==== Example ====
<pre>
# This line causes all filters that don't have an MT mode explicitly use mode 2 by default.
# Mode 2 is a relatively safe choice until you don't know most of your calls to be either mode 1 or 3.
# Compared with mode 1, mode 2 trades memory for MT-safety, but only a select few filters will work with mode 1.
SetFilterMTMode("DEFAULT_MT_MODE", 2)
or
SetFilterMTMode("DEFAULT_MT_MODE", MT_MULTI_INSTANCE)

# FFVideoSource(), like most of all source filters, needs MT mode 3.
# Note: starting with AviSynth+ r2069, it will now automatically recognize source filters.
# If it sees a source filter which has no MT-mode specified at all, it will automatically use
# mode 3 instead of the default MT mode.
SetFilterMTMode("FFVideoSource", 3)
or
SetFilterMTMode("FFVideoSource", MT_SERIALIZED)

# Now comes your script as usual
FFVideoSource(...)
Trim(...)
QTGMC(...)
...

# Enable MT!
Prefetch(4)
</pre>
</div>
<br>
<div style="max-width:62em; min-width:42em;" >
=== Help filling MT modes ===
The following script contains MT modes for various plugins, save it as <tt>mtmodes.avsi</tt> and place in your auto-load folder. The script is a work-in-progess, there's still lots of plugins that need to be tested and validated. When the script is finalized, the only thing the user will have to write in his script is the <code>Prefetch</code> call, all <code>SetFilterMtMode</code> calls will be hidden in a single <tt>.avsi</tt> script.
*You can find the latest revision here: [http://publishwith.me/ep/pad/view/ro.rDkwcdWn4k9/latest AviSynth+ MT modes], if you like to contribute please do so [http://publishwith.me/ooiV92hupl here]. Report any issues [https://forum.doom9.org/showthread.php?t=181351 here].

Note for filter writers: filters can report their mt modes in their SetCacheHint, in this case the manual setting is not necessary.
</div>
<br>
<div style="max-width:62em; min-width:42em;" >
=== Choosing the correct MT mode ===
Please do check if the actual output is correct. Fast but corrupted output is useless. Easy way of checking would be using something like <code>[[ColorBars]](1920, 1080, "YV12").[[AddGrainC]](10000, 10000, seed=1)</code> as a source filter. It doesn't always work right but will do for most stuff.[http://forum.doom9.org/showthread.php?p=1667434#post1667434]

Source: http://forum.doom9.org/showthread.php?p=1667439#post1667439

*<code>MT_NICE_FILTER</code>: Some filters (like nnedi3) use some buffers to do their dirty work and with mode 1 you get multiple threads writing data from different frames to the same buffer. This causes corruption when later someone tries to read from this buffer and gets not what was expected. Most of the "more complicated" filters use some kind of temporary storage thus won't work well with this mode. Simple filters might.

*<code>MT_MULTI_INSTANCE</code>: Mode 2 doesn't have this issue because multiple threads will get their own buffers and no data will be shared. Hence mode 2 is the "default" mode which should work with ''most'' filters, but it wastes memory like crazy (take SangNom2 for example - for 1080p YV12 frame, size of temporary buffers is about 10MB, so with 4 threads you get 40MBs on single filter invocation. Now add some usual supersampling to this and multiple invocations in most aa scripts and... you get the idea).

*<code>MT_SERIALIZED</code>: If the filter requires sequential access or uses some global storage, then mode 3 is the only way to go. Source filter (filters without clip parameter) are autodetected, they do not need an explicit MT mode setting, they will automatically use MT_SERIALIZED.

*<code>MT_SPECIAL_MT</code>: Experimental. Now use only for MP_Pipeline, the filter is like a source filter (no input clip parameter), internally multithreaded, and suffer heavy performance degradation from any of the three regular mt modes. Really, this is a workaround. Available from AviSynth+ version r2440. Avisynth+ 3.6 has serious mt fixes, maybe this mode is not needed anymore.
</div>
<br>
<div style="max-width:62em; min-width:42em;" >
=== Closing notes (don't skip!) ===
*Remember that MT is only stable as long as you have specified a correct MT mode for all filters.
*Instead of the numbers 1-2-3-4, you can also use symbolic names for MT modes: MT_NICE_FILTER (1), MT_MULTI_INSTANCE (2), MT_SERIALIZED (3), MT_SPECIAL_MT (4)
*Mode 3 (MT_SERIALIZED) is evil. It is necessary for some filters, and it is usually no problem for source filters, but it can literally completely negate all advantages of MT, if such a filter is placed near the end of your script. Let us know if you meet a non-source mode 3 filter, we might be able to do something about it, but in general, avoid such calls if you want performance. (And of course, insert what you have found into here.)
*The new caches will save you a lot of memory in single-threaded scripts, but due to the way they work, they will also use more memory than before with MT enabled. The memory usage will scale much closer with the number of threads you have. Just something to keep in mind.
*MT-enabled AviSynth+ triggers a latent bug in AvsPmod v2.5.1. [https://github.com/gispos/AvsPmod/releases Use AvsPmod v2.6.x].
*Using too many threads can easily hurt performance a lot, because there are other bottlenecks too in your PC than just the CPU. For example, if you have a quad-core machine with 8 logical cores, less than 8 threads will often work much better than 8 or more.
</div>
<br>
=== Changes ===
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| xxxxx
| xxxxx
|}
</div>

[[Category:Internal_filters]]
[[Category:Multithreading]]
[[Category:Avisynthplus]]

External filters

2024-01-04T09:09:48Z

Pinterf: /* Audio Filters */ refresh SoxFilter

Rough classification of third-party filters for AviSynth - a perpetual work in progress.

This page lists both scripts (see [[Import]]) and plugins (see [[Plugins]]).

== Introduction ==

==== Download sites ====
A large list of filters can be downloaded from the following sites but be aware that some plugins listed '''may be outdated''', only recommended as a backup.

*[https://web.archive.org/web/20130803185015/http://www.64k.it:80/andres/dettaglio.php?sez=avisynth Andres' Filter Collection]
*[https://chaosking.de/repo/avsfilters/ AviSynth Filter DB by ChaosKing] | [https://web.archive.org/web/20140412062911/http://chaosking.de/avisynth-filter-db mirror]
*[http://www.avisynth.info/?plugin=attach&pcmd=list&refer=%E3%82%A2%E3%83%BC%E3%82%AB%E3%82%A4%E3%83%96 AviSynth.info Filter Archive]
*[http://xhmikosr.1f0.de/_old/avisynth/plugins/ XhmikosR's Builds]
*[http://www.avisynth.nl/users/warpenterprises/ Warp Enterprises' AviSynth Filter Collection]

====64-bit filters====
'''[[AviSynth%2B_x64_plugins|Comprehensive list of AviSynth+ 64-bit filters]] →'''

====Outdated AviSynth plugins====
[[External plugins old|External plugins (old)]] - these older plugins are not recommended, page is there mainly for historical purposes.

==== Using filters ====
Most scripts will apply filters in the following order:

# Create an AviSynth clip from a video file using a source filter.
# 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).



== Source Filters ==

{{FilterTable}}
| [https://forum.doom9.org/showthread.php?t=135855 BassAudio]
| [https://www.un4seen.com/ 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
| [https://forum.doom9.org/showthread.php?t=135855 Plugin]
| dimzon
|-
|[[BestAudioSource]]
|A new sample accurate but somewhat slow FFmpeg based audio source filter for AviSynth+. No indexing required and only available in 64-bit.
|N/A
|[[BestAudioSource|Plugin]]
|{{Author/Myrsloik}}
|-
| [[DGDecNV]]
| DGDecNV is a decoder/frameserver for AVC, HEVC, MPEG2, and VC1 streams that runs on the GPU of Nvidia graphics cards that support CUDA video decoding.
| [[I420]], [[YV12]], [[YUV420P16]]
| [[DGDecNV|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.
| [[RGB24]], [[YUY2]], [[YV12]], [[I420]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
|[http://forum.doom9.org/showthread.php?t=170107 DGMVCSource]
|MVC source filter for AviSynth.
| [[YV12]]
|[http://rationalqm.us/dgmvcsource/dgmvcsource100b26.zip Plugin]
|{{Author/Donald Graft}}
|-
| [[DSS2mod]]
| DirectShowSource2 mod, this version does not require Haali Media Splitter.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DSS2mod|Plugin]]
| forclip
|-
| [[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://github.com/FFMS/ffms2/releases Plugin]
| {{Author/Myrsloik}}, TheFluff, Plorkyeran, others
|-
|[http://forum.doom9.org/showthread.php?t=169651 FRIMSource]
|FRIMSource is an AviSynth plugin for sequential reading of elementary or transport streams (MPEG2, H.264 AVC/MVC-3D, VC1).
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=169651 Plugin]
|videofan3d
|-
| [[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]]
| [[ImageSequence|Plugin]]
| {{Author/WarpEnterprises}}
|-
| [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}}
|-
|[https://forum.doom9.org/showthread.php?t=184825 ImageSourceNV]
|CUDA accelerated plugin that uses the [https://docs.nvidia.com/cuda/nvjpeg/index.html nvJPEG API] to decode jpeg source files and convert their color space to YUV444.
|[[YUV444P8]]
|[https://forum.doom9.org/showthread.php?t=184825 Plugin]
|[https://github.com/ArturAlekseev Argaricolm]
|-
| [[JpegSource]]
| An advanced JPEG decoder for Avisynth 2.6. See [http://forum.doom9.org/showthread.php?t=170028 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/rjnt0y3ead2c6ef/JpegSource_20140419.7z Plugin]
| SEt
|-
| [[LSMASHSource]]
| A source plugin for audio and video, it uses Libav ([http://en.wikipedia.org/wiki/Libav#Contained_codecs libavcodec]) to decode all supported A/V formats. See [http://forum.doom9.org/showthread.php?t=167435 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[LSMASHSource|Plugin]]
| {{Author/VFR-maniac}}
|-
|[[MPEG2DecPlus]]
|MPEG2DecPlus is a MPEG-1/2 decoder plug-in. MPEG2DecPlus is a project to modernize "[[DGDecode]].dll" for AviSynth+.
|[[YV12]], [[YV16]]
|[[MPEG2DecPlus|Plugin]]
|{{Author/Chikuzen}}
|-
| [[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], [http://forum.doom9.org/showthread.php?t=135876 continued discussion].
| N/A
| [[NicAudio|Plugin]]
| {{Author/Nic}}
|-
| [[RawSource26]]
| Loads raw video data directly from files. Further modifications (most raw formats, YUV4MPEG2 compatible with latest spec).
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RawSource26|Plugin]]
| {{Author/Chikuzen}}
|-
| [[VapourSource]]
| VapourSynth script reader for AviSynth+ and AviSynth2.6x.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[VapourSource|Plugin]]
| {{Author/Chikuzen}}
|-
|[http://forum.doom9.org/showthread.php?t=170311 VideoInputSource]
| Capture video frames from video capture card or webcam in real-time.
|[[RGB24]]
|[http://github.com/fieliapm/himawari_avs_plugin/raw/master/VideoInputSource/VideoInputSource.dll Plugin]
|[http://github.com/fieliapm fieliapm]
|-
|[https://github.com/slavanap/ssifSource ssifSource]
| Open m2ts, ssif and mpls files located in decrypted Blu-ray and Blu-ray 3D discs. Supports horizontal of vertical stack of views as output, views selection and swap autodetection.
|[[YV12]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|}

== Restoration Filters ==

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

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

{{FilterTable}}
| [[DAA]]
| Anti-aliasing with contra-sharpening.
| [[YV12]]
| Script
| {{Author/Didée}}
|-
| mcDAA3
| Motion-Compensated Anti-aliasing with contra-sharpening, can deal with ifade too, created because when applied daa3 to fixed scenes, it could damage some details and other issues. See [http://forum.doom9.org/showthread.php?p=1639679#post1639679 discussion]
| [[YV12]]
| [http://www.mediafire.com/?wqkob7zx1p119e0 Script]
| AmjadSONY
|-
| [[MAA2]]
| Updated version of the MAA antialising script.
| [[Y8]], [[YV12]], [[YV24]]
| [http://web.archive.org/web/20140624125132/https://raw.githubusercontent.com/AviSynth/avs-scripts/master/maa2.avsi Script]
| line0
|-
| [[santiag]]
| Simple anti-aliasing with independent horizontal and vertical anti-aliasing strength.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1393006 Script]
| {{Author/cretindesalpes}}
|-
| 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]
| [[YV12]]
| Script
| thetoof
|-
| [[TIsophote]]
| A level-set (isophote) smoothing filter.
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20070222162751/http://bengal.missouri.edu/~kes25c/TIsophotev091.zip Plugin]
| {{Author/tritical}}
|-
|[[xaa]]
|Versatile anti-aliasing script.
|[[Y8]], [[YV12]], [[YV24]]
|[http://www.mediafire.com/download/sygi04y47eknvc2/xaa_v1.1.1.avsi Script]
|Desbreko
|}

=== Chroma correction ===

{{FilterTable}}
|[[caf]]
|Chromatic Aberration Fixer.
| [[YV12]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| Torchlight
|-
| [[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. See [http://forum.doom9.org/showthread.php?t=33302 discussion.]
| [[YV12]], [[YUY2]], [[RGB32]]
| [http://web.archive.org/web/20091026153334/http://www.geocities.com/siwalters_uk/chromashift27.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChromaShiftSP]]
| This script can shift chroma in all directions with subpixel accuracy.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/images/ChromaShiftSP.avsi Script]
| IanB, McCauley
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[ColorMatrix|Plugin]]
| {{Author/Wilbert Dijkhof}}, {{Author/tritical}}
|-
| [[DeBlot]]
| Color bleed reduction plugin.
| [[YUY2]],[[YV12]]
| [[DeBlot|Plugin]]
| {{Author/minamina}}
|-
| [[FixChromaBleeding]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074 discussion]
| [[YV12]]
| [http://web.archive.org/web/20091026141730/http://www.geocities.com/alex_j_jordan/chroma.txt Script]
| {{Author/Alex Jordan}}
|-
| [[FixChromaBleedingMod]]
| Fixes area of chroma bleeding by shifting the chroma and lowering the saturation in the affected areas. See [http://forum.doom9.org/showthread.php?t=77074#post1673932 discussion]
| [[YV12]], [[YUY2]], [[YV411]]
| [[FixChromaBleedingMod_source|Script]]
| AmjadSONY
|-
| [[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. See [http://forum.doom9.org/showthread.php?p=1520786#post1520786 discussion.]
| [[RGB24]], [[RGB32]]
| [http://avisynth.nl/index.php/FixChromaticAberration Script]
| Martin Wagener
|-
| [[MoveChroma]]
| Chroma shifting filter; can be used to independently shift the U/V channels left or right.
| [[YUY2]], [[YV12]]
| [[MoveChroma|Plugin]]
| [http://noraneco.ddo.jp/apechironnup apechironnup]
|-
| [[PixelShiftPlus]]
| Set of functions to independently shift any RGB(A) or YUV(A) plane with subpixel precision.
| All colorspaces
| [[PixelShiftPlus|Script]]
| reel.deal
|-
| [[ReInterpolate411]]
| This is a fast and simple filter to correct the improper 4:1:1 => 4:2:2 conversion that seems to occur with some DV/4:1:1 codecs.
| [[YUY2]]
| [{{N2Archived}}/trbarry/ReInterpolate411.zip Plugin]
| {{Author/Tom Barry}}
|-
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420.html ReInterpolate420]
| Usually, DV decoders upsample [[PAL]] DV (which is YV12) to YUY2 using point sampling. This plugin re-interpolates the original chroma samples.
| [[YUY2]]
| [http://www.avisynth.nl/users/fizick/reinterpolate420/reinterpolate420_v3.zip Plugin]
| {{Author/Wilbert Dijkhof}}
{{Author/Fizick}} (v3)
|}

=== Debanding ===

{{FilterTable}}
| AdaptDBMC
| Luma / Fade / Blue adaptive debanding script. See [http://www.nmm-hd.org/newbbs/viewtopic.php?f=7&t=512 discussion]
| [[YV12]]
| [https://web.archive.org/web/20131111114822/http://www.nmm-hd.org/upload/get~ikKt5ZZhD94/AdaptDBMC_beta.rar Script]
| {{Author/06_taro}}
|-
| [[GradFun2db]]
| A simple and fast debanding filter.
| [[YV12]]
| [[GradFun2db|Plugin]]
| Prunedtree
|-
| [[GradFun2DBmod]]
| An advanced debanding script based on GradFun2DB.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144537 Script]
| {{Author/LaTo}}
|-
| [[Dither_tools#GradFun3|GradFun3]]
| This debanding script, part of the [[Dither_tools|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]]
| [[Dither_tools|Script]]
| {{Author/cretindesalpes}}
|-
| [[f3kdb|flash3kyuu_deband]]
| Fast debanding plugin ported from AviUtl.
| [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[Y8]], [[YV411]]
| [[f3kdb|Plugin]]
| [http://github.com/SAPikachu/ SAPikachu]
|-
|[[avslibplacebo#Deband|libplacebo_Deband]]
|Tunable debanding. Based on flash3kyuu, expanded to provide high quality by combining multiple debanding passes.
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
| LumaDB
| Fast 8-bit 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://web.archive.org/web/20131111114932/http://www.nmm-hd.org/upload/get~3YK_B5TfcyI/LumaDB-0.7.rar Script]
| {{Author/06_taro}}
|-
| LumaDBL
| Fast 16-bit 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://web.archive.org/web/20131111114947/http://www.nmm-hd.org/upload/get~mQYIS9H6Qas/LumaDBL-0.7.rar Script]
| {{Author/06_taro}}
|-
| [[Neo_f3kdb]]
| Fast debanding plugin for AviSynth+.
| [[Y8]], [[YV12]], [[YUY2]], [[YV16]], [[YV24]], [[YV411]], 8-16bit [[planar]] Y/YUV
| [[Neo_f3kdb|Plugin]]
| [https://github.com/msg7086 MeteorRain]
|-
|}

=== Deblocking ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect BlockDetect]
|Determines blockiness of frames.
|All 8-32 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlockDetect/releases Plugin]
|{{Author/Asd-g}}
|-
| BlockKiller
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=1410479#post1410479 discussion].
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1410479&postcount=19 Script]
| Jawed
|-
| BlockTerminator
| Deblocking filter, see [http://forum.doom9.org/showthread.php?p=831936#post831936 discussion.]
| [[YUY2]], [[YV12]]
| [http://forum.doom9.org/showpost.php?p=831936&postcount=24 Script]
| foxyshadis
|-
| [[DeBlock]]
| Deblocking filter. DGDecode also uses DeBlock.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit Y/YUV [[planar]] colorspaces
| [[DeBlock|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." [http://forum.doom9.org/showpost.php?p=913365&postcount=4 Didée]. See [http://forum.doom9.org/showthread.php?p=944459 discussion.] For updated Deblock QED see this [http://forum.doom9.org/showthread.php?t=154777 discussion]
| [[YV12]]
| [http://avisynth.nl/images/Deblock_QED_MT2Mod.avsi Script]
| {{Author/Didée}}
|-
|[[DeblockPP7]]
| A port of the MPlayer PP7 deblocking filter.
|[[YUY2]], [[YV12]]
|[[DeblockPP7|Plugin]]
|John Doe
|-
| [[FunkyDeBlock]]
| Deblocking script based on BlindPP and high/low pass separation. See [http://forum.doom9.org/showthread.php?t=72431 discussion].
| [[YV12]]
| Script
| Mug Funky
|-
| [[MDeblock]]
| Plugin for removing block artifacts.
| [[YV12]]
| [[MDeblock|Plugin]]
| {{Author/kassandro}}
|-
| [[SmoothD]]
| Filter to deblock frames while keeping high frequency detail.
| [[YV12]]
| [[SmoothD|Plugin]]
| Tobias Bergmann
|-
| [[SmoothD2]]
| Deblocking filter. Rewrite of SmoothD. Faster, better detail preservation, optional chroma deblocking.
| [[YV12]]
| [[SmoothD2|Plugin]]
| Jim Conklin
|-
| SmoothDeblock
| 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]<br>[[SmoothDeblock_source|(alt source)]]
| redfordxx
|-
|[http://www.avisynth.nl/users/fizick/unblock/unblock.html Unblock]
|UnBlock is a filter that removes the "blockiness" of heavily or moderately compressed images with statistical approach. See [http://forum.doom9.org/showthread.php?t=133059 discussion].
|[[YV12]]
|[http://www.avisynth.nl/users/fizick/unblock/unblock11.zip Plugin]
|{{Author/Fizick}}
|-
|[[vsDeblockPP7]]
|A port of the MPlayer PP7 deblocking filter. Includes high bit-depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], <br>all 8-32bit [[planar]] colorspaces
|[[vsDeblockPP7|Plugin]]
|Asd-d
|}

=== Dehaloing ===

{{FilterTable}}
| [[abcxyz]]
| Filter to remove halos. See [http://forum.doom9.org/showthread.php?t=144982 discussion].
| [[YV12]]
| [[Media:abcxyz_MT2.avsi|Script]]
| {{Author/Didée}}
|-
| [[BlindDeHalo3]]
| Filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=622289#post622289 discussion].
| [[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=5599&d=1143030001 Script]
| {{Author/Didée}}
|-
| [[DeHalo_alpha]]
| Very powerful filter to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=777956#post777956 discussion].
| [[YV12]]
| [http://avisynth.nl/images/Dehalo_alpha_mt.avsi Script]
| {{Author/Didée}}
|-
|[[DeHaloHmod]]
| Another halo reducer, it includes lots of options to tweak for best performance. See [http://forum.doom9.org/showthread.php?p=1675762#post1675762 discussion]
|[[YV12]]
| [[DeHaloHmod|Script]]
|AmjadSONY
|-
|[[FineDehalo]]
|Halo removal script that uses DeHalo_alpha with a few masks and optional contra-sharpening to try remove halos without removing important details (like line edges).
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/images/FineDehalo.avsi Script]
|{{Author/cretindesalpes}}
|-
|[https://forum.doom9.org/showthread.php?t=172599 HaloBuster]
|Really slow high quality halo remover.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=172599 Script]
|feisty2
|-
| 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
|-
| [[VHSHaloremover]]
| Quick & dirty halo removal. Will introduce some blurriness, but the halos are so huge you can’t avoid it. See [http://forum.doom9.org/showthread.php?p=1758184#post1758184]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://pastebin.com/s24mSgJ5 Script]
| {{Author/cretindesalpes}}
|-
| [[YAHR]]
| Basic filter with no variables to remove edge enhancement artifacts. See [http://forum.doom9.org/showthread.php?p=1205653#post1205653]
| [[YV12]]
| [http://avisynth.nl/images/YAHR.avsi Script]
| {{Author/Didée}}
|-
| YAHRmod
| Basic filter used to reduce halos in modern DVD and other cases.
| [[YV12]]
| [[YAHRmod_source|Script]]
| AmjadSONY
|}

=== Deringing & Mosquito Noise ===

{{FilterTable}}
| [[aWarpSharpDering]]
| Tries to clean up slight ringing around edges by heavily aWarpSharp-ing the image and then applying it only to the areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://avisynth.nl/images/AWarpSharpDering.avsi Script]
| {{Author/Leak}}
|-
| [http://rationalqm.us/dgmpgdec/DGDecodeManual.html#BlindPP BlindPP]
| Deblocking & deringing filter; part of [[DGDecode]]. <br>Mosquito noise removal: <code>BlindPP(quant=16, cpu2="ooooxx")</code>
| [[YV12]], [[YUY2]]
| [{{N2Moved}}/dgmpgdec/dgmpgdec.html Plugin]
| {{Author/Donald Graft}}
|-
| [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
|-
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Deemphasize]
|This AviSynth function deemphasizes ringing common to SD video signals resulting from a playback device in the transfer chain poorly compensating for pre-emphasis baked into the source signal.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://gist.github.com/acuozzo/940869257cc79016215600a2392b33eb Script]
|[https://github.com/acuozzo acuozzo]
|-
|[[Dering]]
|Deringing filter intended for deringing VHS captured video.
|[[YUY2]], [[YV12]]
|[[Dering|C-Plugin]]
|[https://sourceforge.net/u/alexrayne/profile/ alexrayne]
|-
| [[EdgeCleaner]]
| A simple edge cleaning and weak dehaloing function. See [http://forum.doom9.org/showthread.php?t=164592 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1568521&postcount=13 Script]
| [http://forum.doom9.org/member.php?u=80518 canuckerfan]
|-
| [[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}}
|-
| [[HQDering mod]]
| Applies deringing by using a smart smoother near edges (where ringing occurs) only.
| [[YV12]]
| [http://web.archive.org/web/20140711173345/http://www.nmm-hd.org/upload/get~08CusazVphU/HQDeringmod_v1.8.avsi Script]
| [http://www.nmm-hd.org/newbbs/memberlist.php?mode=viewprofile&u=479&sid=ff62d0f6c22fcfdbe97b53c8351429bc mawen1250]
|-
| [[LazyDering]]
| Tries to clean up slight ringing around edges by applying [[aWarpSharp2]] only to areas where the difference is small enough so detail isn't destroyed.
| [[YV12]]
| [http://web.archive.org/web/20131103155455/http://anime-addict.ani-x.com/files/avisynth/scripts/LazyDering_v0.1.avsi Script]
| {{Author/Leak}}, RazorbladeByte
|-
| [[MosquitoNR]]
| A noise reduction filter designed for mosquito noise, which is often caused by lossy compression.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]], [[YUY2]]
| [[MosquitoNR|Plugin]]
| {{Author/b_inary}}
|-
|ungibbs
|ungibbs, a gibbs artifact remover.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=134502 Script]
|*.mp4 guy
|-
|WarpDeRing
|Uses aWarpSharp2's flattening to clean out ringing/smaller halos, then runs some masks to preserve the edges and avoid the thinning.
|[[YV12]]
|[[WarpDeRing_source|Script]]
|mirkosp
|-
|WarpDeRing_faster
|Same as WarpDeRing but may be a bit faster.
|[[YV12]]
|[[WarpDeRing_faster_source|Script]]
|mirkosp
|-
|[[WDFPlus]]
|Faster version of mirkosp's warpdering_faster script for AviSynth+.
|All 8-16 bit Y/YUV colorspaces, except YV411
|[https://github.com/Reel-Deal/AviSynthPlus-Scripts/blob/main/wdfplus.avsi Script]
|reel.deal
|}

=== Deinterlacing ===

{{FilterTable}}
|[[BWDIF]]
|Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic interpolation algorithms.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all 8-32bit [[planar]] colorspaces
|[[BWDIF|Plugin]]
|Asd-g
|-
| [[Decomb]]
| The FieldDeinterlace filter provides functionality similar to the postprocessing function of 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.
| [[YUY2]], [[YUY2]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
| [[EEDI2]]
| EEDI2 resizes an image by 2x in the vertical direction by copying the existing image to 2*y(n) and interpolating the missing field. It is intended for edge-directed interpolation for deinterlacing (i.e. not really made for resizing a normal image, but can do that as well).
| [[YUY2]], [[YV12]]
| [[EEDI2|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI2CUDA]]
| EEDI2 filter using CUDA.
| All [[planar]] Y/YUV/RGB 8 to 16-bit colorspaces
| [[EEDI2CUDA|Plugin]]
| [https://github.com/misakikasumi misakikasumi], [https://github.com/WolframRhodium WolframRhodium]
|-
| [[eedi3|EEDI3]]
| Another edge directed interpolation filter. Works by minimizing a cost functional involving every pixel in a scan line. eedi3 is good for deinterlacing and enlarging images by the powers of 2.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[eedi3|Plugin]]
| {{Author/tritical}}
|-
| [[EEDI3CL]]
| OpenCL implementation of eedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[EEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
|[[FieldHint]]
|FieldHint combines arbitrary fields from the input clip, and optionally adds Telecide-compatible postprocessing hints.
|[[YV12]]
|[http://web.archive.org/web/20120223025813/http://ivtc.org/yatta%20support/fieldhint-0.12.rar Plugin]
|{{Author/akupenguin}}
|-
| [[nnedi3]]
| nnedi3 is an intra-field only deinterlacer. It takes in a frame, throws away one field, and then interpolates the missing pixels using only information from the kept field. It also has same rate and double rate modes.
| [[RGB24]], [[YUY2]], [[YV12]]
| [[nnedi3|Plugin]]
| {{Author/tritical}}
|-
| [[NNEDI3CL]]
| OpenCL implementation of nnedi3. For AviSynth+ only.
| all 8-32bit [[planar]] colorspaces
| [[NNEDI3CL|Plugin]]
| {{Author/Asd-g}}
|-
| [[nnedi3ocl]]
| OpenCL rewrite of [[nnedi3]]. See [http://forum.doom9.org/showthread.php?t=169766 discussion].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://dl.dropboxusercontent.com/s/bmemjsu7jqnlk65/nnedi3ocl_20131208.7z Plugin]
| SEt
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[QTGMC|Script]]
| -Vit-
|-
| [[SangNom2]]
| Reimplementation of the old [[SangNom]] plugin.
| [[Y8]],[[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SangNom2|Plugin]]
| {{Author/tp7}}
|-
| [[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]]
| [[TDeint|Plugin]]
| {{Author/tritical}}
|-
| [[TelecideHints]]
| The filter process the stats file to get the usual progressive matches and identify VFR sections.
| [[YUY2]], [[YV12]]
| [http://mod16.org/fansub/Telecidehints11.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[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
| [[YV12]]
| [[TempGaussMC|Script]]
| {{Author/Didée}}
|-
| [[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]]
| [[yadifmod|Plugin]]
| {{Author/tritical}}
|-
| [[yadifmod2]]
| Yadif + yadifmod for avisynth2.6/avisynth+.
| [[YV24]], [[YV16]], [[YV12]], [[YV411]], [[Y8]]
| [[yadifmod2|Plugin]]
| {{Author/Chikuzen}}
|}

=== Duplicate Frame Detectors ===

{{FilterTable}}
| [[ApparentFPS]]
| Shows underlying framerate where a clip has had many duplicates inserted, easier than counting unique frames.
| (see [[ApparentFPS|docs]])
| [[ApparentFPS|Plugin]]
| StainlessS
|-
| [[DeDup]]
| Remove (drop) duplicate frames in the interest of compression quality and speed. Resulting clip will have a variable frame rate.
| [[YV12]], [[YUY2]]
| [[DeDup]]
| {{Author/akupenguin}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[Dup|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=175357 Duplicity2/DropDeadGorgeous]
|A two faced scheming and double dealing [on your behalf] dupe tool.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://forum.doom9.org/showthread.php?t=175357 Script]
|StainlessS
|-
| [http://forum.doom9.org/showthread.php?t=134930 Dupped]
| Another frame duplication function, similar to Dup, but hopefully more accurate.
| [[YV12]]
| [http://web.archive.org/web/20140420181919/http://www.randomdestination.com/members/corran/misc/dupped/dupped.avsi Script]
| [https://github.com/eparsons Corran]
|-
| [[DupStep]]
| Duplicate frame detector/decimator filter for [[AviSynth+]], 64-bit version only.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|8-16 bits]]
| [[DupStep|Plugin]]
| [http://github.com/Orum Orum]
|-
|[[ExactDedup]]
| ExactDedup is a filter intended to remove frames that are exact duplicates of each other, leaving only the first and (optionally) last frames of a run intact, and generates a Matroska v2 timecodes file with timing information for the ensuing stream.
| [[RGB24]] [[RGB32]], [[Y8]], [[YV12]] [[YV16]], [[YV24]]
| [[ExactDedup|Plugin]]
|Steve Melenchuk, Arick Chan, StainlessS
|-
| [http://www.avisynth.nl/users/fizick/getdups/getdups.html GetDups]
| Selecting unique duplicate frames from clip, it return frames which have copies only, by one from the series (group). Made for 8mm films.
| [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.avisynth.nl/users/fizick/getdups/getdups096.zip Plugin]
| {{Author/Fizick}}
|-
| [http://forum.doom9.org/showthread.php?t=164372 MorphDups]
| Replace duplicate frames by interpolations.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=164372 Script]
| sven_x
|}

=== Fieldblending and Frameblending removal ===

{{FilterTable}}
| [[c_deblend]]
| c_deblend is a simple blend replacing function like unblend or removeblend. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[Cdeint]]
| Restores 24fps FILM out of a fieldblended FILM -> Telecine -> [[NTSC]] -> Blendconversion -> [[PAL]] - Video (alternative for Restore24).
| [[YV12]]
| Script
| MOmonster
|-
| [[Deblend]]
| See [http://forum.doom9.org/showthread.php?p=760375#post760375 discussion].
|
| Script
| actionman133
|-
| [[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.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[ExBlend|Plugin]]
| StainlessS
|-
| [[FixBlendIVTC]]
| A blend replacing/frame restoring function for doubleblends caused by blend-deinterlacing of telecined sources. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[mrestore]]
| Uses conditional frame evaluation to undo standard conversions with blends. Superseded by [[srestore]].
| [[YV12]]
| Script
| MOmonster
|-
| [[RemoveBlend]]
| This filter is used to remove blended fields/frames. See [http://forum.doom9.org/showthread.php?t=75772 discussion.]
| [[YV12]]
| [//web.archive.org/web/20061113201230/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].
|[[YV12]]
| 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]]
| [http://wilbertdijkhof.com/mg262/Restorefps_v10.zip Plugin]
| {{Author/mg262}}
|-
| [[Srestore]]
| Replacement function for mrestore, c_deblend, FixBlendIVTC and DupHq.
| [[YV12]]
| [[Srestore|script]]
| MOmonster
|-
| Specials
| Helps restore video with blended fields/frames using a reference source. See [http://forum.doom9.org/showthread.php?t=165030 discussion] and much more information [http://horman.net/doctorwho/specials.php here] and [http://forum.doom9.org/showthread.php?t=168832 here].
| [[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
|}

=== Film Damage correction ===

{{FilterTable}}
|[[DePulse]]
|DePulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[DePulse|Plugin]]
|
|-
| [[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]]
| [[DeScratch|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]]
| [[DeSpot|Plugin]]
| {{Author/Fizick}}
|-
| [[deVCR]]
| deVCR eliminates (to a certain degree) the annoying horizontal lines that keep crawling around your VHS or Beta recorded video.
| 8-bit RGB/YUV
| [[DeVCR#Script|Script]]
| Ricardo Garcia
|-
|[[KillPulse]]
|KillPulse is dropout remover, removes white/black noise horizontal streaking in analogue captures.
|[[YUY2]]
|[[KillPulse|Plugin]]
|-
|[http://forum.doom9.net/showthread.php?p=1402690 KillerSpots]
|Spot removal function based on Didée's idea from 2010 that makes use of MVTools analysis and RemoveDirt to detect and clean up spots with adiacent pixels.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|[https://github.com/FranceBB/KillerSpots Script]
|Didée, GMJCZP and John Meyer.
|
|-
| [[RemoveDirt]]
| RemoveDirt is a temporal cleaner for AviSynth 2.6 and AviSynth+.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[RemoveDirt|Plugin]]
| {{Author/kassandro}}, {{Author/pinterf}}
|-
|[http://forum.doom9.org/showthread.php?t=121197 RemoveLine]
|Script for removal of horizontal stripes.
|[[YV12]]
|Script
|Yup
|-
|[https://forum.doom9.org/showthread.php?t=181777 SpotLess]
|Script filter to remove spots and noise using mvTools2 and Medianblur2. Copes with spots on multiple consecutive frames, setting RadT accordingly.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182407 SpotRemover]
|This script is designed to clean video from spots. Based on SpotLess script by StainlessS.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://forum.doom9.org/showthread.php?t=144271 VideoFred's Film Restoring]
| A suite of scripts for film restoring.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=144271 Script]
| videoFred
|}

=== Frequency Interference removal ===

{{FilterTable}}
| [http://www.avisynth.nl/users/fizick/defreq/defreq.html 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://www.avisynth.nl/users/fizick/defreq/defreq07.zip Plugin]
| {{Author/Fizick}}
|-
| [http://avisynth.nl/users/vcmohan/FanFilter/FanFilter.html FanFilter]
| Regular vertical frequency interference is filtered in spatial domain.
| [[YV12]], [[YUY2]], [[RGB32]], [[RGB24]]
| [http://www.avisynth.nl/users/vcmohan/FanFilter/FanFilter.zip 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] and See [http://forum.doom9.org/showthread.php?p=1673928] for mod version.
| [[YV12]]
| Script
| thetoof
|-
| [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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=158230 Script]
| jmac698
|-
| [[FDecimate]]
| The FDecimate() filter provides extended decimation capabilities not available from 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]]
| [[FDecimate|Plugin]]
| {{Author/Donald Graft}}
|-
| [[FDecimate2]]
| FDecimate2 is based on FDecimate v1.0.2. FDecimate2, fixes some problems with bugged metrics in FDecimate v1.0.2.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FDecimate2|Plugin]]
| {{Author/StainlessS}}
|-
| [[IT]]
| Inverse Telecine plugin.
| [[YUY2]], [[YV12]]
| [[IT|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[IVTC_txt60mc|ivtc_txt60mc]]
| Deinterlaces telecined footage with that has been overlayed scrolling text at 60i.
| [[YV12]]
| [[IVTC_txt60mc|Script]]
| {{Author/cretindesalpes}}
|-
|JIVTC
|JIVTC applies inverse telecine in a way to minimize artifacts often seen on Japanese TV broadcasts followed by recalculating the fields that might still contain some.
|[[YV12]]
|[http://raw.githubusercontent.com/lovesyk/avisynth-scripts/master/JIVTC.avsi Script]
|[http://github.com/lovesyk lovesyk]
|-
|[[MDec2]]
|MDec2 is a 2 pass decimating filter, acting much like the MultiDecimate filter.
|[[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[MDec2|Plugin]]
|StainlessS
|-
| 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]]
| [{{N2Moved}}/multidecimate/multidecimate.html Plugin]
| {{Author/Donald Graft}}
|-
| RePal
| [http://forum.doom9.org/showthread.php?t=48401 Discussion] / [http://forum.doom9.org/showthread.php?p=1092552#post1092552 repal_29.97Hz_mod]
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/repal_5F25_dll_20030523.zip Plugin] - [http://forum.doom9.org/attachment.php?attachmentid=8028&d=1201414683 Mod]
| Bach
|-
| [[Decomb]]
| The Telecide and Decimate filters can be combined to implement IVTC.
| [[YUY2]], [[YV12]]
| [[Decomb|Plugin]]
| {{Author/Donald Graft}}
|-
|[https://forum.doom9.org/showthread.php?t=182369 TelecineBob]
|If your source soffers from field blending, as long as no deinterlacing is made you will find out that conveniently the blended fields are often paired with a clean one. FieldDeBlend takes advantage of that and checks for frames whose fields don't match to replace the frame with a clean one as long there is one.
|[[YV12]]
|[https://www.mediafire.com/file/sa1oae96m63mkje/TelecineBob.zip/file Plugin]
|Ceppo
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[TIVTC|Plugin]]
| {{Author/tritical}}
|-
| TPRIVTC
| TPRIVTC stands for TMPEG InVerse Telecine, i.e. the process where an 29.97fps interlaced NTSC clip is converted to 23.976fps while removing interlaced frames. [http://web.archive.org/web/20030808191810/http://kurosu.inforezo.org/avs/TPRIVTC/index.html Readme]
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/tprivtc_5F25_dll_20040930.zip Plugin]
| daxab, {{Author/Kurosu}}
|-
| [http://forum.doom9.org/showthread.php?t=167875 WeaveMan]
| Remove arbitrary pulldown patterns manually; meant for perfectionists to undo non-standard 24->25 fps, 25->29.97 fps, etc. telecine conversions, along with other weird telecine anomalies created by broadcasters speeding up film-sourced content. See sample case [http://forum.doom9.org/showthread.php?p=1630931&highlight=weaveman#post1630931 here].
| [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20131208232913/http://chidragon.thedessie.com/Doom9/WeaveMan-v0.2.zip Plugin]
| ChiDragon
|-
| [[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
| FixVHSOversharp attempts to repair the light and dark halos that follow high contrast edges found in VHS sources. See [http://web.archive.org/web/20131014010552/http://www.videohelp.eu/forum/avisynth/2851-avisynth-fixvhsoversharp-beta.html discussion.]
| | [[YUY2]]
| [http://web.archive.org/web/20091026142456/http://www.geocities.com/mrtibsvideo/fixvhsoversharp.html Plugin]
| [http://web.archive.org/web/20091027001215/http://geocities.com/mrtibsvideo/ MrTibs]
|-
| [[GhostBuster|Ghostbuster]]
| A filter for the removal of ghosting.
| [[YUY2]]
| [[GhostBuster|Plugin]]
| {{Author/SansGrip}}
|-
| [[LGhost]]
| Plugin intended for ghost removal but can also reduce edge (ringing) artifacts.
| [[YV12]], [[YUY2]]
| [[LGhost|Plugin]]
| {{Author/minamina}}
|-
| [[vsLGhost]]
| Luminance Ghost reduction filter. Can be used for removing luminance ghost or edge ghost (ringing).
| All [[Planar]] colorspaces (8-32bit)
| [[vsLGhost|Plugin]]
| {{Author/Asd-g}}
|}

=== Logo Removal ===

{{FilterTable}}
| [[AvsInpaint]]
| This plugin comes with the intention to provide a suit for the removal of logos, whether opaque or transparent. It provides algorithms for these tasks: logo detection, deblending, and logo inpainting.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[AvsInpaint|C-Plugin]]
| AMSS0815, {{Author/pinterf}}
|-
| [[DeKafka]]
| This fairly simple filter washes away those annoying bugs from broadcast clips.
| Any
| Script
| poptone
|-
| 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.
| [[RGB32]]
| [{{N2Moved}}/delogo132/delogo.html Plugin] & [http://forum.doom9.org/showthread.php?t=119447 Script]
| Karel Suhajda
|-
|[[DelogoHD]]
|DelogoHD is an overhaul of the original delogo filter, which was originally written by MakKi many years ago.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], <br> 8-16bit planar YUV
|[[DelogoHD|Plugin]]
|MeteorRain
|-
| [https://forum.doom9.org/showthread.php?t=184881 DoomDelogo]
| DoomDelogo meant to be simpler and perform better than deKafka, s_ExLogo, x-Logo and similar.
| Any
| [https://forum.doom9.org/showthread.php?t=184881 Script]
| VoodooFX
|-
| [[ExInpaint]]
| Exemplar-Based Image Inpainting. See [http://forum.doom9.org/showthread.php?t=133773 discussion]
| [[RGB24]] [[RGB32]], [[YUY2]], [[YV12]]
| [[ExInpaint|Plugin]]
| {{Author/Fizick}}
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|InpaintDelogo is an advanced logo and watermark removal function using inpainting and deblending with an adjustable fine process to hide artifacts and get best delogo results.
Can remove opaque, transparent, semi-transparent and some dynamic logos from video.
Can be used to remove hardcoded subtitles or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
| [[InpaintFunc]]
| Script for logo removal using inpainting. Can remove alpha blended or opaque logos with a basic postprocessing to hide artifacts.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[InpaintFunc|Script]]
| Reuf Toc
|-
| LogoNR
| Post-denoise filter for EraseLogo or [[DelogoHD]]. See [https://web.archive.org/web/20210915185704/https://www.nmm-hd.org/newbbs/viewtopic.php?t=649 discussion]
| All [[planar]] colorspaces
| [https://web.archive.org/web/20220702130736/https://pastebin.com/raw/qZBU3NQA Script]
| {{Author/06_taro}}
|-
| [[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]
| [[YV12]]
| [http://avisynth.nl/images/Rm_logo.avs Script]
| Spuds
|-
|[http://forum.doom9.org/showthread.php?t=154559 s_ExLogo]
|De-logo function with clipping (Dekafka mod).
|[[YUY2]]
|[http://www.mediafire.com/download/40cpnnctd0uutpv/s_ExLogo_1.1.zip Script]
|{{Author/StainlessS}}
|-
| [[Uglarm]]
| Filter for blurring a logo, using LogoAway style Uglarm Interpolation method.
| [[RGB24]] [[RGB32]],[[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[Uglarm|Plugin]]
| {{Author/StainlessS}}
|-
| [[X-Logo]]
| X-Logo AviSynth plugin and VirtualDub filter. Removes opaque logos.
| [[RGB32]], [[YUY2]], [[YV12]]
| [[X-Logo|Plugin]]
| [http://web.archive.org/web/20041204210505/http://members.verizon.net/~vze3kkvm/filters.html Leuf]
|}

=== Luma Equalization ===

{{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://www.avisynth.nl/users/warpenterprises/files/antiflicker_5F25_dll_20030304.zip Plugin]
| {{Author/Donald Graft}}
|-
| [[DeFlicker]]
| Can remove old film intensity flicker by temporal mean luma smoothing. Can also correct blinding of automatic gain control after flashes.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]]
| [[DeFlicker|Plugin]]
| {{Author/Fizick}}, {{Author/pinterf}}
|-
| [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}}
|-
| [[EquLines]]
| Equalizes total luminosity in pairs of even and odd lines. Useful for removing inter-line differences from telecined films.
| [[YV12]], [[YUY2]]
| [[EquLines|Plugin]]
| {{Author/Fizick}}
|-
| [[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]]
| [[LMFlicker|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
|-
| [[ReduceFlicker]]
| Plugin to reduce temporal oscillations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[ReduceFlicker|Plugin]]
| {{Author/kassandro}}, {{Author/Chikuzen}}
|-
| [[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.
| [[YV12]], [[YUY2]]
| [[TimeLapseDF|Plugin]]
| {{Author/Denis Zhitenev}}
|-
| [[Vinverse]]
| A simple but effective plugin to remove residual combing.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bit planar Y/YUV
| [[Vinverse|Plugin]]
| {{Author/Didée}}, {{Author/tritical}}, {{Author/tp7}}
|-
| [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
|}

=== [[:Category:Rainbow & Dot Crawl Removal|Rainbow & Dot Crawl Removal]] ===

{{FilterTable}}
| [[Bifrost]]
| Bifrost uses temporal blending to remove or at least reduce the effect of rainbows.
| [[YV12]]
| [[Bifrost|Plugin]]
| {{Author/Myrsloik}}, dubhater
|-
| [[CC]]
| Dot crawl and rainbow removal.
| [[YV12]], [[YUY2]]
| [http://www.chiyoclone.net/dl/cc_20040522.lzh Plugin]
| {{Author/chiyo-clone}}
|-
| [[Checkmate]]
| Spatial-temporal dot crawl removal.
| [[YV12]]
| [[Checkmate|Plugin]]
| {{Author/mf}} / prunedtree
|-
| [[ChubbyRain]]
| Spatial-temporal rainbow reducing script.
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain.avsi Script]
| Mug Funky
|-
| [[ChubbyRain2]]
| Spatial-temporal rainbow reducing script based on [[ChubbyRain]].
| [[YV12]]
| [http://avisynth.nl/images/ChubbyRain2.avsi Script]
| Lothar
|-
| [[DDCR]]
| A purely spatial dot crawl removal script for AviSynth+.
| all 8 bit Y/YUV colorspaces
| [[DDCR|Script]]
| Reel.Deal
|-
| [[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]]
| [[DeCross|Plugin]]
| {{Author/minamina}}
|-
| [[DeDot]]
| Removes dot crawl and may also be useful for rainbows.
| all planar Y, YUV, and YUVA (8-16 bit)
| [[DeDot|Plugin]]
| {{Author/thejam79}} / {{Author/minamina}}
|-
| [[DeRainbow]]
| A simple script to reduce rainbows. See [http://forum.doom9.org/showthread.php?p=398106#post398106 discussion.]
| [[YV12]], [[YUY2]]
| [http://avisynth.nl/images/DeRainbow.avsi 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]]
| [http://avisynth.nl/images/DFMDeRainbow-20140223.avsi Script]
| {{Author/Scintilla}}
|-
|[[DotKill]]
|Spatio-temporal dotcrawl and rainbow remover.
|[[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-16bits
|[[DotKill|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=170328 FadeDeRainbow]
|Another de-rainbowing script.
|[[YV12]]
|[https://forum.doom9.org/showthread.php?t=170328 Script]
|bxyhxyh
|-
| [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 spatial; only targets pixels for dot crawl removal if luma is fluctuating and (optionally) chroma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/http://www.aquilinestudios.org/scripts/LUTDeCrawl-20081003.avsi Script]
| {{Author/Scintilla}}
|-
| [[LUTDeRainbow]]
| Purely spatial; only targets pixels for derainbowing if chroma is fluctuating and (optionally) luma is not.
| [[YV12]]
| [http://web.archive.org/web/20140421001939/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.
| [[YV12]]
| [http://avisynth.nl/images/MfRainbow-v0.32.avsi Script]
| {{Author/mf}}
|-
| [[Rainbow_Smooth]]
| A small spatial derainbow function. It uses [[SmoothUV]] to smooth out chroma and edge masking to prevent color bleeding.
| [[YV12]]
| [http://avisynth.nl/images/Rainbow_smooth.avsi 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.
| [[YV12]]
| [http://avisynth.nl/images/SmartSSIQ.avsi 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}}
|-
| [[TComb]]
| A temporal comb filter (it reduces cross-luminance (rainbowing) and cross-chrominance (dot crawl) artifacts in static areas of the picture).
| [[YV12]], [[YUY2]]
| [[TComb|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]]
| [[YARK|Script]]
| jase99
|-
| [[ASTDR]]
| ASTDR uses mt_motion for motion and edge to deal with moving Rainbow and apply mask once more in the opposite way to keep around the lines as they are. It uses DeCross and other filters to remove Rainbow. ASTDRmc avoids chroma bleeding in moving scenes. See [http://forum.doom9.org/showpost.php?p=1665492&postcount=27 post on doom9.org].
| [[YV12]]
| [[ASTDR|Script]]
| AmjadSONY
|}

=== Stabilization ===

{{FilterTable}}
| [[CelStabilize]]
| Script which holds a fixed background steady. Doesn't work well with pans or fades.
| [[YV12]]
| [http://avisynth.nl/index.php/CelStabilize Script]
| mg262
|-
| [[DePan]]
| Tools for estimation and compensation of global motion (pan).
| [[YUY2]], [[YV12]]
| [[DePan|Plugin]]
| {{Author/Fizick}}
|-
|[[Depansafe]]
|Another DePan stabilization script.
|[[YV12]]
|[[DepanSafe|Script]]
|[http://pastebin.com/u/tophf tophf]
|-
| [[Deshaker3D]]
| Experimental 3D image stabilizer (VDub [http://www.guthspot.se/video/deshaker.htm Deshaker] required).
| [[RGB32]]
| [[Deshaker3D|Plugin]]
| {{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=172136 SpatialAlign]
|Fix spatial alignment between two clips containing similar scenes.
|Any?
|[http://forum.doom9.org/showthread.php?t=172136 Script]
|StainlessS
|-
|[https://github.com/arnean/PerfPan PerfPan]
|PerfPan is an AviSynth plugin to stabilize scanned film using perforation as a reference.
|All colorspaces
|[https://github.com/arnean/PerfPan/tree/master/windows Plugin]
|[https://github.com/arnean arnean]
|-
| [[Stab]]
| Simple but powerful script to remove small high frequency jitter that appears often on old/bad transfers.
| [[YV12]]
| [[Stab|Script]]
| g-force
|-
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Stabilization Tools Pack]
| A set of tools to work with common stabilization issues, mainly from telecine process.
|[[YV12]]
|[http://forum.videohelp.com/threads/371336-Stabilization-Tools-Pack-v1-8 Script]
|{{Author/Dogway}}
|-
|[https://forum.doom9.org/showthread.php?t=182532 Stab_Light]
|Another stabilization script; based on Stab3.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]]
|Script
|Arx1meD
|-
| [http://web.archive.org/web/20151223052321/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)
| [[YV12]]
| [http://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|}

== Denoisers ==
Strength/Quality of Denoisers

(need subclassification)

{{FilterTable}}
| [[AdaptiveMedian]]
| This is an adaptive Median Filter for eliminating certain types of noise. It uses local statistics (minimum, maximum and median values) of a moving local grid, and changes grid size depending on local statistics.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AdaptiveMedian|Plugin]]
|{{Author/vcmohan}}
|-
|[[Deathray]]
|OpenCL GPU accelerated spatial/temporal non-local means de-noising.
|[[YV12]]
|[[Deathray|Plugin]]
|[http://github.com/JawedAshraf Jawed]
|-
| [[DeNoise]]
| This is an adaptive local noise reduction filter. It uses global variance of the noise, local mean and local variance in a moving grid of specified size. It tries to preserve edges as closely as possible. The global variance value can be specified or it can be computed from a window. The global variance can have one value for the entire clip or can vary frame to frame linearly or computed from a window with its coordinates linearly moving with frame numbers.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[DeNoise|Plugin]]
| {{Author/vcmohan}}
|-
| [http://web.archive.org/web/20071105084352/http://www.geocities.com/fredthompson6/Kiraru2002/Kiraru2002sROOM.htm#dnr2 DNR2]
| Dynamic Noise Reduction 2 is based on the VirtualDub [http://www.shdon.com/vid/dnr DNR] filter by Steve Don and Avery Lee.
| [[RGB32]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/dnr2_5F25_dll_20021225.zip Plugin]
| {{Author/kiraru2002}}
|-
| [[DeSaltPepper]]
| Remove white and black noise.
| Any
| [[DeSaltPepper|Plugin]]
| {{Author/vcmohan}}
|-
| [[FFTQuiver]]
| Remove periodic noise. Useful for analog interference.
| [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[FFTQuiver|Plugin]]
| {{Author/vcmohan}}
|-
| [[TNLMeans]]
| TNLMeans is an implementation of the NL-means denoising algorithm.
*[http://forum.doom9.org/showthread.php?t=171817 TfNLMeans] - an AviSynth 2.6 fork of TNLMeans 1.0.3
| [[YV12]], [[YUY2]]
| [[TNLMeans|Plugin]]
| {{Author/tritical}}
|-
| [[KNLMeansCL]]
| KNLMeans is an optimized OpenCL implementation of the Non-local means denoising algorithm.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[KNLMeansCL|Plugin]]
| [http://github.com/Khanattila Khanattila]
|-
|[http://forum.doom9.org/showthread.php?t=172966 xNLMeans]
|xNLMeans is an AviSynth plugin implementation of the Non Local Means denoising proposition. This implementation provides several optimizations and extensions over the original proposition and other implementations.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/4stpv24pvpfclzm/xNLMeans_0.03_20160324.zip Plugin] 
|martin53
|}

=== 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 [{{N2Moved}}/2dcleaner.html 2D Cleaner.]
| [[YV12]], [[YUY2]]
| [[_2DCleanYUY2|Plugin]]
| {{Author/kiraru2002}}, {{Author/xeon533}}
|-
| [[DctFilter]]
| An experimental filter that operates on DCT coefficients.
| [[YV12]], [[YUY2]]
| [[DctFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[frfun7]]
| Fractal denoising. See [http://forum.doom9.org/showthread.php?t=110200 discussion]
| [[YV12]]
| [[Frfun7|Plugin]]
| prunedtree
|-
| [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
|-
|Kuwahara
|This filter is an edge preserving spatial noise reduction filter. It applies spatial smoothing while preserving the edges. See [http://forum.doom9.org/showthread.php?p=1689773 discussion]
|[[RGB24]], [[RGB32]]
|[http://www.wilbertdijkhof.com/Kuwahara_v11.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
|[[MiniDeen]]
|MiniDeen is a spatial denoising filter. It replaces every pixel with the average of its neighbourhood. This is a port of the "a2d" method from the AviSynth plugin [[Deen]], version beta 2.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[MiniDeen|Plugin]]
|{{Author/dubhater}} / MeteorRain
|-
|[[Neo_VagueDenoiser]]
|Wavelet based Denoiser. Refactored version of the original VagueDenoiser; includes optimizations, additional colorspaces, and high bit depth support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar YUV in AviSynth+
|[[Neo_VagueDenoiser|Plugin]]
| HolyWu, [https://github.com/msg7086 MeteorRain]
|-
|[[sbr]]
|sbr is helper function to make a highpass on a blur's difference.
|All YUV [[planar]] 8 to 16-bit colorspaces
|[[sbr|Plugin]]
|{{Author/Asd-g}}
|-
| [[SmoothUV2]]
| SmoothUV2 is a spatial derainbow filter. This filter performs structure-preserving smoothing (blurring) on the U/V (chrominance or colour) information of the image, leaving Y (luminance) intact.
| All YUV, YUVA [[planar]] 8 to 16-bit colorspaces
| [[SmoothUV2|Plugin]]
| {{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[SPresso]]
|A fast script to make SD content compress better while keeping the "original look".
|[[YV12]]
|[[SPresso|Script]]
|{{Author/Didée}}
|-
| [[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]]
| [[TBilateral|Plugin]]
| {{Author/tritical}}
|-
| [[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.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[VagueDenoiser|Plugin]]
| {{Author/Lefungus}}, {{Author/Kurosu}}, {{Author/Fizick}}
|-
|[[vsMSmooth]]
|vsMSmooth is a spatial smoother that doesn't touch edges.
||[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSmooth|Plugin]]
|{{Author/dubhater}}, {{Author/Asd-g}}
|-
|[[vsTBilateral]]
|vsTBilateral is a spatial smoothing filter that uses the bilateral filtering algorithm.
|All [[planar]] 8 to 16-bit colorspaces
|[[vsTBilateral |Plugin]]
|{{Author/Asd-g}}
|}

=== Temporal Denoisers ===

{{FilterTable}}
| [[Cnr2]]
| A fast chroma denoiser. Very effective against stationary rainbows and huge analogic chroma activity. Useful to filter VHS/TV caps.
| [[YV12]], [[YUY2]]
| [[Cnr2|Plugin]]
| {{Author/Marc FD}}, {{Author/tritical}}
|-
| [[FluxSmooth]]
| Examines each pixel and compares it to the corresponding pixel in the previous and last frame.
| [[YV12]], [[YUY2]]
| [[FluxSmooth|Plugin]]
| {{Author/SansGrip}}, {{Author/Sh0dan}}
|-
| MDegrain
| Strong and effective temporal denoiser. Part of the [[MVTools]] package.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| [[TTempSmooth]]
| TTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TTempSmoothv094.zip Plugin]
| {{Author/tritical}}
|-
| [[Temporal Degrain]]
| SLOW but very effective at removing most grain from video sources.
| [[YV12]]
| [http://avisynth.nl/images/TemporalDegrain.avs Script]
| Didée, Sagekilla
|-
| [[TemporalDegrain2]]
| Temporal Degrain enhanced with parts of QTGMC, potentially slower but more effective at removing grain from video sources while retaining more details.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]] (8-16 bit)
| [[TemporalDegrain2|Script]]
| Didée, Sagekilla, Vit, real.finder, ErazorTT
|-
|[[vsCnr2]]
|vsCnr2 is a temporal denoiser designed to denoise only the chroma.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-16 bit)
|[[vsCnr2|Plugin]]
|{{Author/Asd-g}}
|-
|[[vsTTempSmooth]]
|vsTTempSmooth is a motion adaptive (it only works on stationary parts of the picture), temporal smoothing filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV, and YUVA (8-32 bit)
|[[vsTTempSmooth|Plugin]]
|HolyWu, {{Author/Asd-g}}
|}

=== Spatio-Temporal Denoisers ===

{{FilterTable}}
|[[BM3DCUDA]]
|BM3D denoising filter for AviSynth+, implemented in CUDA.
|32-bit [[planar]] colorspaces
|[[BM3DCUDA|Plugin]]
|[https://github.com/WolframRhodium WolframRhodium]
|-
| [[Convolution3D]]
| Convolution3D is a spatio-temporal smoother, it applies a 3D convolution filter to all pixels of consecutive frames.
| [[YV12]]
| [[Convolution3D|Plugin]]
| {{Author/Vlad59}}
|-
| [[Deen]]
| Deen is a set of assembly-optimised denoisers, like various 3d and 2d convolutions.
| [[YV12]]
| [[Deen|Plugin]]
| {{Author/Marc FD}}
|-
| 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].
| [[YV12]]
| [https://web.archive.org/web/20160604213634/http://forum.doom9.org/showthread.php?t=162603 Script]
| rean
|-
| [[dfttest]]
| A 2D/3D frequency domain denoiser.
| [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
| [[dfttest|Plugin]]
| {{Author/tritical}}
|-
| dfttestMC
| A script that motion compensates dfttest. See [http://forum.doom9.org/showthread.php?t=147676 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=147676 Script]
| thewebchat
|-
| [[DeGrainMedian]]
| Two stage Spatio-Temporal Limited Median filter for grain removal.
| [[YV12]], [[YUY2]]
| [[DeGrainMedian|Plugin]]
| {{Author/Fizick}}
|-
| [[FFT3DFilter]]
| A 3D Frequency Domain filter - gives strong denoising and moderate sharpening.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], any Y, YUV and Planar RGB 8-32 bit
| [[FFT3DFilter|Plugin]]
| {{Author/Fizick}}, martin53, {{Author/pinterf}}
|-
| [[FFT3DGPU]]
| Similar algorithm to FFT3DFilter, but uses graphics hardware for increased speed.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[YUY2]], Planar RGB 8 bit
| [[FFT3DGPU|Plugin]]
| {{Author/tsp}}, {{Author/pinterf}}
|-
| [[hqdn3d]]
| High Quality DeNoise 3D is an Avisynth 2.5 port of the MPlayer filter of the same name. It performs a 3-way low-pass filter, which can completely remove high-frequency noise while minimizing blending artifacts.
| 8-16bit planar YUV
| [[hqdn3d|Plugin]]
| {{Author/akupenguin}}
|-
|[https://forum.doom9.org/showthread.php?t=174804 mclean]
|Typical spatial filters work by removing large variations in the image on a small scale, reducing noise but also making the image less sharp or temporally stable. mClean removes noise whilst retaining as much detail as possible, as well as provide optional image enhancement.
|[[YV12]], [[HBD]]
|[https://forum.doom9.org/showthread.php?t=174804 Script]
|burfadel
|-
| [[MC_Spuds]]
| Motion compensated noise removal with sharpening. Extremely slow, but extremely effective.
| [[YV12]]
| [[MC_Spuds|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]]
| [[MCTemporalDenoise|Script]]
| {{Author/LaTo}}
|-
| RemoveDirtMC
| See [http://forum.doom9.org/showthread.php?p=1485300#post1485300 discussion].
| [[YV12]]
| [https://github.com/realfinder/AVS-Stuff/raw/master/avs%202.5%20and%20up/RemoveDirtMC_SE.avsi Script]
| Nephilis/A.SONY
|-
| [[RemoveGrainHD]]
| RemoveGrainHD is like RemoveGrain but intended for high definition content. It includes various spatial and temporal functions. See [http://web.archive.org/web/20130412014246/http://www.removegrainhd.de.tf/ documentation.]
| [[YV12]], [[YUY2]]
| [[RemoveGrainHD|Plugin]]
| {{Author/kassandro}}
|-
|-
| 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.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=110078 Script]
| Heini011
|-
| [[RgTools]]
| Modern rewrite of <tt>[[RgTools/RemoveGrain|RemoveGrain]]</tt>, <tt>[[RgTools/Repair|Repair]]</tt>, <tt>[[RgTools/BackwardClense|BackwardClense]]</tt>, <tt>[[RgTools/Clense|Clense]]</tt>, <tt>[[RgTools/ForwardClense|ForwardClense]]</tt> and <tt>[[RgTools/VerticalCleaner| VerticalCleaner]]</tt> all in a single plugin.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[RgTools|Plugin]]
| {{Author/tp7}}, {{Author/pinterf}}
|-
|[[SMDegrain]]
|SMDegrain is a convenience function for using MDegrain, including 16bit and interlaced support, with extra capabilities for light sharpening and spatial filtering.
| [[YUY2]], [[YV12]]
|[[SMDegrain|Script]]
|{{Author/Dogway}}
|-
|[[STPresso]]
|A fast script to make SD/720p content compress better without losing detail and original grain structure.
|[[YV12]]
|[[STPresso|Script]]
|{{Author/Didée}}
|-
|[[vsDeGrainMedian]]
|vsDeGrainMedian is a spatio-temporal limited median denoiser.
|All [[planar]] 8 to 16bit colorspaces
|[[vsDeGrainMedian|Plugin]]
|{{Author/Asd-g}}
|-
| 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 ==

=== Averaging/Layering/Masking ===

{{FilterTable}}
| [[Average]]
| A simple plugin that calculates weighted frame-by-frame average from multiple clips.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Average|Plugin]]
| {{Author/tp7}}, {{Author/mg262}}
|-
|[[AviSynthGimpLayer]]
|AviSynth Gimp-style Layer merge plugin.
|[[RGB24]], [[RGB32]]
|[[AviSynthGimpLayer|Plugin]]
| [http://sourceforge.net/u/panzerboy66/profile/ panzerboy66]
|-
|[[AVS_SoftLight]]
|AviSynth+ plugin. It makes a softlight blend with a negative of average. Only x64 version available and with CUDA support.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AVS_SoftLight|Plugin]]
|Argaricolm
|-
| BlockAverage
| A simple filter that just averages the Y values of each 2x2 pixel block in a YV12 image – U and V values are left alone as they already common to each 2x2 block in a progressive YV12 image. Just made to see if it satisfies the requirements in [http://forum.doom9.org/showthread.php?s=&threadid=91580&perpage=10&pagenumber=1 this thread].
| [[YV12]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/blockaverage01.zip Plugin]
| {{Author/Simon Walters}}
|-
|CheckMask
|A YV12 spatial dot finding filter for AviSynth.
|[[YV12]]
|[http://www.avisynth.nl/users/warpenterprises/files/checkmask_5F25_dll_20050310.zip Plugin]
|[http://web.archive.org/web/20090618112048/http://kawaii-shoujo.net/AntiAliased/index.html Dan Donovan]
|-
|[[ClipBlend]]
|Filter to blend consecutive frames in a clip.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[ClipBlend|Plugin]]
|StainlessS
|-
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe.html ColorKeyFrame]
| Linear interpolation of color correction with key frames.
| [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/fizick/colorkeyframe/colorkeyframe03.zip Plugin]
| {{Author/Fizick}}
|-
|[[ColorScreenMask]]
|ColorScreenMask is a special effects plugin for processing chroma key (i.e., a green screen or blue screen) backgrounds. It uses color thresholds rather than absolute values as the criteria for setting the alpha channel transparency.
|[[RGB32]]
|[[ColorScreenMask|Plugin]]
|Grandpa Oddball
|-
|[[ColourMask]]
|Creates colour masks.
|[[YV12]]
|[[ColourMask|Plugin]]
|{{Author/mg262}}
|-
|[[CombMask]]
|A filter to create and process comb masks. These filters were written from scratch, but most of logic comes from tritical's [[TIVTC]] plugin.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CombMask|Plugin]]
|{{Author/Chikuzen}}
|-
|[[Fusion]]
|Pyramidal image processing for video, it uses image pyramids to blend clips together (more commonly used in the creation of HDR images and image stitching).
|[[RGB32]]
|[[Fusion|Plugin]]
|{{Author/David Horman}}
|-
| [[GraMaMa]]
| Gradient Mask Maker: Creates a mask (either a gradient or black/white) given a prescribed shape (such as circle, ellipse, line, square or rectangle).
| [[YV12]]
| [[GraMaMa|Plugin]]
| {{author/E-Male}},
{{author/Wilbert Dijkhof}}
|-
|[http://umezawa.dyndns.info/archive/imck/imck-2.3.0-readme.html ImasMultiColorKeying]
|Chroma keying filter (Japanese)
|[[RGB32]]
|[http://umezawa.dyndns.info/archive/imck/ Plugin]
|Umezawa Takeshi
|-
|MaskCrop
|Non-clip plugin and function to speed up filtering with a mask.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://www.dropbox.com/s/8c4rxlwbs020ib1/MaskCrop0.1.2.7z?dl=1 Plugin] 
|
|-
|[http://forum.videohelp.com/threads/369143-ResizersPack-MasksPack-PlaygroundPack-SmoothContrast-Logo-mod-functions?s=7811fcf9c429ffb99f2e0a4b8043832d&p=2364052&viewfull=1#post2364052 MasksPack]
|This is a set of functions related to masks, so localized filtering will be able, giving you finer control on how and where to filter or protect certain zones.
|[[YV12]]
|[http://www.mediafire.com/download/mch99c0z5957u9z/MasksPack2.3.zip Script]
|{{Author/Dogway}}
|-
|[[Median]]
|A filter plugin for AviSynth which generates a pixel-by-pixel median of several clips. This is particularly useful for filtering out noise and glitches from multiple VHS/SVHS/8mm/Hi8 tape captures, but can be used for other purposes also.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[Median|Plugin]]
|{{Author/ajk}}
|-
|[[MTCombMask]]
|This filter produces a mask showing areas that are combed, it uses 3-point sampling to determine combing in a pixel.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8-32bit planar Y/YUV/YUVA
|[[MTCombMask|Plugin]]
|{{Author/Manao}}, [https://github.com/Asd-g Asd-g]
|-
|[[OverlayPlus]]
|Layering scrip similar to AviSynth's internal Overlay but includes more blending modes and some additional features.
|All 8-32bit colorspaces
|[[OverlayPlus|Script]]
|reel.deel
|-
| ParameterisedBlend
| ParameterisedBlend allows you to blend any number of frames within a clip, or blend any number of different clips together. You can use it as an extended, gamma-aware replacement for Merge().
| [[YV12]]
| [https://web.archive.org/web/20201020085042/https://sites.google.com/site/ourenthusiasmsasham/soft#TOC-ParameterisedBlendd Plugin]
| [https://web.archive.org/web/20201020085035/https://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
|[http://forum.doom9.org/showthread.php?t=172388 Polygon]
|The very raw beginning of a plugin for drawing high quality polygons (mainly to be used as masks) in AviSynth.
| [[RGB32]]
| [http://forum.doom9.org/showthread.php?t=172388 Plugin]
| {{Author/David Horman}}
|-
|[[RedAverage]]
|Frame-by-frame averaging/merging of multiple clips. Includes a masked average, weighted average, and a merge filter.
|[[YV12]]
|[[RedAverage|Plugin]]
|redfordxx
|-
|[http://github.com/jojje/shapemask ShapeMask]
|A filter plugin for AviSynth that identifies bright areas such as projector screens at conferences and creates a mask out of them. The use case for which it was created is to deal with overly bright lectures, such as screen casts or talks where the speaker or producer hasn't followed presentation 101; Use light text on a dark background! See [http://forum.doom9.org/showthread.php?t=172308 discussion.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20150702103042/http://snarl.zapto.org/files/ShapeMask-1.0.zip Plugin]
|[http://github.com/jojje jojje]
|-
|[[TColorMask]]
|A simple color masking plugin for AviSynth.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]], 8/16bit planar YUV
|[[TColorMask|Plugin]]
|{{Author/tp7}}
|-
|[[TCombMask]]
|TCombMask is a simple filter that creates a comb map that can (could) be used by other filters. It currently supports optional motion adaption, optional spatial adaption, optional luma <-> chroma linking, different thresholds for chroma and luma, and much more.
|[[YUY2]], [[YV12]]
|[[TCombMask|Plugin]]
|{{Author/tritical}}
|-
|[[TempLinearApproximate]]
|TempLinearApproximate takes several frames and for each pixel calculates linear approximation of its values through time, then returns its value in the middle (unless close to beginning or end of clip) of that line.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[TempLinearApproximate|Plugin]]
|Mystery Keeper
|-
|[[TMaskCleaner]]
|A really simple mask cleaning plugin for AviSynth based on mt_hysteresis.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[TMaskCleaner|Plugin]]
|{{Author/tp7}}
|-
| [[TMM]]
| TMM builds a motion-mask for TDeint, which TDeint uses via its 'emask' parameter.
| [[YUY2]], [[YV12]]
| [[TMM|Plugin]]
| {{Author/tritical}}
|-
| [[TMM2]]
| A rewrite of TMM
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[TMM2|Plugin]]
| {{Author/Chikuzen}}
|-
| [[Unpremultiply]]
| This plugin convert the input RGBA clip from premultiplied alpha to straight matted alpha.
| [[RGB32]]
| [[Unpremultiply|Plugin]]
| [http://web.archive.org/web/20160610124858/http://code.google.com/p/avisynth-unpremultiply/ Josh Sutinen]
|-
| [[uu_mt_blend]]
| ''Blend'' (''[[Overlay]], [[Layer]]'') two clips using [[MaskTools2|MaskTools]]. Wide selection of blend modes.
| [[YV12]],[[RGB24]],[[RGB32]]
| [[Media:UU_mt_blend.avs|Script]]
| rafriff42
|-
|[[Watermark2]]
|Creates a transparent deformation in the video akin to a watermark. The watermark is defined by a black and white image which may be a dynamic image. The intensity of the effect is controlled by several parameters.
|[[RGB32]]
|[[Watermark2|Plugin]]
|[http://sourceforge.net/u/phillvanleersum/profile/ DrPhill], {{Author/StainlessS}}
|-
| [[YRangeMask]]
| AviSynth script to create a mask by specifying the range of the brightness.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[YRangeMask|Script]]
| Chikuzen
|}

=== Blurring ===

{{FilterTable}}
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect BlurDetect]
|Determines blurriness of frames.
|All 8-16 bit [[planar]] formats.
|[https://github.com/Asd-g/AviSynthPlus-BlurDetect/releases Plugin]
|{{Author/Asd-g}}
|-
|[https://www.animemusicvideos.org/forum/viewtopic.php?t=101724 BlurMod/ApplyOnAngle]
|BlurMod() shrinks, blurs, then resizes; resulting in a very strong blur. ApplyonAngle() rotates, filters, then rotates back; making any filter appear as if applied on an angle.
|[[YV12]]
|Script
|Phantasmagoriat
|-
| [[BucketMedian]]
| BucketMedian is an implementation of spatial median filter adapting bucket (counting) sort algorithm.
| [[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[BucketMedian|Plugin]]
| {{Author/Chikuzen}}
|-
| [[FastBlur]]
| Fast approximate Gaussian blurs.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[FastBlur|Plugin]]
| {{Author/David Horman}}
|-
| [[GBlur]]
| Gaussian blur.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[GBlur|Plugin]]
| {{Author/vcmohan}}
|-
|[[MedianBlur]]
| A plugin with 5 different types of median blur filters.
| [[YV12]]
| [[MedianBlur|Plugin]]
| {{Author/tsp}}
|-
|[[MedianBlur2]]
| Implementation of [http://nomis80.org/ctmf.html constant time median filter] for AviSynth 2.6, similar to MedianBlur.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MedianBlur2|Plugin]]
| {{Author/tp7}}
|-
|[[neo_TMedian]]
|Temporal denoising filter that replaces every pixel with the median of its temporal neighbourhood.
|8-16 and 32-bit planar
|[[neo_TMedian|Plugin]]
|[https://github.com/msg7086 MeteorRain]
|-
| [[VariableBlur]]
| VariableBlur is a Gaussian, binomial or average blur filter with a variable radius (variance).
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]],
| [[VariableBlur|Plugin]]
| {{Author/tsp}}, {{Author/tritical}}
|-
| [[VariableMedian]]
| A simple median filter. See [http://forum.doom9.org/showthread.php?t=83985 discussion]
| [[RGB32]]
| [http://web.archive.org/web/20091027134543if_/http://www.geocities.com/siwalters_uk/variablemedian.zip Plugin]
| {{Author/Simon Walters}}
|}

=== Borders and Cropping ===

{{FilterTable}}
|[[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. See original [http://forum.doom9.org/showthread.php?t=37204 discussion] and updated AutoCrop [http://forum.doom9.org/showthread.php?t=87602 discussion]
| [[YUY2]], [[YV12]]
| [http://len0x.leffe.dnsalias.com/autocrop12.zip Plugin]
| [http://web.archive.org/web/20050404182221/http://www.videofringe.com/autocrop/ Glenn Bussell], len0x
|-
|[[BorderControl]]
| It's designed to allow you to manipulate the regions at the top, bottom and sides of a frame. Set a black border, set a border region to be faded out and you can "smear" the border to save having to crop and resize the whole frame for the sake of a few pixels. Each border (top,bottom.left and right) can be manipulated independently. See [http://forum.doom9.org/showthread.php?t=33479 discussion] and [http://avisynth.org.ru/docs/english/externalfilters/bordercontrol.htm documentation].
| [[YUY2]], [[YV12]]
|[http://web.archive.org/web/20140709005736/http://www.geocities.com/siwalters_uk/bordercontrol14.zip Plugin]
|{{Author/Simon Walters}}
|-
|[https://github.com/slavanap/ssifSource CropDetect]
| Plugin to detect black bounding box in video and crop it easily. See [http://forum.doom9.org/showthread.php?p=1761842#post1761842 discussion]. Note, CropDetect small plugin merged within ssifSource project. Look for "CropDetect" function in Sub3D.dll
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/releases plugin]
|[http://github.com/slavanap slavanap]
|-
|CropEven
|Script to crop evenly based on the dimensions given. It will crop the extra pixels off the bottom and right sides if the target resolution is odd. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1739589#post1739589 Script]
|Desbreko
|-
|[[EdgeFixer]]
|EdgeFixer repairs bright and dark line artifacts near the border of an image.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[EdgeFixer]]
|[https://github.com/sekrit-twc sekrit-twc]
|-
|[[FillBorders]]
|This is a simple filter that fills the borders of a clip, without changing the clip's dimensions.
|All [[planar]] colorspaces
|[[FillBorders]]
|[http://github.com/dubhater dubhater] / Asd
|-
|Padding
|Duplicate edge pixels to the outside with [[PointResize]]. See [http://forum.doom9.org/showthread.php?t=165946 discussion.]
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showpost.php?p=1596804&postcount=5 Script]
|{{Author/Didée}}
|-
|PadFFT
|A simple plugin to add borders evenly on each side. See [https://forum.doom9.org/showthread.php?p=1769503#post1769503 discussion]
|[[Y8]], [[YV12]]
|[https://web.archive.org/web/20221113033752if_/https://files.videohelp.com/u/223002/PaddFFT_dll_v0.02_20160604.zip Plugin]
|StainlessS
|-
|PadToMod
|Script to pad to a specified mod. See [https://forum.doom9.org/showthread.php?t=172577 discussion].
|All colorspaces
|[https://forum.doom9.org/showthread.php?p=1746579#post1746579 Script]
|Desbreko
|-
|[[RoboCrop]]
| RoboCrop is an automatic cropping solution to crop black borders from video clips, loosely based on (but using no code from) AutoCrop by Glenn Bussell. See [http://forum.doom9.org/showthread.php?t=168053 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
| [[RoboCrop|Plugin]]
| StainlessS
|}

=== Colourspace Conversion ===

{{FilterTable}}
|[https://forum.doom9.org/showthread.php?t=183453 ColorMatrixTransform]
|AviSynth+ plugin for applying a color matrix transform to 32 bit floating point clips.
|[[RGBPS]]
|[https://github.com/TomArrow/ColorMatrixTransform/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| 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
|-
|[https://forum.doom9.org/showthread.php?t=183990 LabConvert]
|AviSynth+ plugin to convert to LChab (derivative of LAB) color space and back for beautiful color manipulations.
|[[RGBPS]], [[YUV444PS]]
|[https://github.com/TomArrow/LabConvertAVS/releases/ Plugin]
|[https://github.com/TomArrow TomArrow]
|-
| ManualColorMatrix
| Can perform any matrix-based color conversion. See [http://forum.doom9.org/showthread.php?t=161777 discussion.]
| [[RGB24]], [[RGB32]], [[YV24]]
| [http://forum.doom9.org/attachment.php?attachmentid=12346&d=1309522614 Plugin]
| xv
|-
|[[nnedi3_resize16]]
|An advanced script for high quality 16-bit image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
|[[PlanarTools]]
|This plugin is a set of filters that offers converting packed(interleaved) formats to planar formats and vice versa.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV16]]
|[[PlanarTools|Plugin]]
|{{Author/Chikuzen}}
|-
|[[YV12To422]]
|YV12 to YV16/YUY2 converter for AviSynth 2.6.
|[[YV12]]
|[[YV12To422|Plugin]]
|{{Author/Chikuzen}}
|}

=== Effects ===

{{FilterTable}}
| [[AddGrainC]]
| 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
| [[RGB24]], [[RGB32]], [[YUY2]],
[[Y8]], [[YV411]], [[YV12]], [[YV16]], [[YV24]]
| [[AddGrainC|Plugin]]
|{{Author/Tom Barry}}, {{Author/Foxyshadis}}<br>
{{Author/LaTo}}, {{Author/cretindesalpes}}
|-
| AddStaticGrainM
| This function adds static grain in dark areas based on a mask.
| [[YV12]]
| [[AddStaticGrainM_source|Script]]
| [http://canihaziframe.wordpress.com/2011/02/23/addstaticgrainm/ Daiz]
|-
| [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://www.avisynth.nl/users/warpenterprises/files/blockbuster_5F25_src_20021229.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://www.avisynth.nl/users/warpenterprises/files/avishader_5F25_dll_20041228.zip Plugin]
| Antitorgo
|-
|[[AGM]]
|Uses an adaptive mask based on frame and pixels brightness to apply grain.
|All YUV [[planar]] colorspaces
|[[AGM|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=167217 Checker]
|Checkerboard combining filter.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://www.mediafire.com/?ewq8rc0aprzmk8r Plugin] /// [https://web.archive.org/web/20230206191644if_/https://files.videohelp.com/u/223002/checker.zip Archived]
|{{Author/Chikuzen}}
|-
|[https://forum.doom9.org/showthread.php?t=184052 ChickenDream]
|Realistic film-grain rendering for AviSynth+.
|[[Y32]], [[RGBPS]]
|[https://github.com/EleonoreMizo/chickendream/releases Plugin]
|{{Author/cretindesalpes}}
|-
| [[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]]
| [[ColorLooks|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
| [[crt_display]]
| CRT emulation with scanline and phosphor effects. crt_display emulates a CRT display using aperture grille (Trinitron) or Cromaclear technologies.
| [[RGB24]], [[RGB32]]
| [[crt_display|Script]]
|{{Author/cretindesalpes}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[EffectsMany|Plugin]]
| {{Author/vcmohan}}
|-
| [[EffectsPlus]]
| '''AviSynth+ only'''. Creates 26 types of special "animated" effects. Effects act on the input clip in the range of the frame numbers specified. The Audio is not affected.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[HBD]] colorspaces
| [[EffectsPlus|Plugin]]
| {{Author/vcmohan}}
|-
| [[f3kgrain]]
| Another 8/16-bit luma adaptive grain generator.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://web.archive.org/web/20131111114900/http://www.nmm-hd.org/upload/get~ElhZlazJbsQ/f3kgrain_v0.4.avsi Script]
| {{Author/06_taro}}
|-
| [[f3kgrainPlus]]
| Another 8/16-bit luma adaptive grain generator for AviSynth+.
| All 8-16 bit Y/YUV colorspaces, except YV411
| [[f3kgrainPlus|Script]]
| {{Author/06_taro}}
|-
|[[Fingerprint]]
|Video fingerprint filter.
|[[RGB32]]
|[[Fingerprint|Plugin]]
|{{Author/David Horman}}
|-
| [[GrainFactory3]]
| Noise generator that tries to simulate the behavior of silver grain on film. See [http://forum.doom9.org/showthread.php?t=141303 discussion.]
| [[YV12]]
| [[GrainFactory3|Script]]
| {{Author/Didée}}
|-
| [[GrainFactory3mod]]
| Luma adaptive grain generating filter in 8-bit precision. Based on Didée's [[GrainFactory3]] script.
| [[YV12]]
| [http://web.archive.org/web/20140722190952/http://www.nmm-hd.org/upload/get~kvNvGpuyxfc/GrainFactory3mod_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [[GrainFactoryLite]]
| Luma adaptive grain generating filter with stacked 16-bit input/output support. Based on Didée's [[GrainFactory3]] script, processing in 16-bit precision, and some commonly unused parameters removed.
| [[YV12]]
| [http://web.archive.org/web/20140722185917/http://www.nmm-hd.org/upload/get~FaqsQaMom9s/GrainFactoryLite_v1.2.avsi Script]
| {{Author/06_taro}}
|-
| [http://www.avisynth.nl/users/vcmohan/HollywoodSq/HollywoodSq.html HollywoodSQ]
| Creates popup album, akin to Hollywood squares TV show
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [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
|-
| [[Scanlines]]
| Add Scanlines (black horizontal bars) to a video. see [http://en.wikipedia.org/wiki/Scan_line wikipedia:Scan Line]
| [[YV12]]
| [http://avisynth.nl/users/warpenterprises/files/scanlines_5F25_dll_20031103.zip Plugin]
| turulo
|-
|[[ShufflessS]]
|Shuffle spacial columns or rows (1D), or blocks(2D) of frames, or temporal shuffle (frame order), all shuffles Inversable, ie undoable.
|[[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[HBD]] formats in AviSynth+
|[[ShufflessS|Plugin]]
|{{Author/StainlessS}}
|-
|[https://github.com/sorayuki/TawawaFilter TawawaFilter]
|An AviSynth plugin to make video in blue color.
|[[RGB24]]
|[https://github.com/sorayuki/TawawaFilter/releases/ Plugin]
|[https://github.com/sorayuki sorayuki]
|-
| [[TurnsTile]]
| Applies mosaic and/or palette effects to a clip.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[TurnsTile|Plugin]]
| {{Author/Robert Martens}}
|}

=== Field Order ===

{{FilterTable}}
| PFR
| Tries to restore the original progressive field order of a movie (or any predominantly filmed material transferred to video) where the field order changes at scene changes in a seemingly random fashion! See [http://forum.doom9.org/showthread.php?t=49815 discussion.]
| [[YV12]], [[YUY2]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/pfravs.html Plugin]
| {{Author/Simon Walters}}
|-
| ReverseFieldDominance
| This filter is intended to reverse the field dominance of [[PAL]] DV video. See [http://forum.doom9.org/showthread.php?t=46765 discussion.]
| [[YUY2]], [[RGB24]], [[RGB32]]
| [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/reversefielddominance.html Plugin]
| {{Author/Simon Walters}}
|}

=== 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.
| Any
| Script
| actionman133
|-
| [[convert60ito24p]]
| convert60ito24p converts a 60fps interlaced NTSC Video into a 24fps progressive Video using different blending techniques.
| [[RGB32]], [[RGB24]], [[YUY2]]
| Script
| scharfis_brain
|-
|[[FixFPS]]
|Fix the frames to a more consistent pattern with the help of Matroska Version 2 Timecodes. Mostly useful for fixing weird framerate from using a third party program to capture (ex. .kkapture with Mupen). Generally used with the plugin ExactDedup. It should be noted that FixFPS would try it's best not to lose any frames from the source. It does this by pushing frames to the next available spot, if possible, but it can cause side effects. See [http://tasvideos.org/forum/viewtopic.php?t=18914 discussion].
|Any
|[https://www.mediafire.com/?7bip52hu7v1pps2 Plugin]
|Aktan
|-
| [http://github.com/arkeet/fpsdown/blob/master/README.md 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]]
| [http://github.com/arkeet/fpsdown/blob/master/README.md Plugin]
| [http://github.com/arkeet/ arkeet]
|-
| [[FrameRateConverter]]
| FrameRateConverter uses motion interpolation with fine artifact removal.
| [[YV24]], [[YV16]], [[YV12]], [[Y8]]
| [[FrameRateConverter|Plugin]]
| [https://github.com/mysteryx93 MysteryX]
|-
| [http://www.spirton.com/uploads/InterFrame/InterFrame2.html InterFrame]
| Frame rate conversion script. Interframe works very well at converting 24FPS to 60FPS; converts videos to higher frame rates like newer TVs do. Common names are frame doubling, smooth motion, among others. See [http://forum.doom9.org/showthread.php?t=160226 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1486831&postcount=1 Script]
|{{Author/SubJunk}}
|-
|[[JohnFPS]]
|Frame Rate Converter based on the example from the MVTools documentation with some modifications. This script is also known as "jm_fps".
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[JohnFPS|Script]]
|johnmeyer, StainlessS
|-
| NTSC tools
| Automatic [[NTSC]] to [[PAL]] conversion with 24p, 30p, 60i detection. See [http://forum.doom9.org/showthread.php?t=114054 discussion].
| [[YV12]]
| [http://avisynth.nl/images/NTSC_tools.avsi Script]
| Mug Funky
|-
|[[RIFE]]
|Real-Time Intermediate Flow Estimation for Video Frame Interpolation.
|[[RGBPS]]
|[[RIFE|Plugin]]
|{{Author/Asd-g}}
|-
| [[SickJumps]]
| Speed ramping, aka time-remapping (smooth speed changes). Processes both video and audio.
| [[RGB]], [[YUV]]
| [[SickJumps|Plugin]]
| {{Author/Robert Martens}}
|-
| [[SVPflow]]
| SVPflow provides fast and high quality GPU accelerated frame rate interpolation.
| [[YV12]]
| [[SVPflow|Plugin]]
| [http://www.svp-team.com/wiki/Credits SVP Team]
|-
| [http://github.com/gnaggnoyil/tc2cfr tc2cfr]
| This plugin that can read a timecode file and convert a given video clip in to one with a constant framerate by adding duplicate frames. Note: only supports Matroska V1 timecodes.
| [[YV12]]
| [http://github.com/gnaggnoyil/tc2cfr/releases Plugin]
| [http://github.com/gnaggnoyil gnaggnoyil]
|-
| [[TimecodeFPS]]
| Converts clip from VFR to CFR. Timing information from clip is discarded, and matroska v2 timecodes from the timecodes file are used instead.
| Any
| [[TimecodeFPS|C-Plugin]]
| natt
|-
| [[VFRtoCFR]]
| Converts a variable frame rate (VFR) video to a constant frame rate (CFR) video with the help of Matroska Version 2 Timecodes.
| [[YV12]]
| [[VFRtoCFR|Plugin]]
| Aktan
|-
| [[VfrToCfr]]
| This plugin converts variable frame rate clips to constant frame rate by introducing null frames.
| [[YV12]]
| [[VfrToCfr|Plugin]]
| joyje
|-
|[[YFRC]]
| Yushko Frame Rate Converter - doubles the frame rate with strong artifact detection and scene change detection.
|[[YV12]]
|[http://avisynth.nl/images/YFRC-01dd-10mm-2015yyyy.avsi Script]
| Oleg Yushko
|}

=== Frame Replacement/Range Processing ===

{{FilterTable}}
|[[ApplyEvery]]
|A collection of AviSynth functions that operate at regular intervals in a clip.
|
|[[ApplyEvery|Plugin]]
|{{Author/stickboy}}
|-
|[http://www.avisynth.nl/users/fizick/badframes/badframes.html BadFrames]
|Replaces given bad frames by neighbors or blend (interpolation). Useful for frames with very large defects.
|
|[http://www.avisynth.nl/users/fizick/badframes/badframes20.zip Plugin]
|{{Author/Fizick}}
|-
|[[ClipClop]]
|Clipclop is a simple plugin to replace ranges in a source clip with the same range, from a replacement clip. Supports up to 255 replacement clips, with unlimited number of replacements into output clip.
|
|[[ClipClop|Plugin]]
|StainlessS
|-
|[[FrameRepeat]]
|FrameRepeat() is a simple plugin to select frames to repeat. Requires AviSynth 2.6.
|
|[[FrameRepeat|Plugin]]
|StainlessS
|-
|[[FrameSel|FrameSel/FrameRep]]
|FrameSel() is a simple plugin to select individual frames from a clip. Can select frames numbers by direct arguments to filter, or in a string, or in a command file.
|
|[[FrameSel|Plugin]]
|StainlessS
|-
|[http://forum.doom9.org/showthread.php?t=164766 MatchFrames/LocateFrames]
|MatchFrames, intended for matched frames extraction,LocateFrames, intended to be usable by other scripts to identify matches.
|
|[http://www.mediafire.com/folder/hb26mthbjz7z6/StainlessS Script]
|StainlessS
|-
|[[Prune]]
|Prune is a simple plugin to trim() multiple source clips and splice the results into a new clip. Supports up to 256 source clips, with unlimited number of trims/splices into output clip. Prune can fade Audio (to reduce clicks between splices) for supported audio formats. The plugin will do [[AlignedSplice]] only.
|
|[[Prune|Plugin]]
|StainlessS
|-
|[[RemapFrames]]
|A collection of functions to rearrange frames between clips. Remaps the frame indices in a clip or from a second clip as specified by an input text file or by an input string. Efficient alternatives to long chains of <tt>FreezeFrame, DeleteFrame, or ApplyRange</tt>.
|
|[[RemapFrames|Plugin]]
|{{Author/stickboy}}, {{Author/cretindesalpes}}
|-
|[https://github.com/TomArrow/SelectRangeEveryReversing SelectRangeEveryReversing]
|Modified version of the internal [[SelectRangeEvery]] filter, except every second range is reversed in direction. See [https://forum.doom9.org/showthread.php?t=183239 discussion] for more information.
|
|[https://github.com/TomArrow/SelectRangeEveryReversing/releases Plugin]
|[https://github.com/TomArrow TomArrow]
|}

=== Levels and Chroma ===

{{FilterTable}}
| [[AutoAdjust]]
| A high quality automatic adjustement filter. It calculates statistics of clip, averages them temporally to stabilize data and uses them to adjust luminance gain & color balance.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AutoAdjust|Plugin]]
| {{Author/LaTo}}
|-
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 AutoContrast]
|Auto contrast adjustment.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=173208#post1757661 Script]
|{{Author/StainlessS}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Autolevels|Plugin]]
| {{Author/frustum}} & Theodor Anschütz & StainlessS
|-
|[[AVSCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs].
|[[Avisynthplus_color_formats|RGBP16]]
|[[AVSCube|Plugin]]
|{{Author/Donald Graft}}
|-
| [https://forum.doom9.org/showthread.php?t=168062 AWB]
| Automatic white balance for real world footage, similar to the known function in digital cameras.
| [[YV12]]
| [https://forum.doom9.org/showthread.php?t=168062 Script]
| martin53
|-
|Brightness
|Restore dark and bright zones.
|8-16 planar Y/YUV
|[https://forum.doom9.org/showthread.php?t=182411 Script]
|Arx1meD
|-
| ChangeColour
| Simple plugin to replace one specified color to another, see [https://forum.doom9.org/showthread.php?t=88727 discussion] for additional information.
| [[RGB32]]
| [https://web.archive.org/web/20220322043620/https://files.videohelp.com/u/223002/changecolour01.zip Plugin]
| {{Author/Simon Walters}}
|-
| [[ChanMix]]
| Creates a grayscale image from an RGB24 source, it has 3 parameters to specify how much of each color-channel is used.
| [[RGB24]]
| [[ChanMix|Plugin]]
| E-Male
|-
| [[ChannelMixer]]
| Very similar to the ChannelMixer function found in Photoshop. 9 Adjustments are possible, 3 for each color channel.
| [[RGB24]], [[RGB32]]
| [[ChannelMixer|Plugin]]
| Gustaf Ullberg
|-
| [https://forum.doom9.org/showthread.php?t=173364 ChromaJig]
| Automatic Colorization.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?p=1775733#post1775733 Script]
| MWilson
|-
| [[ColorBalance]]
| Same tool that is found in Gimp & Cinepaint.
| [[RGB24]], [[RGB32]]
| [[ColorBalance|Plugin]]
| Gavino & mikeytown2
|-
|[[ColorLooks]]
| The plugin contains the following filters: Technicolor, Colorize, Sepia and Posterize.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[ColorLooks|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[ColorYUV2]]
|YUV color adjustment plugin with a graffer.
|[[YV12]]
|[[ColorYUV2|Plugin]]
|{{Author/StainlessS}}
|-
| [[ColourLike]]
| Makes a clip look like a 'reference' clip by adjusting each colour mask.
| [[RGB32]], [[YV12]]
| [[ColourLike|Plugin]]
| {{Author/mg262}}
|-
| [[ColourWarp]]
| Smooth remapping of UV colour values using control points for colour correction.
| [[YV12]], [[YV16]], [[YV24]]
| [[ColourWarp|Plugin]]
| {{Author/David Horman}}
|-
|[[DGCube]]
|[[AviSynth+]] plugin to load and apply .cube [http://en.wikipedia.org/wiki/3D_lookup_table 3D LUTs]. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|RGBP16]]
|[[DGCube|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGHDRtoSDR]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 to SDR. (GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGHDRtoSDR|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGPQtoHLG]]
|[[AviSynth+]] plugin to convert UHD BluRay HDR10 PQ to HDR10 HLG. GPU accelerated - CUDA)
|[[Avisynthplus_color_formats|YUV420P16]]
|[[DGPQtoHLG|Plugin]]
|{{Author/Donald Graft}}
|-
|[[DGTonemap]]
|[[AviSynth+]] plugin for basic Reinhard tonemapping for HDR->SDR.
|[[Avisynthplus_color_formats|RGBPS]]
|[[DGTonemap|Plugin]]
|{{Author/Donald Graft}}
|-
|[https://github.com/erazortt/DoViBaker DoViBaker]
|This AviSynth plugin reads the Base Layer, Enhancement Layer and RPU data from a profile 7 DolbyVision stream to create a clip with the DolbyVision data baked in.
|[[YUV444P16]], [[YUV420P16]]
|[https://github.com/erazortt/DoViBaker/releases Plugin]
|[https://github.com/erazortt erazortt]
|-
| [[ExpLabo]]
| ExpLabo is a multi-filters plugin, focused on the non-linear transformation of image color space.
| [[RGB24]], [[RGB32]]
| [[ExpLabo|Plugin]]
| brabbudu
|-
|[https://web.archive.org/web/20180916224719/http://mpierce.pie2k.com/pages/211.php Exposure]
|Exposure function for AviSynth.
|[[RGB24]]
|[https://web.archive.org/web/20171023011558if_/http://mpierce.pie2k.com/downloads/exposure.zip Plugin]
|Matt Pierce
|-
| [[FlimsYlevels]]
| Luma adjustment function to give a more "film-ish" look. (Based on {{Author/Didée}}'s [[Ylevels]]).
| [[YV12]]
| Script
| FlimsyFeet
|-
|[[GamMac]]
|Useful to correct color cast on old 8mm films.
|[[RGB32]], [[RGB24]]
|[[GamMac|Plugin]]
|{{Author/StainlessS}}
|-
|[[GamMatch]]
|Gamma Matcher; useful to correct bad color clip where there is a better color source of perhaps lower rez available.
|[[RGB32]], [[RGB24]]
|[[GamMatch|Plugin]]
|{{Author/StainlessS}}
|-
| [[GiCocu]]
| Use GIMP/Photoshop curve files.
| [[RGB24]], [[RGB32]]
| [[GiCocu|Plugin]]
| E-Male
|-
|[https://github.com/magiblot/gradation Gradation]
|Gradation Curves filter for VirtualDub and AviSynth+
|[[RGB32]]
|[https://github.com/magiblot/gradation/releases Plugin]
|[https://github.com/magiblot magiblot]
|-
|[[GradationCurve]]
|[[AviSynth+]] plugin that loads Photoshop ACV and GIMP crv curve files. Also can compute the gradation curve through given anchor points. Like what Photoshop and Gimp do in the Curves setting.
|[[Avisynthplus_color_formats|PlanarRGB, PlanarYUV]]
|[[GradationCurve|Plugin+Script]]
|ErazorTT
|-
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Gray_Balance]
|A gray balance script, which is based on Black/White/Gray balance picker.
|[[RGB24]], [[YUY2]], [[YV12]]
|[http://forum.doom9.org/showthread.php?t=167027#post1629321 Script]
|Kisa_AG
|-
|[https://github.com/Asd-g/AviSynthPlus-grayworld grayworld]
|Port of [https://ffmpeg.org/ffmpeg-filters.html#grayworld FFmpeg's grayworld] filter to AviSynth+. See [https://forum.doom9.org/showthread.php?t=183750 discussion]
|[[RGBPS]], [[RGBAPS]]
|[https://github.com/Asd-g/AviSynthPlus-grayworld/releases Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[YUY2]], [[YV12]]
| [[HDRAGC|Plugin]]
| {{Author/paviko}}
|-
|[[HDRTools]]
|HDR color conversion plugin for AviSynth+.
|[[RGB32]], [[RGB64]], Planar YUV/RGB (8-16 and 32bit)
|[[HDRTools|Plugin]]
|[https://github.com/jpsdr jpsdr]
|-
| [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
|-
| [[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]]
| [[HistogramAdjust|Plugin]]
| {{Author/vcmohan}}
|-
| [[Histograms in RGB & CMY]]
| Similar to Histogram("levels") but for RGB and CMY instead of YUV. It also includes a RGB parade color scope.
| [[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Histograms in RGB & CMY|Script]]
| -Vit-
|-
|[https://github.com/magiblot/HSLTint HSLTint]
|An [[AviSynth+]] filter for creating monochromatic tints with user-defined hue and saturation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]] - all bit-depths
|[https://github.com/magiblot/HSLTint/blob/master/HSLTint.avsi Script]
|magiblot
|-
|[[HSVAdjust]]
|HSVAdjust/HSLAdjust/HSIAdjust let's you rotate hues, control the strength of color (saturation), or modify the brightness of a clip. The type of brightness depends on the filter. It's value for HSVAdjust, lightness for HSLAdjust or intensity for HSIAdjust.
|[[RGB24]], [[RGB32]]
|[[HSVAdjust|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[Hue]]
|This plugin is a port of Donald Graft's VirtualDub [http://rationalqm.us/hue.html Hue] filter.
|[[RGB24]], [[RGB32]]
|[[Hue|Plugin]]
|{{Author/Wilbert Dijkhof}}
|-
|[[avslibplacebo#Tonemap|libplacebo_Tonemap]]
|Dynamic HDR tone mapping, includes peak and scene-change detection, chroma-preserving (luma-only) tone mapping, highlight desaturation, dynamic exposure control and a variety of industry-standard EETFs including BT.2390.
|16-bit planar RGB or YUV444P16
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[https://forum.doom9.org/showthread.php?t=176091 LinearTransformation]
|This script performs Linear Transformations based on a matrix conversion. Matrices are made by Francesco Bucciantini (FranceBB).
|[[YV12]], [[YV16]], [[YV24]], [[RGB24]], [[RGB32]], [[RGB32]], [[RGB48]],[[RGBPS]]
|[https://github.com/FranceBB/LinearTransformation Linear Transformation]
|[https://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[MatchHistogram]]
| Tries to modify the histogram of the input clip to match that of a reference clip. Should be used for analysis only, not for production.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MatchHistogram|Plugin]]
| {{Author/LaTo}}
|-
| [[OutRange]]
| A simple function to scan the whole video and output a log file, in which out-of-tv-range frames are logged.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[OutRange|Script]]
| 06_taro
|-
|[[RGBAdapt]]
|Another RGB color correction plugin, it also also includes a graffer.
|[[RGB24]], [[RGB32]]
|[[RGBAdapt|Plugin]]
|{{Author/StainlessS}}
|-
|[[RgbAmplifier]]
|An AviSynth forensic plugin to amplify color shifts.
|[[RGB24]], [[RGB32]]
|[[RgbAmplifier|Plugin]]
|{{Author/StainlessS}}
|-
| [https://forum.doom9.org/showthread.php?t=181857 SafeColorLimiter]
| Automatic Clipping to get a broadcast safe output in Limited TV Range.
| [[Y8]], [[Y10]], [[Y12]], [[Y14]], [[Y16]], [[Y32]], [[YV12]], [[YV411]], [[YUY2]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/SafeColorLimiter Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
|[[SelectiveColour]]
|AviSynth implementation of Photoshop's selective colour adjustment.
|[[RGB32]]
|[[SelectiveColour|Plugin]]
|{{Author/David Horman}}
|-
| [[SGradation]]
| SGradation is much like a gamma function, but '2nd order'.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| Script
| martin53
|-
|[[ShowChannels]]
|Simple plugin whose only function is to display the average Y,U and V values for a YUV frame or R,G, and B for an RGB frame. Also shows accumulated average for all frames visited so far.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[ShowChannels|Plugin]]
|{{Author/StainlessS}}
|-
| [[ShowOverRange]]
| Shows illegal "TV range" by painting pixels blue for anything less than 16 and red for anything greater than 235.
| [[YUY2]], [[YV12]]
| [[ShowOverRange|Plugin]]
| {{Author/SAPikachu}}
|-
| [[SmoothAdjust]]
| SmoothAdjust is a set of 5 plugins to make YUV adjustments. These 5 plugins have a smoothing & dithering algorithm to avoid banding issue. SmoothAdjust is [[SmoothLevels|SmoothLevels']] successor.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[SmoothAdjust|Plugin]]
| {{Author/LaTo}}
|-
| [[Tint]]
| Tints the image toward a specified colour.
| [[YUY2]], [[YV12]]
| Script
| actionman133
|-
| [[TweakColor]]
| Target specific hue and saturation ranges for hue and saturation adjustments.
| [[YV12]], [[YUY2]]
| [[TweakColor|Plugin]]
| {{Author/Trevlac}}
|-
| [[VideoScope]]
| Similar to Histogram("classic") but with additional features, it shows waveform monitors and a vectorscope.
| [[YUY2]]
| [[VideoScope|Plugin]]
| {{Author/Randy French}}
|-
| [http://forum.doom9.org/showthread.php?p=1832763#post1832763 VideoTek]
| VideoTek is a Tektronix-like waveform monitor for AviSynth.
| [[YV12]], [[YV16]], [[YV24]]
| [https://github.com/FranceBB/VideoTek/blob/master/VideoTek.avsi Script]
| [http://forum.doom9.org/member.php?u=219051 FranceBB]
|-
| [[WhiteBalance]]
| Correct the white balance of a clip with a large degree of control and accuracy over other methods of correcting white balance.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[WhiteBalance|Plugin]]
| SomeJoe
|-
| [[Ylevels]]
| A simple replacement for Avisynth's internal [[Levels]] command, with a few neat differences.
| [[YV12]]
| Script
| {{Author/Didée}}
|}

=== Line Darkening ===

{{FilterTable}}
| 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]]
| [http://forum.doom9.org/showthread.php?p=1060081#post1060081 Script]
| Vectrangle / {{Author/Didée}}
|-
|[[Hysteria]]
|Hysteria, a line darkening script by Scintilla.
|[[YV12]]
|[http://pastebin.com/raw/fvDdiV6m Script]
|Scintilla
|-
|[http://forum.doom9.org/showpost.php?p=993939&postcount=2 LineDarkenToon]
| LineDarkenToon use the idea of mf_toon (0.5) for linedarken. I wanted a really small fast code like FastLineDarken but with similar output like mf_toon and this is the result.
|[[YV12]]
| [http://forum.doom9.org/showpost.php?p=993939&postcount=2 Script]
| MOmonster
|-
| [[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}}
|-
|[[proToon]]
|Line darkening script, used to be known as vmToon and before that mfToon.
|[[YV12]]
|[http://pastebin.com/raw/Aw9En26L Script]
|TheProfileth
|-
| [[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 line darkener.
| [[YV12]]
| [http://dl.dropbox.com/s/guk5plphkthdy2f/Toon-v1.1.7z Plugin]
| {{Author/mf}}
|-
| [[ToonLite]]
| It's the same as [[Toon]], just without the warpsharp processing..
| [[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}}
|[https://forum.doom9.org/showthread.php?t=181665 AiUpscale]
|An AviSynth+ implementation of some Super-Resolution Convolutional Neural Networks.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://github.com/Alexkral/AviSynthAiUpscale Script]
|[https://github.com/Alexkral Alexkral]
|-
|[[Anime4KCPP]]
|Anime4K is a simple high-quality anime upscale algorithm with GPU acceleration support. [[AviSynth+]] x64 only.
|[[RGB24]], [[YV24]], [[YV16]], [[YV12]]
|[[Anime4KCPP|Plugin]]
|TianZerL
|-
| [[avsresize]]
| [http://github.com/sekrit-twc/zimg z.lib] resizers for [[AviSynth+]]. avsresize provides resizing, colorspace and bit depth conversation.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
| [[avsresize|Plugin]]
| [http://github.com/sekrit-twc sekrit-twc]
|-
| [[AreaResize]]
| An area-average resizer plugin; only use to downscale.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[AreaResize|Plugin]]
| {{Author/Chikuzen}}, Aktanusa
|-
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Desample]
|Desampling functions for AviSynth+, replaces DebilinearM and lineart_rpow2. Also includes DeCrossConversionMT which is a replacement for ccc, ccc_720.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[https://gist.github.com/kgrabs/b042214d715176ac9ab563c188995457 Script]
|[https://github.com/kgrabs kgrabs]
|-
|[[Descale]]
|AviSynth+ filter to undo upscaling.
|All planar Y/YUV/RGB color formats
|[[Descale|Plugin]]
|[https://github.com/Frechdachs Frechdachs]
|-
|[[DPID]]
|DPID is an algorithm that preserves visually important details in downscaled images and is especially suited for large downscaling factors.
|All [[planar]] colorspaces
|[[DPID|Plugin]]
|{{Author/Asd-g}}
|-
|[http://forum.doom9.org/showthread.php?p=1738351#post1738351 edi_rpow2]
|An improved rpow2 function for nnedi3, nnedi3ocl, eedi3, and eedi2. Requires [http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi ResizeX]
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/view/pcmkxaauku375xd/edi_rpow2_v1.0.avsi Script]
|Desbreko
|-
|[[FCBI]]
|Fast Curvature Based Interpolation.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], 8-16bit planar clips
|[[FCBI|Plugin]]
|{{Author/Chikuzen}}
|-
| [[fmtconv]]
| fmtconv is a format-conversion plug-in, it provides resizing, colorspace and bitdepth conversation.
| All [[planar]] 8 to 32-bit colorspaces
| [[fmtconv|Plugin]]
| {{Author/cretindesalpes}}
|-
| [[JincResize]]
| Jinc (EWA Lanczos) Resampler Plugin for AviSynth/AviSynth+.
| All 8-32bit [[planar]] colorspaces
| [[JincResize|Plugin]]
| innocenat
|-
|[[avslibplacebo#Resample|libplacebo_Resample]]
|High-quality, optimized upscaling and downscaling including support for polar filters ("Jinc"), anti-aliasing, anti-ringing and gamma correct scaling
|8, 16 or 32-bit planar RGB/YUV formats.
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|-
|[[nnedi3/nnedi3_rpow2|nnedi3_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3_rpow2 is a function included in [[nnedi3]].
|[[RGB24]], [[YUY2]], [[YV12]]
|[[nnedi3|Plugin]]
|{{Author/tritical}}
|-
|[[nnedi3ocl/nnedi3x_rpow2|nnedi3x_rpow2]]
| Enlarge images by the powers of 2 using Neural Network New-Edge Directed Interpolation ; nnedi3x_rpow2 is a script function included in [[nnedi3ocl]].
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[nnedi3ocl|Script and Plugin]]
|SeT
|-
|[[nnedi3_resize16]]
|An advanced script for high quality image resizing and colorspace conversion.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://avisynth.nl/index.php/Nnedi3_resize16 Script]
|mawen1250
|-
| [[PointSize]]
| A set of [http://en.wikipedia.org/wiki/Image_scaling pixel art resizers]; Includes Scale2x/3x, LQ2x/3x/4x, HQ2x/3x/4x, xBRZ (2x to 6x).
| [[RGB32]]
| [[PointSize|Plugin]]
| `Orum
|-
| [[ResampleHQ]]
| ResampleHQ provides gamma-aware resizing and colorspace conversion.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [[ResampleHQ|Plugin]]
| Cory Nelson
|-
|[[ResampleMT]]
|Internaly multi-threaded resampling functions, also includes desampling functions (DeBilinear, DeBicubic,...).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[Avisynthplus_color_formats|plus HBD formats in AVS+]]
|[[ResampleMT|Plugin]]
|[http://github.com/jpsdr jpsdr]
|-
|[[Resize8]]
|<tt>Resize8()</tt> works just like AviSynth's internal resizers but with some extra features. It had correct chroma placement, optional adaptive anti-ringing algorithm and few other features.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://web.archive.org/web/20150911013350/http://www.nmm-hd.org/upload/get~8y1IjaaqvoI/Resize8_v1.2.avsi Script]
|mawen1250
|-
|ResizeX
|ResizeX is a wrapper function for AviSynth's internal resizers and Dither_resize16 that corrects for the chroma shift caused by the internal resizers when they're used on horizontally subsampled chroma with MPEG2 placement.
|[[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://www.mediafire.com/download/lcbtb7uta4ta5pc/ResizeX_v1.0.avsi Script]
|Desbreko
|-
| [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}}
|-
|SincResize
|SincResize is an experimental plugin that uses DCT to perform resizing. See [http://forum.doom9.org/showthread.php?p=953002#post953002 discussion], read on for more information.
|[[YV12]]
|[http://cafxx.strayorange.com/files/SincResize4.7z Plugin]
|[http://cafxx.strayorange.com/ CAFxX]
|-
| [[SimpleResize]]
| Resizing plugin with 4 filters: SimpleResize, WarpResize, InterlacedResize and InterlacedWarpedResize.
| [[YV12]], [[YUY2]]
| [[SimpleResize|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}}
|-
|[http://forum.doom9.org/showthread.php?t=175945 Unwiden/Widen]
|Resize filters to unwiden/widen, see discussion.
|[[RGB32]], [[YV24]]
|[http://forum.doom9.org/showthread.php?t=175945 Plugin]
|{{Author/David Horman}}
|-
|[[w2xncnnvk]]
|[https://en.wikipedia.org/wiki/Waifu2x waifu2x] implemented in Vulkan.
|[[RGBPS]]
|[[w2xncnnvk|Plugin]]
|{{Author/Asd-g}}
|-
|[http://github.com/sunnyone/Waifu2xAvisynth waifu2x]
|Single-Image Super-Resolution for anime/fan-art using Deep Convolutional Neural Networks.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[http://github.com/sunnyone/Waifu2xAvisynth/releases Plugin]
|[http://github.com/sunnyone sunnyone]
|-
| [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
| mikeytown2
|}

=== Sharpeners ===

{{FilterTable}}
| [[aSharp]]
| Simple unsharp mask filter with optional adaptive sharpening.
| [[YV12]]
| [[aSharp|Plugin]]
| {{Author/Marc FD}}
|-
|[[AVSShock]]
|This Shock Filter sharpens edges of images by applying erosions or dilations depending on the sign of the Laplacian (or the so called Haralick-Canny edge detector).
|[[YUY2]], [[YV12]]
|[[AVSShock|C-Plugin]]
|AMSS0815
|-
| [[aWarpSharp2]]
| A modern rewrite of aWarpSharp with several bugfixes and optimizations.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV formats, 8 to 16-bit
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
| [[blah]]
| Sharpening. See [http://forum.doom9.org/showthread.php?t=155030 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1406843 Script]
| *.mp4 guy
|-
|[[CAS]]
|Contrast Adaptive Sharpening.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], all planar Y, YUV(A), RGB(A) formats, 8 to 32-bit
|[[CAS|Plugin]]
|Asd-g
|-
| [[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}}
|-
| [[LimitedSharpen]]
| LimitedSharpen can be used like a traditional sharpener, but producing much less artifacts. 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.
| [[YV12]]
| [http://avisynth.nl/images/LimitedSharpenFaster.avsi 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}}
|-
|[http://forum.doom9.org/showthread.php?t=173515 MCLS_16]
|Motion Compensate Limited Sharpen 16bit
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=173515 Script]
|Motenai Yoda
|-
|[http://forum.doom9.org/showthread.php?t=153201 MedSharp]
|Soft thresholded median sharpening function. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?t=153201 Script]
|*.mp4 guy
|-
| [[MSharpen]]
| <tt>MSharpen</tt> is a very simple masked sharpening plugin for AviSynth. This version is a reimplementation of neuron2's old <tt>MSharpen</tt> plugin.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MSharpen|Plugin]]
| {{Author/tp7}}
|-
| [[NonlinUSM]]
| Non-linear Unsharp Masking.
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1555234&postcount=46 Script]
| {{Author/Didée}}
|-
| [[pSharpen]]
| Performs two-point sharpening to avoid overshoot. See [http://forum.doom9.org/showthread.php?t=172422 discussion].
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=172422#post1732663 Script]
| ilpippo80, colours
|-
|[[ReCon]]
|'''ReCon'''volution - makes things sharp by mixing pixels together. See [http://forum.doom9.org/showthread.php?t=153201 discussion].
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1409582#post1409582 Script]
|*.mp4 guy
|-
| [[SeeSaw]]
| SeeSaw uses a balance of denoising and sharpening to enhance a clip. The aim is to enhance weak detail without over-sharpening or creating jaggies on strong detail, and produce a result that is temporally stable without detail shimmering.
| [[YV12]]
| [http://avisynth.nl/images/SeeSaw.avs Script]
| {{Author/Didée}}
|-
| SharpenComplex2
| Port of MPC-HC's Sharpen Complex 2 to AviSynth. Despite the name, this script is very simple, see [http://forum.doom9.org/showthread.php?t=158385 discussion.]
| [[YV12]]
| [[SharpenComplex2_source|Script]]
|
|-
| SSXSharpen
| Included in SharpTools. Sharpens the picture using [[supersampling]] techniques.
| [[YV12]]
| [http://web.archive.org/web/20100120201434/http://mf.creations.nl/avs/functions/SharpTools-v0.3.avs Script]
| {{Author/mf}}, {{Author/Didée}}
|-
| [[SSSharp]]
| Also known as Super Slow Sharpen - a very slow, but high quality sharpener. See [http://forum.doom9.org/showthread.php?t=132330 discussion]
| [[YV12]]
| [http://forum.doom9.org/showpost.php?p=1071731 Script]
| *.mp4 guy
|-
| [[TUnsharp]]
| TUnsharp is a basic sharpening filter that uses a couple different variations of unsharp masking and allows for controlled sharpening based on edge magnitude and min/max neighborhood value clipping.
| [[YUY2]], [[YV12]]
| [[TUnsharp|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.
| [[YUY2]], [[YV12]]
| [[UnFilter|Plugin]]
| {{Author/Tom Barry}}
|-
| [[UnsharpHQ]]
| A strong and fast unsharp mask with some new features.
| [[YV12]]
| [[UnsharpHQ|Plugin]]
| list
|-
|[[vsMSharpen]]
|vsMSharpen is a sharpener that tries to sharpen only edges. This plugin is a port of the VapourSynth plugin MSharpen.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]], all planar Y, YUV, and RGB formats, 8 to 16 bit
|[[vsMSharpen|Plugin]]
|Dubhater, Asd-g
|-
| [[WarpSharp]]
| WarpSharp contains these sharpeners: <tt>UnsharpMask, WarpSharp, Xsharpen</tt>.
| [[YUY2]], [[YV12]]
| [[WarpSharp|Plugin]]
|???, {{Author/seraphy}}
|}

=== Rotation/Shear/Skew/Perspective ===

{{FilterTable}}
| [[DeBarrel]]
| Remove barrel and pincushion distortion, where straight lines appear curved.
| [[RGB24]], [[RGB32]], [[Y8]]
| [[DeBarrel|Plugin]]
| {{Author/vcmohan}}
|-
|[[Defish]]
|Barrel and pincushion distortion correction filter.
|[[RGB32]]
|[[Defish|Plugin]]
|{{Author/David Horman}}
|-
|[http://forum.doom9.org/showthread.php?t=171922 Defish Different Projections]
|Defish with different map projections, like Lambert Cylindrical Equal Area, Mercator and Miller projections.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=171922 Script]
|Kisa_AG
|-
| [[FTurn]]
| Fast implementation of [[TurnLeft]](), [[TurnRight]]() and [[Turn180]]() AviSynth functions.
| [[Y8]], [[YV12]],[[YV24]]
| [[FTurn|Plugin]]
| {{Author/tp7}}
|-
|[http://forum.doom9.org/showthread.php?t=165978 Quad]
|An Avisynth plugin to perform quadrilateral transformations. Quad is now superseded by [[warp]].
|[[RGB32]]
|[http://horman.net/quad.zip Plugin] -- [http://forum.doom9.org/showpost.php?p=1602709&postcount=22 no SSE]
|{{Author/David Horman}}
|-
| [[Reform]]
| Skewed images are corrected or vice versa, useful if video is recorded with slightly incorrectly located camera. Sometimes referred to as perspective correction.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Reform|Plugin]]
| {{Author/vcmohan}}
|-
| [[Reformer]]
| Perspective correction and warping.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[Reformer|Plugin]]
| {{Author/vcmohan}}
|-
| [[Rotate]]
| Rotate or shear on any given angle.
| [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[Rotate|Plugin]]
| {{Author/Fizick}}
|-
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner.html Spinner]
| Spinner plugin rotates a frame or selected part of it about the given axis coordinates in floating point precision.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [http://www.avisynth.nl/users/vcmohan/Spinner/Spinner_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[[warp]]
|A collection of geometry correction filters (also includes new version of Quad).
|[[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[[warp|Plugin]]
|{{Author/David Horman}}
|-
|[[xyremap]]
|xyremap is a filter for remapping pixels using formulae written in [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation].
|[[RGB32]]
|[[xyremap|Plugin]]
|{{Author/David Horman}}
|-
| [[Zoom]]
| Zoom, Pan & Rotate Clip. Adds alpha layer to clip.
| [[RGB32]]
| [[Zoom|Plugin]]
| {{Author/WarpEnterprises}}
|}

=== Subtitling ===

{{FilterTable}}
| [[AssRender]]
| Libass-based subtitle renderer.
| [[RGB32]], [[RGB24]], [[YV24]], [[YV12]], [[Y8]]
| [[AssRender|C-Plugin]]
| lachs0r, TheFluff
|-
|[https://forum.doom9.org/showthread.php?t=183148 DetSub]
|Can be used to remove hardcoded subtitles with halo from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=183148 Script]
|{{Author/StainlessS}}
|-
|[[FreeSub]]
|Subtitle with bdf fonts.
|[[RGB24]], [[RGB32]], [[YV24]]
|[[FreeSub|C-Plugin]]
|Natt
|-
|[[FreeSubPlus]]
|Script that adds support for additional colorspaces to the FreeSub plugin.
|All colorspaces
|[[FreeSubPlus|Script]]
|reel.deel
|-
|[https://forum.doom9.org/showthread.php?t=176860 InpaintDelogo]
|Can be used to remove hardcoded subtitles from video or extract them to images for OCR.
|Any
|[https://forum.doom9.org/showthread.php?t=176860 Script]
|VoodooFX
|-
|[https://github.com/slavanap/ssifSource sub3d]
|Plugin for rendering subtitles on 3D video with correct depth.
|[[RGB32]]
|[https://github.com/slavanap/ssifSource/tree/master/Sub3D Sources] [https://github.com/slavanap/ssifSource/releases Binaries][http://forum.doom9.org/showthread.php?t=173143 Discussion]
|slavanap
|-
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile SubImageFile]
|AviSynth+ plugin that renders image-based subtitles such as VOBSUB and PGS.
|[[RGB24]], [[Y8]]
|[https://github.com/Asd-g/AviSynthPlus-SubImageFile/releases/ Plugin]
|{{Author/Asd-g}}
|-
| [[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.
| [[RGB24]], [[RGB32]], [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[SubtitleEx|Plugin]]
|[http://web.archive.org/web/20070821222318/http://mvideo.ddpp.net/eng/index.htm basilik]
|-
|[http://forum.doom9.org/showthread.php?t=119390 SUPtext]
|Overlays SUP-subtitles on a video clip.
|[[RGB32]], [[YV12]]
|[http://forum.doom9.org/attachment.php?attachmentid=7846&d=1196858433 Plugin]
|emmel
|-
| [[SupTitle]]
| Blu-ray PGS .SUP Subtitle Renderer Plugin for AviSynth. See [http://forum.doom9.org/showthread.php?t=148167 discussion]
| [[YV12]]
| [[SupTitle|Plugin]]
| {{Author/ZachSaw}}
|-
|[[tcasFilter]]
|Renders TCAS subtitle effects.
|[[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
|[[tcasFilter|Plugin]]
|milkyjing
|-
| [http://avisynth.org.ru/docs/english/externalfilters/vsfilter.htm 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]
|
|-
| [[VSFilterMod]]
| VSFilterMod is modification of original VSFilter subtitle renderer by Gabest. This mod brings up new features and some minor bugfixes.
|[[RGB24]], [[RGB32]], [[YV12]]
| [[VSFilterMod|Plugin]]
|
|-
|[[xy-VSFilter]]
|High performance VSFilter compatible subtitle filters.
|[[RGB24]], [[RGB32]], [[YV12]]
|[[xy-VSFilter|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}}
|-
| [[TransAll]]
| Around 150 distinct transitions can be created with this plugin.
| [[RGB]], [[YUY2]], [[YV12]]
| [[TransAll|Plugin]]
| {{Author/vcmohan}}
|-
| [[Transition_AlbertGasset|Transition (Albert Gasset)]]
| Various wipe and random block modes. Has 19 built in patterns or it can use an external file.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_AlbertGasset|C-Plugin]]
| {{Author/Albert Gasset}}
|-
| [[Transition_Shubin|Transition (Shubin)]]
| Contains 2 transition modes: circle and line.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[Transition_Shubin|Plugin]]
| {{Author/shubin}}
|}

== Other Filters ==

=== Debugging/Diagnostic Filters ===

{{FilterTable}}
| AVInfo
| AVIInfo gives information about the streams in the clip without loading any frames. filename can be a WAV file or an AVI file with several audio streams (it won't open AVI files with embedded subtitles though). It will return the info as a string.
|
| [http://www.avisynth.nl/users/warpenterprises/files/avinfo_5F25_dll_20050417.zip Plugin]
| trevlac, wilbert
|-
| [http://forum.doom9.org/showthread.php?t=174797 AVSMeter]
| AVSMeter is a CLI (command line interface) tool which measures the speed/efficiency of Avisynth scripts and checks if Avisynth and its plugin sub-system are set up and working correctly. Documentation for usage and features is included in the distribution package.
|
| Command line executable
| Groucho2004
|-
| [http://forum.doom9.org/showthread.php?t=176079 Avisynth Info Tool]
| This program performs a thorough test of your Avisynth installation and associated plugins, checking if external dependencies are installed, etc.
|
| Windows application with graphical user interface
| Groucho2004
|-
|[http://forum.doom9.org/showthread.php?t=173259 avsr]
|CLI (command line interface) tool which simply executes an Avisynth script. This is useful when, for example, you want to write an image sequence to the disk by using "ImageWriter".
|
| Command line executable
| Groucho2004
|-
|[[Butteraugli]]
|Butteraugli is an estimating filter for the psychovisual similarity of two images.
|8-32bit planar RGB/RGBA
|[[Butteraugli|Plugin]]
|{{Author/Asd-g}}
|-
|[[ColorDiff]]
|ColorDiff makes a greyscale (Y8) frame according to the input frame's pixels' "distance" from a specified color. The diff is calculated by simply getting the diff of the individual color components from the desired color's components and summing them up. Also, weights can be set for the individual diffs.
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[[ColorDiff|C-Plugin]]
|Ignus2
|-
|[https://forum.doom9.org/showthread.php?t=182817 DebugColourSpaces]
|Debugging filter which applies a specified filter to multiple Avisynth+ colourspaces and displays a labelled grid of the results.
|Any
|[http://horman.net/avisynth/download/DebugColourSpaces.zip Plugin]
|{{Author/David Horman}}
|-
| [[DumpPixelValues]]
| Samples the colors from selected pixels for every frame in a video source and outputs the data to a text or binary file. See [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://www.theneitherworld.com/mcpoodle/Tools/DumpPixelValues.zip Plugin]
| [http://www.theneitherworld.com/mcpoodle/Tools/index.html McPoodle]
|-
|[[FFTSpectrum]]
|FFTSpectrum is a filter that displays the FFT frequency spectrum of a given clip.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[FFTSpectrum|Plugin]]
|{{Author/Asd-g}}
|-
|[[GrainEvaluate]]
| A script to analyze and log the strength of grain for each frame. See [http://forum.doom9.org/showthread.php?t=167455 discussion.]
| [[YV12]]
|[http://www.nmm-hd.org/upload/get~-eJfUjEXJY4/GrainEvaluate.avsi Script]
|{{Author/06_taro}}
|-
| [http://forum.doom9.org/showpost.php?p=1462931&postcount=81 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]
| jmac698
|-
| [[Grid]]
| Overlays a grid, useful for pixel counting.
| Any
| [http://www.avisynth.nl/users/vcmohan/Grid/Grid.zip Plugin]
| {{Author/vcmohan}}
|-
|[[Info2]]
| A faster, prettier alternative to info().
|Any
|[[Info2|Plugin]]
|{{Author/David Horman}}
|-
|[[KPassFilterCL]]
|KPassFilterCL is a set of tools in the frequency domain.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[KPassFilterCL|Plugin]]
|[http://github.com/Khanattila Khanattila ]
|-
|[[LinesLumaDiff]]
|AviSynth+ plugin to check if luma difference between lines are below or above given threshold and writes frame number in text file.
|[[Planar]] YUV
|[[LinesLumaDiff|Plugin]]
|{{Author/Asd-g}}
|-
|[[MaxCLLFind]]
| PQ HDR Analyzer plugin for [[AviSynth+]], analyzes MaxCLL and MaxFALL and writes it to a text file.
|[[RGB64]]
|[[MaxCLLFind|Plugin]]
|Tom Arrow
|-
| [http://web.archive.org/web/20160610124531/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
|[[Pixelscope]]
|This debugging filter displays individual pixel values.
|[[RGB24]], [[RGB32]], [[Y8]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://forum.doom9.org/showthread.php?t=175688 Plugin]
|{{Author/David Horman}}
|-
|[https://github.com/EmiyaSyahriel/RollCompare RollCompare]
|AviSynth Plugin to create rolling comparison between videos.
|[[RGB24]], [[RGB32]]
|[https://github.com/EmiyaSyahriel/RollCompare/releases Plugin]
|EmiyaSyahriel
|-
|[http://github.com/lcferrum/segment-display-ocr SegmentDisplayOCR]
|SegmentDisplayOCR is a seven-segment display recognition filter for AviSynth. It has built in logging functionality (it will log frame recognition results) and also can be used in AviSynth conditional filters. The main purpose of this filter is to process readings of various digital instruments (e.g. digital multimeters) captured on video. So if your favourite instrument lacks interface for connecting it to PC you can capture it's readings on cam and convert them to computer readable format with SegmentDisplayOCR filter.
| [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[http://sourceforge.net/projects/segmentdisplayocr/files/SegmentDisplayOCR/ Plugin]
|[http://github.com/lcferrum lcferrum]
|-
|[[SSIM]]
|A filter that compute an objective video quality metric between two videos. Based on SSIM work from [http://web.archive.org/web/20060515090025/http://www.cns.nyu.edu/~zwang/files/research/ssim/index.html Zhou Wang]. It has been created with the help of Mfa.
|[[YV12]]
|[[SSIM|Plugin]]
|[http://web.archive.org/web/20060507012947/http://perso.wanadoo.fr/reservoir/ Lefungus]
|-
| [[ShowPixelValues]]
| This filter displays the actual Y U and V (or R G and B) values from pixels within a frame. See [http://forum.doom9.org/showthread.php?t=64192 discussion] and [http://web.archive.org/web/20091028073306/http://geocities.com/siwalters_uk/showpixelvalues.html homepage.]
| [[RGB32]], [[YUY2]]
| [http://web.archive.org/web/20091028122947/http://geocities.com/siwalters_uk/showpixelvalues1.4c.zip Plugin]
| {{Author/Simon Walters}}
|-
|[https://forum.doom9.org/showthread.php?t=176131 SysInfo]
|This plugin returns info about OS/CPU*/Memory/Screen/AviSynth.
|Any
|[https://forum.doom9.org/showthread.php?t=176131 Plugin]
|Groucho2004
|-
|[https://forum.doom9.org/showthread.php?t=168241 Timer]
|AviSynth script to add a highly customizable timer to your video.
|Any
|[https://forum.doom9.org/showthread.php?t=168241 Script]
|djcj
|-
| [http://web.archive.org/web/20151223052321/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://web.archive.org/web/20151223052318/https://code.google.com/p/avisynthrestoration/downloads/list Script]
| halifaxgeorge
|-
| [http://avisynth.org.ru/docs/english/externalfilters/tmonitor.htm TMonitor]
| TMonitor is a filter very similar to AVSMon. It enables monitoring of an Avisynth clip via previewing the video, viewing clip information (such as video width, height, colorspace, number of frames, audio samples, sample rate, number of audio channels, and more), and adjusting the audio delay. It also supports multiple instances per script, allowing viewing of differences between different parts of a processing chain.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [http://web.archive.org/web/20151125175557/http://bengal.missouri.edu/~kes25c/TMonitorv094.zip Plugin]
|{{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?t=53238 ViewFields/UnViewFields]
| [http://web.archive.org/web/20140709004333/http://www.geocities.com/siwalters_uk/unviewfields.html UnViewFields], [http://web.archive.org/web/20140708181324/http://www.geocities.com/siwalters_uk/viewfields.html ViewFields]
|
| Plugin
| {{Author/Simon Walters}}
|-
|[[VMAF]]
|VMAF is a perceptual video quality assessment algorithm developed by Netflix.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]],<br> 8-10bit planar YUV
|[[VMAF|Plugin]]
|{{Author/Asd-g}}
|-
| [[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
|
|}

=== Edge Detection ===

{{FilterTable}}
| [[aWarpsharp2/aSobel|aSobel]]
| Sobel edge dectecion filter included in [[aWarpSharp2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[aWarpSharp2|Plugin]]
| {{Author/SEt}}
|-
|[[MaskTools2/Mt edge| mt_edge]]
| Edge detection filter included in [[MaskTools2]].
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}
|-
|[[scharr]]
|Edge detection using the [https://en.wikipedia.org/wiki/Sobel_operator#Alternative_operators Scharr operator].
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[scharr|Script]]
|zorr
|-
| [[tcanny]]
| Contains a canny edge detection filter and distance transform filter.
| [[YUY2]], [[YV12]]
| [[tcanny|Plugin]]
| {{Author/tritical}}
|-
| [[TCannyMod]]
| Canny edge detection filter for Avisynth 2.6. Reimplementation of tcanny. See [http://forum.doom9.org/showthread.php?t=168449 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TCannyMod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[TEdgeMask]]
| TEdgeMask creates an edge mask based off gradient vector magnitude.
| [[YUY2]], [[YV12]]
| [[TEdgeMask|Plugin]]
| {{Author/tritical}}
|-
| [[TEMmod]]
| TEdgeMask modified for Avisynth 2.6. It creates an edge mask using gradient vector magnitude. See [http://forum.doom9.org/showthread.php?t=168390 discussion]
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [[TEMmod|Plugin]]
| {{Author/Chikuzen}}
|-
| [[vsTCanny]]
| Builds an edge map using canny edge detection.
| All 8-32bit [[planar]] colorspaces
| [[vsTCanny|Plugin]]
| {{Author/Asd-g}}
|-
| [[vsTEdgeMask]]
| vsTEdgeMask is an edge detection filter. This is a port of the TEdgeMask/TEMmod AviSynth plugins.
| All 8-16bit [[planar]] colorspaces
| [[vsTEdgeMask|Plugin]]
| {{Author/Asd-g}}
|}

=== Export Filters ===

These filters can write directly to media files.

{{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?t=172837 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://forum.doom9.org/showthread.php?t=172761 Update for AviSynth 2.6]. [http://forum.doom9.org/showthread.php?p=1750415#post1750415 Usage]. [http://forum.doom9.org/showthread.php?p=1073371#post1073371 Old mod by squid_80].
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [https://github.com/Asd-g/AviSynth-TWriteAVI/releases Plugin]
| {{Author/tritical}}
|-
| [http://forum.doom9.org/showthread.php?p=1403600 Sashimi]
(function "RawWriter")
| Sashimi writes (and reads) almost any regular raw uncompressed data format you can define. You'll find a fuller description under [[#Source_Filters|Source Filters]].
| [[RGB]], [[YUY2]],[[YV12]]
| [http://sites.google.com/site/ourenthusiasmsasham/soft Plugin with scripts]
| [http://sites.google.com/site/ourenthusiasmsasham/ PitifulInsect]
|-
| [[SoundOut]]
| SoundOut is a GUI driven sound file output module for AviSynth (it exports audio to several compressors).
| All audio.
| [[SoundOut|Plugin]]
| {{Author/Sh0dan}}
|}

=== 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://www.avisynth.nl/users/warpenterprises/files/freeframe_5F25_dll_20050426.zip Plugin]
| {{Author/Myrsloik}}
|}

=== Meta-Filters ===

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

{{FilterTable}}
|[[AVSTP]]
|A library for multithreaded plug-in development
|Any
|[[AVSTP|Plugin]]
|{{Author/cretindesalpes}}
|-
|[[MP_Pipeline]]
|Run parts of an AviSynth script in external processes.
|Any
|[[MP_Pipeline|Plugin]]
|[http://github.com/SAPikachu/ SAPikachu]
|-
| [[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
| [http://www.avisynth.nl/users/warpenterprises/files/mt_20070301.zip 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]
| [[YUY2]], [[YV12]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
|[http://forum.doom9.org/showthread.php?t=164073 SoraThread]
|Sora's avs multi-process/multi-thread plugin package
|Any
|[http://forum.doom9.org/showthread.php?t=164073 Plugin]
|leiming2006
|-
|[http://forum.doom9.org/showthread.php?t=154886 ThreadRequest]
|Yet another plugin for multithread processing. [http://web.archive.org/web/20130124045626/http://lantis.homeunix.org/avisynth.shtml Archive homepage (Japanese)]
|Any
|[http://www.mediafire.com/download/4xux7d7l1u3toy8/ThreadRequest+102a.rar Plugin]
|lantis
|}

=== Multipurpose Filters ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=174433 amDCT]
|amDCT() is an adaptive video filter providing deblocking, sharpening, local range expansion, smoothing, and bright noise removal in a single filter that can be used on video of any level of quality. These four operations work synergistically to drastically reduce block artifacts while maintaining detail and increasing local contrast.
|[[YV12]]
|[http://sites.google.com/site/amdctfilter/ Plugin]
|jconklin
|-
|[[AVExtensions]]
|Audio-video extensions is a collection of various AviSynth filters used to modify audio or video.
|[[RGB24]], [[RGB32]]
|[[AVExtensions|Plugin]]
|nutbread
|-
|[[AviSynthShader]]
|This plugin allows running HLSL pixel shaders within AviSynth. This gives access to various HLSL filters that haven't been programmed in AviSynth.
|[[RGB32]], [[YV24]], [[YV12]]
|[[AviSynthShader|Plugin]]
|[http://github.com/mysteryx93 MysteryX]
|-
|[[avs-mlrt]]
|This project provides AviSynth+ ML filter runtimes for variety of platforms.
|Y32, RGPS
|[[avs-mlrt|Plugin]]
|{{Author/Asd-g}}
|-
|[[CLExpr]]
|AviSynth Expr filter implemented in OpenCL for runtime calculation of expressions on 8 and 16-bit depths clips. Makes mt_lutxy and mt_lutxyz possible on 16-bit.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[CLExpr|Plugin]]
|{{Author/tp7}}
|-
|[https://forum.doom9.org/showthread.php?t=183823 CTools]
|Includes various filters for IVTC, deinterlacing, denoising, dehalo and duplicate frames.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]]
|[https://github.com/CeppoTools/CTools/releases Plugin]
|Ceppo
|-
| [http://forum.doom9.org/showthread.php?t=166061 HybridFuPP]
| An adaptive processor, allowing picture cleaning and compressibility gain. Original [http://forum.doom9.org/showthread.php?t=146632 discussion.]
| [[YV12]]
| [http://www.mediafire.com/download/6g09aazs4z7m11a/HybridFuPP_0.992b.zip Script]
| Fupp
|-
| [[MaskTools2]]
| This plugin provides tools for the creation, enhancement and manipulation of masks for each [[YUV]] component.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]]
| [[MaskTools2|Plugin]]
| {{Author/Manao}}, {{Author/tp7}}
|-
| [[MVTools]]
| This plugin provides a collection of functions for motion estimation and compensation.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| Various
|-
|[[avslibplacebo#Shader|Shader]]
|Loads GLSL shaders written in mpv's .hook syntax.
|16-bit planar YUV
|[[avslibplacebo|Plugin]]
|{{Author/Asd-g}}
|}

=== Scene Change Detection ===

{{FilterTable}}
|[http://forum.doom9.org/showthread.php?t=171624 DBSC]
|A scene change detection tool set/kit/box (work-in-progress).
|All
|[http://forum.doom9.org/showthread.php?t=171624 Script]
|{{Author/StainlessS}}
|-
| [http://forum.doom9.org/showthread.php?t=145143 EDLmaker]
| Simple scenechange detector that writes to EDL file.
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=145143 Script]
| Mug Funky
|-
| [[MVTools2/MSCDetection|MSCDetection]]
| Part of MVTools2; MSCDetection creates a scene detection mask clip from motion vectors data.
| [[YV12]], [[YUY2]]
| [[MVTools|Plugin]]
| {{Author/Fizick}}
|-
| SCDetect
| Detect scene change and output scene change frames to a file.
| [[YV12]]
| [http://web.archive.org/web/20140614152525/http://www.nmm-hd.org/upload/get~TfPm2QO4jbk/SCDetect_v0.3.rar Script]
| {{Author/06_taro}}
|-
| [http://akuvian.org/src/avisynth/sclavc/readme.txt SceneChangeLavc]
| SClavc is an AviSynth plugin intended to allow access to libavcodec's scene-change metrics. See [http://akuvian.org/src/avisynth/sclavc/ homepage.]
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/scenechangelavc_5F25_dll_20041201.zip Plugin]
| {{Author/akupenguin}}
|-
| [[SCXvid]]
| SCXvid produces first pass Xvid logs from AviSynth at the equivalent of the default VFW preset. These logs are primarily intended to get scene change information from but may have other uses.
| [[YV12]]
| [http://dl.dropbox.com/s/402hlckyn669p9n/SCXvid-1.1.rar Plugin]
| {{Author/Myrsloik}}
|-
| [[SCXvidMask]]
| A tiny AviSynth plugin that reads an SCXvid log and creates a binary mask based on it.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://github.com/tp7/SCXvidMask/releases Plugin]
| {{Author/tp7}}
|}

=== Support filters ===

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

{{FilterTable}}
| [[ApplyInterlacedFilter]]
| ApplyInterlacedFilter safely processes interlaced video with spatial and temporal filters.
|
| Script
|
|-
|[http://forum.doom9.org/showthread.php?t=162874 ArcFuns]
|This plugin expands the available numerical functions with missing inverse trig functions.
|N/A
|[http://forum.doom9.org/attachment.php?attachmentid=12494&d=1319627190 Plugin]
|{{Author/Gavino}}
|-
|[[AvsFilterNet]]
|The main objective of AvsFilterNet is to provide a wrapper for AviSynth, making it possible to write simple filter in any .Net languages.
|N/A
|[[AvsFilterNet|Plugin]]
|SAPikachu
|-
|[[AvsMotion]]
|AviSynth plugin for animating clips with AAE motion tracking data.
| [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[[AvsMotion|Plugin]]
|{{Author/tp7}}
|-
| [http://forum.doom9.org/showthread.php?t=46506 Call]
| Call an external program from the script.
| N/A
| [http://avisynth.nl/users/warpenterprises/files/call_5F25_dll_20030310.zip Plugin]
| Nic, DDogg
|-
|[[CallCmd]]
|Plugin to execute command on selectable frames or at startup or closedown. Based on [http://forum.doom9.org/showthread.php?t=46506 Call by Nic].
|N/A
|[[CallCmd|Plugin]]
|StainlessS
|-
|[[ClipBoard]]
|Get text from Clipboard.
|N/A
|[[ClipBoard|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=182910 Feedback]
|A filter that lets you use a filter chain's output as its own input.
|Any
|[http://horman.net/avisynth/download/feedback.zip Plugin]
|{{Author/David Horman}}
|-
|[[FileSize]]
|Plugin to get filesize.
|N/A
|[[FileSize|Plugin]]
|pureexe
|-
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.html GetProgramName]
|An AviSynth plug-in to retrieve the name of the calling application.
|N/A
|[https://www.roelofs-coaching.nl/blobs/downloads/ProgramName.zip Plugin]
|[http://www.roelofs-coaching.nl/J.M. Roelofs]
|-
|[[GetProgramName2]]
|GetProgramName2 is similar to GetProgramName by JM Roelofs, but this plugin is a newly written.
|N/A
|[[GetProgramName2|Plugin]]
|[https://github.com/enccc enccc]
|-
| GetSystemEnv
| An AviSynth plug-in to retrieve information from the system.
| N/A
| [http://www.avisynth.nl/users/stickboy/GetSystemEnv.zip Plugin]
| {{Author/stickboy}}
|-
| [[GRunT]]
| Extends AviSynth's [[Runtime_environment|Runtime Environment]], making it easier to use, especially inside script functions.
| Any
| [[GRunT|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
| [[GScript|Plugin]]
| {{Author/Gavino}}
|-
|[[LoadDLL]]
| Used to manually load dll files in AviSynth. Useful if a filter relies on an external dll that is not in the system PATH.
| N/A
| [[LoadDLL|Plugin]]
|{{Author/tsp}}
|-
|[https://forum.doom9.org/showthread.php?t=162790 MinMax]
|Finds the min or max value in each line or column and then sets the entire line or column to that value. Only processes the luma (Y) plane.
|[[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
|[https://web.archive.org/web/20160610142230if_/http://latoninf.free.fr/div/minmax.7z Plugin]
|{{Author/LaTo}}
|-
| [http://forum.doom9.org/showthread.php?t=97748 PlaneMinMax]
| Frame-based YV12 plane Min/Max/Avg functions without [[ConditionalFilter]].
| [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/planeminmax_5F25_dll_20050727.zip Plugin]
| Bart Silverstein
|-
|[http://forum.doom9.org/showthread.php?t=83451 pop]
|A filter to get values from variables that may not yet be initialized.
|Any
|[https://web.archive.org/web/20160606142540if_/http://www.tsp.person.dk/pop.zip Plugin]
|{{Author/tsp}}
|-
| [[RT_Stats]]
| Compile-time/Runtime Functions.
| N/A
| [[RT_Stats|Plugin]]
| StainlessS
|-
|[[StrFmt]]
|Simple plugin to produce formatted string, and additional function to string replace with another string.
|Any
|[[StrFmt|Plugin]]
|StainlessS
|-
|[https://forum.doom9.org/showthread.php?t=174387 StrResolve]
|String Variables Resolving Plugin (for masktools expressions)
|Any
|[http://www.mediafire.com/file/wu6zexhssd0y77i/170310_StrResolve_v050.zip Plugin]
|martin53
|}

=== Deepcolor Filters ===
(also check the [[High_bit-depth_Support_with_Avisynth#Processing_High_Bit-depth_Video_with_AviSynth|High Bit-Depth]] page and the [[:Category:Deep_color_tools|Deep Color Tools]] category)

{{FilterTable}}
| [[Dither_tools|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 color banding 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
| [[Dither_tools|Plugin + scripts]]
| {{Author/cretindesalpes}}
|}

=== 3D Filters ===

{{FilterTable}}
|[https://sourceforge.net/projects/voix/files/2d3/ 2Dto3D]
|2Dto3D is a collection of scripts for 2D to 3D conversion. Conversion is good but not perfect.
|[[YV12]]
|[https://sourceforge.net/projects/voix/files/2d3/ Script]
|[https://sourceforge.net/u/brankoj/profile/ brankoj]
|-
| [http://web.archive.org/web/20110809073332/http://arenafilm.hu/alsog/anaglyph/ Analglyph]
| 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://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z Plugin] / [http://web.archive.org/web/20140412062911/http://chaosking.de/wp-content/uploads/avsfilters/Unclassified/Anaglyph___(0.85_-_2010-08-29).7z mirror]
| {{Author/Kertai Gábor}}
|-
| Anaglypher
| A plugin for combining stereopairs into single anaglyph image.
| [[RGB32]], [[RGB24]]
| [http://shura.luberetsky.ru/anaglypher/Anaglypher.zip Plugin]
| [http://shura.luberetsky.ru/ Shura Luberetsky]
|-
|[http://forum.doom9.org/showthread.php?t=162616 Displace / McM_2D_to_3D]
|Plugin and script that enables you to convert 2d to 3d stereo with bidirectional pulfrich effect + add depth to stationary objects.
|[[RGB32]]
|[http://forum.doom9.org/showthread.php?t=162616#post1539121 Plugin/Script]
|Mcmount
|-
|[http://forum.doom9.org/showthread.php?t=143855 fauxD]
|2D to stereo-3D conversion in real-time.
|[[RGB24]], [[RGB32]]
|[http://forum.doom9.org/attachment.php?attachmentid=9278&d=1232092731 Plugin]
|eslave
|-
| [http://www.pantarheon.org/AviSynth3DToolbox/ Pantarheon 3D AviSynth Toolbox]
| The Toolbox contains a number of basic functions which allow you to multiplex the left and right views found in two separate videos into one video, using several of the common methods currently in use.
| [[YUY2]], [[YV12]]
| [http://www.pantarheon.org/AviSynth3DToolbox/zip/ Script]
| [http://www.pantarheon.org/ G. Adam Stanislav]
|}

=== 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}}
| [[AddAudio]]
| A function that adds silent audio to a clip. Needed for CCE 2.50 users.
| N/A
| Script
|
|-
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Audiofix]
|Plugin to fix a specific audio problem, see [http://forum.doom9.org/showthread.php?t=175991 discussion].
|
|[http://forum.doom9.org/showthread.php?p=1861891#post1861891 Plugin]
|{{Author/David Horman}}
|-
| [[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.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV24]], 8-bit [[Planar]] RGB
| [[AudioGraph|Plugin]]
| Richard Ling, {{author/Sh0dan}}
|-
|[[AudioLimiter]]
| To increase volume for silent sounds a lot, to increase volume for middle-volume sounds a little and to keep hi-volume sounds untoched.
| N/A
|[[AudioLimiter|Plugin]]
|dimzon
|-
|[[AudioTimeline]]
|Displays a audio timeline track under the frame. It is especially suited for thumbsheets, where it allows to estimate the audio track of the thumbnailed clip.
|[[RGB24]], [[RGB32]], [[Y8]], [[YV16]], [[YV24]], [[YV411]]
|[[AudioTimeline|Plugin]]
|martin53
|-
| [[BeFa]]
| Band Eliminate Filter for Audio.
| N/A
| [[BeFa|Plugin]]
| {{Author/kiraru2002}}
|-
| [[FindAudioSyncScript]]
| FindAudioSyncScript helps you to find the appropriate audio delays, if you have desync'ed audio.
| N/A
| Script
| IanB
|-
| [[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 float. It's a conditional audio filter, so the computation is done framewise.
| N/A
| [[MinMaxAudio|Plugin]]
| {{author/Wilbert Dijkhof}}
|-
|[[Normalize2]]
|Audio normalizing plugin. The main difference between this plugin and the built-in normalizing plugin [[Normalize]]() is that this plugin can store the peak level value in an external file and uses a lookup table to do the actual normalizing (for speed).
|N/A
|[[Normalize2|Plugin]]
|[http://sourceforge.net/u/jcsston/profile/ jcsston]
|-
| [[SoxFilter]]
| Use [http://sox.sourceforge.net/ SOX] audio effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
| N/A
| [[SoxFilter|Plugin]]
| {{author/Sh0dan}}, [https://github.com/pinterf pinterf]
|-
|[[Spectrogram]]
|Linear [http://en.wikipedia.org/wiki/Spectrogram spectrogram] for AviSynth 2.6.
|Any
|[[Spectrogram|Plugin]]
|[http://github.com/innocenat innocenat]
|-
|SwitchByAudio
|Plugin to switch video source based on audio. See [http://forum.doom9.org/showthread.php?t=167011 discussion]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://www.avisynth.nl/users/vcmohan/SwitchByAudio/SwitchByAudio.zip Plugin]
|{{Author/vcmohan}}
|-
|[http://forum.doom9.org/showpost.php?p=1722472&postcount=20 TimeStretchPlugin]
|[[TimeStretch]] with multichannel support and updated SoundTouch library.
|N/A
|[http://www.wilbertdijkhof.com/TimeStretch_v258.zip Plugin]
|{{Author/Wilbert Dijkhof}}
|-
| [[ViewAudio]]
| Includes two filters: ViewAudio and CacheAudio.
| [[YUY2]], [[YV12]]
| [[ViewAudio|Plugin]]
| {{Author/minamina}}
|-
| VUmeter
| Classic analog-style VU meter; see [https://forum.doom9.org/showthread.php?t=175370 discussion]. Uses MinMaxAudio.
| Any
| [https://github.com/raffriff42/AvisynthPlusUtilities script]
| raffriff42
|-
| [[Waveform]]
| Displays audio waveforms superimposed on the video, similar to AudioGraph below but with multi-channel support and consistent support for all colourspaces.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [[Waveform|Plugin]]
| {{Author/David Horman}}
|}

== 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. See [http://forum.doom9.org/showthread.php?p=397426 discussion.]
| [[RGB24]], [[RGB32]], [[YUY2]]
| [http://avisynth.nl/users/warpenterprises/files/adjust_5F25_dll_20031110.zip Plugin]
| [http://avisynth.nl/users/warpenterprises/ WarpEnterprises]
|-
|[http://forum.doom9.org/showthread.php?t=166588 Adaptive Lens Blur Repair]
|This function adaptively repairs video damaged by lens blur, using a frame-adaptive repair mask, a selection of sharpeners and multi-stage motion-compensated artifact removal.
|[[YV12]]
| [http://forum.doom9.org/attachment.php?attachmentid=13154&stc=1&d=1354907363 Script]
| fvisagie
|-
|[[amp]]
|Inspired by [http://forum.doom9.org/showthread.php?t=168293 RgbAmplifier], it performs temporal smoothing, then (optionally) enhances the difference between the windowed average and the current frame.
| [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
| [[amp|Plugin]]
| {{Author/David Horman}}
|-
|[[AutoOverlay]]
|Auto-aligned optimal overlay of one video clip onto another with color adjustment.
| [[RGB32]], [[YV24]], [[YV12]]
| [https://github.com/introspected/AutoOverlay/releases Plugin]
| [https://github.com/introspected introspected]
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace AutoTraceFilter]
|An intentionally useless plugin that uses [http://autotrace.sourceforge.net/ AutoTrace] to trace and then resize a source video, rendering the result using GDI+.
|[[RGB24]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/AutoTrace Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|-
| [http://forum.doom9.org/showthread.php?p=675275#post675275 BeforeAfter]
| See the difference before and after; similar discussion [http://forum.doom9.org/showthread.php?t=98876 here]. (missing [http://www.animemusicvideos.org/forum/viewtopic.php?f=11&t=45223 BeforeAfterDiff] and BeforeAfterLine scripts.)
| any
| Script
| Corran
|-
|[http://forum.doom9.org/showthread.php?t=158696 ccc]
|A plugin specifically designed for Cross-Conversion Correction.
|[[YV12]]
|[http://web.archive.org/web/20150403181720/http://japland.org/ccc/ccc_v0.4a_avs.zip Plugin]
|Daemon404
|-
| [http://www.avisynth.nl/users/vcmohan/ColorIt/ColorIt.html Colorit]
| Color a black and white image or recolor a color image. See [http://forum.doom9.org/showthread.php?t=93990 discussion.]
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/ColorIt/Colorit.zip Plugin]
| {{Author/vcmohan}}
|-
| 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]
| mikeytown2
|-
| DCT
| Plugin with the following functions: IDCT, IDCT2, FDCT, FDCT2. See [http://forum.doom9.org/showthread.php?p=667382#post667382 discussion]
| [[YUY2]]
| [http://alainmuchembled.free.fr/DCT.zip Plugin]
| lcld
|-
| [http://forum.doom9.org/showthread.php?p=1444027#post1444027 DDigit]
| DDigit Plugin Text Rendering Pack for Plugin writers. See [http://forum.doom9.org/showthread.php?t=156888 discussion.]
|
| [http://www.mediafire.com/download/bfhj5crwaxbupeh/DDigitTest_25%2626_v1-06_dll_20150330-RECOMPILE.zip Plugin]
| {{Author/StainlessS}}
|-
|[http://forum.doom9.org/showthread.php?t=95193 DeJump]
| This is a specific filter which might be used to stabilize some "jumpy" video sources captured from VHS.
|[[YUY2]]
| [http://forum.doom9.org/attachment.php?attachmentid=3988&d=1117479069 Plugin]
| dinstun
|-
|[[FFAvisynth]]
| A plugin which lets you directly use [http://en.wikipedia.org/wiki/Ffdshow ffdshow] video and audio filters from AviSynth scripts.
| [[YV12]], [[YUY2]], [[RGB24]], [[RGB32]]
| [http://sourceforge.net/projects/ffdshow-tryout/ Plugin]
| Milan Cutka
|-
|[http://github.com/Youka/FLuaG FLuaG]
| FLuaG (Floating Lua Graphics) is an AviSynth plugin for video/audio data editing via Lua scripting. See [http://forum.doom9.org/showthread.php?t=161852 discussion]
| [[RGB32]]
| [http://github.com/Youka/FLuaG/archive/master.zip Plugin]
| [http://github.com/Youka Youka]
|-
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
| Use Avisynth to process still images.
|
| [http://forum.doom9.org/showthread.php?t=150291 FritzPhoto]
|
|-
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 FSubstitute]
|Tries to automate the task of replacing bad frames using adjacent or close-by frames.
|[[YV12]]
|[http://forum.doom9.org/showthread.php?p=1600151#post1600151 Script]
|martin53
|-
|[http://forum.doom9.org/showthread.php?t=130611 GrainOptimizer]
|The only temporal-only grain reducer! See discussion for more information. Related topics: [http://forum.doom9.org/showthread.php?t=137117 x264: Film Grain Optimization], [http://web.archive.org/web/20090916181521/http://x264dev.blogspot.com/2008/05/film-grain-optimization.html]
|[[YV12]]
|[http://web.archive.org/web/20081228144846/http://mirror05.x264.nl/Dark/force.php?file=./GrainOptimizer_2.02.zip Plugin]
|Dark Shikari
|-
|[http://github.com/Youka/LVS LVS]
| LVS (Lua Video Sync) is a video frameserver plugin to edit video frames with the capability of scripting language Lua + 2D image processing functionality. See [http://forum.doom9.org/showthread.php?t=167716 discussion]. [https://github.com/Youka/LVS GitHub]
| [[RGB32]], [[RGB24]]
| [http://sourceforge.net/projects/lua-video-sync/files/ Plugin]
| [http://github.com/Youka Youka]
|-
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.html NeuralNet]
| Neural networks through back propagation learn and filter some types of noise. Classification and linear type networks are included.
| [[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
| [http://www.avisynth.nl/users/vcmohan/NeuralNet/NeuralNet.zip Plugin]
| {{Author/vcmohan}}
|-
| PseudoColor
| This filter first converts clip to b/w, then colors it to pseudorandom colors according to brightness. See [http://forum.doom9.org/showthread.php?t=61570 discussion.]
| [[RGB32]], [[RGB24]], [[YV12]]
| [http://www.avisynth.nl/users/warpenterprises/files/pseudocolor_5F25_dll_20030919.zip Plugin]
| Shubin
|-
|[http://github.com/jeremypoulter/QRCodeSource QRCodeSource]
|AviSynth plugin to provide a means to embed QR codes in video.
|[[RGB32]]
|[http://github.com/jeremypoulter/QRCodeSource/releases Plugin]
|[http://github.com/jeremypoulter jeremypoulter]
|-
|RemoveDeadPixels
|See [http://forum.doom9.org/showthread.php?p=699915#post699915 here] and [http://videoprocessing.fr.yuku.com/topic/27/Removedeadpixels here].
|[[YUY2]]
|[http://web.archive.org/web/20160610103945/http://home.arcor.de/kassandro/RemoveDeadPixels.rar Plugin]
|{{Author/kassandro}}
|-
|[http://forum.doom9.org/showthread.php?t=172601 rgba_rpn]
|A filter for manipulating the pixels of [[RGB]] (and also [[YUV]]) clips using [http://en.wikipedia.org/wiki/Reverse_Polish_notation reverse Polish notation.]
|[[RGB32]], [[RGB24]], [[YUY2]], [[YV12]]
|[http://horman.net/avisynth/downloads/rgba_rpn0.1.zip Plugin]
|{{Author/David Horman}}
|-
| [[SegmentedAmp]]
| Image is segmented with watershed algorithm for smoothing and/or sharpening.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| [http://avisynth.nl/index.php/SegmentedAmp Plugin]
| {{Author/vcmohan}}
|-
|[http://forum.doom9.org/showthread.php?t=172377 SmoothSkip]
|In tribute to tritical's awesome filter, this one tackles the inverse problem of [[TIVTC/TDecimate|TDecimate]]; allowing for addressing frames that have non-smooth, skippy motion. For source code see [http://github.com/jojje/SmoothSkip GitHub repository].
|[[YUY2]], [[YV12]]
|[http://github.com/jojje/SmoothSkip/releases/download/v1.0.2/SmoothSkip-1.0.2.zip Plugin]
|[http://github.com/jojje jojje]
|-
| [[Soothe]]
| Lessens the temporal instability and aliasing caused by sharpening, by comparing the original and sharpened clip, leaving a smoother and slightly softer output. See [http://forum.doom9.org/showthread.php?t=99679 discussion.]
| [[YV12]]
| [http://forum.doom9.org/showthread.php?t=99679 Script]
| {{Author/Didée}}
|-
|[https://sourceforge.net/projects/ssbrenderer/ SSBRenderer]
|SSBRenderer is a plugin for AviSynth to render 2D graphics and subtitles by SSB (Substation Beta) data on frames of video streams. [https://forum.doom9.org/showthread.php?t=169951 Doom9 Forum discussion], [https://github.com/Youka/SSBRenderer GitHub]
|[[RGB24]], [[RGB32]]
|[https://sourceforge.net/projects/ssbrenderer/files/ C-Plugin]
|[https://github.com/Youka Youka ]
|-
| [http://sourceforge.net/projects/avisynthtrackin/ Tracking]
| Use computer vision to track objects in the video, and produce ConditionalReader input. Demo at [http://www.youtube.com/watch?v=SQ-JtJs7US0 Youtube].
| [[RGB24]]
| [http://sourceforge.net/projects/avisynthtrackin/files/1.1/AvisynthTrackin.1.1.binary.zip/download Plugin]
| [http://avisynthtrackin.sourceforge.net/ Shlomo Matichin]
|-
| UnSmooth
| What does it do. It amplifies noise, small detail, and artifacts. Doesn't sound very attractive, but there can still be some detail left in over smoothed encodes. See [http://forum.doom9.org/showthread.php?t=63361 discussion.]
| [[YV12]]
| [http://web.archive.org/web/20090821183550/http://mf.creations.nl/avs/functions/UnSmooth-v0.1.avs Script]
| {{Author/mf}}
|-
| [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.html WaterShed]
| Assuming image grey values to be elevations, it is segmented into basins and watershed lines. Useful in certain medical image analysis and recoloring work.
| [[RGB32]], [[RGB24]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
| AviSynth 2.5.8: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed.zip Plugin]
AviSynth 2.6.0: [http://www.avisynth.nl/users/vcmohan/WaterShed/Watershed_2_6.zip Plugin]
| {{Author/vcmohan}}
|-
|[http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins xvplugins]
|This is simply a bunch of AviSynth stuff that isn't (really) possible using plain AviSynth and instead required a plugin.
|[[RGB32]]
| [http://github.com/Xenoveritas/AviSynth-Stuff/tree/master/xvplugins Plugin]
| [http://github.com/Xenoveritas Xenoveritas]
|}
<br/>

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

Xy-VSFilter

2024-01-04T08:29:48Z

Pinterf: new version .809

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Subtitling|Deep_color_tools}}
{{Filter3
|1=Gabest, guliverkli2, [https://github.com/Cyberbeing cyberbeing], {{Author/pinterf}}
|2=3.2.0.809
|3=[https://github.com/pinterf/xy-VSFilter/releases xyVSFilterSubFilter-pfmod-3.2.0.809.7z]
|4=Subtitling
|5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6= [https://forum.doom9.org/showthread.php?t=168282 Doom9 Forum]}}
<br>
== Description ==
xy-VSFilter Project (High Performance [[VSFilter]] Compatible Subtitle Filters). Based on VSFilter 2.39 Guliverkli2 with various important changes from VSFilter 2.41 MPC-HC.

VSFilter includes the following functions:
*VobSub
*TextSub
*TextSubSwapUV
*MaskSub

<br>

== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6]
* [x64]: [[AviSynth+]]
* Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: <code>TextSub</code> accepts YUV420P10, YUV420P16, YUV422P10 and YUV422P16 formats
<br>

== [[Script variables|Syntax and Parameters]] ==

===TextSub===
Adds subtitles from text-based subtitle formats.

{| class="wikitable"
|-
! Format name<br />
! Extension
|-
|[https://en.wikipedia.org/wiki/SubStation_Alpha SubStation Alpha / Advanced SubStation Alpha]
|.ssa / .ass
|-
|[https://en.wikipedia.org/wiki/SubRip SubRip]
|.srt
|-
|[https://en.wikipedia.org/wiki/MicroDVD MicroDVD]
|.sub
|-
|[https://en.wikipedia.org/wiki/SAMI SAMI]
|.smi
|-
|PowerDivX
|.psb
|-
|[https://en.wikipedia.org/wiki/Universal_Subtitle_Format Universal Subtitle Format]
|.usf
|-
|Structured Subtitle Format
|.ssf
|-
|[https://en.wikipedia.org/wiki/WebVTT WebVTT]
|.vtt
|}

<br>
:{{Template:FuncDef|TextSub (clip, string "file", int "charset", float "fps", string "vfr") }}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2|file|string|}}
:::Path to subtitles file.
<br>
::{{Par2|charset|int|1}}
:::''charset'' is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)
<br>
::{{Par2|fps|float|-1.0}}
:::''fps'' is the FPS to assume the video is at. You could just as well just use <code>AssumeFPS</code> instead of using this. VFR overrides this.
<br>
::{{Par2|vfr|string|""}}
:::''vfr'' is the path to the VFR timecodes file (format 1 or 2) to use for frame times. If set, overrides all other FPS specifications.
<br>

===VobSub===
Adds image-based subtitles in VobSub format. It consists of an *.idx file that stores the subtitle properties and a .sub file that contains the binary data..
<br>
<br>
:{{Template:FuncDef|VobSub (clip, string) }}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2| |string| }}
:::Path to subtitles file, only .idx and .sub files supported.
<br>
===MaskSub===
Creates a subtitle mask. 
<br>
<br>
:{{Template:FuncDef|MaskSub (string "file", int "width", int "height", float "fps", int "length", int "charset", string "vfr", string "pixel_type") }}
<br>
::{{Par2|file|string|}}
:::Path to subtitles file.
<br>
::{{Par2|width|int| }}
::{{Par2|height|int| }}
:::''width'' and ''height'' specify the size of the generated clip, in pixels.
<br>
::{{Par2|fps|float| }}
:::''fps'' specifies the framerate of the generated clip.
<br>
::{{Par2|length|int| }}
:::''length'' is the number of frames to produce in the clip.
<br>
::{{Par2|charset|int| }}
:::''charset'' is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)
<br>
::{{Par2|vfr|string|""}}
:::''vfr'' is the path to the VFR timecodes file (format 1 or 2) to use for frame times.
<br>
::{{Par2|pixel_type|string|"RGB32"}}
:::Pixel type, can be set to: <code>"RGB32", "YUV420P10" or "YUV420P16"</code>
:::<s>'''Note:''' With "RGB32" output the mask is flipped vertically, use <code>[[FlipVertical]]()</code> to correct it.</s> - Fixed in v3.2.0.808
<br>

===TextSubSwapUV===
<br>
:{{Template:FuncDef|TextSubSwapUV (bool) }}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2| |bool|false}}
:::Toggles (globally) whether to swap assume the U and V planes are swapped in YV12 video when rendering subtitles. Default is false.
<br>

== Examples ==
[[AviSource]]("Blah.avi")
TextSub(file="subtitle.ass")

#Assume clip is 1280x720, 24fps, and 3,000 frames total
MaskSub(file="subtitle.ass", width=1280, height=720, fps=24, length=3000)
<br>
#or alternatively you can get the [[Clip_properties|clip properties]]
video = AviSource("Blah.avi")
MaskSub(file="subtitle.ass", width=video.Width(), height=video.Height(), fps=video.FrameRate(), length=video.FrameCount())

[[AviSource]]("Blah.avi")
VobSub("subtitle.sub")

<br>

== Changelog ==
See GitHub releases page: https://github.com/pinterf/xy-VSFilter/releases
<br>
<br>

== External Links ==
*[https://github.com/pinterf/xy-VSFilter GitHub] - Source code repository (latest version from pinterf).
*[https://github.com/HomeOfVapourSynthEvolution/xy-VSFilter GitHub] - xy-VSFilter with VapourSynth interface added, based on pinterf's fork
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Subtitling|External Filters]] ←'''

SoxFilter

2024-01-04T08:27:37Z

Pinterf: version 2.2

{{FilterCat4|External_filters|Plugins|Plugins_x64|Audio_filters}}
{{Filter3
| pinterf v2.2
{{author/Sh0dan}} v1.1 beta
| v2.2
| 3=[https://github.com/pinterf/SoxFilter/releases SoxFilter 2 releases]
| 4=Audio filters
| 5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
| 6=[https://forum.doom9.org/showthread.php?t=104792 Doom9 Forum]<br>[https://forum.doom9.org/showthread.php?t=181566 Doom9 Forum (v1.1 x64 version)]}}

== Description ==
This plugin will allow you to run [http://sox.sourceforge.net/ SOX] effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
<br>Version 1.1 is based on SoX library 12.17.9
<br>Version 2.0 is based on SoX library 14.4.2
<br>
SoX library works with 32 bit integer samples internally. All inputs will be automatically converted to this audio format.
<br>
<br>
== Requirements ==
=== v2.x ===
* [x86/x64]: [[AviSynth+ 3.7.3]]
=== v1.1 ===
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.5.8 or greater]
* [x64]: [[AviSynth+]]
* Supported color formats: N/A
<br>
== [[Script variables|Syntax and Parameters]] ==

:{{Template:FuncDef|SoxFilter (clip, string effect1 [, string effect 2, string effect 3...])}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Any number of effects can be entered, and they will be executed in the order they are specified. Effect syntax is just like SOX. See [[#Effect Overview|Effect Overview]] and [[#Filter Reference|Filter Reference]] below.
<br>
==Usage==

A simple filter could look like this:<br />

<pre>AviSource("movie.avi")
SoxFilter("bandpass 500 100")
convertAudioTo16Bit()</pre>
This will keep a 100Hz band around 500Hz. SoxFilter converts audio to 32 bit integers. This allows to keep the additional dynamic range of float point samples, but it requires a convertion to 16 bit audio before output, since most codecs only support 16 bit.

Multiple effects can be stacked like this:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000", "vol 2.0", "reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
Which is a faster version of:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000")
SoxFilter("vol 2.0")
SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
<br>
== AviSynth Specifics ==

=== Remarks ===

Since v1.1 release SoX library internal API has been changed. v2.x was created from scratch.
Also, some effects were removed, and others added in the past ~15 years.
The parameters of some effects had been changed as well.

E.g. reverb parameters were modified in 2008; "filter" was removed, use "sinc" instead
(with a different syntax).

Check SoxFilter_usages.txt in v2.x release pack, or visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for effect parameters and their actual description.

=== Known Issues ===

* Linear access is heavily recommended. SOX filters doesn't support seeking, so stream is restarted every time a samples previous to the last one is requested.
* Do not use Avisynth+ versions before 3.7.3 if filter result is used later in the script multiple times. Audio cache (which was reintroduced in Avisynth+ 3.7.3) is a must have in those cases.
* (v2.1-) none of filters were removed from 14.4.2 SoX library, still, some may be incompatible. Filters can even change sample rate or alter the number of channels. In v1.1 these filters were not allowed.
* (v1.1 only) The AviSynth version is VERY picky about spaces. If you make double spaces or a space before or after the quotes the command will not be recognized.
* (v1.1 only) If one filter doesn't support multichannel audio the entire chain is converted to mono filters, this might affect some filters like '''earwax'''. Use multiple filter instances instead.
* (v1.1 only) Some filters have been removed since they were incompatible with the AviSynth version. All these filters have internal Avisynth equivalents.
* (v1.1 only) '''compand''' is very unstable in the current interface, and doesn't support restarts (distorted audio). Don't use this together with other effetcs.
* (v1.1 only) The length of audio cannot be modified.

=== Version 1.1 ===

*Solved issue with earwax refusing to play.

*Solved problem with time alternating effects.

*Solved issues with some filters producing clicks.

*Made sure compand and mcompand doesn't crash. Still quite buggy though.
<br>
== Effect Overview ==

This section contains effects supported in SoxFilter v1.1 (12.17.9 SoX Library version).

For effects supported by SoxFilter v2.x (SoX Library 14.4.2) visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for parameters and their actual description.

<pre> Effects:
band [ -n ] center [ width ]
bandpass frequency bandwidth

bandreject frequency bandwidth
chorus gain-in gain out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ]
compand attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]

dcshift shift [ limitergain ]
deemph
earwax
echo gain-in gain-out delay decay [ delay decay ... ]
echos gain-in gain-out delay decay [ delay decay ... ]
fade [ type ] fade-in-length

[ stop-time [ fade-out-length ] ]
filter [ low ]-[ high ] [ window-len [ beta ]]
flanger gain-in gain-out delay decay speed < -s | -t >

highp frequency
highpass frequency
lowp frequency
lowpass frequency

mask
mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]" xover_freq
noiseprof [profile-file]
noisered profile-file [threshold]
phaser gain-in gain-out delay decay speed < -s | -t >

pitch shift [ width interpole fade ]
reverb gain-out reverb-time delay [ delay ... ]
silence above_periods [ duration threshold[ d | % ]
[ below_periods duration
threshold[ d | % ]]
speed [ -c ] factor
stretch [ factor [ window fade shift fading ]
swap [ 1 2 | 1 2 3 4 ]
synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
vibro speed [ depth ]
vol gain [ type [ limitergain ] ]</pre>
== Filter Reference ==

This section contains effects supported in SoxFilter v1.1 (12.17.9 SoX Library version).

For effects supported by SoxFilter v2.x (SoX Library 14.4.2) visit https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects for parameters and their actual description.

<pre> band [ -n ] center [ width ]
Apply a band-pass filter. The frequency response drops loga-
rithmically around the center frequency. The width gives the
slope of the drop. The frequencies at center + width and
center - width will be half of their original amplitudes.
Band defaults to a mode oriented to pitched signals, i.e.
voice, singing, or instrumental music. The -n (for noise)
option uses the alternate mode for un-pitched signals. Warn-
ing: -n introduces a power-gain of about 11dB in the filter,
so beware of output clipping. Band introduces noise in the
shape of the filter, i.e. peaking at the center frequency and
settling around it. See filter for a bandpass effect with
steeper shoulders.

bandpass frequency bandwidth
Butterworth bandpass filter. Description coming soon!

bandreject frequency bandwidth
Butterworth bandreject filter. Description coming soon!

chorus gain-in gain-out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ... ]
which the absolute value of the input signal is integrated to
determine its volume; attacks refer to increases in volume
and decays refer to decreases. Where more than one pair of
attack/decay parameters are specified, each channel is
treated separately and the number of pairs must agree with
the number of input channels. The second parameter is a list
of points on the compander's transfer function specified in
dB relative to the maximum possible signal amplitude. The
input values must be in a strictly increasing order but the
transfer function does not have to be monotonically rising.
The special value -inf may be used to indicate that the input
volume should be associated output volume. The points
-inf,-inf and 0,0 are assumed; the latter may be overridden,
but the former may not.

The third (optional) parameter is a post-processing gain in
dB which is applied after the compression has taken place;
the fourth (optional) parameter is an initial volume to be
assumed for each channel when the effect starts. This per-
mits the user to supply a nominal level initially, so that,
for example, a very large gain is not applied to initial sig-
nal levels before the companding action has begun to operate:
it is quite probable that in such an event, the output would
be severely clipped while the compander gain properly adjusts
itself.

The fifth (optional) parameter is a delay in seconds. The
input signal is analyzed immediately to control the compan-
der, but it is delayed before being fed to the volume
adjuster. Specifying a delay approximately equal to the
attack/decay times allows the compander to effectively oper-
ate in a "predictive" rather than a reactive mode.

dcshift shift [ limitergain ]
DC Shift the audio data, with basic linear amplitude formula.
This is most useful if your audio data tends to not be cen-
tered around a value of 0. Shifting it back will allow you
to get the most volume adjustments without clipping audio
data.
The first option is the dcshift value. It is a floating
point number that indicates the amount to shift.
An option limtergain value can be specified as well. It
should have a value much less then 1.0 and is used only on
peaks to prevent clipping.

deemph Apply a treble attenuation shelving filter to samples in
audio cd format. The frequency response of pre-emphasized
recordings is rectified. The filtering is defined in the
standard document ISO 908.
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.
earwax Makes sound easier to listen to on headphones. Adds audio-
cues to samples in audio cd format so that when listened to
on headphones the stereo image is moved from inside your head
(standard for headphones) to outside and in front of the lis-
tener (standard for speakers). See
www.geocities.com/beinges for a full explanation.

echo gain-in gain-out delay decay [ delay decay ... ]
Add echoing to a sound sample. Each delay/decay part gives
the delay in milliseconds and the decay (relative to gain-in)
of that echo. Gain-out is the volume of the output.

echos gain-in gain-out delay decay [ delay decay ... ]
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.

fade [ type ] fade-in-length
[ stop-time [ fade-out-length ] ]
Add a fade effect to the beginning, end, or both of the audio
data.

For fade-ins, this starts from the first sample and ramps the
volume of the audio from 0 to full volume over fade-in-length
seconds. Specify 0 seconds if no fade-in is wanted.

For fade-outs, the audio data will be truncated at the stop-
time and the volume will be ramped from full volume down to 0
starting at fade-out-length seconds before the stop-time. No
fade-out is performed if these options are not specified.
All times can be specified in either periods of time or sam-
ple counts. To specify time periods use the format
hh:mm:ss.frac format. To specify using sample counts, spec-
ify the number of samples and append the letter 's' to the
sample count (for example 8000s).
An optional type can be specified to change the type of enve-
lope. Choices are q for quarter of a sinewave, h for half a
sinewave, t for linear slope, l for logarithmic, and p for
inverted parabola. The default is a linear slope.

filter [ low ]-[ high ] [ window-len [ beta ] ]
Apply a Sinc-windowed lowpass, highpass, or bandpass filter
of given window length to the signal. low refers to the fre-
quency of the lower 6dB corner of the filter. high refers to
the frequency of the upper 6dB corner of the filter.

A lowpass filter is obtained by leaving low unspecified, or
0. A highpass filter is obtained by leaving high unspeci-
fied, or 0, or greater than or equal to the Nyquist fre-
quency.

The window-len, if unspecified, defaults to 128. Longer win-
dows give a sharper cutoff, smaller windows a more gradual
cutoff.

The beta, if unspecified, defaults to 16. This selects a
Kaiser window. You can select a Nuttall window by specifying
anything <= 2.0 here. For more discussion of beta, look
under the resample effect.

flanger gain-in gain-out delay decay speed < -s | -t >
Add a flanger to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
Gain-out is the volume of the output.
highp frequency
Apply a single pole recursive high-pass filter. The fre-
quency response drops logarithmically with I frequency in the
middle of the drop. The slope of the filter is quite gentle.
See filter for a highpass effect with sharper cutoff.

highpass frequency
Butterworth highpass filter. Description coming soon!

lowp frequency
Apply a single pole recursive low-pass filter. The frequency
response drops logarithmically with frequency in the middle
of the drop. The slope of the filter is quite gentle. See
filter for a lowpass effect with sharper cutoff.

lowpass frequency
Butterworth lowpass filter. Description coming soon!

mask Add "masking noise" to signal. This effect deliberately adds
white noise to a sound in order to mask quantization effects,
created by the process of playing a sound digitally. It
tends to mask buzzing voices, for example. It adds 1/2 bit
of noise to the sound file at the output bit depth.

mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[gain [initial-volume [delay ] ] ]" xover_freq

Multi-band compander is similar to the single band compander
but the audio file is first divided up into bands and then
the compander is ran on each band. See the compand effect
for definition of its options. Compand options are specified
between double quotes and the crossover frequency for that
band is specefied seperately with xover_fre. This can be
repeated multiple times to create multiple bands.

noiseprof [profile-file]

noisered profile-file [threshold]
Noise reduction filter with profiling. This filter is moder-
ately effective at removing consistent background noise such
as hiss or hum. To use it, first run the noiseprof effect on
a section of silence (that is, a section which contains noth-
ing but noise). The noiseprof effect will print a noise pro-
file to profile-file, or to stdout if no profile-file is
specified. If there is sound output on stdout then the pro-
file will instead be directed to stderr.

To actually remove the noise, run SoX again with the noisered
filter. The filter needs one argument, profile-file, which
contains the noise profile from noiseprof. thershold speci-
fies how much noise should be removed, and may be between 0
and 1 with a default of 0.5. Higher values will remove more
noise but present a greater possibility of distorting the
desired audio signal. Experiment with different threshold
values to find the optimal one for your sample.

phaser gain-in gain-out delay decay speed < -s | -t >
Add a phaser to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
The decay should be less than 0.5 to avoid feedback. Gain-
out is the volume of the output.

pitch shift [ width interpole fade ]
Change the pitch of file without affecting its duration by
cross-fading shifted samples. shift is given in cents. Use a
positive value to shift to treble, negative value to shift to
bass. Default shift is 0. width of window is in ms. Default
width is 20ms. Try 30ms to lower pitch, and 10ms to raise
-w < nut / ham > : select either a Nuttal (~90 dB stopband)
or Hamming (~43 dB stopband) window. Default is nut.

-width long / short / # : specify the (approximate) width of
the filter. long is 1024 samples; short is 128 samples.
Alternatively, an exact number can be used. Default is long.
The short option is not recommended, as it produces poor
quality results.

-cutoff # : specify the filter cutoff frequency in terms of
fraction of frequency bandwidth, also know as the Nyquist
frequency. Please see the resample effect for further infor-
mation on Nyquist frequency. If upsampling, then this is the
fraction of the original signal that should go through. If
downsampling, this is the fraction of the signal left after
downsampling. Default is 0.95. Remember that this is a
float.

reverb gain-out reverbe-time delay [ delay ... ]
Add reverberation to a sound sample. Each delay is given in
milliseconds and its feedback is depending on the reverb-time
in milliseconds. Each delay should be in the range of half
to quarter of reverb-time to get a realistic reverberation.
Gain-out is the volume of the output.

silence above_periods [ duration threshold[ d | % ]
[ below_periods duration threshold[ d | % ]]
Removes silence from the beginning or end of a sound file.
Silence is anything below a specified threshold.
When trimming silence from the beginning of a sound file, you
specify a duration of audio that is above a given silence
threshold before audio data is processed. You can also spec-
ify the count of periods of none silence you want to detect
before processing audio data. Specify a period of 0 if you
do not want to trim data from the front of the sound file.
When optionally trimming silence form the end of a sound
file, you specify the duration of audio that must be below a
given threshold before stopping to process audio data. A
count of periods that occur below the threshold may also be
specified. If this options are not specified then data is
not trimmed from the end of the audio file.
Duration counts may be in the format of time, hh:mm:ss.frac,
or in the exact count of samples.
Threshold may be suffixed with d, or % to indicated the value
is in decibels or a percentage of max value of the sample
value. A value of '0%' will look for total silence.

speed [ -c ] factor
Speed up or down the sound, as a magnetic tape with a speed
control. It affects both pitch and time. A factor of 1.0
means no change, and is the default. 2.0 doubles speed, thus
time length is cut by a half and pitch is one octave higher.
0.5 halves speed thus time length doubles and pitch is one
octave lower. If the optional -c parameter is used then the
factor is specified in "cents".

stretch factor [window fade shift fading]
Time stretch file by a given factor. Change duration without
affecting the pitch. factor of stretching: >1.0 lengthen,
<1.0 shorten duration. window size is in ms. Default is
20ms. The fade option, can be "lin". shift ratio, in [0.0
1.0]. Default depends on stretch factor. 1.0 to shorten, 0.8
to lengthen. The fading ratio, in [0.0 0.5]. The amount of a
fade's default depends on factor and shift.

synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
The synth effect will generate various types of audio data.
Although this effect is used to generate audio data, an input
file must be specified. The length of the input audio file
determines the length of the output audio file.
<length> length in sec or hh:mm:ss.frac, 0=inputlength,
default=0
<type> is sine, square, triangle, sawtooth, trapetz, exp,
whitenoise, pinknoise, brownnoise, default=sine
<mix> is create, mix, amod, default=create
<freq> frequency at beginning in Hz, not used for noise..
<freq2> frequency at end in Hz, not used for noise..
<freq/2> can be given as %%n, where 'n' is the number of half
notes in respect to A (440Hz)
<off> Bias (DC-offset) of signal in percent, default=0
<ph> phase shift 0..100 shift phase 0..2*Pi, not used for
noise..
<p1> square: Ton/Toff, triangle+trapetz: rising slope time
(0..100)
<p2> trapetz: ON time (0..100)
the audio data. The format for specifying sample counts is
the number of samples with the letter 's' appended to it. A
value of 8000s will wait until 8000 samples are read before
starting to process audio data.

vibro speed [ depth ]
Add the world-famous Fender Vibro-Champ sound effect to a
sound sample by using a sine wave as the volume knob. Speed
gives the Hertz value of the wave. This must be under 30.
Depth gives the amount the volume is cut into by the sine
wave, ranging 0.0 to 1.0 and defaulting to 0.5.

vol gain [ type [ limitergain ] ]
The vol effect is much like the command line option -v. It
allows you to adjust the volume of an input file and allows
you to specify the adjustment in relation to amplitude,
power, or dB. If type is not specified then it defaults to
amplitude.
When type is amplitude then a linear change of the amplitude
is performed based on the gain. Therefore, a value of 1.0
will keep the volume the same, 0.0 to < 1.0 will cause the
volume to decrease and values of > 1.0 will cause the volume
to increase. Beware of clipping audio data when the gain is
greater then 1.0. A negative value performs the same adjust-
ment while also changing the phase.
When type is power then a value of 1.0 also means no change
in volume.
When type is dB the amplitude is changed logarithmically.
0.0 is constant while +6 doubles the amplitude.
An optional limitergain value can be specified and should be
a value much less then 1.0 (ie 0.05 or 0.02) and is used only
on peaks to prevent clipping. Not specifying this parameter
will cause no limiter to be used. In verbose mode, this
effect will display the percentage of audio data that needed
to be limited.</pre>

== Examples ==

<pre> Echo

An echo(1,3x,1 builtins) effect can be naturally found in(1,8) the mountains, standing some-
where on a mountain and shouting a single word will result in(1,8) one or
more repetitions of the word (if(3,n) not, turn a bit around and try again,
or climb to the next mountain).

However, the time(1,2,n) difference between shouting and repeating is the
delay (time(1,2,n)), its loudness is the decay. Multiple echos can have dif-
ferent delays and decays.

It is very popular to use echos to play an instrument with itself
together, like some guitar players (Brain May from Queen) or vocalists
are doing. For music samples of more than one instrument, echo(1,3x,1 builtins) can be
used to add a second sample shortly after the original one.

This will sound as if(3,n) you are doubling the number of instruments play-
ing in(1,8) the same sample:

SoxFilter("echo 0.8 0.88 60.0 0.4")

If the delay is very short, then it sound like a (metallic) robot play-
ing music:

SoxFilter("echo 0.8 0.88 6.0 0.4")

Longer delay will sound like an open(2,3,n) air concert in(1,8) the mountains:

SoxFilter("echo 0.8 0.9 1000.0 0.3")

One mountain more, and:

SoxFilter("echo 0.8 0.9 1000.0 0.3 1800.0 0.25")

Echos

Like the echo effect, echos stand for "ECHO in Sequel", that is the
first echos takes the input, the second the input and the first echos,
the third the input and the first and the second echos, ... and so on.
Care should be taken using many echos (see introduction); a single
echos has the same effect as a single echo.

The sample will be bounced twice in(1,8) symmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 700.0 0.3")

The sample will be bounced twice in(1,8) asymmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 900.0 0.3")

The sample will sound as if(3,n) played in(1,8) a garage:

SoxFilter("echos 0.8 0.7 40.0 0.25 63.0 0.3")

Chorus

The chorus effect has its name because it will often be used to make a
single vocal sound like a chorus. But it can be applied to other
instrument samples too.

It works like the echo(1,3x,1 builtins) effect with a short delay, but the delay isn't
constant. The delay is varied using a sinusoidal or triangular modula-
tion. The modulation depth defines the range the modulated delay is
played before or after the delay. Hence the delayed sound will sound
slower or faster, that is the delayed sound tuned around the original
one, like in(1,8) a chorus where some vocals are a bit out of tune.

The typical delay is around 40ms to 60ms, the speed of the modulation
is best near 0.25Hz and the modulation depth around 2ms.

A single delay will make the sample more overloaded:

SoxFilter("chorus 0.7 0.9 55.0 0.4 0.25 2.0 -t")

Two delays of the original samples sound like this:

SoxFilter("chorus 0.6 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 1.3 -s")

A big chorus of the sample is (three additional samples):

SoxFilter("chorus 0.5 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 2.3 -t 40.0 0.3 0.3 1.3 -s")

Flanger

The flanger effect is like the chorus effect, but the delay varies
between 0ms and maximal 5ms. It sound like wind blowing, sometimes
faster or slower including changes of the speed.

The flanger effect is widely used in(1,8) funk and soul music, where the
guitar sound varies frequently slow or a bit faster.

The typical delay is around 3ms to 5ms, the speed of the modulation is
best near 0.5Hz.

Now, let's groove the sample:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -s")

listen carefully between the difference of sinusoidal and triangular
modulation:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -t")

If the decay is a bit lower, than the effect sounds more popular:

SoxFilter("flanger 0.8 0.88 3.0 0.4 0.5 -t")

The drunken loudspeaker system:

SoxFilter("flanger 0.9 0.9 4.0 0.23 1.3 -s")

Reverb

The reverb effect is often used in(1,8) audience hall which are to small or
contain too many many visitors which disturb (dampen) the reflection of
sound at the walls. Reverb will make the sound be perceived as if(3,n) it
were in(1,8) a large hall. You can try the reverb effect in(1,8) your bathroom
or garage or sport halls by shouting loud some words. You'll hear the
words reflected from the walls.

The biggest problem in(1,8) using the reverb effect is the correct setting
of the (wall) delays such that the sound is realistic and doesn't sound
like music playing in(1,8) a tin(1,5) can or has overloaded feedback which
destroys any illusion of playing in(1,8) a big hall. To help you obtain
realistic reverb effects, you should decide first how long the reverb
should take place until it is not loud enough to be registered by your
ears. This is be done by varying the reverb time(1,2,n) "t". To simulate
small halls, use 200ms. To simulate large halls, use 1000ms. Clearly,
the walls of such a hall aren't far away, so you should define its set-
ting be given every wall its delay time. However, if(3,n) the wall is to
far away for the reverb time(1,2,n), you won't hear the reverb, so the nearest
wall will be best at "t/4" delay and the farthest at "t/2". You can try
other distances as well, but it won't sound very realistic. The walls
shouldn't stand to close(2,7,n) to each other and not in(1,8) a multiple integer
distance to each other ( so avoid wall like: 200.0 and 202.0, or some-
thing like 100.0 and 200.0 ).

Since audience halls do have a lot of walls, we will start designing
one beginning with one wall:

SoxFilter("reverb 1.0 600.0 180.0")

One wall more:

SoxFilter("reverb 1.0 600.0 180.0 200.0")

Next two walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")

Now, why not a futuristic hall with six walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0 280.0 300.0")

If you run out of machine power or memory, then stop as many applica-
tions as possible (every interrupt will consume a lot of CPU time(1,2,n) which
for bigger halls is absolutely necessary).

Phaser

The phaser effect is like the flanger effect, but it uses a reverb
instead of an echo(1,3x,1 builtins) and does phase shifting. You'll hear the difference
in(1,8) the examples comparing both effects (simply change the effect name).
The delay modulation can be sinusoidal or triangular, preferable is the
later for multiple instruments. For single instrument sounds, the sinu-
soidal phaser effect will give a sharper phasing effect. The decay
shouldn't be to close(2,7,n) to 1.0 which will cause dramatic feedback. A
good range is about 0.5 to 0.1 for the decay.

We will take a parameter setting as for the flanger before (gain-out is
lower since feedback can raise(3,n) the output dramatically):

SoxFilter("phaser 0.8 0.74 3.0 0.4 0.5 -t")

The drunken loudspeaker system (now less(1,3) alcohol):

SoxFilter("phaser 0.9 0.85 4.0 0.23 1.3 -s")

A popular sound of the sample is as follows:

SoxFilter("phaser 0.89 0.85 1.0 0.24 2.0 -t")

The sample sounds if(3,n) ten springs are in(1,8) your ears:

SoxFilter("phaser 0.6 0.66 3.0 0.6 2.0 -t")

Compander

The compander effect allows the dynamic range of a signal(2,7) to be com-
pressed or expanded. For most situations, the attack time(1,2,n) (response to
the music getting louder) should be shorter than the decay time(1,2,n) because
our ears are more sensitive to suddenly loud music than to suddenly
soft music.

For example, suppose you are listening to Strauss' "Also Sprach
Zarathustra" in(1,8) a noisy environment such as a car. If you turn up the
volume enough to hear the soft passages over the road noise, the loud
sections will be too loud. You could try this:

SoxFilter("compand 0.3,1 -90,-90,-70,-70,-60,-20,0,0 -5 0 0.2")

The transfer function ("-90,...") says that very soft sounds between
-90 and -70 decibels (-90 is about the limit of 16-bit encoding(3,n)) will
remain unchanged. That keeps the compander from boosting the volume on
"silent" passages such as between movements. However, sounds in(1,8) the
range -60 decibels to 0 decibels (maximum volume) will be boosted so
that the 60-dB dynamic range of the original music will be compressed
3-to-1 into a 20-dB range, which is wide enough to enjoy the music but
narrow enough to get around the road noise. The -5 dB output gain is
needed to avoid clipping (the number is inexact, and was derived by
experimentation). The 0 for the initial volume will work fine for a
clip that starts with a bit of silence, and the delay of 0.2 has the
effect of causing the compander to react a bit more quickly to sudden
volume changes.

</pre>
<br>
== Changelog ==
Version Date Changes<br>
v2.2 2024/01/04 - Change the way how the effect chain is reinitialized:
Fix the "Normalize" after SoxFilter("compand") case.
v2.1 2023/12/03 - Allow effects which can alter sampling rate
- Allow effects which can change the number of channels
- Add distinct XP build (v141_xp toolset) needed in 2023
v2.0 2023/12/02 - Full rewrite, using 14.4.2 libsox library version, moved to github
v1.1 beta 2006/01/02 - release (12.17.9 libsox)
v1.0 2005/12/29 - initial release
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.1
|[x86]: [https://forum.doom9.org/attachment.php?attachmentid=5193&d=1136242927 SoxFilter_11.zip] /// [https://forum.doom9.org/attachment.php?attachmentid=5194&d=1136242951 SoxFilter_11_src.zip]
---------
[x64]: [https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|[x86]: [https://web.archive.org/web/20200626015535if_/https://files.videohelp.com/u/223002/SoxFilter_11.zip SoxFilter_11.zip] (src included)
---------
[x64]: [https://web.archive.org/web/20200703223101if_/https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|}
<br>

==External Links ==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Audio_Filters|External Filters]] ←'''

SoxFilter

2023-12-18T09:56:33Z

Pinterf: /* Filter Reference */ Add warning and link for a newer effect reference page.

{{FilterCat4|External_filters|Plugins|Plugins_x64|Audio_filters}}
{{Filter3
| pinterf v2.1
{{author/Sh0dan}} v1.1 beta
| v2.1
| 3=[https://github.com/pinterf/SoxFilter/releases SoxFilter 2 releases]
| 4=Audio filters
| 5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
| 6=[https://forum.doom9.org/showthread.php?t=104792 Doom9 Forum]<br>[https://forum.doom9.org/showthread.php?t=181566 Doom9 Forum (v1.1 x64 version)]}}

== Description ==
This plugin will allow you to run [http://sox.sourceforge.net/ SOX] effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
<br>Version 1.1 is based on SoX library 12.17.9
<br>Version 2.0 is based on SoX library 14.4.2
<br>
SoX library works with 32 bit integer samples internally. All inputs will be automatically converted to this audio format.
<br>
<br>
== Requirements ==
=== v2.1 ===
* [x86/x64]: [[AviSynth+ 3.7.3]]
=== v1.1 ===
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.5.8 or greater]
* [x64]: [[AviSynth+]]
* Supported color formats: N/A
<br>
== [[Script variables|Syntax and Parameters]] ==

:{{Template:FuncDef|SoxFilter (clip, string effect1 [, string effect 2, string effect 3...])}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Any number of effects can be entered, and they will be executed in the order they are specified. Effect syntax is just like SOX. See [[#Effect Overview|Effect Overview]] and [[#Filter Reference|Filter Reference]] below.
<br>
==Usage==

A simple filter could look like this:<br />

<pre>AviSource("movie.avi")
SoxFilter("bandpass 500 100")
convertAudioTo16Bit()</pre>
This will keep a 100Hz band around 500Hz. SoxFilter converts audio to 32 bit integers. This allows to keep the additional dynamic range of float point samples, but it requires a convertion to 16 bit audio before output, since most codecs only support 16 bit.

Multiple effects can be stacked like this:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000", "vol 2.0", "reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
Which is a faster version of:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000")
SoxFilter("vol 2.0")
SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
<br>
== AviSynth Specifics ==

=== Remarks ===

Since v1.1 release SoX library internal API has been changed. v2.x was created from scratch.
Also, some effects were removed, and others added in the past ~15 years.
The parameters of some effects had been changed as well.

E.g. reverb parameters were modified in 2008; "filter" was removed, use "sinc" instead
(with a different syntax).

Check SoxFilter_usages.txt in v2.x release pack, or visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for effect parameters and their actual description.

=== Known Issues ===

* Linear access is heavily recommended. SOX filters doesn't support seeking, so stream is restarted every time a samples previous to the last one is requested.
* Do not use Avisynth+ versions before 3.7.3 if filter result is used later in the script multiple times. Audio cache (which was reintroduced in Avisynth+ 3.7.3) is a must have in those cases.
* (v2.1-) none of filters were removed from 14.4.2 SoX library, still, some may be incompatible. Filters can even change sample rate or alter the number of channels. In v1.1 these filters were not allowed.
* (v1.1 only) The AviSynth version is VERY picky about spaces. If you make double spaces or a space before or after the quotes the command will not be recognized.
* (v1.1 only) If one filter doesn't support multichannel audio the entire chain is converted to mono filters, this might affect some filters like '''earwax'''. Use multiple filter instances instead.
* (v1.1 only) Some filters have been removed since they were incompatible with the AviSynth version. All these filters have internal Avisynth equivalents.
* (v1.1 only) '''compand''' is very unstable in the current interface, and doesn't support restarts (distorted audio). Don't use this together with other effetcs.
* (v1.1 only) The length of audio cannot be modified.

=== Version 1.1 ===

*Solved issue with earwax refusing to play.

*Solved problem with time alternating effects.

*Solved issues with some filters producing clicks.

*Made sure compand and mcompand doesn't crash. Still quite buggy though.
<br>
== Effect Overview ==

This section contains effects supported in SoxFilter v1.1 (12.17.9 SoX Library version).

For effects supported by SoxFilter v2.x (SoX Library 14.4.2) visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for parameters and their actual description.

<pre> Effects:
band [ -n ] center [ width ]
bandpass frequency bandwidth

bandreject frequency bandwidth
chorus gain-in gain out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ]
compand attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]

dcshift shift [ limitergain ]
deemph
earwax
echo gain-in gain-out delay decay [ delay decay ... ]
echos gain-in gain-out delay decay [ delay decay ... ]
fade [ type ] fade-in-length

[ stop-time [ fade-out-length ] ]
filter [ low ]-[ high ] [ window-len [ beta ]]
flanger gain-in gain-out delay decay speed < -s | -t >

highp frequency
highpass frequency
lowp frequency
lowpass frequency

mask
mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]" xover_freq
noiseprof [profile-file]
noisered profile-file [threshold]
phaser gain-in gain-out delay decay speed < -s | -t >

pitch shift [ width interpole fade ]
reverb gain-out reverb-time delay [ delay ... ]
silence above_periods [ duration threshold[ d | % ]
[ below_periods duration
threshold[ d | % ]]
speed [ -c ] factor
stretch [ factor [ window fade shift fading ]
swap [ 1 2 | 1 2 3 4 ]
synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
vibro speed [ depth ]
vol gain [ type [ limitergain ] ]</pre>
== Filter Reference ==

This section contains effects supported in SoxFilter v1.1 (12.17.9 SoX Library version).

For effects supported by SoxFilter v2.x (SoX Library 14.4.2) visit https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects for parameters and their actual description.

<pre> band [ -n ] center [ width ]
Apply a band-pass filter. The frequency response drops loga-
rithmically around the center frequency. The width gives the
slope of the drop. The frequencies at center + width and
center - width will be half of their original amplitudes.
Band defaults to a mode oriented to pitched signals, i.e.
voice, singing, or instrumental music. The -n (for noise)
option uses the alternate mode for un-pitched signals. Warn-
ing: -n introduces a power-gain of about 11dB in the filter,
so beware of output clipping. Band introduces noise in the
shape of the filter, i.e. peaking at the center frequency and
settling around it. See filter for a bandpass effect with
steeper shoulders.

bandpass frequency bandwidth
Butterworth bandpass filter. Description coming soon!

bandreject frequency bandwidth
Butterworth bandreject filter. Description coming soon!

chorus gain-in gain-out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ... ]
which the absolute value of the input signal is integrated to
determine its volume; attacks refer to increases in volume
and decays refer to decreases. Where more than one pair of
attack/decay parameters are specified, each channel is
treated separately and the number of pairs must agree with
the number of input channels. The second parameter is a list
of points on the compander's transfer function specified in
dB relative to the maximum possible signal amplitude. The
input values must be in a strictly increasing order but the
transfer function does not have to be monotonically rising.
The special value -inf may be used to indicate that the input
volume should be associated output volume. The points
-inf,-inf and 0,0 are assumed; the latter may be overridden,
but the former may not.

The third (optional) parameter is a post-processing gain in
dB which is applied after the compression has taken place;
the fourth (optional) parameter is an initial volume to be
assumed for each channel when the effect starts. This per-
mits the user to supply a nominal level initially, so that,
for example, a very large gain is not applied to initial sig-
nal levels before the companding action has begun to operate:
it is quite probable that in such an event, the output would
be severely clipped while the compander gain properly adjusts
itself.

The fifth (optional) parameter is a delay in seconds. The
input signal is analyzed immediately to control the compan-
der, but it is delayed before being fed to the volume
adjuster. Specifying a delay approximately equal to the
attack/decay times allows the compander to effectively oper-
ate in a "predictive" rather than a reactive mode.

dcshift shift [ limitergain ]
DC Shift the audio data, with basic linear amplitude formula.
This is most useful if your audio data tends to not be cen-
tered around a value of 0. Shifting it back will allow you
to get the most volume adjustments without clipping audio
data.
The first option is the dcshift value. It is a floating
point number that indicates the amount to shift.
An option limtergain value can be specified as well. It
should have a value much less then 1.0 and is used only on
peaks to prevent clipping.

deemph Apply a treble attenuation shelving filter to samples in
audio cd format. The frequency response of pre-emphasized
recordings is rectified. The filtering is defined in the
standard document ISO 908.
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.
earwax Makes sound easier to listen to on headphones. Adds audio-
cues to samples in audio cd format so that when listened to
on headphones the stereo image is moved from inside your head
(standard for headphones) to outside and in front of the lis-
tener (standard for speakers). See
www.geocities.com/beinges for a full explanation.

echo gain-in gain-out delay decay [ delay decay ... ]
Add echoing to a sound sample. Each delay/decay part gives
the delay in milliseconds and the decay (relative to gain-in)
of that echo. Gain-out is the volume of the output.

echos gain-in gain-out delay decay [ delay decay ... ]
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.

fade [ type ] fade-in-length
[ stop-time [ fade-out-length ] ]
Add a fade effect to the beginning, end, or both of the audio
data.

For fade-ins, this starts from the first sample and ramps the
volume of the audio from 0 to full volume over fade-in-length
seconds. Specify 0 seconds if no fade-in is wanted.

For fade-outs, the audio data will be truncated at the stop-
time and the volume will be ramped from full volume down to 0
starting at fade-out-length seconds before the stop-time. No
fade-out is performed if these options are not specified.
All times can be specified in either periods of time or sam-
ple counts. To specify time periods use the format
hh:mm:ss.frac format. To specify using sample counts, spec-
ify the number of samples and append the letter 's' to the
sample count (for example 8000s).
An optional type can be specified to change the type of enve-
lope. Choices are q for quarter of a sinewave, h for half a
sinewave, t for linear slope, l for logarithmic, and p for
inverted parabola. The default is a linear slope.

filter [ low ]-[ high ] [ window-len [ beta ] ]
Apply a Sinc-windowed lowpass, highpass, or bandpass filter
of given window length to the signal. low refers to the fre-
quency of the lower 6dB corner of the filter. high refers to
the frequency of the upper 6dB corner of the filter.

A lowpass filter is obtained by leaving low unspecified, or
0. A highpass filter is obtained by leaving high unspeci-
fied, or 0, or greater than or equal to the Nyquist fre-
quency.

The window-len, if unspecified, defaults to 128. Longer win-
dows give a sharper cutoff, smaller windows a more gradual
cutoff.

The beta, if unspecified, defaults to 16. This selects a
Kaiser window. You can select a Nuttall window by specifying
anything <= 2.0 here. For more discussion of beta, look
under the resample effect.

flanger gain-in gain-out delay decay speed < -s | -t >
Add a flanger to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
Gain-out is the volume of the output.
highp frequency
Apply a single pole recursive high-pass filter. The fre-
quency response drops logarithmically with I frequency in the
middle of the drop. The slope of the filter is quite gentle.
See filter for a highpass effect with sharper cutoff.

highpass frequency
Butterworth highpass filter. Description coming soon!

lowp frequency
Apply a single pole recursive low-pass filter. The frequency
response drops logarithmically with frequency in the middle
of the drop. The slope of the filter is quite gentle. See
filter for a lowpass effect with sharper cutoff.

lowpass frequency
Butterworth lowpass filter. Description coming soon!

mask Add "masking noise" to signal. This effect deliberately adds
white noise to a sound in order to mask quantization effects,
created by the process of playing a sound digitally. It
tends to mask buzzing voices, for example. It adds 1/2 bit
of noise to the sound file at the output bit depth.

mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[gain [initial-volume [delay ] ] ]" xover_freq

Multi-band compander is similar to the single band compander
but the audio file is first divided up into bands and then
the compander is ran on each band. See the compand effect
for definition of its options. Compand options are specified
between double quotes and the crossover frequency for that
band is specefied seperately with xover_fre. This can be
repeated multiple times to create multiple bands.

noiseprof [profile-file]

noisered profile-file [threshold]
Noise reduction filter with profiling. This filter is moder-
ately effective at removing consistent background noise such
as hiss or hum. To use it, first run the noiseprof effect on
a section of silence (that is, a section which contains noth-
ing but noise). The noiseprof effect will print a noise pro-
file to profile-file, or to stdout if no profile-file is
specified. If there is sound output on stdout then the pro-
file will instead be directed to stderr.

To actually remove the noise, run SoX again with the noisered
filter. The filter needs one argument, profile-file, which
contains the noise profile from noiseprof. thershold speci-
fies how much noise should be removed, and may be between 0
and 1 with a default of 0.5. Higher values will remove more
noise but present a greater possibility of distorting the
desired audio signal. Experiment with different threshold
values to find the optimal one for your sample.

phaser gain-in gain-out delay decay speed < -s | -t >
Add a phaser to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
The decay should be less than 0.5 to avoid feedback. Gain-
out is the volume of the output.

pitch shift [ width interpole fade ]
Change the pitch of file without affecting its duration by
cross-fading shifted samples. shift is given in cents. Use a
positive value to shift to treble, negative value to shift to
bass. Default shift is 0. width of window is in ms. Default
width is 20ms. Try 30ms to lower pitch, and 10ms to raise
-w < nut / ham > : select either a Nuttal (~90 dB stopband)
or Hamming (~43 dB stopband) window. Default is nut.

-width long / short / # : specify the (approximate) width of
the filter. long is 1024 samples; short is 128 samples.
Alternatively, an exact number can be used. Default is long.
The short option is not recommended, as it produces poor
quality results.

-cutoff # : specify the filter cutoff frequency in terms of
fraction of frequency bandwidth, also know as the Nyquist
frequency. Please see the resample effect for further infor-
mation on Nyquist frequency. If upsampling, then this is the
fraction of the original signal that should go through. If
downsampling, this is the fraction of the signal left after
downsampling. Default is 0.95. Remember that this is a
float.

reverb gain-out reverbe-time delay [ delay ... ]
Add reverberation to a sound sample. Each delay is given in
milliseconds and its feedback is depending on the reverb-time
in milliseconds. Each delay should be in the range of half
to quarter of reverb-time to get a realistic reverberation.
Gain-out is the volume of the output.

silence above_periods [ duration threshold[ d | % ]
[ below_periods duration threshold[ d | % ]]
Removes silence from the beginning or end of a sound file.
Silence is anything below a specified threshold.
When trimming silence from the beginning of a sound file, you
specify a duration of audio that is above a given silence
threshold before audio data is processed. You can also spec-
ify the count of periods of none silence you want to detect
before processing audio data. Specify a period of 0 if you
do not want to trim data from the front of the sound file.
When optionally trimming silence form the end of a sound
file, you specify the duration of audio that must be below a
given threshold before stopping to process audio data. A
count of periods that occur below the threshold may also be
specified. If this options are not specified then data is
not trimmed from the end of the audio file.
Duration counts may be in the format of time, hh:mm:ss.frac,
or in the exact count of samples.
Threshold may be suffixed with d, or % to indicated the value
is in decibels or a percentage of max value of the sample
value. A value of '0%' will look for total silence.

speed [ -c ] factor
Speed up or down the sound, as a magnetic tape with a speed
control. It affects both pitch and time. A factor of 1.0
means no change, and is the default. 2.0 doubles speed, thus
time length is cut by a half and pitch is one octave higher.
0.5 halves speed thus time length doubles and pitch is one
octave lower. If the optional -c parameter is used then the
factor is specified in "cents".

stretch factor [window fade shift fading]
Time stretch file by a given factor. Change duration without
affecting the pitch. factor of stretching: >1.0 lengthen,
<1.0 shorten duration. window size is in ms. Default is
20ms. The fade option, can be "lin". shift ratio, in [0.0
1.0]. Default depends on stretch factor. 1.0 to shorten, 0.8
to lengthen. The fading ratio, in [0.0 0.5]. The amount of a
fade's default depends on factor and shift.

synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
The synth effect will generate various types of audio data.
Although this effect is used to generate audio data, an input
file must be specified. The length of the input audio file
determines the length of the output audio file.
<length> length in sec or hh:mm:ss.frac, 0=inputlength,
default=0
<type> is sine, square, triangle, sawtooth, trapetz, exp,
whitenoise, pinknoise, brownnoise, default=sine
<mix> is create, mix, amod, default=create
<freq> frequency at beginning in Hz, not used for noise..
<freq2> frequency at end in Hz, not used for noise..
<freq/2> can be given as %%n, where 'n' is the number of half
notes in respect to A (440Hz)
<off> Bias (DC-offset) of signal in percent, default=0
<ph> phase shift 0..100 shift phase 0..2*Pi, not used for
noise..
<p1> square: Ton/Toff, triangle+trapetz: rising slope time
(0..100)
<p2> trapetz: ON time (0..100)
the audio data. The format for specifying sample counts is
the number of samples with the letter 's' appended to it. A
value of 8000s will wait until 8000 samples are read before
starting to process audio data.

vibro speed [ depth ]
Add the world-famous Fender Vibro-Champ sound effect to a
sound sample by using a sine wave as the volume knob. Speed
gives the Hertz value of the wave. This must be under 30.
Depth gives the amount the volume is cut into by the sine
wave, ranging 0.0 to 1.0 and defaulting to 0.5.

vol gain [ type [ limitergain ] ]
The vol effect is much like the command line option -v. It
allows you to adjust the volume of an input file and allows
you to specify the adjustment in relation to amplitude,
power, or dB. If type is not specified then it defaults to
amplitude.
When type is amplitude then a linear change of the amplitude
is performed based on the gain. Therefore, a value of 1.0
will keep the volume the same, 0.0 to < 1.0 will cause the
volume to decrease and values of > 1.0 will cause the volume
to increase. Beware of clipping audio data when the gain is
greater then 1.0. A negative value performs the same adjust-
ment while also changing the phase.
When type is power then a value of 1.0 also means no change
in volume.
When type is dB the amplitude is changed logarithmically.
0.0 is constant while +6 doubles the amplitude.
An optional limitergain value can be specified and should be
a value much less then 1.0 (ie 0.05 or 0.02) and is used only
on peaks to prevent clipping. Not specifying this parameter
will cause no limiter to be used. In verbose mode, this
effect will display the percentage of audio data that needed
to be limited.</pre>

== Examples ==

<pre> Echo

An echo(1,3x,1 builtins) effect can be naturally found in(1,8) the mountains, standing some-
where on a mountain and shouting a single word will result in(1,8) one or
more repetitions of the word (if(3,n) not, turn a bit around and try again,
or climb to the next mountain).

However, the time(1,2,n) difference between shouting and repeating is the
delay (time(1,2,n)), its loudness is the decay. Multiple echos can have dif-
ferent delays and decays.

It is very popular to use echos to play an instrument with itself
together, like some guitar players (Brain May from Queen) or vocalists
are doing. For music samples of more than one instrument, echo(1,3x,1 builtins) can be
used to add a second sample shortly after the original one.

This will sound as if(3,n) you are doubling the number of instruments play-
ing in(1,8) the same sample:

SoxFilter("echo 0.8 0.88 60.0 0.4")

If the delay is very short, then it sound like a (metallic) robot play-
ing music:

SoxFilter("echo 0.8 0.88 6.0 0.4")

Longer delay will sound like an open(2,3,n) air concert in(1,8) the mountains:

SoxFilter("echo 0.8 0.9 1000.0 0.3")

One mountain more, and:

SoxFilter("echo 0.8 0.9 1000.0 0.3 1800.0 0.25")

Echos

Like the echo effect, echos stand for "ECHO in Sequel", that is the
first echos takes the input, the second the input and the first echos,
the third the input and the first and the second echos, ... and so on.
Care should be taken using many echos (see introduction); a single
echos has the same effect as a single echo.

The sample will be bounced twice in(1,8) symmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 700.0 0.3")

The sample will be bounced twice in(1,8) asymmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 900.0 0.3")

The sample will sound as if(3,n) played in(1,8) a garage:

SoxFilter("echos 0.8 0.7 40.0 0.25 63.0 0.3")

Chorus

The chorus effect has its name because it will often be used to make a
single vocal sound like a chorus. But it can be applied to other
instrument samples too.

It works like the echo(1,3x,1 builtins) effect with a short delay, but the delay isn't
constant. The delay is varied using a sinusoidal or triangular modula-
tion. The modulation depth defines the range the modulated delay is
played before or after the delay. Hence the delayed sound will sound
slower or faster, that is the delayed sound tuned around the original
one, like in(1,8) a chorus where some vocals are a bit out of tune.

The typical delay is around 40ms to 60ms, the speed of the modulation
is best near 0.25Hz and the modulation depth around 2ms.

A single delay will make the sample more overloaded:

SoxFilter("chorus 0.7 0.9 55.0 0.4 0.25 2.0 -t")

Two delays of the original samples sound like this:

SoxFilter("chorus 0.6 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 1.3 -s")

A big chorus of the sample is (three additional samples):

SoxFilter("chorus 0.5 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 2.3 -t 40.0 0.3 0.3 1.3 -s")

Flanger

The flanger effect is like the chorus effect, but the delay varies
between 0ms and maximal 5ms. It sound like wind blowing, sometimes
faster or slower including changes of the speed.

The flanger effect is widely used in(1,8) funk and soul music, where the
guitar sound varies frequently slow or a bit faster.

The typical delay is around 3ms to 5ms, the speed of the modulation is
best near 0.5Hz.

Now, let's groove the sample:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -s")

listen carefully between the difference of sinusoidal and triangular
modulation:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -t")

If the decay is a bit lower, than the effect sounds more popular:

SoxFilter("flanger 0.8 0.88 3.0 0.4 0.5 -t")

The drunken loudspeaker system:

SoxFilter("flanger 0.9 0.9 4.0 0.23 1.3 -s")

Reverb

The reverb effect is often used in(1,8) audience hall which are to small or
contain too many many visitors which disturb (dampen) the reflection of
sound at the walls. Reverb will make the sound be perceived as if(3,n) it
were in(1,8) a large hall. You can try the reverb effect in(1,8) your bathroom
or garage or sport halls by shouting loud some words. You'll hear the
words reflected from the walls.

The biggest problem in(1,8) using the reverb effect is the correct setting
of the (wall) delays such that the sound is realistic and doesn't sound
like music playing in(1,8) a tin(1,5) can or has overloaded feedback which
destroys any illusion of playing in(1,8) a big hall. To help you obtain
realistic reverb effects, you should decide first how long the reverb
should take place until it is not loud enough to be registered by your
ears. This is be done by varying the reverb time(1,2,n) "t". To simulate
small halls, use 200ms. To simulate large halls, use 1000ms. Clearly,
the walls of such a hall aren't far away, so you should define its set-
ting be given every wall its delay time. However, if(3,n) the wall is to
far away for the reverb time(1,2,n), you won't hear the reverb, so the nearest
wall will be best at "t/4" delay and the farthest at "t/2". You can try
other distances as well, but it won't sound very realistic. The walls
shouldn't stand to close(2,7,n) to each other and not in(1,8) a multiple integer
distance to each other ( so avoid wall like: 200.0 and 202.0, or some-
thing like 100.0 and 200.0 ).

Since audience halls do have a lot of walls, we will start designing
one beginning with one wall:

SoxFilter("reverb 1.0 600.0 180.0")

One wall more:

SoxFilter("reverb 1.0 600.0 180.0 200.0")

Next two walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")

Now, why not a futuristic hall with six walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0 280.0 300.0")

If you run out of machine power or memory, then stop as many applica-
tions as possible (every interrupt will consume a lot of CPU time(1,2,n) which
for bigger halls is absolutely necessary).

Phaser

The phaser effect is like the flanger effect, but it uses a reverb
instead of an echo(1,3x,1 builtins) and does phase shifting. You'll hear the difference
in(1,8) the examples comparing both effects (simply change the effect name).
The delay modulation can be sinusoidal or triangular, preferable is the
later for multiple instruments. For single instrument sounds, the sinu-
soidal phaser effect will give a sharper phasing effect. The decay
shouldn't be to close(2,7,n) to 1.0 which will cause dramatic feedback. A
good range is about 0.5 to 0.1 for the decay.

We will take a parameter setting as for the flanger before (gain-out is
lower since feedback can raise(3,n) the output dramatically):

SoxFilter("phaser 0.8 0.74 3.0 0.4 0.5 -t")

The drunken loudspeaker system (now less(1,3) alcohol):

SoxFilter("phaser 0.9 0.85 4.0 0.23 1.3 -s")

A popular sound of the sample is as follows:

SoxFilter("phaser 0.89 0.85 1.0 0.24 2.0 -t")

The sample sounds if(3,n) ten springs are in(1,8) your ears:

SoxFilter("phaser 0.6 0.66 3.0 0.6 2.0 -t")

Compander

The compander effect allows the dynamic range of a signal(2,7) to be com-
pressed or expanded. For most situations, the attack time(1,2,n) (response to
the music getting louder) should be shorter than the decay time(1,2,n) because
our ears are more sensitive to suddenly loud music than to suddenly
soft music.

For example, suppose you are listening to Strauss' "Also Sprach
Zarathustra" in(1,8) a noisy environment such as a car. If you turn up the
volume enough to hear the soft passages over the road noise, the loud
sections will be too loud. You could try this:

SoxFilter("compand 0.3,1 -90,-90,-70,-70,-60,-20,0,0 -5 0 0.2")

The transfer function ("-90,...") says that very soft sounds between
-90 and -70 decibels (-90 is about the limit of 16-bit encoding(3,n)) will
remain unchanged. That keeps the compander from boosting the volume on
"silent" passages such as between movements. However, sounds in(1,8) the
range -60 decibels to 0 decibels (maximum volume) will be boosted so
that the 60-dB dynamic range of the original music will be compressed
3-to-1 into a 20-dB range, which is wide enough to enjoy the music but
narrow enough to get around the road noise. The -5 dB output gain is
needed to avoid clipping (the number is inexact, and was derived by
experimentation). The 0 for the initial volume will work fine for a
clip that starts with a bit of silence, and the delay of 0.2 has the
effect of causing the compander to react a bit more quickly to sudden
volume changes.

</pre>
<br>
== Changelog ==
Version Date Changes<br>
v2.1 2023/12/03 - Allow effects which can alter sampling rate
- Allow effects which can change the number of channels
- Add distinct XP build (v141_xp toolset) needed in 2023
v2.0 2023/12/02 - Full rewrite, using 14.4.2 libsox library version, moved to github
v1.1 beta 2006/01/02 - release (12.17.9 libsox)
v1.0 2005/12/29 - initial release
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.1
|[x86]: [https://forum.doom9.org/attachment.php?attachmentid=5193&d=1136242927 SoxFilter_11.zip] /// [https://forum.doom9.org/attachment.php?attachmentid=5194&d=1136242951 SoxFilter_11_src.zip]
---------
[x64]: [https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|[x86]: [https://web.archive.org/web/20200626015535if_/https://files.videohelp.com/u/223002/SoxFilter_11.zip SoxFilter_11.zip] (src included)
---------
[x64]: [https://web.archive.org/web/20200703223101if_/https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|}
<br>

==External Links ==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Audio_Filters|External Filters]] ←'''

SoxFilter

2023-12-18T09:50:39Z

Pinterf: New version: SoxFilter v2.1 additions

{{FilterCat4|External_filters|Plugins|Plugins_x64|Audio_filters}}
{{Filter3
| pinterf v2.1
{{author/Sh0dan}} v1.1 beta
| v2.1
| 3=[https://github.com/pinterf/SoxFilter/releases SoxFilter 2 releases]
| 4=Audio filters
| 5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
| 6=[https://forum.doom9.org/showthread.php?t=104792 Doom9 Forum]<br>[https://forum.doom9.org/showthread.php?t=181566 Doom9 Forum (v1.1 x64 version)]}}

== Description ==
This plugin will allow you to run [http://sox.sourceforge.net/ SOX] effects within AviSynth. Most effects are supported, and multiple effects can be stacked after each other.
<br>Version 1.1 is based on SoX library 12.17.9
<br>Version 2.0 is based on SoX library 14.4.2
<br>
SoX library works with 32 bit integer samples internally. All inputs will be automatically converted to this audio format.
<br>
<br>
== Requirements ==
=== v2.1 ===
* [x86/x64]: [[AviSynth+ 3.7.3]]
=== v1.1 ===
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.5.8 or greater]
* [x64]: [[AviSynth+]]
* Supported color formats: N/A
<br>
== [[Script variables|Syntax and Parameters]] ==

:{{Template:FuncDef|SoxFilter (clip, string effect1 [, string effect 2, string effect 3...])}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2||string|}}
:::Any number of effects can be entered, and they will be executed in the order they are specified. Effect syntax is just like SOX. See [[#Effect Overview|Effect Overview]] and [[#Filter Reference|Filter Reference]] below.
<br>
==Usage==

A simple filter could look like this:<br />

<pre>AviSource("movie.avi")
SoxFilter("bandpass 500 100")
convertAudioTo16Bit()</pre>
This will keep a 100Hz band around 500Hz. SoxFilter converts audio to 32 bit integers. This allows to keep the additional dynamic range of float point samples, but it requires a convertion to 16 bit audio before output, since most codecs only support 16 bit.

Multiple effects can be stacked like this:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000", "vol 2.0", "reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
Which is a faster version of:

<pre>AviSource("movie.avi")
SoxFilter("bandpass 2000 1000")
SoxFilter("vol 2.0")
SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")
ConvertAudioTo16Bit()</pre>
<br>
== AviSynth Specifics ==

=== Remarks ===

Since v1.1 release SoX library internal API has been changed. v2.x was created from scratch.
Also, some effects were removed, and others added in the past ~15 years.
The parameters of some effects had been changed as well.

E.g. reverb parameters were modified in 2008; "filter" was removed, use "sinc" instead
(with a different syntax).

Check SoxFilter_usages.txt in v2.x release pack, or visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for effect parameters and their actual description.

=== Known Issues ===

* Linear access is heavily recommended. SOX filters doesn't support seeking, so stream is restarted every time a samples previous to the last one is requested.
* Do not use Avisynth+ versions before 3.7.3 if filter result is used later in the script multiple times. Audio cache (which was reintroduced in Avisynth+ 3.7.3) is a must have in those cases.
* (v2.1-) none of filters were removed from 14.4.2 SoX library, still, some may be incompatible. Filters can even change sample rate or alter the number of channels. In v1.1 these filters were not allowed.
* (v1.1 only) The AviSynth version is VERY picky about spaces. If you make double spaces or a space before or after the quotes the command will not be recognized.
* (v1.1 only) If one filter doesn't support multichannel audio the entire chain is converted to mono filters, this might affect some filters like '''earwax'''. Use multiple filter instances instead.
* (v1.1 only) Some filters have been removed since they were incompatible with the AviSynth version. All these filters have internal Avisynth equivalents.
* (v1.1 only) '''compand''' is very unstable in the current interface, and doesn't support restarts (distorted audio). Don't use this together with other effetcs.
* (v1.1 only) The length of audio cannot be modified.

=== Version 1.1 ===

*Solved issue with earwax refusing to play.

*Solved problem with time alternating effects.

*Solved issues with some filters producing clicks.

*Made sure compand and mcompand doesn't crash. Still quite buggy though.
<br>
== Effect Overview ==

This section contains effects supported in SoxFilter v1.1 (12.17.9 SoX Library version).

For effects supported by SoxFilter v2.x (SoX Library 14.4.2) visit
https://manpages.ubuntu.com/manpages/lunar/en/man1/sox.1.html#effects
for parameters and their actual description.

<pre> Effects:
band [ -n ] center [ width ]
bandpass frequency bandwidth

bandreject frequency bandwidth
chorus gain-in gain out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ]
compand attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]

dcshift shift [ limitergain ]
deemph
earwax
echo gain-in gain-out delay decay [ delay decay ... ]
echos gain-in gain-out delay decay [ delay decay ... ]
fade [ type ] fade-in-length

[ stop-time [ fade-out-length ] ]
filter [ low ]-[ high ] [ window-len [ beta ]]
flanger gain-in gain-out delay decay speed < -s | -t >

highp frequency
highpass frequency
lowp frequency
lowpass frequency

mask
mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[ gain [ initial-volume [ delay ] ] ]" xover_freq
noiseprof [profile-file]
noisered profile-file [threshold]
phaser gain-in gain-out delay decay speed < -s | -t >

pitch shift [ width interpole fade ]
reverb gain-out reverb-time delay [ delay ... ]
silence above_periods [ duration threshold[ d | % ]
[ below_periods duration
threshold[ d | % ]]
speed [ -c ] factor
stretch [ factor [ window fade shift fading ]
swap [ 1 2 | 1 2 3 4 ]
synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
vibro speed [ depth ]
vol gain [ type [ limitergain ] ]</pre>
== Filter Reference ==

<pre> band [ -n ] center [ width ]
Apply a band-pass filter. The frequency response drops loga-
rithmically around the center frequency. The width gives the
slope of the drop. The frequencies at center + width and
center - width will be half of their original amplitudes.
Band defaults to a mode oriented to pitched signals, i.e.
voice, singing, or instrumental music. The -n (for noise)
option uses the alternate mode for un-pitched signals. Warn-
ing: -n introduces a power-gain of about 11dB in the filter,
so beware of output clipping. Band introduces noise in the
shape of the filter, i.e. peaking at the center frequency and
settling around it. See filter for a bandpass effect with
steeper shoulders.

bandpass frequency bandwidth
Butterworth bandpass filter. Description coming soon!

bandreject frequency bandwidth
Butterworth bandreject filter. Description coming soon!

chorus gain-in gain-out delay decay speed depth

-s | -t [ delay decay speed depth -s | -t ... ]
which the absolute value of the input signal is integrated to
determine its volume; attacks refer to increases in volume
and decays refer to decreases. Where more than one pair of
attack/decay parameters are specified, each channel is
treated separately and the number of pairs must agree with
the number of input channels. The second parameter is a list
of points on the compander's transfer function specified in
dB relative to the maximum possible signal amplitude. The
input values must be in a strictly increasing order but the
transfer function does not have to be monotonically rising.
The special value -inf may be used to indicate that the input
volume should be associated output volume. The points
-inf,-inf and 0,0 are assumed; the latter may be overridden,
but the former may not.

The third (optional) parameter is a post-processing gain in
dB which is applied after the compression has taken place;
the fourth (optional) parameter is an initial volume to be
assumed for each channel when the effect starts. This per-
mits the user to supply a nominal level initially, so that,
for example, a very large gain is not applied to initial sig-
nal levels before the companding action has begun to operate:
it is quite probable that in such an event, the output would
be severely clipped while the compander gain properly adjusts
itself.

The fifth (optional) parameter is a delay in seconds. The
input signal is analyzed immediately to control the compan-
der, but it is delayed before being fed to the volume
adjuster. Specifying a delay approximately equal to the
attack/decay times allows the compander to effectively oper-
ate in a "predictive" rather than a reactive mode.

dcshift shift [ limitergain ]
DC Shift the audio data, with basic linear amplitude formula.
This is most useful if your audio data tends to not be cen-
tered around a value of 0. Shifting it back will allow you
to get the most volume adjustments without clipping audio
data.
The first option is the dcshift value. It is a floating
point number that indicates the amount to shift.
An option limtergain value can be specified as well. It
should have a value much less then 1.0 and is used only on
peaks to prevent clipping.

deemph Apply a treble attenuation shelving filter to samples in
audio cd format. The frequency response of pre-emphasized
recordings is rectified. The filtering is defined in the
standard document ISO 908.
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.
earwax Makes sound easier to listen to on headphones. Adds audio-
cues to samples in audio cd format so that when listened to
on headphones the stereo image is moved from inside your head
(standard for headphones) to outside and in front of the lis-
tener (standard for speakers). See
www.geocities.com/beinges for a full explanation.

echo gain-in gain-out delay decay [ delay decay ... ]
Add echoing to a sound sample. Each delay/decay part gives
the delay in milliseconds and the decay (relative to gain-in)
of that echo. Gain-out is the volume of the output.

echos gain-in gain-out delay decay [ delay decay ... ]
Add a sequence of echos to a sound sample. Each delay/decay
part gives the delay in milliseconds and the decay (relative
to gain-in) of that echo. Gain-out is the volume of the out-
put.

fade [ type ] fade-in-length
[ stop-time [ fade-out-length ] ]
Add a fade effect to the beginning, end, or both of the audio
data.

For fade-ins, this starts from the first sample and ramps the
volume of the audio from 0 to full volume over fade-in-length
seconds. Specify 0 seconds if no fade-in is wanted.

For fade-outs, the audio data will be truncated at the stop-
time and the volume will be ramped from full volume down to 0
starting at fade-out-length seconds before the stop-time. No
fade-out is performed if these options are not specified.
All times can be specified in either periods of time or sam-
ple counts. To specify time periods use the format
hh:mm:ss.frac format. To specify using sample counts, spec-
ify the number of samples and append the letter 's' to the
sample count (for example 8000s).
An optional type can be specified to change the type of enve-
lope. Choices are q for quarter of a sinewave, h for half a
sinewave, t for linear slope, l for logarithmic, and p for
inverted parabola. The default is a linear slope.

filter [ low ]-[ high ] [ window-len [ beta ] ]
Apply a Sinc-windowed lowpass, highpass, or bandpass filter
of given window length to the signal. low refers to the fre-
quency of the lower 6dB corner of the filter. high refers to
the frequency of the upper 6dB corner of the filter.

A lowpass filter is obtained by leaving low unspecified, or
0. A highpass filter is obtained by leaving high unspeci-
fied, or 0, or greater than or equal to the Nyquist fre-
quency.

The window-len, if unspecified, defaults to 128. Longer win-
dows give a sharper cutoff, smaller windows a more gradual
cutoff.

The beta, if unspecified, defaults to 16. This selects a
Kaiser window. You can select a Nuttall window by specifying
anything <= 2.0 here. For more discussion of beta, look
under the resample effect.

flanger gain-in gain-out delay decay speed < -s | -t >
Add a flanger to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
Gain-out is the volume of the output.
highp frequency
Apply a single pole recursive high-pass filter. The fre-
quency response drops logarithmically with I frequency in the
middle of the drop. The slope of the filter is quite gentle.
See filter for a highpass effect with sharper cutoff.

highpass frequency
Butterworth highpass filter. Description coming soon!

lowp frequency
Apply a single pole recursive low-pass filter. The frequency
response drops logarithmically with frequency in the middle
of the drop. The slope of the filter is quite gentle. See
filter for a lowpass effect with sharper cutoff.

lowpass frequency
Butterworth lowpass filter. Description coming soon!

mask Add "masking noise" to signal. This effect deliberately adds
white noise to a sound in order to mask quantization effects,
created by the process of playing a sound digitally. It
tends to mask buzzing voices, for example. It adds 1/2 bit
of noise to the sound file at the output bit depth.

mcompand "attack1,decay1[,attack2,decay2...]
in-dB1,out-dB1[,in-dB2,out-dB2...]
[gain [initial-volume [delay ] ] ]" xover_freq

Multi-band compander is similar to the single band compander
but the audio file is first divided up into bands and then
the compander is ran on each band. See the compand effect
for definition of its options. Compand options are specified
between double quotes and the crossover frequency for that
band is specefied seperately with xover_fre. This can be
repeated multiple times to create multiple bands.

noiseprof [profile-file]

noisered profile-file [threshold]
Noise reduction filter with profiling. This filter is moder-
ately effective at removing consistent background noise such
as hiss or hum. To use it, first run the noiseprof effect on
a section of silence (that is, a section which contains noth-
ing but noise). The noiseprof effect will print a noise pro-
file to profile-file, or to stdout if no profile-file is
specified. If there is sound output on stdout then the pro-
file will instead be directed to stderr.

To actually remove the noise, run SoX again with the noisered
filter. The filter needs one argument, profile-file, which
contains the noise profile from noiseprof. thershold speci-
fies how much noise should be removed, and may be between 0
and 1 with a default of 0.5. Higher values will remove more
noise but present a greater possibility of distorting the
desired audio signal. Experiment with different threshold
values to find the optimal one for your sample.

phaser gain-in gain-out delay decay speed < -s | -t >
Add a phaser to a sound sample. Each triple
delay/decay/speed gives the delay in milliseconds and the
decay (relative to gain-in) with a modulation speed in Hz.
The modulation is either sinodial (-s) or triangular (-t).
The decay should be less than 0.5 to avoid feedback. Gain-
out is the volume of the output.

pitch shift [ width interpole fade ]
Change the pitch of file without affecting its duration by
cross-fading shifted samples. shift is given in cents. Use a
positive value to shift to treble, negative value to shift to
bass. Default shift is 0. width of window is in ms. Default
width is 20ms. Try 30ms to lower pitch, and 10ms to raise
-w < nut / ham > : select either a Nuttal (~90 dB stopband)
or Hamming (~43 dB stopband) window. Default is nut.

-width long / short / # : specify the (approximate) width of
the filter. long is 1024 samples; short is 128 samples.
Alternatively, an exact number can be used. Default is long.
The short option is not recommended, as it produces poor
quality results.

-cutoff # : specify the filter cutoff frequency in terms of
fraction of frequency bandwidth, also know as the Nyquist
frequency. Please see the resample effect for further infor-
mation on Nyquist frequency. If upsampling, then this is the
fraction of the original signal that should go through. If
downsampling, this is the fraction of the signal left after
downsampling. Default is 0.95. Remember that this is a
float.

reverb gain-out reverbe-time delay [ delay ... ]
Add reverberation to a sound sample. Each delay is given in
milliseconds and its feedback is depending on the reverb-time
in milliseconds. Each delay should be in the range of half
to quarter of reverb-time to get a realistic reverberation.
Gain-out is the volume of the output.

silence above_periods [ duration threshold[ d | % ]
[ below_periods duration threshold[ d | % ]]
Removes silence from the beginning or end of a sound file.
Silence is anything below a specified threshold.
When trimming silence from the beginning of a sound file, you
specify a duration of audio that is above a given silence
threshold before audio data is processed. You can also spec-
ify the count of periods of none silence you want to detect
before processing audio data. Specify a period of 0 if you
do not want to trim data from the front of the sound file.
When optionally trimming silence form the end of a sound
file, you specify the duration of audio that must be below a
given threshold before stopping to process audio data. A
count of periods that occur below the threshold may also be
specified. If this options are not specified then data is
not trimmed from the end of the audio file.
Duration counts may be in the format of time, hh:mm:ss.frac,
or in the exact count of samples.
Threshold may be suffixed with d, or % to indicated the value
is in decibels or a percentage of max value of the sample
value. A value of '0%' will look for total silence.

speed [ -c ] factor
Speed up or down the sound, as a magnetic tape with a speed
control. It affects both pitch and time. A factor of 1.0
means no change, and is the default. 2.0 doubles speed, thus
time length is cut by a half and pitch is one octave higher.
0.5 halves speed thus time length doubles and pitch is one
octave lower. If the optional -c parameter is used then the
factor is specified in "cents".

stretch factor [window fade shift fading]
Time stretch file by a given factor. Change duration without
affecting the pitch. factor of stretching: >1.0 lengthen,
<1.0 shorten duration. window size is in ms. Default is
20ms. The fade option, can be "lin". shift ratio, in [0.0
1.0]. Default depends on stretch factor. 1.0 to shorten, 0.8
to lengthen. The fading ratio, in [0.0 0.5]. The amount of a
fade's default depends on factor and shift.

synth [ length ] type mix [ freq [ -freq2 ]
[ off ] [ ph ] [ p1 ] [ p2 ] [ p3 ]
The synth effect will generate various types of audio data.
Although this effect is used to generate audio data, an input
file must be specified. The length of the input audio file
determines the length of the output audio file.
<length> length in sec or hh:mm:ss.frac, 0=inputlength,
default=0
<type> is sine, square, triangle, sawtooth, trapetz, exp,
whitenoise, pinknoise, brownnoise, default=sine
<mix> is create, mix, amod, default=create
<freq> frequency at beginning in Hz, not used for noise..
<freq2> frequency at end in Hz, not used for noise..
<freq/2> can be given as %%n, where 'n' is the number of half
notes in respect to A (440Hz)
<off> Bias (DC-offset) of signal in percent, default=0
<ph> phase shift 0..100 shift phase 0..2*Pi, not used for
noise..
<p1> square: Ton/Toff, triangle+trapetz: rising slope time
(0..100)
<p2> trapetz: ON time (0..100)
the audio data. The format for specifying sample counts is
the number of samples with the letter 's' appended to it. A
value of 8000s will wait until 8000 samples are read before
starting to process audio data.

vibro speed [ depth ]
Add the world-famous Fender Vibro-Champ sound effect to a
sound sample by using a sine wave as the volume knob. Speed
gives the Hertz value of the wave. This must be under 30.
Depth gives the amount the volume is cut into by the sine
wave, ranging 0.0 to 1.0 and defaulting to 0.5.

vol gain [ type [ limitergain ] ]
The vol effect is much like the command line option -v. It
allows you to adjust the volume of an input file and allows
you to specify the adjustment in relation to amplitude,
power, or dB. If type is not specified then it defaults to
amplitude.
When type is amplitude then a linear change of the amplitude
is performed based on the gain. Therefore, a value of 1.0
will keep the volume the same, 0.0 to < 1.0 will cause the
volume to decrease and values of > 1.0 will cause the volume
to increase. Beware of clipping audio data when the gain is
greater then 1.0. A negative value performs the same adjust-
ment while also changing the phase.
When type is power then a value of 1.0 also means no change
in volume.
When type is dB the amplitude is changed logarithmically.
0.0 is constant while +6 doubles the amplitude.
An optional limitergain value can be specified and should be
a value much less then 1.0 (ie 0.05 or 0.02) and is used only
on peaks to prevent clipping. Not specifying this parameter
will cause no limiter to be used. In verbose mode, this
effect will display the percentage of audio data that needed
to be limited.</pre>
== Examples ==

<pre> Echo

An echo(1,3x,1 builtins) effect can be naturally found in(1,8) the mountains, standing some-
where on a mountain and shouting a single word will result in(1,8) one or
more repetitions of the word (if(3,n) not, turn a bit around and try again,
or climb to the next mountain).

However, the time(1,2,n) difference between shouting and repeating is the
delay (time(1,2,n)), its loudness is the decay. Multiple echos can have dif-
ferent delays and decays.

It is very popular to use echos to play an instrument with itself
together, like some guitar players (Brain May from Queen) or vocalists
are doing. For music samples of more than one instrument, echo(1,3x,1 builtins) can be
used to add a second sample shortly after the original one.

This will sound as if(3,n) you are doubling the number of instruments play-
ing in(1,8) the same sample:

SoxFilter("echo 0.8 0.88 60.0 0.4")

If the delay is very short, then it sound like a (metallic) robot play-
ing music:

SoxFilter("echo 0.8 0.88 6.0 0.4")

Longer delay will sound like an open(2,3,n) air concert in(1,8) the mountains:

SoxFilter("echo 0.8 0.9 1000.0 0.3")

One mountain more, and:

SoxFilter("echo 0.8 0.9 1000.0 0.3 1800.0 0.25")

Echos

Like the echo effect, echos stand for "ECHO in Sequel", that is the
first echos takes the input, the second the input and the first echos,
the third the input and the first and the second echos, ... and so on.
Care should be taken using many echos (see introduction); a single
echos has the same effect as a single echo.

The sample will be bounced twice in(1,8) symmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 700.0 0.3")

The sample will be bounced twice in(1,8) asymmetric echos:

SoxFilter("echos 0.8 0.7 700.0 0.25 900.0 0.3")

The sample will sound as if(3,n) played in(1,8) a garage:

SoxFilter("echos 0.8 0.7 40.0 0.25 63.0 0.3")

Chorus

The chorus effect has its name because it will often be used to make a
single vocal sound like a chorus. But it can be applied to other
instrument samples too.

It works like the echo(1,3x,1 builtins) effect with a short delay, but the delay isn't
constant. The delay is varied using a sinusoidal or triangular modula-
tion. The modulation depth defines the range the modulated delay is
played before or after the delay. Hence the delayed sound will sound
slower or faster, that is the delayed sound tuned around the original
one, like in(1,8) a chorus where some vocals are a bit out of tune.

The typical delay is around 40ms to 60ms, the speed of the modulation
is best near 0.25Hz and the modulation depth around 2ms.

A single delay will make the sample more overloaded:

SoxFilter("chorus 0.7 0.9 55.0 0.4 0.25 2.0 -t")

Two delays of the original samples sound like this:

SoxFilter("chorus 0.6 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 1.3 -s")

A big chorus of the sample is (three additional samples):

SoxFilter("chorus 0.5 0.9 50.0 0.4 0.25 2.0 -t 60.0 0.32 0.4 2.3 -t 40.0 0.3 0.3 1.3 -s")

Flanger

The flanger effect is like the chorus effect, but the delay varies
between 0ms and maximal 5ms. It sound like wind blowing, sometimes
faster or slower including changes of the speed.

The flanger effect is widely used in(1,8) funk and soul music, where the
guitar sound varies frequently slow or a bit faster.

The typical delay is around 3ms to 5ms, the speed of the modulation is
best near 0.5Hz.

Now, let's groove the sample:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -s")

listen carefully between the difference of sinusoidal and triangular
modulation:

SoxFilter("flanger 0.6 0.87 3.0 0.9 0.5 -t")

If the decay is a bit lower, than the effect sounds more popular:

SoxFilter("flanger 0.8 0.88 3.0 0.4 0.5 -t")

The drunken loudspeaker system:

SoxFilter("flanger 0.9 0.9 4.0 0.23 1.3 -s")

Reverb

The reverb effect is often used in(1,8) audience hall which are to small or
contain too many many visitors which disturb (dampen) the reflection of
sound at the walls. Reverb will make the sound be perceived as if(3,n) it
were in(1,8) a large hall. You can try the reverb effect in(1,8) your bathroom
or garage or sport halls by shouting loud some words. You'll hear the
words reflected from the walls.

The biggest problem in(1,8) using the reverb effect is the correct setting
of the (wall) delays such that the sound is realistic and doesn't sound
like music playing in(1,8) a tin(1,5) can or has overloaded feedback which
destroys any illusion of playing in(1,8) a big hall. To help you obtain
realistic reverb effects, you should decide first how long the reverb
should take place until it is not loud enough to be registered by your
ears. This is be done by varying the reverb time(1,2,n) "t". To simulate
small halls, use 200ms. To simulate large halls, use 1000ms. Clearly,
the walls of such a hall aren't far away, so you should define its set-
ting be given every wall its delay time. However, if(3,n) the wall is to
far away for the reverb time(1,2,n), you won't hear the reverb, so the nearest
wall will be best at "t/4" delay and the farthest at "t/2". You can try
other distances as well, but it won't sound very realistic. The walls
shouldn't stand to close(2,7,n) to each other and not in(1,8) a multiple integer
distance to each other ( so avoid wall like: 200.0 and 202.0, or some-
thing like 100.0 and 200.0 ).

Since audience halls do have a lot of walls, we will start designing
one beginning with one wall:

SoxFilter("reverb 1.0 600.0 180.0")

One wall more:

SoxFilter("reverb 1.0 600.0 180.0 200.0")

Next two walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0")

Now, why not a futuristic hall with six walls:

SoxFilter("reverb 1.0 600.0 180.0 200.0 220.0 240.0 280.0 300.0")

If you run out of machine power or memory, then stop as many applica-
tions as possible (every interrupt will consume a lot of CPU time(1,2,n) which
for bigger halls is absolutely necessary).

Phaser

The phaser effect is like the flanger effect, but it uses a reverb
instead of an echo(1,3x,1 builtins) and does phase shifting. You'll hear the difference
in(1,8) the examples comparing both effects (simply change the effect name).
The delay modulation can be sinusoidal or triangular, preferable is the
later for multiple instruments. For single instrument sounds, the sinu-
soidal phaser effect will give a sharper phasing effect. The decay
shouldn't be to close(2,7,n) to 1.0 which will cause dramatic feedback. A
good range is about 0.5 to 0.1 for the decay.

We will take a parameter setting as for the flanger before (gain-out is
lower since feedback can raise(3,n) the output dramatically):

SoxFilter("phaser 0.8 0.74 3.0 0.4 0.5 -t")

The drunken loudspeaker system (now less(1,3) alcohol):

SoxFilter("phaser 0.9 0.85 4.0 0.23 1.3 -s")

A popular sound of the sample is as follows:

SoxFilter("phaser 0.89 0.85 1.0 0.24 2.0 -t")

The sample sounds if(3,n) ten springs are in(1,8) your ears:

SoxFilter("phaser 0.6 0.66 3.0 0.6 2.0 -t")

Compander

The compander effect allows the dynamic range of a signal(2,7) to be com-
pressed or expanded. For most situations, the attack time(1,2,n) (response to
the music getting louder) should be shorter than the decay time(1,2,n) because
our ears are more sensitive to suddenly loud music than to suddenly
soft music.

For example, suppose you are listening to Strauss' "Also Sprach
Zarathustra" in(1,8) a noisy environment such as a car. If you turn up the
volume enough to hear the soft passages over the road noise, the loud
sections will be too loud. You could try this:

SoxFilter("compand 0.3,1 -90,-90,-70,-70,-60,-20,0,0 -5 0 0.2")

The transfer function ("-90,...") says that very soft sounds between
-90 and -70 decibels (-90 is about the limit of 16-bit encoding(3,n)) will
remain unchanged. That keeps the compander from boosting the volume on
"silent" passages such as between movements. However, sounds in(1,8) the
range -60 decibels to 0 decibels (maximum volume) will be boosted so
that the 60-dB dynamic range of the original music will be compressed
3-to-1 into a 20-dB range, which is wide enough to enjoy the music but
narrow enough to get around the road noise. The -5 dB output gain is
needed to avoid clipping (the number is inexact, and was derived by
experimentation). The 0 for the initial volume will work fine for a
clip that starts with a bit of silence, and the delay of 0.2 has the
effect of causing the compander to react a bit more quickly to sudden
volume changes.

</pre>
<br>
== Changelog ==
Version Date Changes<br>
v2.1 2023/12/03 - Allow effects which can alter sampling rate
- Allow effects which can change the number of channels
- Add distinct XP build (v141_xp toolset) needed in 2023
v2.0 2023/12/02 - Full rewrite, using 14.4.2 libsox library version, moved to github
v1.1 beta 2006/01/02 - release (12.17.9 libsox)
v1.0 2005/12/29 - initial release
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.1
|[x86]: [https://forum.doom9.org/attachment.php?attachmentid=5193&d=1136242927 SoxFilter_11.zip] /// [https://forum.doom9.org/attachment.php?attachmentid=5194&d=1136242951 SoxFilter_11_src.zip]
---------
[x64]: [https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|[x86]: [https://web.archive.org/web/20200626015535if_/https://files.videohelp.com/u/223002/SoxFilter_11.zip SoxFilter_11.zip] (src included)
---------
[x64]: [https://web.archive.org/web/20200703223101if_/https://down.7086.in/soxfilter_64_r0.zip soxfilter_64_r0.zip]
|}
<br>

==External Links ==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Audio_Filters|External Filters]] ←'''

TIVTC

2023-12-13T16:08:37Z

Pinterf: version 1.28

{{FilterCat6|External_filters|Plugins|Plugins_x64|IVTC|Decimation|Deep_color_tools}}
{{Filter3
|1={{Author/tritical}}, {{Author/pinterf}}
|2=1.0.28
|3=[https://github.com/pinterf/TIVTC/releases TIVTC-v1.0.28.7z]
|4=[[:Category:IVTC|IVTC]] & [[:Category:Decimation|Decimation]]
|5=[https://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[https://forum.doom9.org/showthread.php?t=82264 Doom9 Thread]}}

==Description==
'''TIVTC''' is a plugin package containing 7 different filters and 3 conditional functions. The seven filters included are '''[[TIVTC/TFM|TFM]], [[TIVTC/TDecimate|TDecimate]], [[TIVTC/MergeHints|MergeHints]], [[TIVTC/FrameDiff|FrameDiff]], [[TIVTC/FieldDiff|FieldDiff]], [[TIVTC/ShowCombedTIVTC|ShowCombedTIVTC]],''' and '''[[TIVTC/RequestLinear|RequestLinear]]'''.

*'''TFM''' is a field matching filter that will recreate the original progressive frames in a telecined source, and '''TDecimate''' is a decimation filter that removes duplicates. These filters can be used together to achieve an [http://en.wikipedia.org/wiki/Ivtc IVTC] or separately to accomplish other tasks.

*'''TDecimate''' also provides special options for handling hybrid material which include [[VFR]] via [http://en.wikipedia.org/wiki/Matroska Matroska] (using a timecodes file) and blend decimation/upconversion for CFR solutions.

*'''Mergehints, RequestLinear, FrameDiff, FieldDiff,''' and '''ShowCombedTIVTC''' are special utility filters included to help perform specific functions.

*The conditional functions are '''IsCombedTIVTC, CFieldDiff,''' and '''CFrameDiff''' which can be used via AviSynth's [[ConditionalFilter|conditional filtering]] environment to test if frames are combed, determine how well two fields fit together, or calculate the difference between frames.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6.0]
* [x64]: [[AviSynth+]]
* Supported color formats: [[YUY2]], [[YV12]], [[YV16]], [[YV411]], [[YV24]]
**AviSynth+: all [[planar]] Y and YUV formats (8/10/12/14/16-bit) are supported.
<br>
==Usage Examples==

====NTSC cases:====

1.) NTSC Film, normal source (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate()

2.) NTSC Film, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=1)

3.) NTSC Hybrid, using blend decimation on video sections (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(hybrid=1)

4.) NTSC Hybrid, using blend decimation on video sections, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=1,hybrid=1)

5.) NTSC Hybrid, using vfr via mkv (not anime or cartoon). One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=3,hybrid=2,vfrDec=0,mkvOut="mkv-timecodesfile.txt")

6.) NTSC Hybrid, using vfr via mkv, anime or cartoon source. One pass.
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(mode=3,hybrid=2,vfrDec=1,mkvOut="mkv-timecodesfile.txt")

7.) NTSC, two pass (enables use of conCycleTP parameter) mkv vfr for hybrid source.
First pass:
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",output="matches.txt")
tdecimate(mode=4,output="metrics.txt")
Second pass (not anime or cartoon):
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",input="matches.txt")
tdecimate(mode=5,hybrid=2,vfrDec=0,input="metrics.txt",tfmIn="matches.txt",mkvOut="mkv-timecodesfile.txt")
Second pass (anime or cartoon):
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v",input="matches.txt")
tdecimate(mode=5,hybrid=2,vfrDec=1,input="metrics.txt",tfmIn="matches.txt",mkvOut="mkv-timecodesfile.txt")

====PAL Cases:====

1.) PAL, no decimation (just field matching)
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")

2.) PAL, decimate 1 in 25 (most similar)
mpeg2source("c:\oursource.d2v")
tfm(d2v="c:\oursource.d2v")
tdecimate(cycle=25)
<br>
== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.0.5
|[https://web.archive.org/web/20140420181748if_/http://bengal.missouri.edu/~kes25c/TIVTCv105.zip TIVTCv105.zip]
|[https://web.archive.org/web/20120223025813if_/http://ivtc.org/yatta%20support/TIVTCv105.zip TIVTCv105.zip]
|}

<br>

==External Links==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#IVTC_.26_Decimation|External Filters]] ←'''
-----------------------------------------------

ConvertBits

2021-12-09T14:28:50Z

Pinterf: /* Changes */ fix table formatting

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
</div>
__NOTOC__

<div style="max-width:62em; min-width:42em;" >

==== ConvertBits ====
Changes bit depth while keeping [[Avisynthplus_color_formats|color format]] the same, if possible. <br>
If the conversion is not possible – for example, converting [[RGB32]] to 14bit – an error is raised.

{{FuncDef
|ConvertBits(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

''(older bit-depth conversion filters – deprecated)''

{{Func3Def
|ConvertToFloat(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo16bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo8bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

:{{Par2||clip|(required)}}
::Source clip.

:{{Par2|bits|int|(actual bit depth)}}
::Bit depth of output clip. If provided valid values are: ''8'', ''10'', ''12'', ''14'', ''16'' (integer) or ''32'' (floating point).
::From 3.7.1 parameter is optional since no bitdepth change is needed when doing only range conversion (fulls-fulld) or artistic dithering (dither_bits<bit depth)
::<3.7.1: required

:{{Par2|truerange|bool|true}}
::Hint: forget it. Deprecated, do not use. Maybe once removed.
::When converting from true 10-16 bit formats, {{FuncArg|truerange}}=false indicates bitdepth of 16 bits regardless of the 10-12-14 bit format. Not applicable for non planar formats.

{{HiddenAnchor|dither}}
:{{Par2|dither|int|-1}}
::*If ''-1'' (default), do not add dither;
::*If ''0'', add [[Ordered_dithering|ordered]] dither;
::*If ''1'', add [[wikipedia:Floyd–Steinberg_dithering|error diffusion (Floyd-Steinberg)]] dither <sup>[http://forum.doom9.org/showthread.php?p=1838145#post1838145 doom9]</sup>
::Dithering is allowed only for scaling down (bit depth reduction), not up. Bit depth can be kept though if a smaller dither_bits is given.
::From 3.7.1: no limit. Note: (behind the scenese) 32 bit float clips are first converted down to 16 (or less if needed) bits, then are further dithered down from this intermediate clip.
::<3.7.1: Dithering is allowed only for 10-16bit (not 32bit float) sources.

:{{Par2|dither_bits|int|{{Template:FuncArg|bits}}}}
::Exaggerated dither effect: dither to a lower color depth than required by {{FuncArg|bits}} argument.
::Has no effect if {{FuncArg|dither}}=''-1'' (off).
::* from 3.7.1 Arbitrary number from 1 to {{FuncArg|bits}}, inclusive.
::* <3.7.1: Must be an even number from ''2'' to {{FuncArg|bits}}, inclusive.
::* <3.7.1: In addition, must be >= ({{FuncArg|clip}}.[[Clip_properties#Color_Format|BitsPerComponent]]-8).
:{{Par2|fulls|bool|(auto)}}
::''Use the default value unless you know what you are doing.''
::Default value can come from <code>_ChromaRange</code> frame property
::If ''true'' (RGB default), scale by multiplication: 0-255 → 0-65535; <p>Note: full scale U and V chroma is specially handled</p>
::if ''false'' (YUV default), scale by [[wikipedia:Arithmetic_shift|bit-shifting]].
::Use case: override greyscale conversion to fullscale instead of bit-shifts.
::Conversion from and to float is always full-scale.
::Alpha plane is always treated as full scale.

:{{Par2|fulld|bool|{{Template:FuncArg|fulls}}}}
::''Use the default value unless you know what you are doing.''
::From 3.7.1: can be any combination with {{FuncArg|fulls}}.
::<3.7.1: ''must'' match {{FuncArg|fulls}}.

:ConvertBits writes <code>_ChromaRange</code> frame property (0-full or 1-limited)



==== Changes ====
{|border=1 cellspacing=1 cellpadding=4
|-
| 3.7.1
|parameter ''bits'' optional
<p>_ChromaRange frame property handling</p>
<p>Free fulls-fulld combination</p>
<p>Free target dither_bits down to 1</p>
<p>Allow dithering from 32 bit float</p>
<p>Allow dithering while keeping actual bit depth (but with a smaller dither_bits)</p>
<p>Specially handled full scale chroma</p>
|-
| 20170310 r2440
| parameter ''dither_bits''
|-
| 20170202 r2420
| parameters ''fulls'', ''fulld''
|}
</div>

[[Category:Internal_filters]]
[[Category:Colourspace_Conversion]]
[[Category:Deep_color_tools]]
[[Category:Avisynthplus]]

ConvertBits

2021-12-09T14:26:49Z

Pinterf: /* Changes */ 3.7.1

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
</div>
__NOTOC__

<div style="max-width:62em; min-width:42em;" >

==== ConvertBits ====
Changes bit depth while keeping [[Avisynthplus_color_formats|color format]] the same, if possible. <br>
If the conversion is not possible – for example, converting [[RGB32]] to 14bit – an error is raised.

{{FuncDef
|ConvertBits(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

''(older bit-depth conversion filters – deprecated)''

{{Func3Def
|ConvertToFloat(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo16bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo8bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

:{{Par2||clip|(required)}}
::Source clip.

:{{Par2|bits|int|(actual bit depth)}}
::Bit depth of output clip. If provided valid values are: ''8'', ''10'', ''12'', ''14'', ''16'' (integer) or ''32'' (floating point).
::From 3.7.1 parameter is optional since no bitdepth change is needed when doing only range conversion (fulls-fulld) or artistic dithering (dither_bits<bit depth)
::<3.7.1: required

:{{Par2|truerange|bool|true}}
::Hint: forget it. Deprecated, do not use. Maybe once removed.
::When converting from true 10-16 bit formats, {{FuncArg|truerange}}=false indicates bitdepth of 16 bits regardless of the 10-12-14 bit format. Not applicable for non planar formats.

{{HiddenAnchor|dither}}
:{{Par2|dither|int|-1}}
::*If ''-1'' (default), do not add dither;
::*If ''0'', add [[Ordered_dithering|ordered]] dither;
::*If ''1'', add [[wikipedia:Floyd–Steinberg_dithering|error diffusion (Floyd-Steinberg)]] dither <sup>[http://forum.doom9.org/showthread.php?p=1838145#post1838145 doom9]</sup>
::Dithering is allowed only for scaling down (bit depth reduction), not up. Bit depth can be kept though if a smaller dither_bits is given.
::From 3.7.1: no limit. Note: (behind the scenese) 32 bit float clips are first converted down to 16 (or less if needed) bits, then are further dithered down from this intermediate clip.
::<3.7.1: Dithering is allowed only for 10-16bit (not 32bit float) sources.

:{{Par2|dither_bits|int|{{Template:FuncArg|bits}}}}
::Exaggerated dither effect: dither to a lower color depth than required by {{FuncArg|bits}} argument.
::Has no effect if {{FuncArg|dither}}=''-1'' (off).
::* from 3.7.1 Arbitrary number from 1 to {{FuncArg|bits}}, inclusive.
::* <3.7.1: Must be an even number from ''2'' to {{FuncArg|bits}}, inclusive.
::* <3.7.1: In addition, must be >= ({{FuncArg|clip}}.[[Clip_properties#Color_Format|BitsPerComponent]]-8).
:{{Par2|fulls|bool|(auto)}}
::''Use the default value unless you know what you are doing.''
::Default value can come from <code>_ChromaRange</code> frame property
::If ''true'' (RGB default), scale by multiplication: 0-255 → 0-65535; <p>Note: full scale U and V chroma is specially handled</p>
::if ''false'' (YUV default), scale by [[wikipedia:Arithmetic_shift|bit-shifting]].
::Use case: override greyscale conversion to fullscale instead of bit-shifts.
::Conversion from and to float is always full-scale.
::Alpha plane is always treated as full scale.

:{{Par2|fulld|bool|{{Template:FuncArg|fulls}}}}
::''Use the default value unless you know what you are doing.''
::From 3.7.1: can be any combination with {{FuncArg|fulls}}.
::<3.7.1: ''must'' match {{FuncArg|fulls}}.

:ConvertBits writes <code>_ChromaRange</code> frame property (0-full or 1-limited)



==== Changes ====
{|border=1 cellspacing=1 cellpadding=4
|-
| 3.7.1
| parameter ''bits'' optional
| _ChromaRange frame property handling
| Free fulls-fulld combination
| Free target dither_bits down to 1
| Allow dithering from 32 bit float
| Allow dithering while keeping actual bit depth (but with a smaller dither_bits)
| Specially handled full scale chroma
|-
| 20170310 r2440
| parameter ''dither_bits''
|-
| 20170202 r2420
| parameters ''fulls'', ''fulld''
|}
</div>

[[Category:Internal_filters]]
[[Category:Colourspace_Conversion]]
[[Category:Deep_color_tools]]
[[Category:Avisynthplus]]

ConvertBits

2021-12-09T14:23:55Z

Pinterf: /* ConvertBits */ bit parameter made optional

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
</div>
__NOTOC__

<div style="max-width:62em; min-width:42em;" >

==== ConvertBits ====
Changes bit depth while keeping [[Avisynthplus_color_formats|color format]] the same, if possible. <br>
If the conversion is not possible – for example, converting [[RGB32]] to 14bit – an error is raised.

{{FuncDef
|ConvertBits(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

''(older bit-depth conversion filters – deprecated)''

{{Func3Def
|ConvertToFloat(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo16bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo8bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

:{{Par2||clip|(required)}}
::Source clip.

:{{Par2|bits|int|(actual bit depth)}}
::Bit depth of output clip. If provided valid values are: ''8'', ''10'', ''12'', ''14'', ''16'' (integer) or ''32'' (floating point).
::From 3.7.1 parameter is optional since no bitdepth change is needed when doing only range conversion (fulls-fulld) or artistic dithering (dither_bits<bit depth)
::<3.7.1: required

:{{Par2|truerange|bool|true}}
::Hint: forget it. Deprecated, do not use. Maybe once removed.
::When converting from true 10-16 bit formats, {{FuncArg|truerange}}=false indicates bitdepth of 16 bits regardless of the 10-12-14 bit format. Not applicable for non planar formats.

{{HiddenAnchor|dither}}
:{{Par2|dither|int|-1}}
::*If ''-1'' (default), do not add dither;
::*If ''0'', add [[Ordered_dithering|ordered]] dither;
::*If ''1'', add [[wikipedia:Floyd–Steinberg_dithering|error diffusion (Floyd-Steinberg)]] dither <sup>[http://forum.doom9.org/showthread.php?p=1838145#post1838145 doom9]</sup>
::Dithering is allowed only for scaling down (bit depth reduction), not up. Bit depth can be kept though if a smaller dither_bits is given.
::From 3.7.1: no limit. Note: (behind the scenese) 32 bit float clips are first converted down to 16 (or less if needed) bits, then are further dithered down from this intermediate clip.
::<3.7.1: Dithering is allowed only for 10-16bit (not 32bit float) sources.

:{{Par2|dither_bits|int|{{Template:FuncArg|bits}}}}
::Exaggerated dither effect: dither to a lower color depth than required by {{FuncArg|bits}} argument.
::Has no effect if {{FuncArg|dither}}=''-1'' (off).
::* from 3.7.1 Arbitrary number from 1 to {{FuncArg|bits}}, inclusive.
::* <3.7.1: Must be an even number from ''2'' to {{FuncArg|bits}}, inclusive.
::* <3.7.1: In addition, must be >= ({{FuncArg|clip}}.[[Clip_properties#Color_Format|BitsPerComponent]]-8).
:{{Par2|fulls|bool|(auto)}}
::''Use the default value unless you know what you are doing.''
::Default value can come from <code>_ChromaRange</code> frame property
::If ''true'' (RGB default), scale by multiplication: 0-255 → 0-65535; <p>Note: full scale U and V chroma is specially handled</p>
::if ''false'' (YUV default), scale by [[wikipedia:Arithmetic_shift|bit-shifting]].
::Use case: override greyscale conversion to fullscale instead of bit-shifts.
::Conversion from and to float is always full-scale.
::Alpha plane is always treated as full scale.

:{{Par2|fulld|bool|{{Template:FuncArg|fulls}}}}
::''Use the default value unless you know what you are doing.''
::From 3.7.1: can be any combination with {{FuncArg|fulls}}.
::<3.7.1: ''must'' match {{FuncArg|fulls}}.

:ConvertBits writes <code>_ChromaRange</code> frame property (0-full or 1-limited)



==== Changes ====
{|border=1 cellspacing=1 cellpadding=4
|-
| 20170310 r2440
| parameter ''dither_bits''
|-
| 20170202 r2420
| parameters ''fulls'', ''fulld''
|}
</div>

[[Category:Internal_filters]]
[[Category:Colourspace_Conversion]]
[[Category:Deep_color_tools]]
[[Category:Avisynthplus]]

ConvertBits

2021-12-09T14:16:18Z

Pinterf: /* ConvertBits */ 3.7.1. changes, allowed parameters, frame props

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
</div>
__NOTOC__

<div style="max-width:62em; min-width:42em;" >

==== ConvertBits ====
Changes bit depth while keeping [[Avisynthplus_color_formats|color format]] the same, if possible. <br>
If the conversion is not possible – for example, converting [[RGB32]] to 14bit – an error is raised.

{{FuncDef
|ConvertBits(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

''(older bit-depth conversion filters – deprecated)''

{{Func3Def
|ConvertToFloat(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo16bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )
|ConvertTo8bit(clip, int bits [, bool ''truerange'', int ''dither'', int ''dither_bits'', bool ''fulls'', bool ''fulld'' ] )}}

:{{Par2||clip|(required)}}
::Source clip.

:{{Par2||bits|(required)}}
::Bit depth of output clip. Valid values: ''8'', ''10'', ''12'', ''14'', ''16'' (integer) or ''32'' (floating point).

:{{Par2|truerange|bool|true}}
::Hint: forget it. Deprecated, do not use. Maybe once removed.
::When converting from true 10-16 bit formats, {{FuncArg|truerange}}=false indicates bitdepth of 16 bits regardless of the 10-12-14 bit format. Not applicable for non planar formats.

{{HiddenAnchor|dither}}
:{{Par2|dither|int|-1}}
::*If ''-1'' (default), do not add dither;
::*If ''0'', add [[Ordered_dithering|ordered]] dither;
::*If ''1'', add [[wikipedia:Floyd–Steinberg_dithering|error diffusion (Floyd-Steinberg)]] dither <sup>[http://forum.doom9.org/showthread.php?p=1838145#post1838145 doom9]</sup>
::Dithering is allowed only for scaling down (bit depth reduction), not up. Bit depth can be kept though if a smaller dither_bits is given.
::Until 3.7.1: Dithering is allowed only for 10-16bit (not 32bit float) sources.
::From 3.7.1: no limit. Note: (behind the scenese) 32 bit float clips are first converted down to 16 (or less if needed) bits, then are further dithered down from this intermediate clip.

:{{Par2|dither_bits|int|{{Template:FuncArg|bits}}}}
::Exaggerated dither effect: dither to a lower color depth than required by {{FuncArg|bits}} argument.
::Has no effect if {{FuncArg|dither}}=''-1'' (off).
::* from 3.7.1 Arbitrary number from 1 to {{FuncArg|bits}}, inclusive.
::* until 3.7.1: Must be an even number from ''2'' to {{FuncArg|bits}}, inclusive.
::* until 3.7.1: In addition, must be >= ({{FuncArg|clip}}.[[Clip_properties#Color_Format|BitsPerComponent]]-8).
:{{Par2|fulls|bool|(auto)}}
::''Use the default value unless you know what you are doing.''
::Default value can come from <code>_ChromaRange</code> frame property
::If ''true'' (RGB default), scale by multiplication: 0-255 → 0-65535; <p>Note: full scale U and V chroma is specially handled</p>
::if ''false'' (YUV default), scale by [[wikipedia:Arithmetic_shift|bit-shifting]].
::Use case: override greyscale conversion to fullscale instead of bit-shifts.
::Conversion from and to float is always full-scale.
::Alpha plane is always treated as full scale.

:{{Par2|fulld|bool|{{Template:FuncArg|fulls}}}}
::''Use the default value unless you know what you are doing.''
::From 3.7.1: can be any combination with {{FuncArg|fulls}}.
::Until 3.7.1: ''must'' match {{FuncArg|fulls}}.

:ConvertBits writes <code>_ChromaRange</code> frame property (0-full or 1-limited)



==== Changes ====
{|border=1 cellspacing=1 cellpadding=4
|-
| 20170310 r2440
| parameter ''dither_bits''
|-
| 20170202 r2420
| parameters ''fulls'', ''fulld''
|}
</div>

[[Category:Internal_filters]]
[[Category:Colourspace_Conversion]]
[[Category:Deep_color_tools]]
[[Category:Avisynthplus]]

Convert

2021-12-09T14:00:25Z

Pinterf: /* Changelog */ Frame prop _ChromaLocation

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "470bg:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "470bg:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Frame properties {{AvsPluscon}} =====

In Avisynth v3.7.1. frame property (_ChromaLocation) support appears in selected filters (e.g. ConvertToYUV422).
Property can be read and/or set.
A frame property can replace default behaviour of location parameters and is set (or deleted) upon finishing conversion.
Since a format without subsampling such as 4:4:4 (YV24) does not have chroma location, the property is deleted automatically when converting to 4:4:4 or RGB.

: "ChromaInLocation" rules:
::* if source has _ChromaLocation frame property it will be used else the default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaInLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: "ChromaOutLocation" rules:
::* default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaOutLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: Accepted values for "ChromaInLocation" and "ChromaOutLocation" (when source/target is a chroma subsampled format)
: (full list):
::* "left" or "mpeg2"
::* "center" or "jpeg" or "mpeg1"
::* "top_left"
::* "dv"
::* "top"
::* "bottom_left"
::* "bottom"

: _ChromaLocation constants - as seen in propShow()

::* AVS_CHROMA_LEFT = 0
::* AVS_CHROMA_CENTER = 1
::* AVS_CHROMA_TOP_LEFT = 2 (4:2:0 only)
::* AVS_CHROMA_TOP = 3 (4:2:0 only)
::* AVS_CHROMA_BOTTOM_LEFT = 4 (4:2:0 only)
::* AVS_CHROMA_BOTTOM = 5 (4:2:0 only)
::* AVS_CHROMA_DV = 6 Special to Avisynth

===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants<br>Added _ChromaLocation frame property
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:59:35Z

Pinterf: /* Frame properties */ Add content

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "470bg:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "470bg:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Frame properties {{AvsPluscon}} =====

In Avisynth v3.7.1. frame property (_ChromaLocation) support appears in selected filters (e.g. ConvertToYUV422).
Property can be read and/or set.
A frame property can replace default behaviour of location parameters and is set (or deleted) upon finishing conversion.
Since a format without subsampling such as 4:4:4 (YV24) does not have chroma location, the property is deleted automatically when converting to 4:4:4 or RGB.

: "ChromaInLocation" rules:
::* if source has _ChromaLocation frame property it will be used else the default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaInLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: "ChromaOutLocation" rules:
::* default is "mpeg2" ("left")
::* if parameter is "auto" or not given at all, ChromaOutLocation will be set to the above mentioned default value
::* if parameter is explicitely given, it will be used

: Accepted values for "ChromaInLocation" and "ChromaOutLocation" (when source/target is a chroma subsampled format)
: (full list):
::* "left" or "mpeg2"
::* "center" or "jpeg" or "mpeg1"
::* "top_left"
::* "dv"
::* "top"
::* "bottom_left"
::* "bottom"

: _ChromaLocation constants - as seen in propShow()

::* AVS_CHROMA_LEFT = 0
::* AVS_CHROMA_CENTER = 1
::* AVS_CHROMA_TOP_LEFT = 2 (4:2:0 only)
::* AVS_CHROMA_TOP = 3 (4:2:0 only)
::* AVS_CHROMA_BOTTOM_LEFT = 4 (4:2:0 only)
::* AVS_CHROMA_BOTTOM = 5 (4:2:0 only)
::* AVS_CHROMA_DV = 6 Special to Avisynth

===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:51:21Z

Pinterf: /* Notes */ Add section Frame properties

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "470bg:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "470bg:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Frame properties =====

===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:48:55Z

Pinterf: /* Parameter Details */ Fix rec601 mapping as new-old matrix

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "470bg:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "470bg:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:45:57Z

Pinterf: /* Changelog */ fix table format for recent commit

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "170m:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "170m:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions<br>Added new matrix constants, optional new syntax<br>Added new chroma location constants
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:44:18Z

Pinterf: /* Changelog */ 3.7.1 additions

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "170m:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "170m:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v3.7.1
| Added ChromaOutPlacement to 4:2:2 related functions
| Added new matrix constants, optional new syntax
| Added new chroma location constants
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:42:36Z

Pinterf: /* Parameter Details */ matrix and ChromaOutPlacement changes

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.2020" : Uses Rec.2020 (UHD) coefficients; keep range unchanged. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{AvsPluscon}}
:New syntax: more matrix string constants with separate full/limited range markers
:"matrixname:full_or_limited" where
:"matrixname" can be (internal _Matrix integer constant in parenthesys)
::* "rgb" (0 - AVS_MATRIX_RGB)
::* "709" (1 - AVS_MATRIX_BT709)
::* "unspec" (2 - AVS_MATRIX_UNSPECIFIED)
::* "170m" (6 - AVS_MATRIX_ST170_M)
::* "240m" (7 - AVS_MATRIX_ST240_M)
::* "470bg" (5 - AVS_MATRIX_BT470_BG)
::* "601" (5 - AVS_MATRIX_BT470_BG)
::* "fcc" (4 - AVS_MATRIX_BT470_M)
::* "bt470m" (4 - AVS_MATRIX_BT470_M)
::* "ycgco" (8 - AVS_MATRIX_YCGCO not supported)
::* "2020ncl" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020" (9 - AVS_MATRIX_BT2020_NCL)
::* "2020cl" (10 - AVS_MATRIX_BT2020_CL same as 2020ncl)
::* "chromacl" (13 - AVS_MATRIX_CHROMATICITY_DERIVED_CL not supported)
::* "chromancl" (12 - AVS_MATRIX_CHROMATICITY_DERIVED_NCL not supported)
::* "ictcp" (14 - AVS_MATRIX_ICTCP not supported)

:: The above "matrix" parameters can be followed by a "full" or "f" and "limited" or "l" or "auto" marker after a ":"<p>e.g. "709:f" means the same as the old "PC.709"</p>
:: When there is no limited-ness marker, or is set to "auto" then value of _ColorRange frame property is used

: Note: old-style "matrix" parameters are kept, their name indicate the full/limited

: For memo and the similar new string
:* "rec601" same as "170m:l"
:* "rec709" "709:l"
:* "pc.601" and "pc601" "170m:f"
:* "pc.709" and "pc709" "709:f"
:* "average" - kept for compatibility, really it has no standard _Matrix equivalent
:* "rec2020" "2020cl:l"
:* "pc.2020" and "pc2020" "2020cl:f"

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12 (4:2:0) or YV16 (4:2:2) {{AvsPluscon}}.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2"  ( {{AvsPluscon}} synonyms: "left")
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1" ( {{AvsPluscon}} synonyms: "jpeg", "center")
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|-
|"top_left"  {{AvsPluscon}}
|Subsampling used in UHD 4:2:0. Chroma samples are located on the top left pixel column of the group .
|-
|"bottom_left"  {{AvsPluscon}}
|4:2:0 only
|-
|"bottom"  {{AvsPluscon}}
|4:2:0 only
|-
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:20:21Z

Pinterf: /* Syntax and Parameters */ Add ChromaOutPlacement in YUV422

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' {{AvsPluscon}} ] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2" 
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1"
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".
</div>

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Convert

2021-12-09T13:12:50Z

Pinterf: Converts: mention ConvertBits to have full-limited conversion

<div style="max-width:62em" >
Convert between any of the color formats that AviSynth supports:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[RGB24]]'''
| [[Interleaved|interleaved]]
| 8
| 4:4:4
| (full chroma)
|-
| '''[[RGB32]]'''
| interleaved
| 8
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[YV24]]''' &diams;
| planar
| 8
| 4:4:4
| (full chroma)
|-
| '''[[YV16]]''' &diams;
| planar
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YUY2]]'''
| interleaved
| 8
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[YV12]]'''
| planar
| 8
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[YV411]]''' &diams;
| planar
| 8
| 4:1:1
| (chroma shared between 4 pixels)
|-
| '''[[Y8]]''' &diams;
| (both)
| 8
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  (&diams; = not supported in AviSynth version 2.58 or below)
|}

{{AvsPluscon}} supports all of the above, plus:
:{| class="wikitable"
|-
! Color format 
! Image format 
! Bit depth 
! Sample ratio 
!style="text-align:left"|  Description
|-
| '''[[Avisynthplus_color_formats|RGB48]]'''
| interleaved
| 16
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGB64]]'''
| interleaved
| 16
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|RGBPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|RGBAPxx]]'''
| [[Planar|planar]]
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4
| (full chroma)
|-
| '''[[Avisynthplus_color_formats|YUVA444Pxx]]'''
| planar
| 8-16, 32 * 
| 4:4:4:4
| (full chroma + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2
| (chroma shared between 2 pixels)
|-
| '''[[Avisynthplus_color_formats|YUVA422Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:2:4
| (chroma shared between 2 pixels + alpha)
|-
| '''[[Avisynthplus_color_formats|YUV420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0
| (chroma shared between 2x2 pixels) 
|-
| '''[[Avisynthplus_color_formats|YUVA420Pxx]]'''
| planar
| 8-16, 32 * 
| 4:2:0:4
| (chroma shared between 2x2 pixels + alpha) 
|-
| '''[[Avisynthplus_color_formats|Y10..Y32]]'''
| (both)
| 10-16, 32 * 
| 4:0:0
| (no chroma)
|-
!colspan="5" style="text-align:left; font-weight:normal;"|  '''*''' 8-16 = ''8,10,12,14,16 bit integer;''  32 = ''32 bit float''
|}

When the target format is the same as the source format, the original clip will be returned unchanged, except for the case of '''ConvertToYV12''' where the {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} parameters are different.

{{BlueBox}}
There is no unique way of [[Color_conversions|converting]] YUV to RGB or vice-versa. There are different ''conversion matrices'' in use; the two most common ones are available in AviSynth, namely ''Rec.601'' and ''Rec.709'', plus some others. The following should be correct in ''most'' cases (see [[Colorimetry#How_can_I_see_if_the_correct_standard_is_used_upon_playback.3F|'''here''']] for more)
*Rec.601 should be used when your source is standard definition (usually defined as smaller than [[Wikipedia:720p|720p]]):
:<code>ConvertToRGB(clip)</code> (using default "Rec601")
*Rec.709 should be used when your source is DVD or HDTV:
:<code>ConvertToRGB(clip, matrix="Rec709")</code>
*The special-purpose matrices ''PC.601'' and ''PC.709'' keep the ''range'' unchanged,
:instead of converting between 0{{D}}-255{{D}} RGB and 16{{D}}-235{{D}} YUV, as is the normal practice.
*The special-purpose matrix ''AVERAGE'' is used for (rarely found) sources with ''unweighted'' luma,
:where ''Y'' = (R + G + B) / 3.
{{End_BlueBox}}

Note '''ConvertToRGB''' always converts to [[RGB32]] – unless your source is RGB24, in which case no conversion is done. If you need 24-bit RGB for some reason, use '''ConvertToRGB24''' explicitly.

Use '''ConvertBackToYUY2''' to convert ''back'' to YUY2 with minimal color-blurring when you have previously applied a YUY2→RGB conversion.

{{AvsPluscon}} See also [[ConvertBits]] to convert between bit depths and/or between full-limited range.
</div>

__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em" >
===== ''RGB interleaved'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToRGB(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB24(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToRGB32(clip [, string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToRGB48(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
      string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToRGB64(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''RGB planar'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToPlanarRGB(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}} <br>
{{FuncDef
|ConvertToPlanarRGBA(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV444'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV24(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV444(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

===== ''YUV422'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV16(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}} <br>
{{FuncDef
|ConvertToYUY2(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}<br>
{{FuncDef
|ConvertToYUV422(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'' ] ) {{AvsPluscon}}
}}

{{FuncDef
|ConvertBackToYUY2(clip [, string ''matrix'' ] )
}}

===== ''YUV420'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV12(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement''] )
}} <br>
{{FuncDef
|ConvertToYUV420(clip, [ string ''matrix'', bool ''interlaced'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample'', <br>
     string ''ChromaOutPlacement'' ] ) {{AvsPluscon}}
}}

===== ''YUV411'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToYV411(clip [, bool ''interlaced'', string ''matrix'', <br>
     string ''ChromaInPlacement'', <br>
     string ''chromaresample''] )
}}

===== ''Y-only'' ===== __NOEDITSECTION__
{{FuncDef
|ConvertToY8(clip [, string ''matrix''] )
}}<br>
{{FuncDef
|ConvertToY(clip, [ string ''matrix'' ] ) {{AvsPluscon}}
}}

==== Parameter Details ====
{{HiddenH5|Matrix}}
{{Par2|matrix|string|"Rec601"}}
:Controls the colour coefficients and scaling factors used in RGB↔YUV conversions.
:*"Rec601"  : Uses Rec.601 coefficients; scale full range [0{{D}}..255{{D}}] RGB ↔ TV range [16{{D}}..235{{D}}] YUV.
:*"Rec709"  : Uses Rec.709 (HD) coefficients; scale full range RGB ↔ TV range YUV.
:*"Rec2020" : Uses Rec.2020 (UHD) coefficients; scale full range RGB ↔ TV range YUV. {{AvsPluscon}}
:*"PC.601"  : Uses Rec.601 coefficients; keep range unchanged.
:*"PC.709"  : Uses Rec.709 (HD) coefficients; keep range unchanged.
:*"Average"  : Uses averaged coefficients (the luma becomes the average of the RGB channels); keep range unchanged.

{{HiddenH5|Interlaced}}
{{Par2|interlaced|bool|false}}
:If true, it is assumed that {{FuncArg|clip}} is interlaced; by default, it is assumed to be progressive.
:This option is needed because for example, the following (assuming clip is interlaced YV12):
<div {{BoxWidthIndent|28|2}} >
[[SeparateFields]](clip)
ConvertToYUY2
[[Weave]]
</div>
:...is upsampled incorrectly. Instead it is better to use:
<div {{BoxWidthIndent|28|2}} >
ConvertToYUY2(clip, interlaced=true)
</div>
:Note, {{FuncArg|interlaced}}=true has an effect only on YV12↔YUY2 or YV12↔RGB conversions. More about that can be found [[Interlaced fieldbased|'''here''']].

{{HiddenH5|Chroma placement}}
{{Par2|ChromaInPlacement|string|"MPEG2"}}
{{Par2|ChromaOutPlacement|string|"MPEG2"}}
:{{FuncArg|ChromaInPlacement}} determines the chroma placement in the clip when converting ''from'' YV12.
:{{FuncArg|ChromaOutPlacement}} determines the chroma placement in the clip when converting ''to'' YV12.
:The placement can be one of these strings:
:{|class="wikitable" width="600"
|-
|"MPEG2" 
|Subsampling used in MPEG-2 4:2:''x'' and most other formats. Chroma samples are located on the left pixel column of the group (default).
|-
|"MPEG1"
|Subsampling used in MPEG-1 4:2:0. Chroma samples are located on the center of each group of 4 pixels.
|-
|"DV"
| Like MPEG-2, but U and V channels are “co-sited” vertically: V on the top row, and U on the bottom row. For 4:1:1, chroma is located on the leftmost column.
|}

{{HiddenH5|Chroma resample}}
{{Par2|chromaresample|string|"bicubic"}}
:Determines which chroma resampler is used in the conversion. Only used when the chroma resolutions of the source and target are different. All AviSynth [[Resize|resizers]] are allowed ("point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"). Default is "bicubic".
</div>

==== Notes ====
<div style="max-width:62em" >
===== Conversion paths =====

:In v2.60 the following conversion paths occur:
:* YUV planar → RGB via YV24
:* YUV planar → YUY2 via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YV12 to YUY2)
:* RGB → YUV planar via YV24
:* YUY2 → YUV planar via YV16
::(except for YV12 and chroma options listed above not explicitly set; in that case there is a direct conversion from YUY2 to YV12)

: The chroma options {{FuncArg|chromaresample}}, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} are only used in the 'planar conversion' part of the conversion path.

:Suppose you have a YUY2 clip for example and you convert it to YV24. The YUY2 will be converted to YV16 first without applying the chroma options. Then YV16 will be converted to YV24 while applying {{FuncArg|chromaresample}}. Since YV12 is not involved, {{FuncArg|ChromaInPlacement}} and {{FuncArg|ChromaOutPlacement}} won't be used.

===== Sampling =====

:[[Sampling|'''[This page]''']] covers the sampling methods and color formats in more detail.

===== Color conversions =====

:[[Color_conversions|'''[This page]''']] covers the color conversions in more detail.
</div>

==== Changelog ====
<div style="max-width:62em" >
{| border="1"
|-
| v2.60
| Added ConvertToY8, ConvertToYV411, ConvertToYV16, ConvertToYV24, ChromaInPlacement, ChromaOutPlacement, chromaresample, matrix="AVERAGE".
|-
| v2.50
| Added ConvertToYV12.
|}
</div>

[[Category:Internal filters]]
[[Category:Colourspace_Conversion]]

Expr

2021-12-09T13:09:49Z

Pinterf: /* Expr language/RPN elements */ fix formatter missing end

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV'', int ''lut''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit integer or 32 bit float for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

:{{Par2|lut|int|0}}
:: Since v3.7.1
:: LUT (Look-up Table) mode. LUT is precalculated table. Expression values are calculated for all pixel value combinations in advance.
:: Then in each frame the resulting pixel value is 'looked up' from the ready-made table, which is indexed by the actual (x) or (x,y) pixel value.
::* Default is 0, which means the usual realtime calculation. lut=1: 1D LUT (lutx) lut=2: 2D lut (lutxy)
::* 1D luts are available for 8-16 bit inputs. A 8 bit 1D lut need 256 byte memory. A 16 bit 1D lut needs 65536 2-byte-words (131072 bytes)
::* 2D luts are available for 8-14 bit inputs. Note: a 14 bit 2D lut needs (2^14)*(2^14)*2 bytes buffer in memory per plane (~1GByte)
::* When lut is not available for a given bit depth then Expr will silently fallback to realtime (lut=0) mode.
::* In 1D or 2D lut mode some keywords and features are forbidden in the expression: sx, sy, sxr, syr, frameno, time, relative pixel addressing.
::* Frame property access works, but is limited to frame #0 which is read before LUT evaluation.
::* In lut mode the input clip's bit depths must be the same.

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)</p>
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 and f32 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14, 16 or 32 bits by the 'i10'..'i16','f32' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535 (chroma is a bit different, since it is converted by moving into signed domain and back such as in (x-32768)*(127/32767)+128)
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::chroma: <code>result = (calculate_value((input-32768) / 32767.0 * 127.0 + 128 ) - 128) / 127.0 * 32767.0 + 32768</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
lut (Lookup table) support 1D and 2D<br>
Enhanced: special full scale conversion of chroma plane
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T13:07:45Z

Pinterf: /* Changes */ mention special full scale chroma method

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV'', int ''lut''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit integer or 32 bit float for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

:{{Par2|lut|int|0}}
:: Since v3.7.1
:: LUT (Look-up Table) mode. LUT is precalculated table. Expression values are calculated for all pixel value combinations in advance.
:: Then in each frame the resulting pixel value is 'looked up' from the ready-made table, which is indexed by the actual (x) or (x,y) pixel value.
::* Default is 0, which means the usual realtime calculation. lut=1: 1D LUT (lutx) lut=2: 2D lut (lutxy)
::* 1D luts are available for 8-16 bit inputs. A 8 bit 1D lut need 256 byte memory. A 16 bit 1D lut needs 65536 2-byte-words (131072 bytes)
::* 2D luts are available for 8-14 bit inputs. Note: a 14 bit 2D lut needs (2^14)*(2^14)*2 bytes buffer in memory per plane (~1GByte)
::* When lut is not available for a given bit depth then Expr will silently fallback to realtime (lut=0) mode.
::* In 1D or 2D lut mode some keywords and features are forbidden in the expression: sx, sy, sxr, syr, frameno, time, relative pixel addressing.
::* Frame property access works, but is limited to frame #0 which is read before LUT evaluation.
::* In lut mode the input clip's bit depths must be the same.

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 and f32 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14, 16 or 32 bits by the 'i10'..'i16','f32' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535 (chroma is a bit different, since it is converted by moving into signed domain and back such as in (x-32768)*(127/32767)+128)
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::chroma: <code>result = (calculate_value((input-32768) / 32767.0 * 127.0 + 128 ) - 128) / 127.0 * 32767.0 + 32768</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
lut (Lookup table) support 1D and 2D<br>
Enhanced: special full scale conversion of chroma plane
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T13:05:41Z

Pinterf: /* Auto-scale inputs with "scale_inputs" */ some missing f32 mentioning, chroma mode

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV'', int ''lut''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit integer or 32 bit float for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

:{{Par2|lut|int|0}}
:: Since v3.7.1
:: LUT (Look-up Table) mode. LUT is precalculated table. Expression values are calculated for all pixel value combinations in advance.
:: Then in each frame the resulting pixel value is 'looked up' from the ready-made table, which is indexed by the actual (x) or (x,y) pixel value.
::* Default is 0, which means the usual realtime calculation. lut=1: 1D LUT (lutx) lut=2: 2D lut (lutxy)
::* 1D luts are available for 8-16 bit inputs. A 8 bit 1D lut need 256 byte memory. A 16 bit 1D lut needs 65536 2-byte-words (131072 bytes)
::* 2D luts are available for 8-14 bit inputs. Note: a 14 bit 2D lut needs (2^14)*(2^14)*2 bytes buffer in memory per plane (~1GByte)
::* When lut is not available for a given bit depth then Expr will silently fallback to realtime (lut=0) mode.
::* In 1D or 2D lut mode some keywords and features are forbidden in the expression: sx, sy, sxr, syr, frameno, time, relative pixel addressing.
::* Frame property access works, but is limited to frame #0 which is read before LUT evaluation.
::* In lut mode the input clip's bit depths must be the same.

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 and f32 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14, 16 or 32 bits by the 'i10'..'i16','f32' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535 (chroma is a bit different, since it is converted by moving into signed domain and back such as in (x-32768)*(127/32767)+128)
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::chroma: <code>result = (calculate_value((input-32768) / 32767.0 * 127.0 + 128 ) - 128) / 127.0 * 32767.0 + 32768</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
lut (Lookup table) support 1D and 2D<br>
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T12:51:37Z

Pinterf: /* Changes */ lut in 3.7.1

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV'', int ''lut''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit integer or 32 bit float for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

:{{Par2|lut|int|0}}
:: Since v3.7.1
:: LUT (Look-up Table) mode. LUT is precalculated table. Expression values are calculated for all pixel value combinations in advance.
:: Then in each frame the resulting pixel value is 'looked up' from the ready-made table, which is indexed by the actual (x) or (x,y) pixel value.
::* Default is 0, which means the usual realtime calculation. lut=1: 1D LUT (lutx) lut=2: 2D lut (lutxy)
::* 1D luts are available for 8-16 bit inputs. A 8 bit 1D lut need 256 byte memory. A 16 bit 1D lut needs 65536 2-byte-words (131072 bytes)
::* 2D luts are available for 8-14 bit inputs. Note: a 14 bit 2D lut needs (2^14)*(2^14)*2 bytes buffer in memory per plane (~1GByte)
::* When lut is not available for a given bit depth then Expr will silently fallback to realtime (lut=0) mode.
::* In 1D or 2D lut mode some keywords and features are forbidden in the expression: sx, sy, sxr, syr, frameno, time, relative pixel addressing.
::* Frame property access works, but is limited to frame #0 which is read before LUT evaluation.
::* In lut mode the input clip's bit depths must be the same.

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
lut (Lookup table) support 1D and 2D<br>
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T12:51:01Z

Pinterf: /* Syntax and Parameters */ lut mode

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV'', int ''lut''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit integer or 32 bit float for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

:{{Par2|lut|int|0}}
:: Since v3.7.1
:: LUT (Look-up Table) mode. LUT is precalculated table. Expression values are calculated for all pixel value combinations in advance.
:: Then in each frame the resulting pixel value is 'looked up' from the ready-made table, which is indexed by the actual (x) or (x,y) pixel value.
::* Default is 0, which means the usual realtime calculation. lut=1: 1D LUT (lutx) lut=2: 2D lut (lutxy)
::* 1D luts are available for 8-16 bit inputs. A 8 bit 1D lut need 256 byte memory. A 16 bit 1D lut needs 65536 2-byte-words (131072 bytes)
::* 2D luts are available for 8-14 bit inputs. Note: a 14 bit 2D lut needs (2^14)*(2^14)*2 bytes buffer in memory per plane (~1GByte)
::* When lut is not available for a given bit depth then Expr will silently fallback to realtime (lut=0) mode.
::* In 1D or 2D lut mode some keywords and features are forbidden in the expression: sx, sy, sxr, syr, frameno, time, relative pixel addressing.
::* Frame property access works, but is limited to frame #0 which is read before LUT evaluation.
::* In lut mode the input clip's bit depths must be the same.

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:30:50Z

Pinterf: /* Changes */ Expr 3.7.1

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.7.1
| new: round, floor, ceil, trunc<br>
TAB, CR, LF are valid string delimiters inside expr string<br>
Enhanced: arbitrary variable names, not only A to Z<br>
Access clip's frame properties: clipletter.frameProperty syntax<br>
Enhanced: sin and cos: SIMD acceleration<br>
new: atan2<br>
new: neg, sgn<br>
Enhanced: allow ‘f32’ as internal autoscale target besides integer i8..i16<br>
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:28:14Z

Pinterf: Expr: allow f32 in all autoscale

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16' and 'f32')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16' and 'f32')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16' and 'f32') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 or f32 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 integer or 32 bit float bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16','f32')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16','f32')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16','f32') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:22:24Z

Pinterf: /* Expr language/RPN elements */ New functions sgn and neg

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>neg</code> simple negates stack top
:* Function: <code>sgn</code> simple signum function -1 if x<0; 0 when x==0; 1 if x>0
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:18:09Z

Pinterf: /* Expr language/RPN elements */ sin and cos to SIMD, new atan2

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, neg, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos atan2 tan asin acos atan</code><p>On Intel x86/x64 the functions <code>sin</code>, <code>cos</code> and <code>atan2</code> have SSE2/AVX2 optimization, the others have not (they make the whole expression to evaluate without SIMD optimization)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:12:11Z

Pinterf: Expr: frame property access

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, neg, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos tan asin acos atan</code> (no SSE2/AVX2 optimization when they appear in Expr)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Frame property input =====
:: Frame properties (Integer or 32 bit float type) can be accessed within the expressions.
:: <code>clipletter.frameProperty</code> syntax injects actual frame property values into expression
:: Example:
:: <code>x._ColorRange</code> will push the value of _ColorRange frame property on stack (of clip <code>x</code>)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T11:02:31Z

Pinterf: /* Internal variables */ arbitrary variable names, 32 bit frameno behaviour as float

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, neg, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos tan asin acos atan</code> (no SSE2/AVX2 optimization when they appear in Expr)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Internal variables =====

: <b>User variables</b>
: Variables can freely be used during evaluation for storing and loading intermediate results within the expression.
: Variable names must begin with an English letter (a to z, A to Z) or with _ (underscore), followed by one or more underscore, letters or digits.
: For example <code>A</code>, <code>X2</code>, <code>_myvar</code>, <code>aa</code> etc..
: (until 3.7.1 only uppercase <code>A</code> to <code>Z</code> names were allowed)

: Variables names are case sensitive and cannot be already reserved words.

: <i>Actions with variables</i>

::* Store: <code>varname@</code> <p>Actual stack top is assigned to a variable.</p>
::* Store and pop from stack: <code>varname^</code> <p>Actual stack top is assigned to a variable, then is immediately removed from stack top. Use case: when the value assigned to the variable won't be used immediately.</p>
::* Variables can be used by simply giving their names: <code>varname</code> <p>The actual content of the variable is pushed onto the stack top.</p>

:: Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <b>Special predefined variables</b>

:* <code>frameno</code> : use current frame number in expression. <code>0 <= frameno < <tt>clip_frame_count</tt></code>.<p>A 32 bit integer converted to float, so it is precise only at approximately 24 bits.</p>
:* <code>time</code> : calculation: <code>time = frameno/clip_frame_count</code>. Use relative time position in expression. <code>0 <= time < frameno/clip_frame_count</code>
:* <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T10:20:38Z

Pinterf: /* Expr language/RPN elements */ Add rounding operators

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, neg, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos tan asin acos atan</code> (no SSE2/AVX2 optimization when they appear in Expr)
:* Functions: <code>round, floor, ceil, trunc</code> operators (nearest integer - banker's rounding, round down, round up, round to zero)<p>On Intel builds acceleration requires at least SSE4.1 capable processor or else the whole expression is running in C mode.</p>
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Internal variables =====
: Uppercase ''A'' to ''Z'' for storing and loading intermediate results within the expression
:: Store: <code>A@ .. Z@</code>
:: Store and pop from stack: <code>A^ .. Z^</code>
:: Use: A..Z
:* Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <code>frameno</code> : use current frame number in expression. 0 <= <code>frameno</code> < <tt>clip_frame_count</tt>
: <code>time</code> : calculation: time = frameno/clip_frame_count. Use relative time position in expression. 0 <= time < frameno/clip_frame_count
: <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Expr

2021-12-09T10:07:48Z

Pinterf: /* Syntax and Parameters */ Expr allow TAB, CR and LF delimiters

<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}
__NOTOC__
</div>
<div style="max-width:62em; min-width:42em;" >
Applies a [[wikipedia:Function_(mathematics)|mathematical function]], defined by an ''expression'' string, on the pixels of the source clip(s). A different expression may be set for each color channel. Users of '''[[MaskTools2|MaskTools]]''' may be familiar with this concept.
</div>
__TOC__

==== Syntax and Parameters ====
<div style="max-width:62em; min-width:42em;" >
{{FuncDef
|Expr( [clip ''clip''[, ...], string ''exp''[, ...], string ''format'',<br>
      bool ''optAvx2'', bool ''optSingleMode'', bool ''optSSE2'', string ''scale_inputs'', bool ''clamp_float'', bool ''clamp_float_UV''] )
}}

:{{Par2|clip|clip|}}
::One or more source clips. Up to 26 input clips can be specified.
::* The first three clips are referenced by lowercase letter x, y and z; use 'a', 'b' ... 'w' for the rest.
::* Clips may be YUV(A), RGB(A), or greyscale; 8-16 bit integer or 32 bit float.
::* Width, height and [[wikipedia:Chroma_subsampling|color subsampling]] should be the same; bit depths can be different.

:{{Par2|exp|string|}}
::One or more [[wikipedia:Reverse Polish Notation|RPN]] expressions
::* A different expression may be set for each color channel (or ''plane''). Plane order is Y-U-V-A or R-G-B-A.
::(note: due to a bug, versions prior to r2724 used GBRA ordering)
::* When an expression string is not given, the previous one is used.
::* The empty string ("") is a valid expression; it causes the plane to be copied (see [[#Expressions|Expressions]] below).
::* Keyword delimiters are space, but TAB, CR and LF characters are allowed as whitespace as well since 3.7.1

:{{Par2|format|string|""}}
:: Set color format of the returned clip.
::* Use [[Avisynthplus_color_formats|pixel format strings]] like "YV12", "YUV420P8", "YUV444P16", "RGBP10".
::* By default, the output format is the same as the first clip.

:{{Par2|optAvx2|bool |(auto)}}
:: If false, disable [[wikipedia:Advanced_Vector_Extensions|AVX2]].
::* Enables/Disables AVX2 code generation if available. Do nothing if AVX2 is not supported in Avisynth.

:{{Par2|optSingleMode|bool |false}}
:: If ''true'', generate assembly code using only one XMM/YMM register set instead of two; default false.
::* '''Expr''' generates assembly code that normally uses two 128 (SSE2) or 256 bit (AVX2) registers ("lanes"), thus processing 8 (SSE2)/16 (AVX2) pixels per internal cycle.
::* Experimental parameter, {{FuncArg|optSingleMode}}=true makes the internal compiler generate instructions for only one register (4/8 pixels - SSE2/AVX2). The parameter was introduced to test the speed of x86 code using one working register. Very-very complex expressions would use too many XMM/YMM registers which are then "swapped" to memory slots, that could be slow. Using {{FuncArg|optSingleMode}} = true may result in using less registers with no need for swapping them to memory slots.

:{{Par2|optSSE2|bool |(auto)}}
:: If false, disable [[wikipedia:SSE2|SSE2]].
::* Enables/Disables SSE2 code generation when in non-AVX2 mode. Setting {{FuncArg|optSSE2}}=false and {{FuncArg|optAVX2}}=false forces expression processing in a slow interpreted way (C language)

:{{Par2|scale_inputs|string|"none"}}
:: Autoscale any input bit depths to 8-16 bit for internal expression use, the conversion method is either full range (stretch) or limited YUV range (like bit shift). Feature is similar to the one in masktools2 v2.2.15
:: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.
::*"int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::*"float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::*"floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::*"all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::*"allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::*"none": no magic
:: E.g. scale_inputs="float" will automatically convert 32 bit float input to 8 bit range (but keeps the floating point precision)
:: The default 8 bit target range can be overridden by the i10 .. i16 specifiers at the beginning of the expression string.
:: The script inside will treat the clip as a 8 bit one. This only affects the internal calculations, the output is properly scaled back.
:: Note: ymin, ymax, cmin, cmax, range_min, range_max, range_half and range_size internal variables are changed accordingly (this behaviour was fixed in Avs+ > r2900)

:{{Par2|clamp_float|bool|false}}
:: if true: clamps 32 bit float to valid ranges, which is 0..1 for luma or for RGB color space and -0.5..0.5 for YUV chroma UV channels
:: Default false: as usual, 32 bit float pixels are not clamped
:: Until 3.4: Ignored when scale_inputs scales 32bit-float type pixels
:: From 3.5: not ignored, even when parameter "scale_inputs" auto-scales 32 bit float type pixels to integer

:{{Par2|clamp_float_UV|bool|false}}
:: Since v3.5
:: this parameter affects clamping of chroma planes: chroma is clamped between 0..1.0 instead of -0.5..0.5.
:: Default false: as usual, 32 bit float pixels are not clamped

</div>

<div style="max-width:62em" >

==== Expressions ====

'''Expr''' accepts 1 to 26 '''source clips''', up to four '''expression''' strings (one per color plane), an optional '''output format''' string, and some debug options.
Output video format is inherited from the first clip, when there is no format override.
All clips have to match in their width, height and [[wikipedia:Chroma_subsampling|chroma subsampling]].

Expressions are evaluated on each plane, Y, U, V (and A) or R, G, B (,A).
When an expression string is not specified, the previous expression is used for that plane – except for plane A (alpha) which is copied by default.
When an expression is an empty string ("") then the relevant plane will be copied (if the output clip bit depth is similar).
When an expression is a single clip reference letter ("x") and the source/target bit depth is similar, then the relevant plane will be copied.
When an expression is constant (after constant folding), then the relevant plane will be filled with an optimized memory fill method.
* Example: <code>Expr(clip, "255", "128, "128")</code> fills all three planes.
* Example: <code>Expr(clip, "x", "range_half, "range_half")</code> copies luma, fills U and V with 128/512/... (bit depth dependent)
Other optimizations: do not call GetFrame for input clips that are not referenced or plane-copied

Expressions are written in [[wikipedia:Reverse Polish Notation|RPN]].

Expressions use 32 bit float precision internally.

For 8..16 bit formats output is rounded and clamped from the internal 32 bit float representation to valid 8, 10, ... 16 bits range. 32 bit float output is not clamped at all.

===== Expr language/RPN elements =====
:* Clips: letters ''x'', ''y'', ''z'', ''a''..''w''. ''x'' is the first clip parameter, ''y'' is the second one, etc.
:* Math: <code>* / + -</code>
:* <code>%</code> (modulo), like fmod. Example: <code>result = x - trunc(x/d)*d</code>. Note: the internal 32-bit float can hold only a 24 bit integer number (approximately)
:* Math constant: <code>pi</code>
:* Functions: <code>min, max, sqrt, abs, neg, exp, log, pow ^</code> (synonyms: <code>pow</code> and <code></code>)
:* Function: <code>clip</code> three operand function for clipping. Example: <code>x 16 240 clip</code> means min((max(x,16),240)
:* Functions: <code>sin cos tan asin acos atan</code> (no SSE2/AVX2 optimization when they appear in Expr)
:* Logical: <code> > < = >= <= and or xor not == & | !=</code> (synonyms: <code>==</code> and <code>=</code>, <code>&</code> and <code>and</code>, <code>|</code> and <code>or</code>)
:* Ternary operator: <code>?</code> Example: <code>x 128 < x y ?</code>
:* Duplicate stack elements: <code>dup, dup''n''</code> (dup1, dup2, ...)
:* Swap stack elements: <code>swap, swap''n''</code> (swap1, swap2, ...)
:* Scale by bit shift: <code>scaleb</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)
:* Scale by full scale stretch: <code>scalef</code> (operand is treated as being a number in 8 bit range unless i8..i16 or f32 is specified)

===== Bit-depth aware constants =====
:* <code>ymin, ymax</code> (ymin_a .. ymin_z for individual clips) - the usual luma limits (16..235 or scaled equivalents)
:* <code>cmin, cmax</code> (cmin_a .. cmin_z) - chroma limits (16..240 or scaled equivalents)
:* <code>range_half</code> (range_half_a .. range_half_z) - half of the range, (128 or scaled equivalents)
:* <code>range_size</code> (range_size_a .. range_size_z , etc..) 256, 1024, 4096, 16384, 65536 for integer formats, 1.0 for 32 bit float formats
:* <code>range_min, range_max</code> (range_min_a .. range_min_z) chroma/luma plane aware constants for the actual min-max limits
:* <code>yrange_min, yrange_half, yrange_max</code> Unlike the luma/chroma plane adaptive "range_min", "range_half", "range_max" these constants always report the luma (Y) values. Since v3.5
When the constant name is ended with _x, _y, _z, _a, etc.. the constant is brought from the specified clip (input clips can be of different formats)
When by using parameter "scale_inputs" the input is converted to e.g. 8 bits, these constants are calculated for this internally used bit depth.

===== Keywords for modifying base bit depth =====
:* <code>i8, i10, i12, i14, i16, f32</code> (used with <code>scaleb</code> and <code>scalef</code>)

===== Spatial input variables in expr syntax =====
:: <code>sx, sy</code> (absolute x and y coordinates, 0 to width-1 and 0 to height-1)
:: <code>sxr, syr</code> (relative x and y coordinates, from 0 to 1.0)

===== Internal variables =====
: Uppercase ''A'' to ''Z'' for storing and loading intermediate results within the expression
:: Store: <code>A@ .. Z@</code>
:: Store and pop from stack: <code>A^ .. Z^</code>
:: Use: A..Z
:* Example: <code>"x y - A^ x y 0.5 + + B^ A B / C@ x +"</code>

: <code>frameno</code> : use current frame number in expression. 0 <= <code>frameno</code> < <tt>clip_frame_count</tt>
: <code>time</code> : calculation: time = frameno/clip_frame_count. Use relative time position in expression. 0 <= time < frameno/clip_frame_count
: <code>width, height</code>: clip width and clip height

===== Pixel addressing =====
: Indexed, addressable source clip pixels by relative x,y positions.
:: Syntax: x[a,b] where
:: 'x': source clip letter a..z
:: 'a': horizontal shift. -width < a < width
:: 'b': vertical shift. -height < b < height
:: 'a' and 'b' should be constant. e.g.: "x[-1,-1] x[-1,0] x[-1,1] y[0,-10] + + + 4 /"

:: When an pixel would come from off-screen, the pixels are cloned from the edge.
:: Optimized version of indexed pixels require SSSE3, and no AVX2 version is available. Non-SSSE3 falls back to C for the whole expression

==== Auto-scale inputs with "scale_inputs" ====
: Autoscale works by converting any input bit depths to a common 8-16 bit format for internal expression use, the conversion method is either full range or limited YUV range. Feature is similar to the one in masktools2 v2.2.15

: The primary reason of this feature is the "easy" usage of formerly written expressions optimized for 8 bits.

: Possible values for scale_inputs
::* "int" : scales limited range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "intf": scales full range videos, only integer formats (8-16bits) to 8 (or bit depth specified by 'i8'..'i16')
::* "float" or "floatf" : only scales 32 bit float format to 8 bit range (or bit depth specified by 'i8'..'i16')
::* "floatUV": (since v3.5) chroma pre and post shift by 0.5 for 32 bit float pixels, thus having them in the range of 0..1 instead of -0.5..+0.5 during Expr evaluation
::* "all": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses limited_range logic (mul/div by two's power)
::* "allf": scales videos to 8 (or bit depth specified by 'i8'..'i16') - conversion uses full scale logic (stretch)
::* "none": no magic

: Usually limited range is for normal YUV videos, full scale is for RGB or known-to-be-fullscale YUV

: By default the internal conversion target is 8 bits, so old expressions written for 8 bit videos will probably work.
: This internal working bit-depth can be overwritten by the i8, i10, i12, i14, i16 specifiers.

: When using autoscale mode, scaleb and scalef keywords are meaningless for 8-16 bits, because there is nothing to scale. 32 bit (float) values will be scaled however when "float", "floatUV", "all", "allf" is specified.
: Different conversion methods cannot be set for converting before and after the expression. Neither can you specify different methods for distinct input clips (e.g. x is full, y is limited is not supported).

: How it works:
:*8-32 bit inputs ar all scaled to a common bit depth value, which bit depth is 8 by default and can be set to 10, 12, 14 and 16 bits by the 'i10'..'i16' keywords.<br>
:For example: scale_inputs="all" converts any inputs to 8 bit range. No truncation occurs however (no precision loss), because even a 16 bit data is converted to 8 bit in floating point precision, using division by 256.0 (2^16/2^8).
:So the conversion is _not_ a simple shift-right-8 in the integer domain, which would lose precision.
:*Calculates expression (like in masktools2 mt_lut, mt_lutxy, mt_lutxyz and mt_lutxyza do)
:*Scales the internal result back to the original video bit depth.<br>Clamping (clipping to valid range) and converting to an integer output (if applicable) occurs here.

: The predefined constants such as 'range_max', etc. will behave according to the internal working bit depth

:'''Important note!'''
::This feature was created for easy porting earlier 8-bit-video-only lut expressions. You have to understand how it works internally.
::Let's see a 16bit input in "all" and "allf" mode (target is the default 8 bits)
::Limited range 16->8 bits conversion has a factor of 1/256.0 (Instead of shift right 8 in integer domain, float-division is used or else it would lose presision)
::Full range 16->8 bits conversion has a factor of 255.0/65535
::Using bit shifts (really it's division and multiplication by 2^8=256.0):
::<code>result = calculate_lut_value(input / 256.0) * 256.0</code>
::Full scale 16-8-16 bit mode ('intf', 'allf'):
::<code>result = calculate_lut_value(input / 65535.0 * 255.0 ) / 255.0 * 65535.0</code>
::Use scale_inputs = "all" ("int", "float") for YUV videos with 'limited' range e.g. in 8 bits: Y=16..235, UV=16..240).
::Use scale_inputs = "allf" (intf, floatf) for RGB or YUV videos with 'full' range e.g. in 8 bits: channels 0..255.
::When input is 32bit float, the 0..1.0 (luma) and -0.5..0.5 (chroma) channel is scaled to 0..255 (8 bits), 0..1023 (i10 mode), 0..4095 (i12 mode), 0..16383(i14 mode), 0..65535(i16 mode) then back.

==== Compared to MaskTools ====
Compared to [[MaskTools2|MaskTools2]] version 2.2.15, '''Expr''' has functionality similar to <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt> and <tt>mt_lutspa</tt>.

MaskTools2 is very slow for 10+ bit clips, when a [[wikipedia:Lookup_table|LUT]] (lookup table) cannot be used for memory size reasons, thus the expression is evaluated/interpreted at runtime for each pixel.
MaskTools2 (from v2.2.15) however is able to pass the expressions to this Avisynth+ 'Expr' filter with its 'use_expr' parameter, by passing the expression strings, and clamp_float and scale_inputs parameter.

The [[wikipedia:Just-in-time_compilation|JIT compiler]] in '''Expr''' (adapted from [http://www.vapoursynth.com/doc/functions/expr.html VapourSynth]) turns the expression calculation into realtime assembly code which is much faster and basically bit depth independent.

: In '''Expr''':
:* Up to 26 clips are allowed (x,y,z,a,b,...w). Masktools handles only up to 4 clips with its <tt>mt_lut</tt>, <tt>mt_lutxy</tt>, <tt>mt_lutxyz</tt>, <tt>mt_lutxyza</tt>
:* Clips with different bit depths are allowed
:* Works with 32 bit floats instead of 64 bit double internally
:* Less functions (e.g. no bit shifts)
:* Logical 'false' is 0 instead of -1
:* The ymin, ymax, etc built-in constants can have a _X suffix, where X is the corresponding clip designator letter. E.g. cmax_z, range_half_x
:* mt_lutspa-like functionality is available through "sx", "sy", "sxr", "syr" internal predefined variables
:* No y= u= v= parameters with negative values for filling plane with constant value, constant expressions are changed into optimized "fill" mode

==== Examples ====
Average three clips:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip1, clip2, clip3, "x y + z + 3 /")
</div>

When input clips to have more planes than an implicitely specified output format:
<div {{BoxWidthIndent|64|2}} >
Expr(aYV12Clip, "x 255.0 /", format="Y32") # target is Y only which needs only Y plane from YV12
</div>

Y-plane-only clip(s) can be used as source planes when a non-subsampled (rgb or 444) output format is specified:
<div {{BoxWidthIndent|70|2}} >
Expr(Y, "x", "x 2.0 /", "x 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
Expr(Grey_r, Grey_g, Grey_b, "x", "y 2.0 /", "z 3.0 /", format="RGBPS") # r, g and b expression uses Y plane
</div>

Using spatial feature:
<div {{BoxWidthIndent|62|2}} >
c = Expr(clip_for_format, "sxr syr 1 sxr - 1 syr - * * * 4096 scaleb *", "", "")
</div>

Mandelbrot zoomer (original code and idea from here: https://forum.doom9.org/showthread.php?p=1738391#post1738391 )
<div {{BoxWidthIndent|64|2}} >
a="X dup * Y dup * - A + T^ X Y 2 * * B + 2 min Y^ T 2 min X^ "
b=a+a
c=b+b
blankclip(width=960,height=640,length=1600,pixel_type="YUV420P8")
Expr("sxr 3 * 2 - -1.2947627 - 1.01 frameno ^ / -1.2947627 + A@ X^ syr 2 * 1 - 0.4399695 "
\ + "- 1.01 frameno ^ / 0.4399695 + B@ Y^ "+c+c+c+c+c+b+a+"X dup * Y dup * + 4 < 0 255 ?",
\ "128", "128")
</div>

For other ideas of spatial variables, see [http://avisynth.nl/index.php/MaskTools2/mt_lutspa MaskTools2:mt_lutspa]
</div>

==== Changes ====
<div style="max-width:62em; min-width:42em;" >
{|border=1 cellspacing=1 cellpadding=4
|-
| r3.5
| allow "floatUV" for parameter "clamp_float"<br>
new parameter "clamp_float_UV"
|-
| r2724 (20180702)
| new three operand function: clip<br>
new parameter "clamp_float"<br>
new parameter "scale_inputs"
|-
| r2574 (20171219)
| new: Indexable source clip pixels by relative x,y positions like x[-1,1]
new functions: sin cos tan asin acos atan
<br>new operator: % (modulo)
<br>new: Variables: uppercase letters A..Z for storing and reuse temporary results, frequently used computations.
<br>new: predefined expr variables 'frameno', 'time', 'width', 'height'
<br>fix: jitasm code generation at specific circumstances
|-
| r2544 (20171115)
| optimization; fix ''scalef''
|-
| r2542 (20171114)
| first added
|}
</div>

[[Category:Internal_filters]]
[[Category:Layering]]
[[Category:Masking]]
[[Category:Avisynthplus]]

Internal functions

2021-12-09T10:04:20Z

Pinterf: /* Property get */ propGet for Clip value type

<div style="max-width:82em; min-width:42em;" >
<div style="max-width:64em" >
In addition to [[Internal_filters|internal filters]] AviSynth has a fairly large number of other (non-clip) internal functions.

The input or/and output of these functions are not clips, but some other variables which can be used in a script.
{| style="max-width:56em"
|-
| style="vertical-align:top;" |
<div style="margin:1.0em;padding:2px 8px;">
<div style="border:1px solid #aaa; background-color:#f9f9f9; padding:5px; font-size:95%; width:20em">
<div style="margin=auto;text-align:center">'''Short Contents:'''</div>
# [[#Boolean_functions|Boolean functions]]
# [[#Control_functions|Control functions]]
# [[#Global_options|Global options]]
# [[#Conversion_functions|Conversion functions]]
# [[#Numeric_functions|Numeric functions]]
# [[#Trigonometry_functions|Trigonometry functions]]
# [[#Bit_functions|Bit functions]]
# [[#Runtime_functions|Runtime functions]]
# [[#Functions_for_frame_properties|Functions for frame properties]]
# [[#Script_functions|Script functions]]
# [[#String_functions|String functions]]
# [[#Version_functions|Version functions]]
# [[#Other_helper_functions|Other helper functions]]
<div style="line-height:50%;margin:0;padding:0"> </div>
</div>
</div>
| style="width:4em;" | 
| style="vertical-align:top;" |
<div>
<div style="float:right;clear:right;margin:1.0em;padding:2px 8px;">
__TOC__
</div>
</div>
|}
</div>

== Boolean functions ==
<div style="max-width:62em" >
: These return true or false, if the condition that they test holds or not, respectively.

{{ScriptFunctionH5|IsBool||IsBool(var)}}
: Tests if {{FuncArg|var}} is of the bool type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
b = false
IsBool(b) = true
IsBool(1 < 2 && 0 == 1) = true
IsBool(123) = false
</div>

{{ScriptFunctionH5|IsClip||IsClip(var)}}
: Tests if {{FuncArg|var}} is of the clip type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >

c = [[AviSource]](...)
IsClip(c) = true
IsClip("c") = false
</div>

{{ScriptFunctionH5|IsFloat||IsFloat(var)}}
: Tests if {{FuncArg|var}} is of the float type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
f = [[Internal_functions/Numeric_functions|Sqrt]](2)
IsFloat(f) = true
IsFloat(true) = false
IsFloat("42.") = false
IsFloat(2) = true # ''ints are considered to be floats by this function''
IsReallyFloat(2) = false # see below
</div>
: As a workaround for the issue noted above, you may use the following [[User_functions|user function]]:
<div {{BoxWidthIndent|46|3}} >
## return true for floats only
function IsReallyFloat(val v)
{
return (IsInt(v)==false) && IsFloat(v)
}
</div>

{{ScriptFunctionH5|IsInt||IsInt(var)}}
: Tests if {{FuncArg|var}} is of the int type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
IsInt(2) = true
IsInt(2.1) = false
IsInt(true) = false
</div>

{{ScriptFunctionH5|IsString||IsString(var)}}
: Tests if {{FuncArg|var}} is of the string type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
IsString("test") = true
IsString(2.3) = false
IsString([[Internal_functions/Conversion_functions|String]](2.3)) = true
</div>

{{ScriptFunctionH5|Exist||Exist(filename)}}
: Tests if the file specified by {{FuncArg|filename}} exists.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
filename = ...
clp = Exist(filename)
\ ? [[AviSource]](filename)
\ : [[Internal_functions/Control_functions|Assert]](false, "file: " + filename + " does not exist")
</div>

{{ScriptFunctionH5|Defined||Defined(var)}}
: Tests if {{FuncArg|var}} is defined. Can be used inside [[Script_functions]] to test if an optional argument has been given an explicit value.
: More formally, the function returns false if its argument (normally a function argument or variable) has the void ('undefined') type, otherwise it returns true.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
b_arg_supplied = Defined(arg)
myvar = b_arg_supplied ? ... : ...
</div>

{{ScriptFunctionH5|FunctionExists|{{AvsPluscon}}|FunctionExists(name)}}
: Tests if the function or filter name is defined in the script.
: {{FuncArg|name}} can be any string – it does not need to be a [[Script_variables#Variable_Names|legal name]].
: ''Example'' – see [[#Apply|Apply]] below

{{ScriptFunctionH5|InternalFunctionExists|{{AvsPluscon}}|InternalFunctionExists(name)}}
: Tests if the function, filter or [[Clip_properties|property]] name is defined natively within [[AviSynth+]].
:* Unlike [[#FunctionExists|FunctionExists]], returns ''false'' for [[Plugins|external plugins]] and [[User_functions|user-defined functions]].
</div>

{{ScriptFunctionH5|VarExist|{{AvsPluscon}}|VarExist(name)}}
: Tests if the variable exists or not. Note: if variable exists, it returns true regardless of the "defined" state of the variable
</div>

== Control functions ==
<div style="max-width:62em" >
: These facilitate flow of control (loading of scripts, arguments checks, global settings adjustment, etc.).

{{ScriptFunctionH5|Apply||Apply(string ''func_string'' [, arg1 [, arg2 [, ... [, arg''n'']]]] )}}
: Calls the function or filter {{FuncArg|func_string}} with arguments {{FuncArg|arg1}}, {{FuncArg|arg2}}, ..., {{FuncArg|arg''n''}} (as many as supplied).
:* This provides a way to call a function or filter '''by name''', with arguments.
:* <code>Apply("f", x)</code> is equivalent to <code>f(x)</code>
:* <code>Apply("f", x)</code> is equivalent to <code>[[#Eval|Eval]]("f(" + String(x) + ")")</code>
:* Note that the clip argument must be supplied explicitly - the [[Last|special variable ''Last'']] is not used.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## Building an expression dynamically
new_width = 352
new_height = 288

Apply("[[BicubicResize]]", Last, new_width, new_height)
# Note that the clip argument must be supplied - 'Last' is not implicitly assumed

## the same action, using [[#Eval|Eval]]
Eval( "BicubicResize(" + String(new_width) + "," + String(new_height) + ")" )
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it exists (AviSynth 2.6)
function MyFilter(clip C, string s) {
return C.[[Subtitle]]("MyFilter: "+s, align=5)
}
ColorBars
[[Control_structures|try]] {
Apply("MyFilter", Last, "TEST")
} catch (err_msg) {
# (ignore)
}
return Last
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it exists ([[AviSynth+|AVS+]] only)
ColorBars
return [[#FunctionExists|FunctionExists]]("MyFilter")
\ ? Apply("MyFilter", Last, "TEST")
\ : Last
</div>

{{ScriptFunctionH5|Eval||Eval(expression [, string ''name''])}}
: Evaluates an arbitrary {{FuncArg|expression}} and returns the result of that evaluation. '''It works exactly like [[#Import|Import]] below''', except
:* The expression to be evaluated comes from a string instead of a file;
:* The [[#Script_functions|values of]] ''ScriptName'', ''ScriptFile'' and ''ScriptDir'' are not changed;
:* The current working directory ([[wikipedia:Working_directory|CWD]]) is not changed.
: Argument {{FuncArg|name}} will be shown in the error message beside the script name. Both will be followed with the line number in {{FuncArg|expression}} where the error occurred.

: Variables in your calling script are available within {{FuncArg|expression}}; [[Global|global variables]] are not required.
: Note '''Eval''' can return the result of ''any'' valid expression; usually a clip, but also a string, boolean etc.
: You can use '''Eval''' to construct and evaluate expressions dynamically inside your scripts, based on variable input data.
: '''Eval''' is useful as a [[Control_structures|control structure]] for creating multi-line ''block statements'' without requiring [[AviSynth%2B|AviSynth+]].
: '''Eval''' can be used to put aside the need to install external plugins if they are not actually used.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## Building an expression dynamically
## calls [[BicubicResize]](last, 352, 288)
settings = "352, 288"
Eval( "BicubicResize(" + settings + ")" )
</div>

<div {{BoxWidthIndent|56|2}} >
## if...else [[Control_structures|control structure]]
option = true
option
\ ? '''Eval'''("""
[[Levels]](0, 1.2, 255, 20, 235)
[[Spline36Resize]](720, 400)
[[Sharpen]](0.2)
""")
\ : '''Eval'''("""
[[BicubicResize]](720, 400)
[[Sharpen]](0.3)
""")
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it is needed;
## in this example, [[SMDegrain]] only needs to be installed if the option is ''true''.
option = false
option
\ ? '''Eval'''("""
SMDegrain(tr=2, thSAD=250, contrasharp=true, refinemotion=true, lsb=true)
""")
\ : Last
</div>

<div {{BoxWidthIndent|56|2}} >
## accessing script variables
ColorBars
A=[[Subtitle]]("A", align=5)
'''Eval'''("A")
return Last ## returns clip 'A'
</div>

<div {{BoxWidthIndent|56|2}} >
## setting script variables
ColorBars
A=Subtitle("A", align=5)
'''Eval'''("B = A.Invert")
return B ## returns clip 'A' with colors inverted
</div>

<div {{BoxWidthIndent|56|2}} >
## Increment a global variable, based on a local variable
Eval("global my_counter = my_counter + " + [[#String|String]](increment))
</div>

<div {{BoxWidthIndent|56|2}} >
## multi-line example with comment and line continuation
'''Eval'''("""
[[ColorBars]]
[[BicubicResize]](352, 288)
#FlipVertical
Subtitle(
\ "Width = " + [[#String|String]]([[Clip_properties|Width]]) + "\n"
\ + "Height = " + String(Height)
\ , align=7, lsp=0)
""")
</div>

<div {{BoxWidthIndent|56|2}} >
## Empty expression
## results in error: 'Defined(u) == false'
u = Eval("#")
</div>

<div {{BoxWidthIndent|56|2}} >
## Error reporting
ColorBars
A=Subtitle("A", size=Height, align=2)
Eval("""
A
foo("bar") ## ERROR!
""", '''"eval_test_1"''') ## name for error reporting purposes
return Last

''results in the error message:''
Script error: there is no function named "foo"
'''(eval_test_1, line 3)'''
(E:\_test.avs, line 6)
</div>

{{ScriptFunctionH5|Import||Import(filename)}}
{{ScriptFunctionCode|Import||Import(filename [, ...] [, bool utf8])}} {{AvsPluscon}}
: Evaluates the contents of another script and returns the result of that evaluation. '''It works exactly like [[#Eval|Eval]] above''', except
:* The expression to be evaluated comes from a file instead of a string;
:* The [[#Script_functions|values of]] ''ScriptName'', ''ScriptFile'' and ''ScriptDir'' are set to the current (imported) script;
:* The current working directory ([[wikipedia:Working_directory|CWD]]) is [[Internal_functions#SetWorkingDir|set]] to the current (imported) script.
:* {{FuncArg|utf8}} {{AvsPluscon}} if true, assumes filename(s) are [[wikipedia:UTF-8|UTF8]], else (default), assume ANSI.

:[[Script_functions|Functions]], [[Script_variables|variables]] and loaded plugins declared inside the imported script are made available to the parent script. <b>Import</b>'s return value can be assigned to a variable of the parent script; this is most useful when the imported script ends with a clip.

: Typically '''Import''' is used to make library functions available to the parent script, and the return value is not used. However this is simply a convention; it is not enforced by the [[AviSynth Syntax]]. Some indicative uses of '''Import''' include:
:* Storing multiple script-functions, variables and global variables for reuse by scripts (creation of script libraries).
:* Retrieving pre-built streams.
:* Retrieving dynamically configured pre-built streams (the core idea is that the importing script declares some global variables which the imported script uses to configure the stream that will return).
:'''Note 1''': Since the contents of the imported script are evaluated at the point of invocation, it is possible by enclosing the '''Import''' call in a nested scope (for example inside a function) to make available to the importing script the functions and globals of the imported script ''without'' its script-level variables.
:'''Note 2''': Any script with the [[AVSI]] extension in the AviSynth Plugins folder is automatically imported. This is useful for making script functions available to any new script you create without having to copy and paste.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
# ''B.avsi''
A.Invert
</div><div {{BoxWidthIndent|56|2}} >
ColorBars
A=Subtitle("A", align=5) ## create clip 'A'
Import("B.avsi")
return Last ## returns clip 'A' with colors inverted
</div>

<div {{BoxWidthIndent|56|2}} >
## here we do not care about the return value (''mylib.avsi'' contains only functions)
Import("mylib.avsi")
...
## ''mysources.avsi'' loads predetermined file names from a folder into globals
okflag = Import("mysources.avsi")
source = okflag ? global1 + global2 + global3 : [[BlankClip]]()
</div>

{{ScriptFunctionH5|Select||Select(index, item0 [, item1 [, ...[, itemn]]])}}
: Returns the item selected by the {{FuncArg|index}} argument, which must be of int type (0 returns {{FuncArg|item0}}, 1 returns {{FuncArg|item1}}, ..., etc). Items can be any script [[Script_variables|variable]] or expression of any type and can even be mixed.

:If {{FuncArg|index}} is out of range, an error is raised.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# select a clip-brush from a set of presets
idx = 2
brush = Select(idx, [[AviSource]]("round.avi"),
\ rectangle, diagonal, diagonal.[[FlipHorizontal]])
</div>

Note - all branches are evaluated:
<div {{BoxWidthIndent|56|2}} >
index=1
Select(index, "zero", "one", "two",
\ Assert(false, "Select evaluates all branches"))
## NOTE this code does not run - it throws [[#Assert|Assert]] error
## because Select evaluates all branches
</div>

If this is not desired, use the [[Ternary_operator|conditional execution]] operator:
<div {{BoxWidthIndent|56|2}} >
index=1
x = (index==0) ? "zero"
\ : (index==1) ? "one"
\ : (index==2) ? "two"
\ : Assert(false, "index out of range")
</div>

{{ScriptFunctionH5|Default||Default(x, d)}}
: Returns {{FuncArg|x}} if '''Defined'''(x) is true, {{FuncArg|d}} otherwise. {{FuncArg|x}} must either be a function's argument or an already declared script variable (ie a variable which has been assigned a value) else an error will occur.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
function myfunc(clip c, ..., int "strength") {
...
strength = Default(strength, 4) # if not supplied make it 4
...
}
</div>

{{ScriptFunctionH5|Assert||Assert(condition [, err_msg])}}
: Does nothing if {{FuncArg|condition}} is true; throws an error, immediately terminating script execution, if {{FuncArg|condition}} is false. In the later case {{FuncArg|err_msg}}, if supplied, is presented to the user through a dialog box; else the standard message "Assert: assertion failed" shows up.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
function myfunc(clip c, ..., int "strength") {
...
strength = Default(strength, 4) # if not supplied make it 4
Assert(strength > 0, "'strength' must be positive")
...
}
</div>

{{ScriptFunctionH5|NOP||NOP()}}
: This is a no-operation function provided mainly for conditional execution with non-return value items such as [[Import]], when no "else" condition is desired. That is, use it whenever the [[AviSynth Syntax]] requires an operation (such as with the ?: [[Operators#For_Booleans|operator]]) but your script does not need one.
: Return value: 0 (int type).
''Examples:''
<div {{BoxWidthIndent|56|2}} >
preset = want_presets ? [[AviSource]]("c:\presets\any.avi") : NOP
...
loadlib ? [[Import]]("my_useful_functions.avs") : NOP
</div>

{{ScriptFunctionH5|Undefined|v2.60|Undefined()}}
: Returns the undefined state.
: It's the state for which '''Defined'''() returns false.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
x = Undefined()
Defined(x) # == false
</div>
</div>

== Global Options ==
<div style="max-width:62em" >
{{ScriptFunctionH5|SetMemoryMax||SetMemoryMax(amount)}}
: Sets the maximum memory that AviSynth uses (in MB) to the value of {{FuncArg|amount}}. Setting to zero just returns the current Memory Max value. In the 2.5 series the default Memory Max value is 25% of the free physical memory, with a minimum of 16MB.
: The default Memory Max is also limited to 512MB.
: {{AvsPluscon}}In Avisynth+ this limit for default Memory Max is 1024MB for 32 bits and 4096MB on the x64 version
: DefaultMemoryMax = minimum(physical_memory / 4, secondary_memory_max_limit)
: for classic Avisynth see the table below
:{|class="wikitable" 
|-
| Free memory
| <64
| 128
| 256
| 512
| 1024
| 2048
| 3072
|-
| Default Max
| 16
| 32
| 64
| 192
| 448
| 512
| 512
|}
: In some versions there is a default setting of 5MB, which is quite low. If you encounter problems (e.g. low speed) try to set this values to at least 32MB. Too high values can result in crashes because of 2GB address space limit.
: Return value: Actual MemoryMax value set.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
SetMemoryMax(128)
</div>

:{{AvsPluscon}}{{FuncDef|SetMemoryMax(int, int “type”, int “index”)}}
:With additional arguments for devices such as GPUs. Memory usage is managed individually for devices such as GPUs.
<br>
::{{Par2||int|}}
:::Device (including CPU) memory limit (MB)
::{{Par2|type|int|}}
:::Device type. The following values are available:
::::DEV_TYPE_CPU: CPU (default)
::::DEV_TYPE_CUDA: GPU
::{{Par2|index|int|}}
:::Device number. Same as onCUDA device_index. Only 0 for DEV_TYPE_CPU.
:::Default value: 0

<div style="max-width:62em" >
{{ScriptFunctionH5|SetCacheMode||SetCacheMode(mode)}}
:{{AvsPluscon}}Fine tunes the internal frame caching strategy in AviSynth+.
: Available values:
::* 0 or CACHE_FAST_START start up time and size balanced mode (default)
::* 1 or CACHE_OPTIMAL_SIZE slow start up but optimal speed and cache size
::
* since Avisynth+ 3.6.1

<div style="max-width:62em" >
{{ScriptFunctionH5|SetMaxCPU||SetMaxCPU([string feature1, string feature2, ...])}}
: {{AvsPluscon}}Limits the CPU capabilities which AviSynth reports to its core and external plugins through GetCPUFlags.
: Available values:
::* "" or "none" for zero SIMD support, no processor flags are reported
::* "mmx", "sse", "sse2", "sse3", "ssse3", "sse4" or "sse4.1", "sse4.2", "avx, "avx2"
::
::Parameters are case insensitive.
::Note: "avx2" triggers FMA3 flag as well.
::
::*Processor options w/o any modifier will limit the CPU flag report to at most the processor level.
::*When "feature" is ended by '+', relevant processor feature flag will be switched on
::*When "feature" is ended by '-', relevant processor feature flag will be removed.
::Multiple options can be put in a comma separated list. They will evaluate in that order.
''Examples:''
<div {{BoxWidthIndent|60|2}} >
SetMaxCPU("SSE2") #reports at most SSE2 processor (even if AVX2 is available)
SetMaxCPU("avx,sse4.1-") #limits to avx2 but explicitely removes reporting sse4.1 support
SetMaxCPU("none,avx2+") #limits to plain C, then switches on AVX2-only support
</div>
* since Avisynth+ 3.6

{{ScriptFunctionH5|SetWorkingDir||SetWorkingDir(path)}}
: Sets the default directory for AviSynth to the {{FuncArg|path}} argument.
: This is primarily for easy loading of source clips, [[Import|importing]] scripts, etc. It does not affect plugins' autoloading.
: Return value is 0 if successful, -1 otherwise.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
SetWorkingDir("c:\my_presets")
[[AviSource]]("border_mask.avi") # this loads c:\my_presets\border_mask.avi
</div>

{{ScriptFunctionH5|SetPlanarLegacyAlignment||SetPlanarLegacyAlignment(mode)}}
: Set alignment mode for [[planar]] frames. {{FuncArg|mode}} can either be true or false.
: Some older [[External_plugins|plugins]] illegally assume the layout of video frames in memory. This special filter forces the memory layout of planar frames to be compatible with prior versions of AviSynth. The filter works on the [[The_script_execution_model/Evaluation_of_runtime_scripts|GetFrame]]() call stack, so it effects filters '''before''' it in the script.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Example : Using an older version of Mpeg2Source() (1.10 or older):

LoadPlugin("...\Mpeg2Decode.dll")
Mpeg2Source("test.d2v") # A plugin that illegally assumes the layout of memory
SetPlanarLegacyAlignment(true) # Set legacy memory alignment for prior statements
[[Convert|ConvertToYUY2]]() # Statements through to the end of the script have
... # advanced memory alignment.
</div>

{{ScriptFunctionH5|OPT_AllowFloatAudio||global OPT_AllowFloatAudio = true ## default false}}
: [[Float]] audio is converted to 16 bit when [[Frameserver|frameserving]] through [[ACM]], unless [[Internal_functions#OPT_AllowFloatAudio|OPT_AllowFloatAudio]] is set to true (this option enables WAVE_FORMAT_IEEE_FLOAT audio output<sup>[http://forum.doom9.org/showthread.php?t=109608]</sup>). In that case the audio is kept as it is. When accessing AviSynth directly (like MeGUI, BeHappy or ffmpeg do for example), there is no automatic conversion.

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

{{ScriptFunctionH5|OPT_UseWaveExtensible||global OPT_UseWaveExtensible = true ## default false}}
: This option enables WAVE_FORMAT_EXTENSIBLE audio output. The default is WAVE_FORMAT_EX.
: '''Note:''' The default DirectShow component for .AVS files, "AVI/WAV File Source", does not correctly implement WAVE_FORMAT_EXTENSIBLE processing, so many application may not be able to detect the audio track. There are third party DirectShow readers that do work correctly. Intermediate work files written using the AVIFile interface for later DirectShow processing will work correctly if they use the DirectShow "File Source (async)" component or equivalent.

{{ScriptFunctionH5|OPT_dwChannelMask|v2.60|global OPT_dwChannelMask(int v)}}
: This option enables you to set ChannelMask. It overrides WAVEFORMATEXTENSIBLE.dwChannelMask<sup>[[http://wiki.multimedia.cx/index.php?title=WAVEFORMATEXTENSIBLE]</sup> which is set according to this table
<div {{BoxWidthIndent|56|2}} >
0x00004, // 1 -- -- Cf
0x00003, // 2 Lf Rf
0x00007, // 3 Lf Rf Cf
0x00033, // 4 Lf Rf -- -- Lr Rr
0x00037, // 5 Lf Rf Cf -- Lr Rr
0x0003F, // 5.1 Lf Rf Cf Sw Lr Rr
0x0013F, // 6.1 Lf Rf Cf Sw Lr Rr -- -- Cr
0x0063F, // 7.1 Lf Rf Cf Sw Lr Rr -- -- -- Ls Rs
</div>

{{ScriptFunctionH5|OPT_AVIPadScanlines|v2.60|global OPT_AVIPadScanlines = true ## default false}}
: This option enables DWORD aligned planar padding. Default is packed aligned planar padding. See [[AVIFile output emulation|memory alignment used in the AVIFile output emulation]].<br>

{{ScriptFunctionH5|OPT_VDubPlanarHack|v2.60|global OPT_VDubPlanarHack = true ## default false}}
: This option enables flipped YV24 and YV16 chroma planes. This is an hack for early versions of Virtualdub with YV24/YV16 support. <br>

{{ScriptFunctionH5|OPT_Enable_V210|{{AvsPluscon}}|global OPT_Enable_V210 = true ## default false}}
: For 10bit YUV422, [[Frameserver|Frameserve]] interleaved V210 instead of planar P210. (VfW)
<div {{BoxWidthIndent|56|2}} >
{{BoldColor|black|100|§}} ''VfW'' here means [[wikipedia:Video_for_Windows|Video For Windows]] clients such as VirtualDub are affected, but not other clients such as ffmpeg.
</div>

{{ScriptFunctionH5|OPT_Enable_Y3_10_10|{{AvsPluscon}}|global OPT_Enable_Y3_10_10 = true ## default false}}
: For 10bit YUV422, set the [[FourCC]] to Y3[10][10] ('Y', '3', 10, 10) instead of P210 ('P', '2', '1', '0'). (VfW) <br>

{{ScriptFunctionH5|OPT_Enable_Y3_10_16|{{AvsPluscon}}|global OPT_Enable_Y3_10_16 = true ## default false}}
: For 16bit YUV422, use Y3[10][16] instead of P216 (VfW)<br>

{{ScriptFunctionH5|OPT_Enable_b64a|{{AvsPluscon}}|global OPT_Enable_b64a = true ## default false}}
: Use b64a instead of BRA[64] (VfW)
: works for avs+ version above r2636<br>

{{ScriptFunctionH5|OPT_Enable_PlanarToPackedRGB|{{AvsPluscon}}|global OPT_Enable_PlanarToPackedRGB = true ## default false}}
: Convert Planar RGB to packed RGB (VfW)
: Planar RGB 8, 10, 12, 14 and 16 bits are reported as G3[0][8], G3[0][10], G3[0][12], G3[0][14] and G3[0][16]
: Planar RGBA 8, 10, 12, 14 and 16 bits are reported as G4[0][8], G4[0][10], G4[0][12], G4[0][14] and G4[0][16]
: When these [[FourCC]] codes are not handled through VfW, use OPT_Enable_PlanarToPackedRGB=true.
: Avisynth+ will convert the clip from planar to RGB64 (packed 16bit RGB) and will negotiate this format instead<br>
</div>

== Conversion functions ==
<div style="max-width:62em" >
: These convert between different types.

{{ScriptFunctionH5|Value||Value(string)}}
: Converts a decimal string to its associated numeric value.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Value ("-2.7") = -2.7
</div>

{{ScriptFunctionH5|HexValue||HexValue(string)}}
{{ScriptFunctionCode|HexValue||HexValue(string [, int pos])}} {{AvsPluscon}}
: Converts a hexadecimal string to its associated numeric value.
:* {{FuncArg|pos}} sets the starting point of the numeric parser. All characters to the left of {{FuncArg|pos}} are ignored. Default is 1 (start of string).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
HexValue ("FF00") = 65280
</div>

{{ScriptFunctionH5|Hex|v2.60|Hex(int)}}
{{ScriptFunctionCode|Hex||Hex(int [, int width])}} {{AvsPluscon}}
: Converts a numerical value to its hexadecimal value. See [[Colors]] for more information on specifying colors.
:* {{FuncArg|width}} sets the minimum width of the returned string.
::Resulting string will be left-padded with zeroes as needed. Allowed range is 0..8; default is 0.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Hex (10824234) = "A52A2A"
Hex (15 width=2) = "0F"
</div>

{{ScriptFunctionH5|String||String(var [, string format_string])}}
: Converts a variable to a string. ''String'' arguments are passed along unchanged; ''bools'' are converted to "true" or "false"; numbers are formatted as described below; other [[Script_variables#Variable_Types|variable types]] (''clip'', ''val'') are converted to the empty string.
:The syntax of {{FuncArg|format_string}} is as follows:
::<code>'''%'''[flags][width][.precision]'''f'''</code>    <i>the leading </i>'<tt>%</tt>'<i> and trailing </i>'<tt>f</tt>'<i> are required.</i>
:The parts of {{FuncArg|format_string}} are:
:; ''flags''
::{| class=wikitable
|style="text-align:center"|<tt>-</tt>
|left align (right align by default)
|-
|style="text-align:center"|<tt>+</tt>
|always print the +/- sign (show only '<tt>+</tt>' by default)
|-
|style="text-align:center"|<tt>0</tt>
|pad (see ''width'') with leading zeroes (pad with spaces by default) 
|-
|style="text-align:center"| '<tt> </tt>' 
|print a blank instead of a '<tt>+</tt>'
|-
|style="text-align:center"|<tt>#</tt>
|always print the decimal point (dropped by default if there are no decimal digits) 
|}
:; ''width''
:: the minimum width (the string is never truncated if it is wider than ''width'')
:; ''precision''
:: the number of decimal digits
: You can also put arbitrary text around {{FuncArg|format_string}}, similar to the C-language [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] function.

''Examples:''
<div {{BoxWidthIndent|62|2}} >
Subtitle( String(1.23) ) # '1.230000' (six decimals by default for floats)
Subtitle( String(123) ) # '123' (no decimals by default for ints)

Subtitle( String(1.23, "%0.2f" )) # '1.23'
Subtitle( String(1.23, "%0.1f" )) # '1.2'
Subtitle( String(1.23, "%5.1f") ) # ' 1.2' (padded to 5 characters wide)
Subtitle( String(1.23, "%1.3f") ) # '1.230' (3 decimals; add trailing zeroes)

Subtitle( String(123, "%0.0f") ) # '123' (no decimals for precision=0)
Subtitle( String(123, "%''#''0.0f") ) # '123.' ('#' flag: always show decimal point)
Subtitle( String(123, "%0.2f") ) # '123.00' (2 decimals: add trailing zeroes)
Subtitle( String(123, "%5.0f") ) # ' 123' (padded to 5 characters wide using ' ')
Subtitle( String(123, "%05.0f") ) # '00123' (padded to 5 characters wide using '0')

Subtitle( String(PI, "PI=%0.0f") ) # 'PI=3' (text around format_string)
Subtitle( String(PI, "PI=%''#''0.0f") ) # 'PI=3.' ('#' flag: always show decimal point)
Subtitle( String(PI, "PI=%2.0f") ) # 'PI= 3'
Subtitle( String(PI, "PI=%3.2f") ) # 'PI=3.14'
Subtitle( String(PI, "PI=%0.5f") ) # 'PI=3.14159'
Subtitle( String(PI, "PI=%6.3f") ) # 'PI= 3.142'

Subtitle( String(32, "%0.0f") ) # '32'
Subtitle( String(32, "%3.0f") ) # ' 32'
Subtitle( String(32, "%8.0f") ) # ' 32'

## arbitrary text around format_string:
Subtitle( String(Last.Height, "Clip height is %0.0f") ) # 'Clip height is 480'
## same output as above but using string concatenation:
Subtitle( "Clip height is " + String(Last.Height) )
</div>
</div>

== Numeric functions ==
<div style="max-width:62em" >
: These provide common mathematical operations on numeric variables.

{{ScriptFunctionH5|Max||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:''
<div {{BoxWidthIndent|56|2}} >
Max (1, 2) = 2
Max (5, 3.0, 2) = 5.0
</div>

{{ScriptFunctionH5|Min||Min(float, float [, ...])}}
: Returns the minimum value of a set of numbers.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Min (1, 2) = 1
Min (5, 3.0, 2) = 2.0
</div>

{{ScriptFunctionH5|MulDiv||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:''
<div {{BoxWidthIndent|56|2}} >
MulDiv (1, 1, 2) = 1
MulDiv (2, 3, 2) = 3
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Floor(1.2) = 1
Floor(1.6) = 1
Floor(-1.2) = -2
Floor(-1.6) = -2
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Ceil(1.2) = 2
Ceil(1.6) = 2
Ceil(-1.2) = -1
Ceil(-1.6) = -1
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Round(1.2) = 1
Round(1.6) = 2
Round(-1.2) = -1
Round(-1.6) = -2
</div>

{{ScriptFunctionH5|Int||Int(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round towards zero).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Int(1.2) = 1
Int(1.6) = 1
Int(-1.2) = -1
Int(-1.6) = -1
</div>

{{ScriptFunctionH5|Float||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:''
<div {{BoxWidthIndent|56|2}} >
Float(4) = 4.0
Float(4) / 3 = 1.333 (while 4 / 3 = 1 , due to integer division)
Float(123456789) = 123456792.0 (error = -3, 0.000002%)
Float(1234567890) = 1234567936.0 (error = -46, 0.000004%)
</div>

{{ScriptFunctionH5|Fmod|v2.60|Fmod(float, float)}}
: Returns the modulo of the argument. Output is float.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

{{ScriptFunctionH5|Pi||Pi()}}
: Returns the value of the {{BoldColor|black|110|π}} constant (the ratio of a circle's circumference to its diameter).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
d = Pi() # d == 3.141592653
</div>

{{ScriptFunctionH5|Exp||Exp(float)}}
: Returns the natural (base-e) exponent of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Exp(1) = 2.7182818
Exp(0) = 1.0
</div>

{{ScriptFunctionH5|Log||Log(float)}}
: Returns the natural (base-e) logarithm of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Log(1) = 0.0
Log(10) = 2.30259
Log(Exp(1)) = 1.0
</div>

{{ScriptFunctionH5|Log10|v2.60|Log10(float)}}
: Returns the common logarithm of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Log10(1.0) = 0
Log10(10.0) = 1.0
Log10(2.0) = 0.3010299957
</div>

{{ScriptFunctionH5|Pow||Pow(float base, float power)}}
: Returns {{FuncArg|base}} raised to a {{FuncArg|power}}.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Pow(2, 3) = 8
Pow(3, 2) = 9
Pow(3.45, 1.75) = 8.7334
</div>

{{ScriptFunctionH5|Sqrt||Sqrt(float)}}
: Returns the square root of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sqrt(1) = 1.0
Sqrt(2) = 1.4142
</div>

{{ScriptFunctionH5|Abs||Abs(float or int)}}
: Returns the absolute value of its argument (returns float for float, integer for integer).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Abs(-3.8) = 3.8
Abs(-4) = 4
</div>

{{ScriptFunctionH5|Sign||Sign(float)}}
: Returns the sign of the value passed as argument (1, 0 or -1).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sign(-3.5) = -1
Sign(3.5) = 1
Sign(0) = 0
</div>

{{ScriptFunctionH5|Frac||Frac(float)}}
: Returns the fractional portion of the value provided.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Frac(3.7) = 0.7
Frac(-1.8) = -0.8
</div>

{{ScriptFunctionH5|Rand||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 {{FuncArg|scale}}=true only if [[#Abs|Abs]]({{FuncArg|max}}) > 32768, false otherwise).
:;scale
::When true, ''scales'' the internal random number generator value to the maximum value, while ''modulus mode'' ({{FuncArg|scale}}=false) uses the remainder from an integer divide of the random generator value by the maximum. Modulus mode is recommended for smaller maximums.
:;seed
::When true, seeds the random number generator with the current time. {{FuncArg|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|'''Select''']] function for random clips.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Select(Rand(5), clip1, clip2, clip3, clip4, clip5)
</div>

{{ScriptFunctionH5|Spline||Spline(float X, x1, y1, x2, y2, .... [, bool cubic])}}
: Interpolates the Y value at point X using the control points {{FuncArg|x1}}/{{FuncArg|y1}}, ... There have to be at least 2 x/y-pairs. The interpolation can be {{FuncArg|cubic}} (the result is a spline) or linear (the result is a polygon). Default is cubic.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Spline(5, 0, 0, 10, 10, 20, 0, false) = 5
Spline(5, 0, 0, 10, 10, 20, 0, true) = 7
</div>

===== Continued Numerator, Denominator =====
{{ScriptFunctionCode|ContinuedNumerator|v2.60|ContinuedNumerator(float, int limit)}}
{{ScriptFunctionCode|ContinuedNumerator|v2.60|ContinuedNumerator(int, int, int limit)}}
{{ScriptFunctionCode|ContinuedDenominator|v2.60|ContinuedDenominator(float, int limit)}}
{{ScriptFunctionCode|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/{{FuncArg|limit}}. More information can be found on [http://en.wikipedia.org/wiki/Continued_fraction wikipedia].
: If {{FuncArg|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 {{FuncArg|limit}} is not specified then the normalized original values will be returned, i.e. reduced by the ''GCD'' (greatest common divisor).

''Examples:''
<div {{BoxWidthIndent|56|2}} >

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
</div>
</div>

== Trigonometry functions ==
<div style="max-width:62em" >
: relationships involving lengths and angles of triangles.

{{ScriptFunctionH5|Sin||Sin(float)}}
: Returns the sine of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sin(Pi()/4) = 0.707
Sin(Pi()/2) = 1.0
</div>

{{ScriptFunctionH5|Cos||Cos(float)}}
: Returns the cosine of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Cos(Pi()/4) = 0.707
Cos(Pi()/2) = 0.0
</div>

{{ScriptFunctionH5|Tan|v2.60|Tan(float)}}
: Returns the tangent of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Tan(Pi/4) = 1.0
Tan(Pi/2) = not defined
</div>
: 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.

{{ScriptFunctionH5|Asin|v2.60|Asin(float)}}
: Returns the inverse of the sine of the argument (output is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Asin(0.707) = 0.7852471634 (~ Pi/4)
Asin(1.0) = 1.570796327 (~ Pi/2)
</div>

{{ScriptFunctionH5|Acos|v2.60|Acos(float)}}
: Returns the inverse of the cosine of the argument (output is in radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Acos(0.707) = 0.7852471634 (~ Pi/4)
Acos(0.0) = 1.570796327 (~ Pi/2)
</div>

{{ScriptFunctionH5|Atan|v2.60|Atan(float)}}
: Returns the inverse of the tangent of the argument (output is in radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Atan(0.707) = 0.6154085176
Atan(1.0) = 0.7853981634 (~ Pi/4)
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Sinh(2.0) = 3.626860408
</div>

{{ScriptFunctionH5|Cosh|v2.60|Cosh(float)}}
: Returns the hyperbolic cosine of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Cosh(2.0) = 3.762195691
</div>

{{ScriptFunctionH5|Tanh|v2.60|Tanh(float)}}
: Returns the hyperbolic tangent of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Tanh(2.0) = 0.9640275801
</div>
</div>

== Bit functions ==
<div style="max-width:62em" >
: The functions are ''bitwise operators''. They manipulate individual bits within integer variables. 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.

{{ScriptFunctionH5|BitAnd|v2.60|BitAnd(int, int)}}
: Returns the bitwise AND (sets bit to 1 if both bits are 1 and sets bit to 0 otherwise).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
BitAnd(5, 6) = 4 # since 5 = 101, 6 = 110, and 101&110 = 100
</div>

{{ScriptFunctionH5|BitNot|v2.60|BitNot(int)}}
: Returns the bit-inversion (sets bit to 1 if bit is 0 and vice-versa).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
BitNOT(5) = -6
# since 5 = 101,
# and ~101 = 1111 1111 1111 1111 1111 1111 1111 1010 = -6
</div>
: 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

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

===== Bit shift left =====
{{ScriptFunctionCode|BitLShift|v2.60|BitLShift(int, int)}}
{{ScriptFunctionCode|BitShl|v2.60|BitShl(int, int)}}
{{ScriptFunctionCode|BitSal|v2.60|BitSal(int, int)}}
: Shift the bits of a number to the left.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Shifts the bits of the number 5 two bits to the left:
BitLShift(5, 2) = 20 (since 101 << 2 = 10100)
</div>

===== Bit shift right =====
{{ScriptFunctionCode|BitRShiftA|v2.60|BitRShiftA(int, int)}}
{{ScriptFunctionCode|BitRShiftS|v2.60|BitRShiftS(int, int)}}
{{ScriptFunctionCode|BitSar|v2.60|BitSar(int, int)}}
: Shift the bits of an integer to the right. (Arithmetic, Sign bit fill, Right Shift)
''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

===== Bit shift right, unsigned =====
{{ScriptFunctionCode|BitRShiftL|v2.60|BitRShiftL(int, int)}}
{{ScriptFunctionCode|BitRShiftU|v2.60|BitRShiftU(int, int)}}
{{ScriptFunctionCode|BitShr|v2.60|BitShr(int, int)}}
: Shift the bits of an unsigned integer to the right. (Logical, zero fill, Right Shift)

''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>
: 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

===== Bit rotate left =====
{{ScriptFunctionCode|BitLRotate|v2.60|BitLRotate(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
Rotates the bits of the number -2147483642 one bit to the left:
BitLRotate(-2147483642, 1) = 13
# (since 10000000000000000000000000000110 ROL 1
# = 00000000000000000000000000001101)
</div>

===== Bit rotate right =====
{{ScriptFunctionCode|BitRRotate|v2.60|BitRRotateL(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
Rotates the bits of the number 13 one bit to the right:
BitRRotate(13, 1) = -2147483642
# (since 00000000000000000000000000001101 ROR 1
# = 10000000000000000000000000000110)
</div>

===== Bit test =====
{{ScriptFunctionCode|BitTest|v2.60|BitTest(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|BitSetCount||BitSetCount(int [, int...])}} {{AvsPluscon}}
: Returns the total number of set bits in all supplied integer arguments.

===== Bit clear =====
{{ScriptFunctionCode|BitClear|v2.60|BitClear(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

===== Bit change =====
{{ScriptFunctionCode|BitChange|v2.60|BitChange(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>
</div>

== Runtime functions ==
<div style="max-width:62em" >
: These are internal functions which are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ConditionalFilter]], [[ScriptClip]], [[FrameEvaluate]]) to return information for a frame.

===== Average =====
{{ScriptFunctionCode|AverageLuma||AverageLuma(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageChromaU||AverageChromaU(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageChromaV||AverageChromaV(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageB||AverageB(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|AverageG||AverageG(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|AverageR||AverageR(clip [, int offset = 0])}} {{AvsPluscon}}
: This group of functions return a float value with the average pixel value of a plane (Luma, U-chroma and V-chroma, respectively). They require an [[ISSE]] capable cpu. In v2.61 an {{FuncArg|offset}} argument is added which enables you to access other frames than the current one.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip(Last, """
threshold = 55
luma = AverageLuma ## gives the average luma of the current frame
#luma = AverageLuma(1) ## gives the average luma of the next frame
luma < threshold
\ ? Levels(0, 1.0+0.5*(threshold-luma)/threshold, 255, 0, 255)
\ : last
Subtitle("luma=" + String(luma), align=2)
""")
</div>

===== Difference =====
{{ScriptFunctionCode|LumaDifference||LumaDifference(clip1, clip2)}}
{{ScriptFunctionCode|ChromaUDifference||ChromaUDifference(clip1, clip2)}}
{{ScriptFunctionCode|ChromaVDifference||ChromaVDifference(clip1, clip2)}}
{{ScriptFunctionCode|RGBDifference||RGBDifference(clip1, clip2)}}
{{ScriptFunctionCode|BDifference||BDifference(clip1, clip2)}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifference||GDifference(clip1, clip2)}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifference||RDifference(clip1, clip2)}} {{AvsPluscon}}
: This group of functions return a float value between 0 and 255 of the absolute difference between two planes from two different clips – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively. They require an [[ISSE]] capable cpu.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
ovl = [[Overlay]](last, mov_star, x=some_xvalue, y=some_yvalue, mask=mov_mask)
ldif = LumaDifference(ovl) # implicit last for clip1
udif = ChromaUDifference([[Tweak]](hue=24), ovl)
...
</div>

===== Difference from previous =====
{{ScriptFunctionCode|YDifferenceFromPrevious||YDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|UDifferenceFromPrevious||UDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|VDifferenceFromPrevious||VDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|RGBDifferenceFromPrevious||RGBDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|BDifferenceFromPrevious||BDifferenceFromPrevious(clip)}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifferenceFromPrevious||GDifferenceFromPrevious(clip)}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifferenceFromPrevious||RDifferenceFromPrevious(clip)}} {{AvsPluscon}}
: This group of functions return the absolute difference of pixel value between the current and previous frame of {{FuncArg|clip}} – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
scene_change = (YDifferenceFromPrevious) > threshold)
scene_change ? some_filter(...) : another_filter(...)
</div>

===== Difference to next =====
{{ScriptFunctionCode|YDifferenceToNext||YDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|UDifferenceToNext||UDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|VDifferenceToNext||VDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|RGBDifferenceToNext||RGBDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|BDifferenceToNext||BDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifferenceToNext||GDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifferenceToNext||RDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
: This group of functions return the absolute difference of pixel value between the current and next frame of {{FuncArg|clip}} – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively. In v2.61 an {{FuncArg|offset}} argument is added, which enables you to access the difference between the RGB, luma or chroma plane of the current frame and of ''any'' other frame. Note that for example clip.'''RGBDifferenceToNext'''(-1) = clip.'''RGBDifferenceToPrevious''', and clip.'''RGBDifferenceToNext'''(0) = 0.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# both th1, th2 are positive thresholds; th1 is larger enough than th2
scene_change = (YDifferenceFromPrevious > th1) && (YDifferenceToNext < th2)
scene_change ? some_filter(...) : another_filter(...)
</div>

===== Color plane median, min, max, range =====
{{ScriptFunctionCode|YPlaneMedian||YPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMedian||UPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMedian||VPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMedian||BPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMedian||GPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|RPlaneMedian||RPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMin||YPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMin||UPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMin||VPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMin||BPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMin||GPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}{{ScriptFunctionCode|RPlaneMin||RPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMax||YPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMax||UPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMax||VPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMax||BPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMax||GPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}{{ScriptFunctionCode|RPlaneMax||RPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMinMaxDifference||YPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMinMaxDifference||UPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMinMaxDifference||VPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMinMaxDifference||BPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMinMaxDifference||GPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|RPlaneMinMaxDifference||RPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}

: This group of functions return statistics about the distribution of pixel values on a plane (Luma, U-chroma and V-chroma, respectively). The statistics are, in order of presentation: maximum, minimum, median and range (maximum - minimum difference).
: {{FuncArg|threshold}} is a percentage, stating how many percent of the pixels are allowed above or below minimum. The threshold is optional and defaults to 0. In v2.61 an {{FuncArg|offset}} argument is added, which enables you to access the statistics of other frames than the current one.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# median and average are close only on even distributions;
# this can be a useful diagnostic
have_intense_brights = YPlaneMedian() - AverageLuma() < threshold
...
# a simple per-frame normalizer to [16..235], CCIR, range
[[Levels]](YPlaneMin(), 1.0, YPlaneMax(), 16, 235)
</div>
</div>

== Functions for frame properties ==
<div style="max-width:62em" >
: Core and concept ported from VapourSynth.
: Frame properties are per-frame data. Source or other filters can store useful data into frame properties such as information on colorimetry.
: Imagine them as an array of zero or more elements of PropertyName=Value
: Reading them is possible only by runtime functions.
: <br>
: Note:
: At the moment (v3.6.2test7) Avisynth+ provides only the necessary framework for handling (set, read, clear, pass) such properties. None of its internal functions (such as color space converters) set or work upon frame property values.
: There are already filters (like avsresize) and source plugins that are already using frame properties. Avisynth+ core will rely on frame in the future as well.
: <br>
: Developer info:
: On filter level the set of frame properties should be copied from a previous (or specific) input frame. When filter is using env->MakeWritable in its GetFrame method this happens automatically.
: But a simple env->NewVideoFrame means a dead-end for frame property passing mechanism. So filter must either use env->NewVideoFrameP which has an additional parameter: a source frame of the frame properties.
: Or frame properties have to be copied later, programatically by the copyFrameProps ScriptEnvironment function.
: For compatibility reasons NewVideoFrameP should be called adaptively instead of the traditional NewVideoFrame: usable after detecting Avisynth interface version 8 (NewVideoFrameP was introduced in v8).
: What happens if this copy is not done properly? Then the filter is a dead-end for frame properties since NewVideoFrame constructs new frame with no frame properties. All old filters will behave like this.<br>
: <br>
: Frame property getter functions are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ScriptClip]]).<br>
: Frame property setters can be called both at script level and in runtime. When a property is set on script level it will be constant along the lifetime of the whole clip, unless it is changed in runtime, inside ScriptClip.
: Though using property setter functions are allowed in [[FrameEvaluate]] but since it does not return an altered frame, writing a frame property there has zero effect.<br>
: <br>
:* frame properties are stored as key-value pairs
:** Key is an alphanumeric identifier.
:** Values can be of single value or array of type
:*** 64 bit integer (32 bit integer when converted to AVSValue inside Avisynth+, AVSValue limitation)
:*** 64 bit double (32 bit float when converted to AVSValue inside Avisynth+, AVSValue limitation)
:*** string (or byte data) with given length. Strings are null terminated.
:*** frame reference (PVideoFrame)
:*** clip reference (PClip)
:* property setting has 3 modes: 0-replace 1-append 2-touch (see AVSPropAppendMode in avisynth.h)::
:** 0 - single value for that key is replaced
:** 1 - property is appended (make arrays by calling with mode=1 consecutively)
:** 2 - touch

==== Reserved frame property names ====
: There are quasi-standard frame property names which are used widespread.
: As frame properties came from VapourSynth (see "Reserved Frame Properties" at http://www.vapoursynth.com/doc/apireference.html), it is convenient that Avisynth plugins use the same properties and values.
: Keys starting with _ have strictly defined meanings specified below. It is acceptable to not set any of these keys if they are unknown. It is also a fatal error to set them to a value not specified below.
{{ScriptFunctionH5|_ChromaLocation||int _ChromaLocation}}
: Chroma sample position in YUV formats.
:: 0=left, 1=center, 2=topleft, 3=top, 4=bottomleft, 5=bottom.

{{ScriptFunctionH5|_ColorRange||int _ColorRange}}
: Full or limited range (PC/TV range). Primarily used with YUV formats.
:: 0=full range, 1=limited range.

{{ScriptFunctionH5|_Primaries||int _Primaries}}
: Color primaries as specified in ITU-T H.265 Table E.3.

{{ScriptFunctionH5|_Matrix||int _Matrix}}
: Matrix coefficients as specified in ITU-T H.265 Table E.5.

{{ScriptFunctionH5|_Transfer||int _Transfer}}
: Transfer characteristics as specified in ITU-T H.265 Table E.4.

{{ScriptFunctionH5|_FieldBased||int _FieldBased}}
: If the frame is composed of two independent fields (interlaced).
:: 0=frame based (progressive), 1=bottom field first, 2=top field first

{{ScriptFunctionH5|_AbsoluteTime||float _AbsoluteTime}}
: The frame’s absolute timestamp in seconds if reported by the source filter. Should only be set by the source filter and not be modified. Use durations for all operations that depend on frame length.

{{ScriptFunctionH5|_DurationNum||int _DurationNum}}
{{ScriptFunctionH5|_DurationDen||int _DurationDen}}
: The frame’s duration in seconds as a rational number. Filters that modify the framerate should also change these values.
: This fraction should always be normalized.

{{ScriptFunctionH5|_Combed||int _Combed (boolean)}}
: Whether or not the frame needs postprocessing, usually hinted from field matching filters.

{{ScriptFunctionH5|_Field||int _Field}}
: If the frame was produced by something like core.std.SeparateFields, this property signals which field was used to generate this frame.
:: 0=from bottom field, 1=from top field.

{{ScriptFunctionH5|_PictType||string _PictType}}
: A single character describing the frame type. It uses the common IPB letters but other letters may also be used for formats with additional frame types.

{{ScriptFunctionH5|_SARNum||int _SARNum}}
{{ScriptFunctionH5|_SARDen||int _SARDen}}
: Pixel (sample) aspect ratio as a rational number.

{{ScriptFunctionH5|_SceneChangeNext||int _SceneChangeNext (boolean)}}
: If 1, this frame is the last frame of the current scene. The next frame starts a new scene.

{{ScriptFunctionH5|_SceneChangePrev||int _SceneChangePrev (boolean)}}
: If 1, this frame starts a new scene.

==== Property set ====
: Input value of setter functions are to be come either
:*from the return value of "function objects"
:*direct value
: Property setter function names begin with propSet

: Common parameters:
::*clip c,
::*string key_name,
::*direct value of supported types (integer, float, string, array, clip) or a "function object"
::*int "mode": 0=replace (default), 1=append, 2=touch. There is no append mode for inserting a full array into the property.

{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, function func_obj [, integer "mode"])}}
: generic property setter, automatic type recognition by the return value of the function object

{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, integer value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, float value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, string value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, array value)}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, clip value [, integer "mode"])}}

: The above four functions are setting a property by a directly passed values
: note: array must contain only the similarly typed values, e.g. cannot mix strings with integers.

{{ScriptFunctionH5|propSetInt|{{AvsPluscon}}|propSetInt(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetFloat|{{AvsPluscon}}|propSetFloat(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetString|{{AvsPluscon}}|propSetString(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetArray|{{AvsPluscon}}|propSetArray(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetClip|{{AvsPluscon}}|propSetClip(clip, string key_name, function func_obj [, integer "mode"])}}
: these setters accept only the specific type

==== Property get ====
: Get properties by name or as a whole
: Common parameters:
:: clip c,
:: string key_name,
:: integer "index", (default 0): for zero based indexing array access
:: integer "offset" (default 0), similar to the other runtime functions: frame offset (e.g. -1: previous, 2: next next)

{{ScriptFunctionH5|propGetAny|{{AvsPluscon}}|propGetAny(clip, string key_name[, integer "index", integer "offset"])}}
: returns the automatically detected type

{{ScriptFunctionH5|propGetInt|{{AvsPluscon}}|propGetInt(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is integer, throws an error otherwise (note: unlike Avisynth integer frame properties internally use 64 bit integers)

{{ScriptFunctionH5|propGetFloat|{{AvsPluscon}}|propGetFloat(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is float, throws an error otherwise (note: unlike Avisynth float frame properties internally use 64 bit doubles)

{{ScriptFunctionH5|propGetString|{{AvsPluscon}}|propGetString(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is string, throws an error otherwise

{{ScriptFunctionH5|propGetAsArray|{{AvsPluscon}}|propGetAsArray(clip, string key_name[, integer "index", integer "offset"])}}
: A frame property can hold multiple values of the same type: it can be an array
: propGetAsArray returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)

{{ScriptFunctionH5|propGetClip|{{AvsPluscon}}|propGetClip(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is clip, throws an error otherwise (since 3.7.1)

{{ScriptFunctionH5|propGetAll|{{AvsPluscon}}|propGetAll(clip [, integer "offset"])}}
: Returns all frame properties in an array of [key-value] pairs. Array size will be 'numProps'
: Each key-value pair is contained in a two dimensional subarray.
: If the property value for a given key is an array again then "value" will be an array as well.
: Once you have the array with all properties you can access them with the "associative" feature of AviSynth array access
''Example:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip("""last.propSet("cica","hello"+String(current_frame)).\
propSetInt("test_i1",function[](clip c) { return current_frame*3 }).\
propSet("test_i2", current_frame * 2) """)
ScriptClip("""p = propGetAll() \
SubTitle("size:" + String(p.ArraySize()) + " " + \
String(p["test_i1"]) + " " + \
String(p["cica"]) + " " + \
String(p["test_i2"]))""")
ScriptClip("""p = propGetAll() \
SubTitle("size:" + String(p.ArraySize()) + " " + \
String(p[0,1]) + " " + \
String(p[1,1]) + " " + \
String(p[2,1]), x=0, y=20)""")
</div>

''Example (read-write basic)''
<div {{BoxWidthIndent|80|2}} >
ColorBars()

# just practicing with function objects
ScriptClip(function[](clip c) { c.Subtitle(String(current_frame)) })

# write frame properties with function object
ScriptClip("""propSetInt("frameprop_from_str",func(YPlaneMax))""")
# write frame properties with traditional script string
ScriptClip(function[](clip c) { propSetInt("frameluma_sc_func",func(AverageLuma)) })

# read frame properties (function object, string)
ScriptClip(function[](clip c) { SubTitle(string(propGetInt("frameprop_from_str")), y=20) })
ScriptClip("""SubTitle(string(propGetInt("frameluma_sc_func")), y=40)""")

return last
</div>

''Example (nearly everything)''
<div {{BoxWidthIndent|92|2}} >
ColorBars(width=640, height=480, pixel_type="yv12", staticframes=true)

ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello " + string(current_frame) }) })
ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello array element #2 " }, mode=1) })
ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello array element #3 "}, mode=1 ) })

ScriptClip(function[](clip c) { propSetString("s2",function[](clip c) { return "Another property "} ) })

ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*1 }) })
ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*2 }, mode=1) })
ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*4 }, mode=1 ) })

ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*1*3.14 }) })
ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*2*3.14 }, mode=1) })
ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*3*3.14 }, mode=1 ) })

ScriptClip(function[](clip c) { propSetArray("s_float_arr",function[](clip c) { return [1.1, 2.2] } ) })
ScriptClip(function[](clip c) { propSetArray("s_int_arr",function[](clip c) { return [-1,-2,-5] } ) })
ScriptClip(function[](clip c) { propSetArray("s_string",function[](clip c) { return ["ArrayElementS_1", "ArrayElementS_2"] } ) })
#ScriptClip("""propDelete("s")""")
ScriptClip(function[](clip c) {
y = 0
SubTitle("Prop Key count =" + String(propNumKeys), y=y)
y = y + 15
numKeys = propNumKeys() - 1
for ( i = 0 , numKeys) {
propName = propGetKeyByIndex(index = i)
propType = propGetType(propName)
SubTitle("#"+String(i) + " property: '" + propName + "', Type = " + String(propType) , y=y)
y = y + 15

for(j=0, propNumElements(propName) - 1) {
SubTitle("element #" + String(j) + ", size = " + String(propType == 3 ? propGetDataSize(propName, index=j) : 0) + ", Value = " + String(propGetAny(propName, index=j)), y = y)
#SubTitle("element #" + String(j) + " size = " + String(propType == 3 ? propGetDataSize(propName, index=j) : 0) + ", Value = " + String(propGetAny(propName, index=j)), y = y)
y = y + 15
}
}
return last
})

ScriptClip(function[](clip c) {
a = propGetAsArray("s")
y = 100
x = 400
SubTitle(string(a.ArraySize()), x=x, y=y)
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get int array one pass
ScriptClip(function[](clip c) {
a = propGetAsArray("s_int")
y = 440
x = 400
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get float array one pass
ScriptClip(function[](clip c) {
a = propGetAsArray("s_float")
y = 440
x = 200
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get string array
ScriptClip(function[](clip c) {
a = propGetAsArray("s_string")
y = 440
x = 000
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})
</div>

'''AviSynth 3.7.1''': allow propGetXXX property getter functions called as normal functions, outside runtime.<br>
By default frame property values are read from frame#0 which index can be overridden by the offset parameter.

''Example:''
<div {{BoxWidthIndent|92|2}} >

Colorbars()
PropSet(last, "hello", 1) # Set to 1 for all frames
# Override to 2 with runtime function except for frameNo=1
ScriptClip("""if(current_frame!=1) {propSet("hello",2)}""")
n0 = propGetInt("hello") # same as propGetInt("hello",offset=0)
# or get the frame property from the Nth frame
n1 = propGetInt("hello",offset=1)
n2 = propGetInt("hello",offset=2)
# n0 and n2 is 2 (overridden in runtime)
# n1 will be 1 (keeps global setting)
SubTitle("n0/n1/n2=" + "{n0}/{n1}/{n2}".Format)
</div>

==== Deleting properties ====
<div style="max-width:62em" >
: Delete one specific property or all property entries

{{ScriptFunctionH5|propDelete|{{AvsPluscon}}|propDelete(clip, string)}}
: Deletes a property by name. If property does not exist, do nothing.
:* {{FuncArg|clip}} (required) specifies clip.
:* {{FuncArg|string}} (required) key_name (case sensitive) specifies the name of the parameter to delete
''Example:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip("""propDelete("my_spec_prop")""")
</div>

{{ScriptFunctionH5|propClearAll|{{AvsPluscon}}|propClearAll(clip)}}
: Clears all properties for a given video frame
:* {{FuncArg|clip}} (required) specifies clip.

==== Other property functions ====
{{ScriptFunctionH5|propShow|{{AvsPluscon}}|propShow(clip, integer "size", bool "showtype")}}
: This debug filter lists all frame properties on screen.
: Listing appears as a name = value list. Arrays values are displayed between [ and ]
: Top line contains the number of properties. If no properties found, nothing is displayed.
:* {{FuncArg|clip}} (required) specifies clip.
:* {{FuncArg|integer}} "size" default(16), font size to use (the "Text" filter is used for display, sizes are of limited set)
:* {{FuncArg|bool}} "showtype" default(false), if true, the data type in parenthesis appears next to the property key name

{{ScriptFunctionH5|propGetDataSize|{{AvsPluscon}}|propGetDataSize(clip, string key_name [, integer "index", integer "offset"])}}
: returns the size of the string or underlying data array

{{ScriptFunctionH5|propNumElements|{{AvsPluscon}}|propNumElements(clip, string key_name [, integer "offset"])}}
: returns the array size of a given property. 1=single value

{{ScriptFunctionH5|propNumKeys|{{AvsPluscon}}|propNumKeys(clip, [, integer "offset"])}}
: returns number of entries (keys) for a frame

{{ScriptFunctionH5|propGetKeyByIndex|{{AvsPluscon}}|propGetKeyByIndex(clip, integer "index" [, integer "offset")}}
: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)

{{ScriptFunctionH5|propGetType|{{AvsPluscon}}(v3.7.0)|propGetType(clip, string key_name [, integer "offset"])}}
: returns the type of the given key
::*unset: 0
::*integer: 1
::*float: 2
::*string: 3
::*clip: 4
::*frame: 5

{{ScriptFunctionH5|propCopy|{{AvsPluscon}}(v3.7.1)|propCopy(clip, clip [,bool "merge"])}}
: Copies the frame properties of the second clip to the first.
::*Parameter 'merge' (default false):
:::*when false: exact copy (original target properties will be lost)
:::*when true: keeps original properties, appends all parameters from source but overwrite if a parameter with the same name already exists.

== Script functions ==
<div style="max-width:62em" >
: These provide AviSynth script information.

{{ScriptFunctionH5|ScriptName|v2.60|ScriptName()}}
: Returns the path and filename of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
name = ScriptName() # name = "F:\ProjectXYZ\video.avs"
</div>

{{ScriptFunctionH5|ScriptNameUtf8|{{AvsPluscon}}|ScriptNameUtf8()}}
: Returns the path and filename of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|ScriptFile|v2.60|ScriptFile()}}
: Returns the filename of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
file = ScriptFile() # file = "video.avs"
</div>

{{ScriptFunctionH5|ScriptFileUtf8|{{AvsPluscon}}|ScriptFileUtf8()}}
: Returns the filename of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|ScriptDir|v2.60|ScriptDir()}}
: Returns the path of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
folder = ScriptDir() # folder = "F:\ProjectXYZ"
</div>

{{ScriptFunctionH5|ScriptDirUtf8|{{AvsPluscon}}|ScriptDirUtf8()}}
: Returns the path of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|SetLogParams|{{AvsPluscon}}|SetLogParams([string ''target'', int ''level''])}}
: Sets a file path for a log file, used by [[#LogMsg|LogMsg]] and internal error reporting.
:* {{FuncArg|target}} names a file which will be created when the script loads. If attempting to create or write to {{FuncArg|target}} fails, the script will raise an error immediately. If the file exists, new log entries will be appended to the end. If omitted, {{FuncArg|target}} defaults to [[wikipedia:Stderr|stderr]].
:* {{FuncArg|level}} sets the log ''verbosity''; it can be one of the following:
::{| border="0"
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_ERROR</tt>
|style="line-height:1.0em"|<small>(1)</small>
|style="line-height:1.0em"|creates the fewest log entries
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_WARNING</tt> 
|style="line-height:1.0em"|<small>(2)</small> 
|style="line-height:1.0em"|
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_INFO</tt>
|style="line-height:1.0em"|<small>(3)</small>
|style="line-height:1.0em"|creates the most log entries
|}
::If omitted, {{FuncArg|level}} defaults to <tt>LOG_INFO</tt>.
:''Examples'' see [[#LogMsg|LogMsg]] below.

{{ScriptFunctionH5|LogMsg|{{AvsPluscon}}|LogMsg(string, int)}}
: Creates a new log entry.
:* {{FuncArg|string}} (required) specifies the log message.
:* {{FuncArg|int}} (required) specifies the log entry level: see [[#SetLogParams|SetLogParams]] above.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## creating file and set path for future log entries:
SetLogParams("<path>\_test1.log", LOG_INFO)

...''log contents:''
(empty)
</div>

<div {{BoxWidthIndent|56|2}} >
## logging an INFO message:
SetLogParams("<path>\_test2.log", LOG_INFO)
LogMsg("this is a test", LOG_INFO)

''log contents:''
---------------------------------------------------------------------
INFO: this is a test
</div>

<div {{BoxWidthIndent|56|2}} >
## logging a script error:
SetLogParams("<path>\_test3.log", LOG_INFO)
foo("bar") ## ERROR!

...''log contents (redundant entries are common):''
ERROR: Script error: There is no function named 'foo'.
---------------------------------------------------------------------
ERROR: Script error: There is no function named 'foo'.
(<path>\_test.avs, line 35)
</div>

<div {{BoxWidthIndent|56|2}} >
## logging INFO context for script error:
SetLogParams("<path>\_test4.log", LOG_INFO)
function MyFunction(clip C)
{
C
[[Control_structures|try]] {
foo("bar") ## ERROR!
} catch (err_msg) {
msg2 = "Error in MyFunction: "
LogMsg([[#Time|Time]]("%Y-%m-%d %I:%M:%S %p, %z") + ": " + msg2, LOG_INFO)
#[[#Assert|Assert]](false, msg2 + err_msg) ## optional: stop script, else continue
}
return Last
}

''log contents (redundant entries omitted):''
---------------------------------------------------------------------
ERROR: Script error: There is no function named 'foo'.
(<path>\_test.avs, line 54)
---------------------------------------------------------------------
INFO: 2017-11-12 11:03:41 AM, -0500: Error in MyFunction:
(<path>\_test.avs, line 54)
</div>

{{ScriptFunctionH5|GetProcessInfo|{{AvsPluscon}}|GetProcessInfo(int)}}
: Returns information about the [[wikipedia:Process_(computing)|process]] the script is running in.
: The ''int'' argument has two legal values:
:* if ''0'' (default), returns ''64'' for a 64-bit process or ''32'' for a 32-bit process.
:* else if ''1'',
:** returns 0 for 32-bit process on 32-bit OS;
:** returns 1 for 32-bit process on 64-bit OS;
:** returns 2 for 64-bit process on 64-bit OS;
:** else returns -1 (unknown)
:: /// [[TODO]] this is preliminary info

== String functions ==
<div style="max-width:62em" >
: These provide common operations on string variables.

{{ScriptFunctionH5|LCase||LCase(string)}}
: Returns lower case of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
LCase("AviSynth") = "avisynth"
</div>

{{ScriptFunctionH5|UCase||UCase(string)}}
: Returns upper case of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
UCase("AviSynth") = "AVISYNTH"
</div>

{{ScriptFunctionH5|StrToUtf8||StrToUtf8(string)}} {{AvsPluscon}}
: Converts {{FuncArg|string}} from ANSI to [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|StrFromUtf8||StrFromUtf8(string)}} {{AvsPluscon}}
: Converts {{FuncArg|string}} from [[wikipedia:UTF-8|UTF8]] to ANSI.

{{ScriptFunctionH5|StrLen||StrLen(string)}}
: Returns length of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
StrLen("AviSynth") = 8
</div>

{{ScriptFunctionH5|RevStr||RevStr(string)}}
: Returns {{FuncArg|string}} backwards.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
RevStr("AviSynth") = "htnySivA"
</div>

{{ScriptFunctionH5|LeftStr||LeftStr(string, int)}}
: Returns first {{FuncArg|int}} count of characters.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
LeftStr("AviSynth", 3) = "Avi"
</div>

{{ScriptFunctionH5|RightStr||RightStr(string, int)}}
: Returns last {{FuncArg|int}} count of characters.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
RightStr("AviSynth", 5) = "Synth"
</div>

{{ScriptFunctionH5|MidStr||MidStr(string, int pos [, int length])}}
: Returns substring starting at {{FuncArg|pos}} for optional {{FuncArg|length}} or to end. {{FuncArg|pos}}=1 specifies start.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
MidStr("AviSynth", 3, 2) = "iS"
</div>

{{ScriptFunctionH5|FindStr||FindStr(string, substring)}}
: Returns (1-based) position of {{FuncArg|substring}} within {{FuncArg|string}}
:* Note this function is case-sensitive.
:* Returns 0 if {{FuncArg|substring}} is not found.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Findstr("AviSynth", "Syn") ## returns 4
Findstr("AviSynth", "SYN") ## returns 0
</div>

{{ScriptFunctionH5|ReplaceStr|{{AvsPluscon}}|ReplaceStr(string, substring, replacement_string [, bool sig])}}
: Replaces occurrences of {{FuncArg|substring}} with {{FuncArg|replacement_string}} and returns the result.
:* {{FuncArg|sig}} if false (the default), search is case-sensitive; if true, search is not case-sensitive.
:* Avisynth 2.6.x users have other options, such as the [[User_defined_script_functions|user]] function below, adapted from ''StrReplace'', found [[HDColorBars|here]].
<div {{BoxWidthIndent|46|4}} >
function ReplaceStr(string base, string sought, string repstr) {
pos = FindStr(base, sought)
return (sought=="" || pos==0) ? base : ReplaceStr(
\ LeftStr(base, pos-1) + repstr +
\ MidStr(base, pos+StrLen(sought)),
\ sought, repstr)
}
</div>
''Examples:''
<div {{BoxWidthIndent|56|2}} >
ReplaceStr("FlipHorizontal", "Horizontal", "Vertical")
ReplaceStr("''$a'' x *", "''$a''", String(1.5)) ## (a [[MaskTools2|MaskTools]] expression with argument)
</div>

{{ScriptFunctionH5|Format|{{AvsPluscon}}|Format(formatstring [, value1, value2, ...])}}
: Mixes the string containing inline placeholders with parameters each converted to strings and returns the result.
:* {{FuncArg|formatstring}} unnamed parameter, string literal with parameter insertion points marked with {}.
:* {{FuncArg|value1}}, {{FuncArg|value2}},etc. zero or more values which are inserted into the format string one after another
:Description:
::The format string consists of
::
:::*ordinary characters (except { and }), which are copied unchanged to the output,
:::*escape sequences double "{" ("{{") and double "}" ("}}"), which are replaced with "{" and "}" respectively in the output, and
:::*replacement fields.
:::
:::Each replacement field has the following format:
::::introductory { character;
::::(optional)
::::arg-id, a non-negative number;
:::::or:
::::identifier which is used for lookup named parameters. (["name", value] construction)
:::::or:
::::valid AviSynth variable name
::::final } character.
:::
:::If arg-id is a number it specifies the index of the argument in args whose value is to be used for formatting;
:::Index is zero based.
:::
:::If arg-id is string then it serves as a lookup key from the parameters list given as an array ["name",value] pair.
:::If not found, then arg-id is searched among Avisynth variables.
:::
:::If arg-id is omitted, the arguments are used in order.
:::Mixing manual and automatic indexing is not an error.
:::
::Notes
:::It is not an error to provide more arguments than the format string requires:
<div {{BoxWidthIndent|56|2}} >
Format("{} {}!", "Hello", "world", "something") # OK, produces "Hello world!"
</div>

''Example: By Avisynth variable''
<div {{BoxWidthIndent|56|2}} >
max_pixel_value = 255
SubTitle(Format("max={max_pixel_value}!")) # no format value given, inserts directly from variable
</div>
''Example: By index:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("{0} {1} {0}", "Home", "sweet"))
</div>
''Example: by order:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("{} {} {}", "AviSynth", "+", 2020))
</div>
''Example: by Array name-value pairs:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("maximum={max} minimum={min} max again {max}!", ["max",255], ["min",0]))
</div>
:*since Avisynth+ 3.6

{{ScriptFunctionH5|FillStr|v2.60|FillStr(int [, string])}}
: Fills a string. When {{FuncArg|int}}>1 it concatenates the {{FuncArg|string}} {{FuncArg|int}} times. {{FuncArg|string}} is "<tt> </tt>" (space) by default.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
FillStr(1, "AviSynth") = "AviSynth"
FillStr(2, "AviSynth") = "AviSynthAviSynth"
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
StrCmp("AviSynth", "AviSynth") = 0 # strings are equal.
StrCmp("AviSynth", "Avisynth") != 0 # strings are not equal.
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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).
</div>

===== TrimLeft, TrimRight, TrimAll =====
{{ScriptFunctionCode|TrimLeft||TrimLeft(string)}}
{{ScriptFunctionCode|TrimRight||TrimRight(string)}}
{{ScriptFunctionCode|TrimAll||TrimAll(string)}}
: {{AvsPluscon}} Removes whitespace characters (space, tab, [[wikipedia:Non-breaking_space|nonbreaking space]]) from the ''left, right,'' or ''both'' ends of a string.

{{ScriptFunctionH5|Chr||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:''
<div {{BoxWidthIndent|56|2}} >
Chr(34) returns the quote character
Chr(9) returns the tab character
</div>

{{ScriptFunctionH5|Ord|v2.60|Ord(string)}}
: Gives the ordinal number (character code) of the first character of {{FuncArg|string}} (works like php [http://php.net/manual/en/function.ord.php ord] or Basic [http://msdn.microsoft.com/en-us/library/xfw01fx4%28v=vs.84%29.aspx Asc])
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Ord("a") = 97
Ord("AviSynth") = Ord("A") = 65
Ord("§") = 167
</div>

{{ScriptFunctionH5|Time||Time(string)}}
: Returns a string with the current system time formatted as defined by {{FuncArg|string}}.

: The string may contain any of the codes for output formatting presented below:
:{| class="wikitable"
|-
! style="width:9em" | Code
! style="width:38em" | 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:
:{| class="wikitable"
|-
! style="width:9em" |Code with '#' flag
! style="width:38em" |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 zeroes (if any).
|}
''Examples:''
<div {{BoxWidthIndent|56|2}} >
v = Time("%Y-%m-%d") # "2010-03-01"
v = Time("%d-%b-%Y") # "01-Mar-2010"
v = Time("%#d/%#m/%y") # "1/3/10"
v = Time("%I:%M:%S %p, %z") # "08:04:42 PM, GMT Standard Time"
v = Time("%H:%M:%S %z") # "20:04:42 GMT Standard Time"
</div>

== Version functions ==
<div style="max-width:62em" >
: These provide AviSynth version information.

{{ScriptFunctionH5|VersionNumber||VersionNumber()}}
: Returns AviSynth version number as a float.
:* Note: use [[#VersionString|VersionString]] below to determine if running in [[AviSynth+]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
VersionNumber ## returns 2.60 (release version as of 11/2017)
VersionNumber ## returns 2.61 (beta)
VersionNumber ## returns 2.60 (AVS+ release 2508)
</div>

{{ScriptFunctionH5|VersionString||VersionString()}}
: Returns AviSynth version info as a string (first line used in [[Version]]() command).
''Examples:''
<div {{BoxWidthIndent|56|2}} >
VersionString ## returns "AviSynth 2.60, build:Mar 31 2015 [16:38:54]"
VersionString ## returns "AviSynth 2.61, build:May 17 2016 [16:06:18] VC2008Exp"
VersionString ## returns "AviSynth+ 0.1, (r2508, MT, x86_64)"
</div>

<div {{BoxWidthIndent|56|2}} >
function IsAvsPlus()
{
sVer = [[#LCase|LCase]](VersionString)
return ([[#FindStr|FindStr]](sVer, "avisynth+") > 0)
\ || (FindStr(sVer, "avisynthplus") > 0)
}
</div>

{{ScriptFunctionH5|IsVersionOrGreater||bool IsVersionOrGreater(int majorVersion, int minorVersion [,int bugfixVersion]) {{AvsPluscon}}}}
: Returns true if Avisynth+ version is is equal or greater than the required one in the parameters.
: Since Avisynth+ 3.5
''Examples:''
<div {{BoxWidthIndent|56|2}} >
isAtLeast3_10 = IsVersionOrGreater(3,10)
isAtLeast3_5_1 = IsVersionOrGreater(3,5,1)
</div>

</div>

== Other helper functions ==
<div style="max-width:62em" >
: Non-categorized functions

{{ScriptFunctionH5|BuildPixelType||string BuildPixelType(string family, int bits, int chroma, bool compat, bool oldnames, clip sample_clip)}} {{AvsPluscon}}
: Creates a video format (pixel_type) string by giving a colorspace family, bit depth, optional chroma subsampling and/or a
: template clip, from which the undefined format elements are inherited.
:
:* string {{FuncArg|family}}
:: defines color family: "Y", "YUV", "YUVA", "RGB", "RGBA"
:: use "RGB" for both planar RGB and classic packed RGB24 and RGB48 - {{FuncArg|compat}} switches to classic formats
:* int {{FuncArg|bits}}
:: intended bit depth: 8, 10, 12, 14, 16, 32. In Avisynth+ 8-16 bits are integer formats, 32 bit is float
:* int {{FuncArg|chroma}}
:: chroma subsampling: 411, 420, 422, 444. Applies for YUV(A) formats. Ignored for RGB(A) and Y
:* bool {{FuncArg|compat}} default false
:: When set to true, function returns packed RGB(A) formats instead of planar RGB(A) (e.g. "RGB48" instead of "RGBP16"), when applicable
:* bool {{FuncArg|oldnames}} default false
:: when true, function returns "YV12", "YV16", "YV24" instead of "YUV420P8", "YUV422P8" and "YUV444P8" respectively
:* clip {{FuncArg|sample_clip}} when given, the clip serves as the base format, all optional parameters (bits, subsampling) will modify only its respective properties

:* see also: use [[#Other_helper_functions|ColorSpaceNameToPixelType]] to convert a colorspace string to an integer pixel_type
''Examples:''

:: define "YUV444P10"
<div {{BoxWidthIndent|56|2}} >
family = "YUV"
bits = 10
chroma = 444
compat = false
oldformat = false
s = BuildPixelType(family, bits, chroma, compat, oldformat)
BlankClip(width=320,height=200,length=len,pixel_type=s,color=$008080).Info()
</div>

:: Change only bit depth to 16, sample format is of an existing clip
<div {{BoxWidthIndent|56|2}} >
newbits = 16
c = last
s = BuildPixelType(bits=newbits, sample_clip=c)
BlankClip(width=320,height=200,length=len,pixel_type=s,color=$008080).Info()
</div>

{{ScriptFunctionH5|ColorSpaceNameToPixelType||int ColorSpaceNameToPixelType(string)}} {{AvsPluscon}}
: Creates a video format (pixel_type) by providing a colorspace name
:
:* some formats have multiple valid names: "YV12" is identical to "YUV420P8", "YV16" = "YUV422P8", "YV24" = "YUV444P8"

</div>

----
Back to [[AviSynth Syntax]].
</div>

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

Internal functions

2021-12-09T10:01:33Z

Pinterf: /* Property set */ propSet for Clip value type

<div style="max-width:82em; min-width:42em;" >
<div style="max-width:64em" >
In addition to [[Internal_filters|internal filters]] AviSynth has a fairly large number of other (non-clip) internal functions.

The input or/and output of these functions are not clips, but some other variables which can be used in a script.
{| style="max-width:56em"
|-
| style="vertical-align:top;" |
<div style="margin:1.0em;padding:2px 8px;">
<div style="border:1px solid #aaa; background-color:#f9f9f9; padding:5px; font-size:95%; width:20em">
<div style="margin=auto;text-align:center">'''Short Contents:'''</div>
# [[#Boolean_functions|Boolean functions]]
# [[#Control_functions|Control functions]]
# [[#Global_options|Global options]]
# [[#Conversion_functions|Conversion functions]]
# [[#Numeric_functions|Numeric functions]]
# [[#Trigonometry_functions|Trigonometry functions]]
# [[#Bit_functions|Bit functions]]
# [[#Runtime_functions|Runtime functions]]
# [[#Functions_for_frame_properties|Functions for frame properties]]
# [[#Script_functions|Script functions]]
# [[#String_functions|String functions]]
# [[#Version_functions|Version functions]]
# [[#Other_helper_functions|Other helper functions]]
<div style="line-height:50%;margin:0;padding:0"> </div>
</div>
</div>
| style="width:4em;" | 
| style="vertical-align:top;" |
<div>
<div style="float:right;clear:right;margin:1.0em;padding:2px 8px;">
__TOC__
</div>
</div>
|}
</div>

== Boolean functions ==
<div style="max-width:62em" >
: These return true or false, if the condition that they test holds or not, respectively.

{{ScriptFunctionH5|IsBool||IsBool(var)}}
: Tests if {{FuncArg|var}} is of the bool type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
b = false
IsBool(b) = true
IsBool(1 < 2 && 0 == 1) = true
IsBool(123) = false
</div>

{{ScriptFunctionH5|IsClip||IsClip(var)}}
: Tests if {{FuncArg|var}} is of the clip type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >

c = [[AviSource]](...)
IsClip(c) = true
IsClip("c") = false
</div>

{{ScriptFunctionH5|IsFloat||IsFloat(var)}}
: Tests if {{FuncArg|var}} is of the float type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
f = [[Internal_functions/Numeric_functions|Sqrt]](2)
IsFloat(f) = true
IsFloat(true) = false
IsFloat("42.") = false
IsFloat(2) = true # ''ints are considered to be floats by this function''
IsReallyFloat(2) = false # see below
</div>
: As a workaround for the issue noted above, you may use the following [[User_functions|user function]]:
<div {{BoxWidthIndent|46|3}} >
## return true for floats only
function IsReallyFloat(val v)
{
return (IsInt(v)==false) && IsFloat(v)
}
</div>

{{ScriptFunctionH5|IsInt||IsInt(var)}}
: Tests if {{FuncArg|var}} is of the int type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
IsInt(2) = true
IsInt(2.1) = false
IsInt(true) = false
</div>

{{ScriptFunctionH5|IsString||IsString(var)}}
: Tests if {{FuncArg|var}} is of the string type. {{FuncArg|var}} can be any expression allowed by the [[AviSynth Syntax]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
IsString("test") = true
IsString(2.3) = false
IsString([[Internal_functions/Conversion_functions|String]](2.3)) = true
</div>

{{ScriptFunctionH5|Exist||Exist(filename)}}
: Tests if the file specified by {{FuncArg|filename}} exists.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
filename = ...
clp = Exist(filename)
\ ? [[AviSource]](filename)
\ : [[Internal_functions/Control_functions|Assert]](false, "file: " + filename + " does not exist")
</div>

{{ScriptFunctionH5|Defined||Defined(var)}}
: Tests if {{FuncArg|var}} is defined. Can be used inside [[Script_functions]] to test if an optional argument has been given an explicit value.
: More formally, the function returns false if its argument (normally a function argument or variable) has the void ('undefined') type, otherwise it returns true.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
b_arg_supplied = Defined(arg)
myvar = b_arg_supplied ? ... : ...
</div>

{{ScriptFunctionH5|FunctionExists|{{AvsPluscon}}|FunctionExists(name)}}
: Tests if the function or filter name is defined in the script.
: {{FuncArg|name}} can be any string – it does not need to be a [[Script_variables#Variable_Names|legal name]].
: ''Example'' – see [[#Apply|Apply]] below

{{ScriptFunctionH5|InternalFunctionExists|{{AvsPluscon}}|InternalFunctionExists(name)}}
: Tests if the function, filter or [[Clip_properties|property]] name is defined natively within [[AviSynth+]].
:* Unlike [[#FunctionExists|FunctionExists]], returns ''false'' for [[Plugins|external plugins]] and [[User_functions|user-defined functions]].
</div>

{{ScriptFunctionH5|VarExist|{{AvsPluscon}}|VarExist(name)}}
: Tests if the variable exists or not. Note: if variable exists, it returns true regardless of the "defined" state of the variable
</div>

== Control functions ==
<div style="max-width:62em" >
: These facilitate flow of control (loading of scripts, arguments checks, global settings adjustment, etc.).

{{ScriptFunctionH5|Apply||Apply(string ''func_string'' [, arg1 [, arg2 [, ... [, arg''n'']]]] )}}
: Calls the function or filter {{FuncArg|func_string}} with arguments {{FuncArg|arg1}}, {{FuncArg|arg2}}, ..., {{FuncArg|arg''n''}} (as many as supplied).
:* This provides a way to call a function or filter '''by name''', with arguments.
:* <code>Apply("f", x)</code> is equivalent to <code>f(x)</code>
:* <code>Apply("f", x)</code> is equivalent to <code>[[#Eval|Eval]]("f(" + String(x) + ")")</code>
:* Note that the clip argument must be supplied explicitly - the [[Last|special variable ''Last'']] is not used.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## Building an expression dynamically
new_width = 352
new_height = 288

Apply("[[BicubicResize]]", Last, new_width, new_height)
# Note that the clip argument must be supplied - 'Last' is not implicitly assumed

## the same action, using [[#Eval|Eval]]
Eval( "BicubicResize(" + String(new_width) + "," + String(new_height) + ")" )
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it exists (AviSynth 2.6)
function MyFilter(clip C, string s) {
return C.[[Subtitle]]("MyFilter: "+s, align=5)
}
ColorBars
[[Control_structures|try]] {
Apply("MyFilter", Last, "TEST")
} catch (err_msg) {
# (ignore)
}
return Last
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it exists ([[AviSynth+|AVS+]] only)
ColorBars
return [[#FunctionExists|FunctionExists]]("MyFilter")
\ ? Apply("MyFilter", Last, "TEST")
\ : Last
</div>

{{ScriptFunctionH5|Eval||Eval(expression [, string ''name''])}}
: Evaluates an arbitrary {{FuncArg|expression}} and returns the result of that evaluation. '''It works exactly like [[#Import|Import]] below''', except
:* The expression to be evaluated comes from a string instead of a file;
:* The [[#Script_functions|values of]] ''ScriptName'', ''ScriptFile'' and ''ScriptDir'' are not changed;
:* The current working directory ([[wikipedia:Working_directory|CWD]]) is not changed.
: Argument {{FuncArg|name}} will be shown in the error message beside the script name. Both will be followed with the line number in {{FuncArg|expression}} where the error occurred.

: Variables in your calling script are available within {{FuncArg|expression}}; [[Global|global variables]] are not required.
: Note '''Eval''' can return the result of ''any'' valid expression; usually a clip, but also a string, boolean etc.
: You can use '''Eval''' to construct and evaluate expressions dynamically inside your scripts, based on variable input data.
: '''Eval''' is useful as a [[Control_structures|control structure]] for creating multi-line ''block statements'' without requiring [[AviSynth%2B|AviSynth+]].
: '''Eval''' can be used to put aside the need to install external plugins if they are not actually used.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## Building an expression dynamically
## calls [[BicubicResize]](last, 352, 288)
settings = "352, 288"
Eval( "BicubicResize(" + settings + ")" )
</div>

<div {{BoxWidthIndent|56|2}} >
## if...else [[Control_structures|control structure]]
option = true
option
\ ? '''Eval'''("""
[[Levels]](0, 1.2, 255, 20, 235)
[[Spline36Resize]](720, 400)
[[Sharpen]](0.2)
""")
\ : '''Eval'''("""
[[BicubicResize]](720, 400)
[[Sharpen]](0.3)
""")
</div>

<div {{BoxWidthIndent|56|2}} >
## using a filter only if it is needed;
## in this example, [[SMDegrain]] only needs to be installed if the option is ''true''.
option = false
option
\ ? '''Eval'''("""
SMDegrain(tr=2, thSAD=250, contrasharp=true, refinemotion=true, lsb=true)
""")
\ : Last
</div>

<div {{BoxWidthIndent|56|2}} >
## accessing script variables
ColorBars
A=[[Subtitle]]("A", align=5)
'''Eval'''("A")
return Last ## returns clip 'A'
</div>

<div {{BoxWidthIndent|56|2}} >
## setting script variables
ColorBars
A=Subtitle("A", align=5)
'''Eval'''("B = A.Invert")
return B ## returns clip 'A' with colors inverted
</div>

<div {{BoxWidthIndent|56|2}} >
## Increment a global variable, based on a local variable
Eval("global my_counter = my_counter + " + [[#String|String]](increment))
</div>

<div {{BoxWidthIndent|56|2}} >
## multi-line example with comment and line continuation
'''Eval'''("""
[[ColorBars]]
[[BicubicResize]](352, 288)
#FlipVertical
Subtitle(
\ "Width = " + [[#String|String]]([[Clip_properties|Width]]) + "\n"
\ + "Height = " + String(Height)
\ , align=7, lsp=0)
""")
</div>

<div {{BoxWidthIndent|56|2}} >
## Empty expression
## results in error: 'Defined(u) == false'
u = Eval("#")
</div>

<div {{BoxWidthIndent|56|2}} >
## Error reporting
ColorBars
A=Subtitle("A", size=Height, align=2)
Eval("""
A
foo("bar") ## ERROR!
""", '''"eval_test_1"''') ## name for error reporting purposes
return Last

''results in the error message:''
Script error: there is no function named "foo"
'''(eval_test_1, line 3)'''
(E:\_test.avs, line 6)
</div>

{{ScriptFunctionH5|Import||Import(filename)}}
{{ScriptFunctionCode|Import||Import(filename [, ...] [, bool utf8])}} {{AvsPluscon}}
: Evaluates the contents of another script and returns the result of that evaluation. '''It works exactly like [[#Eval|Eval]] above''', except
:* The expression to be evaluated comes from a file instead of a string;
:* The [[#Script_functions|values of]] ''ScriptName'', ''ScriptFile'' and ''ScriptDir'' are set to the current (imported) script;
:* The current working directory ([[wikipedia:Working_directory|CWD]]) is [[Internal_functions#SetWorkingDir|set]] to the current (imported) script.
:* {{FuncArg|utf8}} {{AvsPluscon}} if true, assumes filename(s) are [[wikipedia:UTF-8|UTF8]], else (default), assume ANSI.

:[[Script_functions|Functions]], [[Script_variables|variables]] and loaded plugins declared inside the imported script are made available to the parent script. <b>Import</b>'s return value can be assigned to a variable of the parent script; this is most useful when the imported script ends with a clip.

: Typically '''Import''' is used to make library functions available to the parent script, and the return value is not used. However this is simply a convention; it is not enforced by the [[AviSynth Syntax]]. Some indicative uses of '''Import''' include:
:* Storing multiple script-functions, variables and global variables for reuse by scripts (creation of script libraries).
:* Retrieving pre-built streams.
:* Retrieving dynamically configured pre-built streams (the core idea is that the importing script declares some global variables which the imported script uses to configure the stream that will return).
:'''Note 1''': Since the contents of the imported script are evaluated at the point of invocation, it is possible by enclosing the '''Import''' call in a nested scope (for example inside a function) to make available to the importing script the functions and globals of the imported script ''without'' its script-level variables.
:'''Note 2''': Any script with the [[AVSI]] extension in the AviSynth Plugins folder is automatically imported. This is useful for making script functions available to any new script you create without having to copy and paste.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
# ''B.avsi''
A.Invert
</div><div {{BoxWidthIndent|56|2}} >
ColorBars
A=Subtitle("A", align=5) ## create clip 'A'
Import("B.avsi")
return Last ## returns clip 'A' with colors inverted
</div>

<div {{BoxWidthIndent|56|2}} >
## here we do not care about the return value (''mylib.avsi'' contains only functions)
Import("mylib.avsi")
...
## ''mysources.avsi'' loads predetermined file names from a folder into globals
okflag = Import("mysources.avsi")
source = okflag ? global1 + global2 + global3 : [[BlankClip]]()
</div>

{{ScriptFunctionH5|Select||Select(index, item0 [, item1 [, ...[, itemn]]])}}
: Returns the item selected by the {{FuncArg|index}} argument, which must be of int type (0 returns {{FuncArg|item0}}, 1 returns {{FuncArg|item1}}, ..., etc). Items can be any script [[Script_variables|variable]] or expression of any type and can even be mixed.

:If {{FuncArg|index}} is out of range, an error is raised.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# select a clip-brush from a set of presets
idx = 2
brush = Select(idx, [[AviSource]]("round.avi"),
\ rectangle, diagonal, diagonal.[[FlipHorizontal]])
</div>

Note - all branches are evaluated:
<div {{BoxWidthIndent|56|2}} >
index=1
Select(index, "zero", "one", "two",
\ Assert(false, "Select evaluates all branches"))
## NOTE this code does not run - it throws [[#Assert|Assert]] error
## because Select evaluates all branches
</div>

If this is not desired, use the [[Ternary_operator|conditional execution]] operator:
<div {{BoxWidthIndent|56|2}} >
index=1
x = (index==0) ? "zero"
\ : (index==1) ? "one"
\ : (index==2) ? "two"
\ : Assert(false, "index out of range")
</div>

{{ScriptFunctionH5|Default||Default(x, d)}}
: Returns {{FuncArg|x}} if '''Defined'''(x) is true, {{FuncArg|d}} otherwise. {{FuncArg|x}} must either be a function's argument or an already declared script variable (ie a variable which has been assigned a value) else an error will occur.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
function myfunc(clip c, ..., int "strength") {
...
strength = Default(strength, 4) # if not supplied make it 4
...
}
</div>

{{ScriptFunctionH5|Assert||Assert(condition [, err_msg])}}
: Does nothing if {{FuncArg|condition}} is true; throws an error, immediately terminating script execution, if {{FuncArg|condition}} is false. In the later case {{FuncArg|err_msg}}, if supplied, is presented to the user through a dialog box; else the standard message "Assert: assertion failed" shows up.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
function myfunc(clip c, ..., int "strength") {
...
strength = Default(strength, 4) # if not supplied make it 4
Assert(strength > 0, "'strength' must be positive")
...
}
</div>

{{ScriptFunctionH5|NOP||NOP()}}
: This is a no-operation function provided mainly for conditional execution with non-return value items such as [[Import]], when no "else" condition is desired. That is, use it whenever the [[AviSynth Syntax]] requires an operation (such as with the ?: [[Operators#For_Booleans|operator]]) but your script does not need one.
: Return value: 0 (int type).
''Examples:''
<div {{BoxWidthIndent|56|2}} >
preset = want_presets ? [[AviSource]]("c:\presets\any.avi") : NOP
...
loadlib ? [[Import]]("my_useful_functions.avs") : NOP
</div>

{{ScriptFunctionH5|Undefined|v2.60|Undefined()}}
: Returns the undefined state.
: It's the state for which '''Defined'''() returns false.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
x = Undefined()
Defined(x) # == false
</div>
</div>

== Global Options ==
<div style="max-width:62em" >
{{ScriptFunctionH5|SetMemoryMax||SetMemoryMax(amount)}}
: Sets the maximum memory that AviSynth uses (in MB) to the value of {{FuncArg|amount}}. Setting to zero just returns the current Memory Max value. In the 2.5 series the default Memory Max value is 25% of the free physical memory, with a minimum of 16MB.
: The default Memory Max is also limited to 512MB.
: {{AvsPluscon}}In Avisynth+ this limit for default Memory Max is 1024MB for 32 bits and 4096MB on the x64 version
: DefaultMemoryMax = minimum(physical_memory / 4, secondary_memory_max_limit)
: for classic Avisynth see the table below
:{|class="wikitable" 
|-
| Free memory
| <64
| 128
| 256
| 512
| 1024
| 2048
| 3072
|-
| Default Max
| 16
| 32
| 64
| 192
| 448
| 512
| 512
|}
: In some versions there is a default setting of 5MB, which is quite low. If you encounter problems (e.g. low speed) try to set this values to at least 32MB. Too high values can result in crashes because of 2GB address space limit.
: Return value: Actual MemoryMax value set.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
SetMemoryMax(128)
</div>

:{{AvsPluscon}}{{FuncDef|SetMemoryMax(int, int “type”, int “index”)}}
:With additional arguments for devices such as GPUs. Memory usage is managed individually for devices such as GPUs.
<br>
::{{Par2||int|}}
:::Device (including CPU) memory limit (MB)
::{{Par2|type|int|}}
:::Device type. The following values are available:
::::DEV_TYPE_CPU: CPU (default)
::::DEV_TYPE_CUDA: GPU
::{{Par2|index|int|}}
:::Device number. Same as onCUDA device_index. Only 0 for DEV_TYPE_CPU.
:::Default value: 0

<div style="max-width:62em" >
{{ScriptFunctionH5|SetCacheMode||SetCacheMode(mode)}}
:{{AvsPluscon}}Fine tunes the internal frame caching strategy in AviSynth+.
: Available values:
::* 0 or CACHE_FAST_START start up time and size balanced mode (default)
::* 1 or CACHE_OPTIMAL_SIZE slow start up but optimal speed and cache size
::
* since Avisynth+ 3.6.1

<div style="max-width:62em" >
{{ScriptFunctionH5|SetMaxCPU||SetMaxCPU([string feature1, string feature2, ...])}}
: {{AvsPluscon}}Limits the CPU capabilities which AviSynth reports to its core and external plugins through GetCPUFlags.
: Available values:
::* "" or "none" for zero SIMD support, no processor flags are reported
::* "mmx", "sse", "sse2", "sse3", "ssse3", "sse4" or "sse4.1", "sse4.2", "avx, "avx2"
::
::Parameters are case insensitive.
::Note: "avx2" triggers FMA3 flag as well.
::
::*Processor options w/o any modifier will limit the CPU flag report to at most the processor level.
::*When "feature" is ended by '+', relevant processor feature flag will be switched on
::*When "feature" is ended by '-', relevant processor feature flag will be removed.
::Multiple options can be put in a comma separated list. They will evaluate in that order.
''Examples:''
<div {{BoxWidthIndent|60|2}} >
SetMaxCPU("SSE2") #reports at most SSE2 processor (even if AVX2 is available)
SetMaxCPU("avx,sse4.1-") #limits to avx2 but explicitely removes reporting sse4.1 support
SetMaxCPU("none,avx2+") #limits to plain C, then switches on AVX2-only support
</div>
* since Avisynth+ 3.6

{{ScriptFunctionH5|SetWorkingDir||SetWorkingDir(path)}}
: Sets the default directory for AviSynth to the {{FuncArg|path}} argument.
: This is primarily for easy loading of source clips, [[Import|importing]] scripts, etc. It does not affect plugins' autoloading.
: Return value is 0 if successful, -1 otherwise.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
SetWorkingDir("c:\my_presets")
[[AviSource]]("border_mask.avi") # this loads c:\my_presets\border_mask.avi
</div>

{{ScriptFunctionH5|SetPlanarLegacyAlignment||SetPlanarLegacyAlignment(mode)}}
: Set alignment mode for [[planar]] frames. {{FuncArg|mode}} can either be true or false.
: Some older [[External_plugins|plugins]] illegally assume the layout of video frames in memory. This special filter forces the memory layout of planar frames to be compatible with prior versions of AviSynth. The filter works on the [[The_script_execution_model/Evaluation_of_runtime_scripts|GetFrame]]() call stack, so it effects filters '''before''' it in the script.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Example : Using an older version of Mpeg2Source() (1.10 or older):

LoadPlugin("...\Mpeg2Decode.dll")
Mpeg2Source("test.d2v") # A plugin that illegally assumes the layout of memory
SetPlanarLegacyAlignment(true) # Set legacy memory alignment for prior statements
[[Convert|ConvertToYUY2]]() # Statements through to the end of the script have
... # advanced memory alignment.
</div>

{{ScriptFunctionH5|OPT_AllowFloatAudio||global OPT_AllowFloatAudio = true ## default false}}
: [[Float]] audio is converted to 16 bit when [[Frameserver|frameserving]] through [[ACM]], unless [[Internal_functions#OPT_AllowFloatAudio|OPT_AllowFloatAudio]] is set to true (this option enables WAVE_FORMAT_IEEE_FLOAT audio output<sup>[http://forum.doom9.org/showthread.php?t=109608]</sup>). In that case the audio is kept as it is. When accessing AviSynth directly (like MeGUI, BeHappy or ffmpeg do for example), there is no automatic conversion.

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

{{ScriptFunctionH5|OPT_UseWaveExtensible||global OPT_UseWaveExtensible = true ## default false}}
: This option enables WAVE_FORMAT_EXTENSIBLE audio output. The default is WAVE_FORMAT_EX.
: '''Note:''' The default DirectShow component for .AVS files, "AVI/WAV File Source", does not correctly implement WAVE_FORMAT_EXTENSIBLE processing, so many application may not be able to detect the audio track. There are third party DirectShow readers that do work correctly. Intermediate work files written using the AVIFile interface for later DirectShow processing will work correctly if they use the DirectShow "File Source (async)" component or equivalent.

{{ScriptFunctionH5|OPT_dwChannelMask|v2.60|global OPT_dwChannelMask(int v)}}
: This option enables you to set ChannelMask. It overrides WAVEFORMATEXTENSIBLE.dwChannelMask<sup>[[http://wiki.multimedia.cx/index.php?title=WAVEFORMATEXTENSIBLE]</sup> which is set according to this table
<div {{BoxWidthIndent|56|2}} >
0x00004, // 1 -- -- Cf
0x00003, // 2 Lf Rf
0x00007, // 3 Lf Rf Cf
0x00033, // 4 Lf Rf -- -- Lr Rr
0x00037, // 5 Lf Rf Cf -- Lr Rr
0x0003F, // 5.1 Lf Rf Cf Sw Lr Rr
0x0013F, // 6.1 Lf Rf Cf Sw Lr Rr -- -- Cr
0x0063F, // 7.1 Lf Rf Cf Sw Lr Rr -- -- -- Ls Rs
</div>

{{ScriptFunctionH5|OPT_AVIPadScanlines|v2.60|global OPT_AVIPadScanlines = true ## default false}}
: This option enables DWORD aligned planar padding. Default is packed aligned planar padding. See [[AVIFile output emulation|memory alignment used in the AVIFile output emulation]].<br>

{{ScriptFunctionH5|OPT_VDubPlanarHack|v2.60|global OPT_VDubPlanarHack = true ## default false}}
: This option enables flipped YV24 and YV16 chroma planes. This is an hack for early versions of Virtualdub with YV24/YV16 support. <br>

{{ScriptFunctionH5|OPT_Enable_V210|{{AvsPluscon}}|global OPT_Enable_V210 = true ## default false}}
: For 10bit YUV422, [[Frameserver|Frameserve]] interleaved V210 instead of planar P210. (VfW)
<div {{BoxWidthIndent|56|2}} >
{{BoldColor|black|100|§}} ''VfW'' here means [[wikipedia:Video_for_Windows|Video For Windows]] clients such as VirtualDub are affected, but not other clients such as ffmpeg.
</div>

{{ScriptFunctionH5|OPT_Enable_Y3_10_10|{{AvsPluscon}}|global OPT_Enable_Y3_10_10 = true ## default false}}
: For 10bit YUV422, set the [[FourCC]] to Y3[10][10] ('Y', '3', 10, 10) instead of P210 ('P', '2', '1', '0'). (VfW) <br>

{{ScriptFunctionH5|OPT_Enable_Y3_10_16|{{AvsPluscon}}|global OPT_Enable_Y3_10_16 = true ## default false}}
: For 16bit YUV422, use Y3[10][16] instead of P216 (VfW)<br>

{{ScriptFunctionH5|OPT_Enable_b64a|{{AvsPluscon}}|global OPT_Enable_b64a = true ## default false}}
: Use b64a instead of BRA[64] (VfW)
: works for avs+ version above r2636<br>

{{ScriptFunctionH5|OPT_Enable_PlanarToPackedRGB|{{AvsPluscon}}|global OPT_Enable_PlanarToPackedRGB = true ## default false}}
: Convert Planar RGB to packed RGB (VfW)
: Planar RGB 8, 10, 12, 14 and 16 bits are reported as G3[0][8], G3[0][10], G3[0][12], G3[0][14] and G3[0][16]
: Planar RGBA 8, 10, 12, 14 and 16 bits are reported as G4[0][8], G4[0][10], G4[0][12], G4[0][14] and G4[0][16]
: When these [[FourCC]] codes are not handled through VfW, use OPT_Enable_PlanarToPackedRGB=true.
: Avisynth+ will convert the clip from planar to RGB64 (packed 16bit RGB) and will negotiate this format instead<br>
</div>

== Conversion functions ==
<div style="max-width:62em" >
: These convert between different types.

{{ScriptFunctionH5|Value||Value(string)}}
: Converts a decimal string to its associated numeric value.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Value ("-2.7") = -2.7
</div>

{{ScriptFunctionH5|HexValue||HexValue(string)}}
{{ScriptFunctionCode|HexValue||HexValue(string [, int pos])}} {{AvsPluscon}}
: Converts a hexadecimal string to its associated numeric value.
:* {{FuncArg|pos}} sets the starting point of the numeric parser. All characters to the left of {{FuncArg|pos}} are ignored. Default is 1 (start of string).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
HexValue ("FF00") = 65280
</div>

{{ScriptFunctionH5|Hex|v2.60|Hex(int)}}
{{ScriptFunctionCode|Hex||Hex(int [, int width])}} {{AvsPluscon}}
: Converts a numerical value to its hexadecimal value. See [[Colors]] for more information on specifying colors.
:* {{FuncArg|width}} sets the minimum width of the returned string.
::Resulting string will be left-padded with zeroes as needed. Allowed range is 0..8; default is 0.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Hex (10824234) = "A52A2A"
Hex (15 width=2) = "0F"
</div>

{{ScriptFunctionH5|String||String(var [, string format_string])}}
: Converts a variable to a string. ''String'' arguments are passed along unchanged; ''bools'' are converted to "true" or "false"; numbers are formatted as described below; other [[Script_variables#Variable_Types|variable types]] (''clip'', ''val'') are converted to the empty string.
:The syntax of {{FuncArg|format_string}} is as follows:
::<code>'''%'''[flags][width][.precision]'''f'''</code>    <i>the leading </i>'<tt>%</tt>'<i> and trailing </i>'<tt>f</tt>'<i> are required.</i>
:The parts of {{FuncArg|format_string}} are:
:; ''flags''
::{| class=wikitable
|style="text-align:center"|<tt>-</tt>
|left align (right align by default)
|-
|style="text-align:center"|<tt>+</tt>
|always print the +/- sign (show only '<tt>+</tt>' by default)
|-
|style="text-align:center"|<tt>0</tt>
|pad (see ''width'') with leading zeroes (pad with spaces by default) 
|-
|style="text-align:center"| '<tt> </tt>' 
|print a blank instead of a '<tt>+</tt>'
|-
|style="text-align:center"|<tt>#</tt>
|always print the decimal point (dropped by default if there are no decimal digits) 
|}
:; ''width''
:: the minimum width (the string is never truncated if it is wider than ''width'')
:; ''precision''
:: the number of decimal digits
: You can also put arbitrary text around {{FuncArg|format_string}}, similar to the C-language [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] function.

''Examples:''
<div {{BoxWidthIndent|62|2}} >
Subtitle( String(1.23) ) # '1.230000' (six decimals by default for floats)
Subtitle( String(123) ) # '123' (no decimals by default for ints)

Subtitle( String(1.23, "%0.2f" )) # '1.23'
Subtitle( String(1.23, "%0.1f" )) # '1.2'
Subtitle( String(1.23, "%5.1f") ) # ' 1.2' (padded to 5 characters wide)
Subtitle( String(1.23, "%1.3f") ) # '1.230' (3 decimals; add trailing zeroes)

Subtitle( String(123, "%0.0f") ) # '123' (no decimals for precision=0)
Subtitle( String(123, "%''#''0.0f") ) # '123.' ('#' flag: always show decimal point)
Subtitle( String(123, "%0.2f") ) # '123.00' (2 decimals: add trailing zeroes)
Subtitle( String(123, "%5.0f") ) # ' 123' (padded to 5 characters wide using ' ')
Subtitle( String(123, "%05.0f") ) # '00123' (padded to 5 characters wide using '0')

Subtitle( String(PI, "PI=%0.0f") ) # 'PI=3' (text around format_string)
Subtitle( String(PI, "PI=%''#''0.0f") ) # 'PI=3.' ('#' flag: always show decimal point)
Subtitle( String(PI, "PI=%2.0f") ) # 'PI= 3'
Subtitle( String(PI, "PI=%3.2f") ) # 'PI=3.14'
Subtitle( String(PI, "PI=%0.5f") ) # 'PI=3.14159'
Subtitle( String(PI, "PI=%6.3f") ) # 'PI= 3.142'

Subtitle( String(32, "%0.0f") ) # '32'
Subtitle( String(32, "%3.0f") ) # ' 32'
Subtitle( String(32, "%8.0f") ) # ' 32'

## arbitrary text around format_string:
Subtitle( String(Last.Height, "Clip height is %0.0f") ) # 'Clip height is 480'
## same output as above but using string concatenation:
Subtitle( "Clip height is " + String(Last.Height) )
</div>
</div>

== Numeric functions ==
<div style="max-width:62em" >
: These provide common mathematical operations on numeric variables.

{{ScriptFunctionH5|Max||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:''
<div {{BoxWidthIndent|56|2}} >
Max (1, 2) = 2
Max (5, 3.0, 2) = 5.0
</div>

{{ScriptFunctionH5|Min||Min(float, float [, ...])}}
: Returns the minimum value of a set of numbers.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Min (1, 2) = 1
Min (5, 3.0, 2) = 2.0
</div>

{{ScriptFunctionH5|MulDiv||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:''
<div {{BoxWidthIndent|56|2}} >
MulDiv (1, 1, 2) = 1
MulDiv (2, 3, 2) = 3
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Floor(1.2) = 1
Floor(1.6) = 1
Floor(-1.2) = -2
Floor(-1.6) = -2
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Ceil(1.2) = 2
Ceil(1.6) = 2
Ceil(-1.2) = -1
Ceil(-1.6) = -1
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Round(1.2) = 1
Round(1.6) = 2
Round(-1.2) = -1
Round(-1.6) = -2
</div>

{{ScriptFunctionH5|Int||Int(float)}}
: Converts from single-precision, [http://en.wikipedia.org/wiki/Floating_point floating-point] value to int (round towards zero).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Int(1.2) = 1
Int(1.6) = 1
Int(-1.2) = -1
Int(-1.6) = -1
</div>

{{ScriptFunctionH5|Float||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:''
<div {{BoxWidthIndent|56|2}} >
Float(4) = 4.0
Float(4) / 3 = 1.333 (while 4 / 3 = 1 , due to integer division)
Float(123456789) = 123456792.0 (error = -3, 0.000002%)
Float(1234567890) = 1234567936.0 (error = -46, 0.000004%)
</div>

{{ScriptFunctionH5|Fmod|v2.60|Fmod(float, float)}}
: Returns the modulo of the argument. Output is float.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

{{ScriptFunctionH5|Pi||Pi()}}
: Returns the value of the {{BoldColor|black|110|π}} constant (the ratio of a circle's circumference to its diameter).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
d = Pi() # d == 3.141592653
</div>

{{ScriptFunctionH5|Exp||Exp(float)}}
: Returns the natural (base-e) exponent of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Exp(1) = 2.7182818
Exp(0) = 1.0
</div>

{{ScriptFunctionH5|Log||Log(float)}}
: Returns the natural (base-e) logarithm of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Log(1) = 0.0
Log(10) = 2.30259
Log(Exp(1)) = 1.0
</div>

{{ScriptFunctionH5|Log10|v2.60|Log10(float)}}
: Returns the common logarithm of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Log10(1.0) = 0
Log10(10.0) = 1.0
Log10(2.0) = 0.3010299957
</div>

{{ScriptFunctionH5|Pow||Pow(float base, float power)}}
: Returns {{FuncArg|base}} raised to a {{FuncArg|power}}.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Pow(2, 3) = 8
Pow(3, 2) = 9
Pow(3.45, 1.75) = 8.7334
</div>

{{ScriptFunctionH5|Sqrt||Sqrt(float)}}
: Returns the square root of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sqrt(1) = 1.0
Sqrt(2) = 1.4142
</div>

{{ScriptFunctionH5|Abs||Abs(float or int)}}
: Returns the absolute value of its argument (returns float for float, integer for integer).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Abs(-3.8) = 3.8
Abs(-4) = 4
</div>

{{ScriptFunctionH5|Sign||Sign(float)}}
: Returns the sign of the value passed as argument (1, 0 or -1).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sign(-3.5) = -1
Sign(3.5) = 1
Sign(0) = 0
</div>

{{ScriptFunctionH5|Frac||Frac(float)}}
: Returns the fractional portion of the value provided.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Frac(3.7) = 0.7
Frac(-1.8) = -0.8
</div>

{{ScriptFunctionH5|Rand||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 {{FuncArg|scale}}=true only if [[#Abs|Abs]]({{FuncArg|max}}) > 32768, false otherwise).
:;scale
::When true, ''scales'' the internal random number generator value to the maximum value, while ''modulus mode'' ({{FuncArg|scale}}=false) uses the remainder from an integer divide of the random generator value by the maximum. Modulus mode is recommended for smaller maximums.
:;seed
::When true, seeds the random number generator with the current time. {{FuncArg|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|'''Select''']] function for random clips.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Select(Rand(5), clip1, clip2, clip3, clip4, clip5)
</div>

{{ScriptFunctionH5|Spline||Spline(float X, x1, y1, x2, y2, .... [, bool cubic])}}
: Interpolates the Y value at point X using the control points {{FuncArg|x1}}/{{FuncArg|y1}}, ... There have to be at least 2 x/y-pairs. The interpolation can be {{FuncArg|cubic}} (the result is a spline) or linear (the result is a polygon). Default is cubic.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Spline(5, 0, 0, 10, 10, 20, 0, false) = 5
Spline(5, 0, 0, 10, 10, 20, 0, true) = 7
</div>

===== Continued Numerator, Denominator =====
{{ScriptFunctionCode|ContinuedNumerator|v2.60|ContinuedNumerator(float, int limit)}}
{{ScriptFunctionCode|ContinuedNumerator|v2.60|ContinuedNumerator(int, int, int limit)}}
{{ScriptFunctionCode|ContinuedDenominator|v2.60|ContinuedDenominator(float, int limit)}}
{{ScriptFunctionCode|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/{{FuncArg|limit}}. More information can be found on [http://en.wikipedia.org/wiki/Continued_fraction wikipedia].
: If {{FuncArg|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 {{FuncArg|limit}} is not specified then the normalized original values will be returned, i.e. reduced by the ''GCD'' (greatest common divisor).

''Examples:''
<div {{BoxWidthIndent|56|2}} >

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
</div>
</div>

== Trigonometry functions ==
<div style="max-width:62em" >
: relationships involving lengths and angles of triangles.

{{ScriptFunctionH5|Sin||Sin(float)}}
: Returns the sine of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Sin(Pi()/4) = 0.707
Sin(Pi()/2) = 1.0
</div>

{{ScriptFunctionH5|Cos||Cos(float)}}
: Returns the cosine of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Cos(Pi()/4) = 0.707
Cos(Pi()/2) = 0.0
</div>

{{ScriptFunctionH5|Tan|v2.60|Tan(float)}}
: Returns the tangent of the argument (assumes it is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Tan(Pi/4) = 1.0
Tan(Pi/2) = not defined
</div>
: 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.

{{ScriptFunctionH5|Asin|v2.60|Asin(float)}}
: Returns the inverse of the sine of the argument (output is radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Asin(0.707) = 0.7852471634 (~ Pi/4)
Asin(1.0) = 1.570796327 (~ Pi/2)
</div>

{{ScriptFunctionH5|Acos|v2.60|Acos(float)}}
: Returns the inverse of the cosine of the argument (output is in radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Acos(0.707) = 0.7852471634 (~ Pi/4)
Acos(0.0) = 1.570796327 (~ Pi/2)
</div>

{{ScriptFunctionH5|Atan|v2.60|Atan(float)}}
: Returns the inverse of the tangent of the argument (output is in radians).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Atan(0.707) = 0.6154085176
Atan(1.0) = 0.7853981634 (~ Pi/4)
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
Sinh(2.0) = 3.626860408
</div>

{{ScriptFunctionH5|Cosh|v2.60|Cosh(float)}}
: Returns the hyperbolic cosine of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Cosh(2.0) = 3.762195691
</div>

{{ScriptFunctionH5|Tanh|v2.60|Tanh(float)}}
: Returns the hyperbolic tangent of the argument.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Tanh(2.0) = 0.9640275801
</div>
</div>

== Bit functions ==
<div style="max-width:62em" >
: The functions are ''bitwise operators''. They manipulate individual bits within integer variables. 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.

{{ScriptFunctionH5|BitAnd|v2.60|BitAnd(int, int)}}
: Returns the bitwise AND (sets bit to 1 if both bits are 1 and sets bit to 0 otherwise).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
BitAnd(5, 6) = 4 # since 5 = 101, 6 = 110, and 101&110 = 100
</div>

{{ScriptFunctionH5|BitNot|v2.60|BitNot(int)}}
: Returns the bit-inversion (sets bit to 1 if bit is 0 and vice-versa).

''Examples:''
<div {{BoxWidthIndent|56|2}} >
BitNOT(5) = -6
# since 5 = 101,
# and ~101 = 1111 1111 1111 1111 1111 1111 1111 1010 = -6
</div>
: 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

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

===== Bit shift left =====
{{ScriptFunctionCode|BitLShift|v2.60|BitLShift(int, int)}}
{{ScriptFunctionCode|BitShl|v2.60|BitShl(int, int)}}
{{ScriptFunctionCode|BitSal|v2.60|BitSal(int, int)}}
: Shift the bits of a number to the left.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
Shifts the bits of the number 5 two bits to the left:
BitLShift(5, 2) = 20 (since 101 << 2 = 10100)
</div>

===== Bit shift right =====
{{ScriptFunctionCode|BitRShiftA|v2.60|BitRShiftA(int, int)}}
{{ScriptFunctionCode|BitRShiftS|v2.60|BitRShiftS(int, int)}}
{{ScriptFunctionCode|BitSar|v2.60|BitSar(int, int)}}
: Shift the bits of an integer to the right. (Arithmetic, Sign bit fill, Right Shift)
''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>

===== Bit shift right, unsigned =====
{{ScriptFunctionCode|BitRShiftL|v2.60|BitRShiftL(int, int)}}
{{ScriptFunctionCode|BitRShiftU|v2.60|BitRShiftU(int, int)}}
{{ScriptFunctionCode|BitShr|v2.60|BitShr(int, int)}}
: Shift the bits of an unsigned integer to the right. (Logical, zero fill, Right Shift)

''Examples:''
<div {{BoxWidthIndent|56|2}} >
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)
</div>
: 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

===== Bit rotate left =====
{{ScriptFunctionCode|BitLRotate|v2.60|BitLRotate(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
Rotates the bits of the number -2147483642 one bit to the left:
BitLRotate(-2147483642, 1) = 13
# (since 10000000000000000000000000000110 ROL 1
# = 00000000000000000000000000001101)
</div>

===== Bit rotate right =====
{{ScriptFunctionCode|BitRRotate|v2.60|BitRRotateL(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
Rotates the bits of the number 13 one bit to the right:
BitRRotate(13, 1) = -2147483642
# (since 00000000000000000000000000001101 ROR 1
# = 10000000000000000000000000000110)
</div>

===== Bit test =====
{{ScriptFunctionCode|BitTest|v2.60|BitTest(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

{{ScriptFunctionH5|BitSetCount||BitSetCount(int [, int...])}} {{AvsPluscon}}
: Returns the total number of set bits in all supplied integer arguments.

===== Bit clear =====
{{ScriptFunctionCode|BitClear|v2.60|BitClear(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>

===== Bit change =====
{{ScriptFunctionCode|BitChange|v2.60|BitChange(int, int)}}
{{ScriptFunctionCode|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:''
<div {{BoxWidthIndent|56|2}} >
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
</div>
</div>

== Runtime functions ==
<div style="max-width:62em" >
: These are internal functions which are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ConditionalFilter]], [[ScriptClip]], [[FrameEvaluate]]) to return information for a frame.

===== Average =====
{{ScriptFunctionCode|AverageLuma||AverageLuma(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageChromaU||AverageChromaU(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageChromaV||AverageChromaV(clip [, int offset = 0])}}
{{ScriptFunctionCode|AverageB||AverageB(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|AverageG||AverageG(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|AverageR||AverageR(clip [, int offset = 0])}} {{AvsPluscon}}
: This group of functions return a float value with the average pixel value of a plane (Luma, U-chroma and V-chroma, respectively). They require an [[ISSE]] capable cpu. In v2.61 an {{FuncArg|offset}} argument is added which enables you to access other frames than the current one.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip(Last, """
threshold = 55
luma = AverageLuma ## gives the average luma of the current frame
#luma = AverageLuma(1) ## gives the average luma of the next frame
luma < threshold
\ ? Levels(0, 1.0+0.5*(threshold-luma)/threshold, 255, 0, 255)
\ : last
Subtitle("luma=" + String(luma), align=2)
""")
</div>

===== Difference =====
{{ScriptFunctionCode|LumaDifference||LumaDifference(clip1, clip2)}}
{{ScriptFunctionCode|ChromaUDifference||ChromaUDifference(clip1, clip2)}}
{{ScriptFunctionCode|ChromaVDifference||ChromaVDifference(clip1, clip2)}}
{{ScriptFunctionCode|RGBDifference||RGBDifference(clip1, clip2)}}
{{ScriptFunctionCode|BDifference||BDifference(clip1, clip2)}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifference||GDifference(clip1, clip2)}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifference||RDifference(clip1, clip2)}} {{AvsPluscon}}
: This group of functions return a float value between 0 and 255 of the absolute difference between two planes from two different clips – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively. They require an [[ISSE]] capable cpu.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
ovl = [[Overlay]](last, mov_star, x=some_xvalue, y=some_yvalue, mask=mov_mask)
ldif = LumaDifference(ovl) # implicit last for clip1
udif = ChromaUDifference([[Tweak]](hue=24), ovl)
...
</div>

===== Difference from previous =====
{{ScriptFunctionCode|YDifferenceFromPrevious||YDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|UDifferenceFromPrevious||UDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|VDifferenceFromPrevious||VDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|RGBDifferenceFromPrevious||RGBDifferenceFromPrevious(clip)}}
{{ScriptFunctionCode|BDifferenceFromPrevious||BDifferenceFromPrevious(clip)}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifferenceFromPrevious||GDifferenceFromPrevious(clip)}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifferenceFromPrevious||RDifferenceFromPrevious(clip)}} {{AvsPluscon}}
: This group of functions return the absolute difference of pixel value between the current and previous frame of {{FuncArg|clip}} – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
scene_change = (YDifferenceFromPrevious) > threshold)
scene_change ? some_filter(...) : another_filter(...)
</div>

===== Difference to next =====
{{ScriptFunctionCode|YDifferenceToNext||YDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|UDifferenceToNext||UDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|VDifferenceToNext||VDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|RGBDifferenceToNext||RGBDifferenceToNext(clip [, int offset = 1])}}
{{ScriptFunctionCode|BDifferenceToNext||BDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
{{ScriptFunctionCode|GDifferenceToNext||GDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
{{ScriptFunctionCode|RDifferenceToNext||RDifferenceToNext(clip [, int offset = 1])}} {{AvsPluscon}}
: This group of functions return the absolute difference of pixel value between the current and next frame of {{FuncArg|clip}} – either the combined RGB difference or the Luma, U-chroma or V-chroma differences, respectively. In v2.61 an {{FuncArg|offset}} argument is added, which enables you to access the difference between the RGB, luma or chroma plane of the current frame and of ''any'' other frame. Note that for example clip.'''RGBDifferenceToNext'''(-1) = clip.'''RGBDifferenceToPrevious''', and clip.'''RGBDifferenceToNext'''(0) = 0.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# both th1, th2 are positive thresholds; th1 is larger enough than th2
scene_change = (YDifferenceFromPrevious > th1) && (YDifferenceToNext < th2)
scene_change ? some_filter(...) : another_filter(...)
</div>

===== Color plane median, min, max, range =====
{{ScriptFunctionCode|YPlaneMedian||YPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMedian||UPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMedian||VPlaneMedian(clip [, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMedian||BPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMedian||GPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|RPlaneMedian||RPlaneMedian(clip [, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMin||YPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMin||UPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMin||VPlaneMin(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMin||BPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMin||GPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}{{ScriptFunctionCode|RPlaneMin||RPlaneMin(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMax||YPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMax||UPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMax||VPlaneMax(clip [, float threshold = 0, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMax||BPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMax||GPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}{{ScriptFunctionCode|RPlaneMax||RPlaneMax(clip [, float threshold = 0, int offset = 0])}} {{AvsPluscon}}

{{ScriptFunctionCode|YPlaneMinMaxDifference||YPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|UPlaneMinMaxDifference||UPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|VPlaneMinMaxDifference||VPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}}
{{ScriptFunctionCode|BPlaneMinMaxDifference||BPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|GPlaneMinMaxDifference||GPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}
{{ScriptFunctionCode|RPlaneMinMaxDifference||RPlaneMinMaxDifference(clip [, float threshold, int offset = 0])}} {{AvsPluscon}}

: This group of functions return statistics about the distribution of pixel values on a plane (Luma, U-chroma and V-chroma, respectively). The statistics are, in order of presentation: maximum, minimum, median and range (maximum - minimum difference).
: {{FuncArg|threshold}} is a percentage, stating how many percent of the pixels are allowed above or below minimum. The threshold is optional and defaults to 0. In v2.61 an {{FuncArg|offset}} argument is added, which enables you to access the statistics of other frames than the current one.

''Examples:''
<div {{BoxWidthIndent|56|2}} >
# median and average are close only on even distributions;
# this can be a useful diagnostic
have_intense_brights = YPlaneMedian() - AverageLuma() < threshold
...
# a simple per-frame normalizer to [16..235], CCIR, range
[[Levels]](YPlaneMin(), 1.0, YPlaneMax(), 16, 235)
</div>
</div>

== Functions for frame properties ==
<div style="max-width:62em" >
: Core and concept ported from VapourSynth.
: Frame properties are per-frame data. Source or other filters can store useful data into frame properties such as information on colorimetry.
: Imagine them as an array of zero or more elements of PropertyName=Value
: Reading them is possible only by runtime functions.
: <br>
: Note:
: At the moment (v3.6.2test7) Avisynth+ provides only the necessary framework for handling (set, read, clear, pass) such properties. None of its internal functions (such as color space converters) set or work upon frame property values.
: There are already filters (like avsresize) and source plugins that are already using frame properties. Avisynth+ core will rely on frame in the future as well.
: <br>
: Developer info:
: On filter level the set of frame properties should be copied from a previous (or specific) input frame. When filter is using env->MakeWritable in its GetFrame method this happens automatically.
: But a simple env->NewVideoFrame means a dead-end for frame property passing mechanism. So filter must either use env->NewVideoFrameP which has an additional parameter: a source frame of the frame properties.
: Or frame properties have to be copied later, programatically by the copyFrameProps ScriptEnvironment function.
: For compatibility reasons NewVideoFrameP should be called adaptively instead of the traditional NewVideoFrame: usable after detecting Avisynth interface version 8 (NewVideoFrameP was introduced in v8).
: What happens if this copy is not done properly? Then the filter is a dead-end for frame properties since NewVideoFrame constructs new frame with no frame properties. All old filters will behave like this.<br>
: <br>
: Frame property getter functions are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ScriptClip]]).<br>
: Frame property setters can be called both at script level and in runtime. When a property is set on script level it will be constant along the lifetime of the whole clip, unless it is changed in runtime, inside ScriptClip.
: Though using property setter functions are allowed in [[FrameEvaluate]] but since it does not return an altered frame, writing a frame property there has zero effect.<br>
: <br>
:* frame properties are stored as key-value pairs
:** Key is an alphanumeric identifier.
:** Values can be of single value or array of type
:*** 64 bit integer (32 bit integer when converted to AVSValue inside Avisynth+, AVSValue limitation)
:*** 64 bit double (32 bit float when converted to AVSValue inside Avisynth+, AVSValue limitation)
:*** string (or byte data) with given length. Strings are null terminated.
:*** frame reference (PVideoFrame)
:*** clip reference (PClip)
:* property setting has 3 modes: 0-replace 1-append 2-touch (see AVSPropAppendMode in avisynth.h)::
:** 0 - single value for that key is replaced
:** 1 - property is appended (make arrays by calling with mode=1 consecutively)
:** 2 - touch

==== Reserved frame property names ====
: There are quasi-standard frame property names which are used widespread.
: As frame properties came from VapourSynth (see "Reserved Frame Properties" at http://www.vapoursynth.com/doc/apireference.html), it is convenient that Avisynth plugins use the same properties and values.
: Keys starting with _ have strictly defined meanings specified below. It is acceptable to not set any of these keys if they are unknown. It is also a fatal error to set them to a value not specified below.
{{ScriptFunctionH5|_ChromaLocation||int _ChromaLocation}}
: Chroma sample position in YUV formats.
:: 0=left, 1=center, 2=topleft, 3=top, 4=bottomleft, 5=bottom.

{{ScriptFunctionH5|_ColorRange||int _ColorRange}}
: Full or limited range (PC/TV range). Primarily used with YUV formats.
:: 0=full range, 1=limited range.

{{ScriptFunctionH5|_Primaries||int _Primaries}}
: Color primaries as specified in ITU-T H.265 Table E.3.

{{ScriptFunctionH5|_Matrix||int _Matrix}}
: Matrix coefficients as specified in ITU-T H.265 Table E.5.

{{ScriptFunctionH5|_Transfer||int _Transfer}}
: Transfer characteristics as specified in ITU-T H.265 Table E.4.

{{ScriptFunctionH5|_FieldBased||int _FieldBased}}
: If the frame is composed of two independent fields (interlaced).
:: 0=frame based (progressive), 1=bottom field first, 2=top field first

{{ScriptFunctionH5|_AbsoluteTime||float _AbsoluteTime}}
: The frame’s absolute timestamp in seconds if reported by the source filter. Should only be set by the source filter and not be modified. Use durations for all operations that depend on frame length.

{{ScriptFunctionH5|_DurationNum||int _DurationNum}}
{{ScriptFunctionH5|_DurationDen||int _DurationDen}}
: The frame’s duration in seconds as a rational number. Filters that modify the framerate should also change these values.
: This fraction should always be normalized.

{{ScriptFunctionH5|_Combed||int _Combed (boolean)}}
: Whether or not the frame needs postprocessing, usually hinted from field matching filters.

{{ScriptFunctionH5|_Field||int _Field}}
: If the frame was produced by something like core.std.SeparateFields, this property signals which field was used to generate this frame.
:: 0=from bottom field, 1=from top field.

{{ScriptFunctionH5|_PictType||string _PictType}}
: A single character describing the frame type. It uses the common IPB letters but other letters may also be used for formats with additional frame types.

{{ScriptFunctionH5|_SARNum||int _SARNum}}
{{ScriptFunctionH5|_SARDen||int _SARDen}}
: Pixel (sample) aspect ratio as a rational number.

{{ScriptFunctionH5|_SceneChangeNext||int _SceneChangeNext (boolean)}}
: If 1, this frame is the last frame of the current scene. The next frame starts a new scene.

{{ScriptFunctionH5|_SceneChangePrev||int _SceneChangePrev (boolean)}}
: If 1, this frame starts a new scene.

==== Property set ====
: Input value of setter functions are to be come either
:*from the return value of "function objects"
:*direct value
: Property setter function names begin with propSet

: Common parameters:
::*clip c,
::*string key_name,
::*direct value of supported types (integer, float, string, array, clip) or a "function object"
::*int "mode": 0=replace (default), 1=append, 2=touch. There is no append mode for inserting a full array into the property.

{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, function func_obj [, integer "mode"])}}
: generic property setter, automatic type recognition by the return value of the function object

{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, integer value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, float value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, string value [, integer "mode"])}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, array value)}}
{{ScriptFunctionH5|propSet|{{AvsPluscon}}|propSet(clip, string key_name, clip value [, integer "mode"])}}

: The above four functions are setting a property by a directly passed values
: note: array must contain only the similarly typed values, e.g. cannot mix strings with integers.

{{ScriptFunctionH5|propSetInt|{{AvsPluscon}}|propSetInt(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetFloat|{{AvsPluscon}}|propSetFloat(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetString|{{AvsPluscon}}|propSetString(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetArray|{{AvsPluscon}}|propSetArray(clip, string key_name, function func_obj [, integer "mode"])}}
{{ScriptFunctionH5|propSetClip|{{AvsPluscon}}|propSetClip(clip, string key_name, function func_obj [, integer "mode"])}}
: these setters accept only the specific type

==== Property get ====
: Get properties by name or as a whole
: Common parameters:
:: clip c,
:: string key_name,
:: integer "index", (default 0): for zero based indexing array access
:: integer "offset" (default 0), similar to the other runtime functions: frame offset (e.g. -1: previous, 2: next next)

{{ScriptFunctionH5|propGetAny|{{AvsPluscon}}|propGetAny(clip, string key_name[, integer "index", integer "offset"])}}
: returns the automatically detected type

{{ScriptFunctionH5|propGetInt|{{AvsPluscon}}|propGetInt(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is integer, throws an error otherwise (note: unlike Avisynth integer frame properties internally use 64 bit integers)

{{ScriptFunctionH5|propGetFloat|{{AvsPluscon}}|propGetFloat(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is float, throws an error otherwise (note: unlike Avisynth float frame properties internally use 64 bit doubles)

{{ScriptFunctionH5|propGetString|{{AvsPluscon}}|propGetString(clip, string key_name[, integer "index", integer "offset"])}}
: returns only if value is string, throws an error otherwise

{{ScriptFunctionH5|propGetAsArray|{{AvsPluscon}}|propGetAsArray(clip, string key_name[, integer "index", integer "offset"])}}
: A frame property can hold multiple values of the same type: it can be an array
: propGetAsArray returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)

{{ScriptFunctionH5|propGetAll|{{AvsPluscon}}|propGetAll(clip [, integer "offset"])}}
: Returns all frame properties in an array of [key-value] pairs. Array size will be 'numProps'
: Each key-value pair is contained in a two dimensional subarray.
: If the property value for a given key is an array again then "value" will be an array as well.
: Once you have the array with all properties you can access them with the "associative" feature of AviSynth array access
''Example:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip("""last.propSet("cica","hello"+String(current_frame)).\
propSetInt("test_i1",function[](clip c) { return current_frame*3 }).\
propSet("test_i2", current_frame * 2) """)
ScriptClip("""p = propGetAll() \
SubTitle("size:" + String(p.ArraySize()) + " " + \
String(p["test_i1"]) + " " + \
String(p["cica"]) + " " + \
String(p["test_i2"]))""")
ScriptClip("""p = propGetAll() \
SubTitle("size:" + String(p.ArraySize()) + " " + \
String(p[0,1]) + " " + \
String(p[1,1]) + " " + \
String(p[2,1]), x=0, y=20)""")
</div>

''Example (read-write basic)''
<div {{BoxWidthIndent|80|2}} >
ColorBars()

# just practicing with function objects
ScriptClip(function[](clip c) { c.Subtitle(String(current_frame)) })

# write frame properties with function object
ScriptClip("""propSetInt("frameprop_from_str",func(YPlaneMax))""")
# write frame properties with traditional script string
ScriptClip(function[](clip c) { propSetInt("frameluma_sc_func",func(AverageLuma)) })

# read frame properties (function object, string)
ScriptClip(function[](clip c) { SubTitle(string(propGetInt("frameprop_from_str")), y=20) })
ScriptClip("""SubTitle(string(propGetInt("frameluma_sc_func")), y=40)""")

return last
</div>

''Example (nearly everything)''
<div {{BoxWidthIndent|92|2}} >
ColorBars(width=640, height=480, pixel_type="yv12", staticframes=true)

ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello " + string(current_frame) }) })
ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello array element #2 " }, mode=1) })
ScriptClip(function[](clip c) { propSetString("s",function[](clip c) { return "Hello array element #3 "}, mode=1 ) })

ScriptClip(function[](clip c) { propSetString("s2",function[](clip c) { return "Another property "} ) })

ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*1 }) })
ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*2 }, mode=1) })
ScriptClip(function[](clip c) { propSetInt("s_int",function[](clip c) { return current_frame*4 }, mode=1 ) })

ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*1*3.14 }) })
ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*2*3.14 }, mode=1) })
ScriptClip(function[](clip c) { propSetFloat("s_float",function[](clip c) { return current_frame*3*3.14 }, mode=1 ) })

ScriptClip(function[](clip c) { propSetArray("s_float_arr",function[](clip c) { return [1.1, 2.2] } ) })
ScriptClip(function[](clip c) { propSetArray("s_int_arr",function[](clip c) { return [-1,-2,-5] } ) })
ScriptClip(function[](clip c) { propSetArray("s_string",function[](clip c) { return ["ArrayElementS_1", "ArrayElementS_2"] } ) })
#ScriptClip("""propDelete("s")""")
ScriptClip(function[](clip c) {
y = 0
SubTitle("Prop Key count =" + String(propNumKeys), y=y)
y = y + 15
numKeys = propNumKeys() - 1
for ( i = 0 , numKeys) {
propName = propGetKeyByIndex(index = i)
propType = propGetType(propName)
SubTitle("#"+String(i) + " property: '" + propName + "', Type = " + String(propType) , y=y)
y = y + 15

for(j=0, propNumElements(propName) - 1) {
SubTitle("element #" + String(j) + ", size = " + String(propType == 3 ? propGetDataSize(propName, index=j) : 0) + ", Value = " + String(propGetAny(propName, index=j)), y = y)
#SubTitle("element #" + String(j) + " size = " + String(propType == 3 ? propGetDataSize(propName, index=j) : 0) + ", Value = " + String(propGetAny(propName, index=j)), y = y)
y = y + 15
}
}
return last
})

ScriptClip(function[](clip c) {
a = propGetAsArray("s")
y = 100
x = 400
SubTitle(string(a.ArraySize()), x=x, y=y)
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get int array one pass
ScriptClip(function[](clip c) {
a = propGetAsArray("s_int")
y = 440
x = 400
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get float array one pass
ScriptClip(function[](clip c) {
a = propGetAsArray("s_float")
y = 440
x = 200
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})

# get string array
ScriptClip(function[](clip c) {
a = propGetAsArray("s_string")
y = 440
x = 000
SubTitle("Array size=" + string(a.ArraySize()), x=x, y=y)
y = y + 15
for(i=0, a.ArraySize()-1) {
SubTitle("["+String(i)+"]="+ String(a[i]),x=x,y=y)
y = y + 15
}
return last
})
</div>

'''AviSynth 3.7.1''': allow propGetXXX property getter functions called as normal functions, outside runtime.<br>
By default frame property values are read from frame#0 which index can be overridden by the offset parameter.

''Example:''
<div {{BoxWidthIndent|92|2}} >

Colorbars()
PropSet(last, "hello", 1) # Set to 1 for all frames
# Override to 2 with runtime function except for frameNo=1
ScriptClip("""if(current_frame!=1) {propSet("hello",2)}""")
n0 = propGetInt("hello") # same as propGetInt("hello",offset=0)
# or get the frame property from the Nth frame
n1 = propGetInt("hello",offset=1)
n2 = propGetInt("hello",offset=2)
# n0 and n2 is 2 (overridden in runtime)
# n1 will be 1 (keeps global setting)
SubTitle("n0/n1/n2=" + "{n0}/{n1}/{n2}".Format)
</div>

==== Deleting properties ====
<div style="max-width:62em" >
: Delete one specific property or all property entries

{{ScriptFunctionH5|propDelete|{{AvsPluscon}}|propDelete(clip, string)}}
: Deletes a property by name. If property does not exist, do nothing.
:* {{FuncArg|clip}} (required) specifies clip.
:* {{FuncArg|string}} (required) key_name (case sensitive) specifies the name of the parameter to delete
''Example:''
<div {{BoxWidthIndent|56|2}} >
ScriptClip("""propDelete("my_spec_prop")""")
</div>

{{ScriptFunctionH5|propClearAll|{{AvsPluscon}}|propClearAll(clip)}}
: Clears all properties for a given video frame
:* {{FuncArg|clip}} (required) specifies clip.

==== Other property functions ====
{{ScriptFunctionH5|propShow|{{AvsPluscon}}|propShow(clip, integer "size", bool "showtype")}}
: This debug filter lists all frame properties on screen.
: Listing appears as a name = value list. Arrays values are displayed between [ and ]
: Top line contains the number of properties. If no properties found, nothing is displayed.
:* {{FuncArg|clip}} (required) specifies clip.
:* {{FuncArg|integer}} "size" default(16), font size to use (the "Text" filter is used for display, sizes are of limited set)
:* {{FuncArg|bool}} "showtype" default(false), if true, the data type in parenthesis appears next to the property key name

{{ScriptFunctionH5|propGetDataSize|{{AvsPluscon}}|propGetDataSize(clip, string key_name [, integer "index", integer "offset"])}}
: returns the size of the string or underlying data array

{{ScriptFunctionH5|propNumElements|{{AvsPluscon}}|propNumElements(clip, string key_name [, integer "offset"])}}
: returns the array size of a given property. 1=single value

{{ScriptFunctionH5|propNumKeys|{{AvsPluscon}}|propNumKeys(clip, [, integer "offset"])}}
: returns number of entries (keys) for a frame

{{ScriptFunctionH5|propGetKeyByIndex|{{AvsPluscon}}|propGetKeyByIndex(clip, integer "index" [, integer "offset")}}
: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)

{{ScriptFunctionH5|propGetType|{{AvsPluscon}}(v3.7.0)|propGetType(clip, string key_name [, integer "offset"])}}
: returns the type of the given key
::*unset: 0
::*integer: 1
::*float: 2
::*string: 3
::*clip: 4
::*frame: 5

{{ScriptFunctionH5|propCopy|{{AvsPluscon}}(v3.7.1)|propCopy(clip, clip [,bool "merge"])}}
: Copies the frame properties of the second clip to the first.
::*Parameter 'merge' (default false):
:::*when false: exact copy (original target properties will be lost)
:::*when true: keeps original properties, appends all parameters from source but overwrite if a parameter with the same name already exists.

== Script functions ==
<div style="max-width:62em" >
: These provide AviSynth script information.

{{ScriptFunctionH5|ScriptName|v2.60|ScriptName()}}
: Returns the path and filename of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
name = ScriptName() # name = "F:\ProjectXYZ\video.avs"
</div>

{{ScriptFunctionH5|ScriptNameUtf8|{{AvsPluscon}}|ScriptNameUtf8()}}
: Returns the path and filename of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|ScriptFile|v2.60|ScriptFile()}}
: Returns the filename of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
file = ScriptFile() # file = "video.avs"
</div>

{{ScriptFunctionH5|ScriptFileUtf8|{{AvsPluscon}}|ScriptFileUtf8()}}
: Returns the filename of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|ScriptDir|v2.60|ScriptDir()}}
: Returns the path of the loaded script as a string.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
folder = ScriptDir() # folder = "F:\ProjectXYZ"
</div>

{{ScriptFunctionH5|ScriptDirUtf8|{{AvsPluscon}}|ScriptDirUtf8()}}
: Returns the path of the loaded script as a [[wikipedia:Unicode|Unicode]] string, encoded in [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|SetLogParams|{{AvsPluscon}}|SetLogParams([string ''target'', int ''level''])}}
: Sets a file path for a log file, used by [[#LogMsg|LogMsg]] and internal error reporting.
:* {{FuncArg|target}} names a file which will be created when the script loads. If attempting to create or write to {{FuncArg|target}} fails, the script will raise an error immediately. If the file exists, new log entries will be appended to the end. If omitted, {{FuncArg|target}} defaults to [[wikipedia:Stderr|stderr]].
:* {{FuncArg|level}} sets the log ''verbosity''; it can be one of the following:
::{| border="0"
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_ERROR</tt>
|style="line-height:1.0em"|<small>(1)</small>
|style="line-height:1.0em"|creates the fewest log entries
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_WARNING</tt> 
|style="line-height:1.0em"|<small>(2)</small> 
|style="line-height:1.0em"|
|-
|style="line-height:1.0em"|{{BoldColor|#669999|85|■}} <tt>LOG_INFO</tt>
|style="line-height:1.0em"|<small>(3)</small>
|style="line-height:1.0em"|creates the most log entries
|}
::If omitted, {{FuncArg|level}} defaults to <tt>LOG_INFO</tt>.
:''Examples'' see [[#LogMsg|LogMsg]] below.

{{ScriptFunctionH5|LogMsg|{{AvsPluscon}}|LogMsg(string, int)}}
: Creates a new log entry.
:* {{FuncArg|string}} (required) specifies the log message.
:* {{FuncArg|int}} (required) specifies the log entry level: see [[#SetLogParams|SetLogParams]] above.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
## creating file and set path for future log entries:
SetLogParams("<path>\_test1.log", LOG_INFO)

...''log contents:''
(empty)
</div>

<div {{BoxWidthIndent|56|2}} >
## logging an INFO message:
SetLogParams("<path>\_test2.log", LOG_INFO)
LogMsg("this is a test", LOG_INFO)

''log contents:''
---------------------------------------------------------------------
INFO: this is a test
</div>

<div {{BoxWidthIndent|56|2}} >
## logging a script error:
SetLogParams("<path>\_test3.log", LOG_INFO)
foo("bar") ## ERROR!

...''log contents (redundant entries are common):''
ERROR: Script error: There is no function named 'foo'.
---------------------------------------------------------------------
ERROR: Script error: There is no function named 'foo'.
(<path>\_test.avs, line 35)
</div>

<div {{BoxWidthIndent|56|2}} >
## logging INFO context for script error:
SetLogParams("<path>\_test4.log", LOG_INFO)
function MyFunction(clip C)
{
C
[[Control_structures|try]] {
foo("bar") ## ERROR!
} catch (err_msg) {
msg2 = "Error in MyFunction: "
LogMsg([[#Time|Time]]("%Y-%m-%d %I:%M:%S %p, %z") + ": " + msg2, LOG_INFO)
#[[#Assert|Assert]](false, msg2 + err_msg) ## optional: stop script, else continue
}
return Last
}

''log contents (redundant entries omitted):''
---------------------------------------------------------------------
ERROR: Script error: There is no function named 'foo'.
(<path>\_test.avs, line 54)
---------------------------------------------------------------------
INFO: 2017-11-12 11:03:41 AM, -0500: Error in MyFunction:
(<path>\_test.avs, line 54)
</div>

{{ScriptFunctionH5|GetProcessInfo|{{AvsPluscon}}|GetProcessInfo(int)}}
: Returns information about the [[wikipedia:Process_(computing)|process]] the script is running in.
: The ''int'' argument has two legal values:
:* if ''0'' (default), returns ''64'' for a 64-bit process or ''32'' for a 32-bit process.
:* else if ''1'',
:** returns 0 for 32-bit process on 32-bit OS;
:** returns 1 for 32-bit process on 64-bit OS;
:** returns 2 for 64-bit process on 64-bit OS;
:** else returns -1 (unknown)
:: /// [[TODO]] this is preliminary info

== String functions ==
<div style="max-width:62em" >
: These provide common operations on string variables.

{{ScriptFunctionH5|LCase||LCase(string)}}
: Returns lower case of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
LCase("AviSynth") = "avisynth"
</div>

{{ScriptFunctionH5|UCase||UCase(string)}}
: Returns upper case of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
UCase("AviSynth") = "AVISYNTH"
</div>

{{ScriptFunctionH5|StrToUtf8||StrToUtf8(string)}} {{AvsPluscon}}
: Converts {{FuncArg|string}} from ANSI to [[wikipedia:UTF-8|UTF8]].

{{ScriptFunctionH5|StrFromUtf8||StrFromUtf8(string)}} {{AvsPluscon}}
: Converts {{FuncArg|string}} from [[wikipedia:UTF-8|UTF8]] to ANSI.

{{ScriptFunctionH5|StrLen||StrLen(string)}}
: Returns length of {{FuncArg|string}}.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
StrLen("AviSynth") = 8
</div>

{{ScriptFunctionH5|RevStr||RevStr(string)}}
: Returns {{FuncArg|string}} backwards.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
RevStr("AviSynth") = "htnySivA"
</div>

{{ScriptFunctionH5|LeftStr||LeftStr(string, int)}}
: Returns first {{FuncArg|int}} count of characters.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
LeftStr("AviSynth", 3) = "Avi"
</div>

{{ScriptFunctionH5|RightStr||RightStr(string, int)}}
: Returns last {{FuncArg|int}} count of characters.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
RightStr("AviSynth", 5) = "Synth"
</div>

{{ScriptFunctionH5|MidStr||MidStr(string, int pos [, int length])}}
: Returns substring starting at {{FuncArg|pos}} for optional {{FuncArg|length}} or to end. {{FuncArg|pos}}=1 specifies start.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
MidStr("AviSynth", 3, 2) = "iS"
</div>

{{ScriptFunctionH5|FindStr||FindStr(string, substring)}}
: Returns (1-based) position of {{FuncArg|substring}} within {{FuncArg|string}}
:* Note this function is case-sensitive.
:* Returns 0 if {{FuncArg|substring}} is not found.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Findstr("AviSynth", "Syn") ## returns 4
Findstr("AviSynth", "SYN") ## returns 0
</div>

{{ScriptFunctionH5|ReplaceStr|{{AvsPluscon}}|ReplaceStr(string, substring, replacement_string [, bool sig])}}
: Replaces occurrences of {{FuncArg|substring}} with {{FuncArg|replacement_string}} and returns the result.
:* {{FuncArg|sig}} if false (the default), search is case-sensitive; if true, search is not case-sensitive.
:* Avisynth 2.6.x users have other options, such as the [[User_defined_script_functions|user]] function below, adapted from ''StrReplace'', found [[HDColorBars|here]].
<div {{BoxWidthIndent|46|4}} >
function ReplaceStr(string base, string sought, string repstr) {
pos = FindStr(base, sought)
return (sought=="" || pos==0) ? base : ReplaceStr(
\ LeftStr(base, pos-1) + repstr +
\ MidStr(base, pos+StrLen(sought)),
\ sought, repstr)
}
</div>
''Examples:''
<div {{BoxWidthIndent|56|2}} >
ReplaceStr("FlipHorizontal", "Horizontal", "Vertical")
ReplaceStr("''$a'' x *", "''$a''", String(1.5)) ## (a [[MaskTools2|MaskTools]] expression with argument)
</div>

{{ScriptFunctionH5|Format|{{AvsPluscon}}|Format(formatstring [, value1, value2, ...])}}
: Mixes the string containing inline placeholders with parameters each converted to strings and returns the result.
:* {{FuncArg|formatstring}} unnamed parameter, string literal with parameter insertion points marked with {}.
:* {{FuncArg|value1}}, {{FuncArg|value2}},etc. zero or more values which are inserted into the format string one after another
:Description:
::The format string consists of
::
:::*ordinary characters (except { and }), which are copied unchanged to the output,
:::*escape sequences double "{" ("{{") and double "}" ("}}"), which are replaced with "{" and "}" respectively in the output, and
:::*replacement fields.
:::
:::Each replacement field has the following format:
::::introductory { character;
::::(optional)
::::arg-id, a non-negative number;
:::::or:
::::identifier which is used for lookup named parameters. (["name", value] construction)
:::::or:
::::valid AviSynth variable name
::::final } character.
:::
:::If arg-id is a number it specifies the index of the argument in args whose value is to be used for formatting;
:::Index is zero based.
:::
:::If arg-id is string then it serves as a lookup key from the parameters list given as an array ["name",value] pair.
:::If not found, then arg-id is searched among Avisynth variables.
:::
:::If arg-id is omitted, the arguments are used in order.
:::Mixing manual and automatic indexing is not an error.
:::
::Notes
:::It is not an error to provide more arguments than the format string requires:
<div {{BoxWidthIndent|56|2}} >
Format("{} {}!", "Hello", "world", "something") # OK, produces "Hello world!"
</div>

''Example: By Avisynth variable''
<div {{BoxWidthIndent|56|2}} >
max_pixel_value = 255
SubTitle(Format("max={max_pixel_value}!")) # no format value given, inserts directly from variable
</div>
''Example: By index:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("{0} {1} {0}", "Home", "sweet"))
</div>
''Example: by order:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("{} {} {}", "AviSynth", "+", 2020))
</div>
''Example: by Array name-value pairs:''
<div {{BoxWidthIndent|56|2}} >
SubTitle(Format("maximum={max} minimum={min} max again {max}!", ["max",255], ["min",0]))
</div>
:*since Avisynth+ 3.6

{{ScriptFunctionH5|FillStr|v2.60|FillStr(int [, string])}}
: Fills a string. When {{FuncArg|int}}>1 it concatenates the {{FuncArg|string}} {{FuncArg|int}} times. {{FuncArg|string}} is "<tt> </tt>" (space) by default.
''Examples:''
<div {{BoxWidthIndent|56|2}} >
FillStr(1, "AviSynth") = "AviSynth"
FillStr(2, "AviSynth") = "AviSynthAviSynth"
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
StrCmp("AviSynth", "AviSynth") = 0 # strings are equal.
StrCmp("AviSynth", "Avisynth") != 0 # strings are not equal.
</div>

{{ScriptFunctionH5|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:''
<div {{BoxWidthIndent|56|2}} >
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).
</div>

===== TrimLeft, TrimRight, TrimAll =====
{{ScriptFunctionCode|TrimLeft||TrimLeft(string)}}
{{ScriptFunctionCode|TrimRight||TrimRight(string)}}
{{ScriptFunctionCode|TrimAll||TrimAll(string)}}
: {{AvsPluscon}} Removes whitespace characters (space, tab, [[wikipedia:Non-breaking_space|nonbreaking space]]) from the ''left, right,'' or ''both'' ends of a string.

{{ScriptFunctionH5|Chr||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:''
<div {{BoxWidthIndent|56|2}} >
Chr(34) returns the quote character
Chr(9) returns the tab character
</div>

{{ScriptFunctionH5|Ord|v2.60|Ord(string)}}
: Gives the ordinal number (character code) of the first character of {{FuncArg|string}} (works like php [http://php.net/manual/en/function.ord.php ord] or Basic [http://msdn.microsoft.com/en-us/library/xfw01fx4%28v=vs.84%29.aspx Asc])
''Examples:''
<div {{BoxWidthIndent|56|2}} >
Ord("a") = 97
Ord("AviSynth") = Ord("A") = 65
Ord("§") = 167
</div>

{{ScriptFunctionH5|Time||Time(string)}}
: Returns a string with the current system time formatted as defined by {{FuncArg|string}}.

: The string may contain any of the codes for output formatting presented below:
:{| class="wikitable"
|-
! style="width:9em" | Code
! style="width:38em" | 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:
:{| class="wikitable"
|-
! style="width:9em" |Code with '#' flag
! style="width:38em" |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 zeroes (if any).
|}
''Examples:''
<div {{BoxWidthIndent|56|2}} >
v = Time("%Y-%m-%d") # "2010-03-01"
v = Time("%d-%b-%Y") # "01-Mar-2010"
v = Time("%#d/%#m/%y") # "1/3/10"
v = Time("%I:%M:%S %p, %z") # "08:04:42 PM, GMT Standard Time"
v = Time("%H:%M:%S %z") # "20:04:42 GMT Standard Time"
</div>

== Version functions ==
<div style="max-width:62em" >
: These provide AviSynth version information.

{{ScriptFunctionH5|VersionNumber||VersionNumber()}}
: Returns AviSynth version number as a float.
:* Note: use [[#VersionString|VersionString]] below to determine if running in [[AviSynth+]].
''Examples:''
<div {{BoxWidthIndent|56|2}} >
VersionNumber ## returns 2.60 (release version as of 11/2017)
VersionNumber ## returns 2.61 (beta)
VersionNumber ## returns 2.60 (AVS+ release 2508)
</div>

{{ScriptFunctionH5|VersionString||VersionString()}}
: Returns AviSynth version info as a string (first line used in [[Version]]() command).
''Examples:''
<div {{BoxWidthIndent|56|2}} >
VersionString ## returns "AviSynth 2.60, build:Mar 31 2015 [16:38:54]"
VersionString ## returns "AviSynth 2.61, build:May 17 2016 [16:06:18] VC2008Exp"
VersionString ## returns "AviSynth+ 0.1, (r2508, MT, x86_64)"
</div>

<div {{BoxWidthIndent|56|2}} >
function IsAvsPlus()
{
sVer = [[#LCase|LCase]](VersionString)
return ([[#FindStr|FindStr]](sVer, "avisynth+") > 0)
\ || (FindStr(sVer, "avisynthplus") > 0)
}
</div>

{{ScriptFunctionH5|IsVersionOrGreater||bool IsVersionOrGreater(int majorVersion, int minorVersion [,int bugfixVersion]) {{AvsPluscon}}}}
: Returns true if Avisynth+ version is is equal or greater than the required one in the parameters.
: Since Avisynth+ 3.5
''Examples:''
<div {{BoxWidthIndent|56|2}} >
isAtLeast3_10 = IsVersionOrGreater(3,10)
isAtLeast3_5_1 = IsVersionOrGreater(3,5,1)
</div>

</div>

== Other helper functions ==
<div style="max-width:62em" >
: Non-categorized functions

{{ScriptFunctionH5|BuildPixelType||string BuildPixelType(string family, int bits, int chroma, bool compat, bool oldnames, clip sample_clip)}} {{AvsPluscon}}
: Creates a video format (pixel_type) string by giving a colorspace family, bit depth, optional chroma subsampling and/or a
: template clip, from which the undefined format elements are inherited.
:
:* string {{FuncArg|family}}
:: defines color family: "Y", "YUV", "YUVA", "RGB", "RGBA"
:: use "RGB" for both planar RGB and classic packed RGB24 and RGB48 - {{FuncArg|compat}} switches to classic formats
:* int {{FuncArg|bits}}
:: intended bit depth: 8, 10, 12, 14, 16, 32. In Avisynth+ 8-16 bits are integer formats, 32 bit is float
:* int {{FuncArg|chroma}}
:: chroma subsampling: 411, 420, 422, 444. Applies for YUV(A) formats. Ignored for RGB(A) and Y
:* bool {{FuncArg|compat}} default false
:: When set to true, function returns packed RGB(A) formats instead of planar RGB(A) (e.g. "RGB48" instead of "RGBP16"), when applicable
:* bool {{FuncArg|oldnames}} default false
:: when true, function returns "YV12", "YV16", "YV24" instead of "YUV420P8", "YUV422P8" and "YUV444P8" respectively
:* clip {{FuncArg|sample_clip}} when given, the clip serves as the base format, all optional parameters (bits, subsampling) will modify only its respective properties

:* see also: use [[#Other_helper_functions|ColorSpaceNameToPixelType]] to convert a colorspace string to an integer pixel_type
''Examples:''

:: define "YUV444P10"
<div {{BoxWidthIndent|56|2}} >
family = "YUV"
bits = 10
chroma = 444
compat = false
oldformat = false
s = BuildPixelType(family, bits, chroma, compat, oldformat)
BlankClip(width=320,height=200,length=len,pixel_type=s,color=$008080).Info()
</div>

:: Change only bit depth to 16, sample format is of an existing clip
<div {{BoxWidthIndent|56|2}} >
newbits = 16
c = last
s = BuildPixelType(bits=newbits, sample_clip=c)
BlankClip(width=320,height=200,length=len,pixel_type=s,color=$008080).Info()
</div>

{{ScriptFunctionH5|ColorSpaceNameToPixelType||int ColorSpaceNameToPixelType(string)}} {{AvsPluscon}}
: Creates a video format (pixel_type) by providing a colorspace name
:
:* some formats have multiple valid names: "YV12" is identical to "YUV420P8", "YV16" = "YUV422P8", "YV24" = "YUV444P8"

</div>

----
Back to [[AviSynth Syntax]].
</div>

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

RGBAdjust

2021-12-09T09:54:00Z

Pinterf: RGBAdjust generally supports 32 bit float

<div style="max-width:62em" >
'''RGBAdjust''' has many different methods of changing the color and luminance of your [[RGB]] clips. Gain, bias (offset) and gamma can be set independently on each channel. Also included are an analysis function and a dither option.

All settings for this filter are optional. [[ColorYUV]] works in a similar manner for [[YUV]] clips.

* {{AvsPluscon}} all [[RGB]] and [[RGBA]] color formats are supported.

__TOC__
</div>

== Syntax and Parameters ==
<div style="max-width:62em" >
{{FuncDef|RGBAdjust(clip ''clip'' [, <br>
     float ''r'', float ''g'', float ''b'', float ''a'', <br>
     float ''rb'', float ''gb'', float ''bb'', float ''ab'', <br>
     float ''rg'', float ''gg'', float ''bg'', float ''ag'', <br>
     bool ''analyze'', bool ''dither'', {{AvsPluscon}} bool ''conditional'', {{AvsPluscon}} bool ''condvarsuffix'' ] )
}}

:{{Par2|r|float|1.0}}
:{{Par2|g|float|1.0}}
:{{Par2|b|float|1.0}}
::Red, green and blue scaling factor. Range 0.0 to 255.0
::For example, {{FuncArg|r}}=3.0 multiplies the red channel pixel values by 3.
::{{AvsPluscon}} [[Autoscale_parameter|autoscaled]] – works without changes at all bit depths, gain is bit depth independent.

:{{Par2|a|float|1.0}}
::Alpha adjustment—the transparency information on a per-pixel basis.
::An alpha value of zero represents full transparency, and a value of 1 represents a full opacity.

:{{Par2|rb|float|0.0}}
:{{Par2|gb|float|0.0}}
:{{Par2|bb|float|0.0}}
:{{Par2|ab|float|0.0}}
::Bias adjustment—add a fixed positive or negative value to a channel's pixel values. For example,
::{{FuncArg|rb}}=16 will add 16 to all red pixel values and
::{{FuncArg|rb}}=-32 will subtract 32 from all red pixel values.
::{{AvsPluscon}} not [[Autoscale_parameter|autoscaled]] – caller must scale arguments by 4 for 10-bit, etc.

:{{Par2|rg|float|1.0}}
:{{Par2|gg|float|1.0}}
:{{Par2|bg|float|1.0}}
:{{Par2|ag|float|1.0}}
::Gamma adjustment—an [[Wikipedia:Gamma_correction|exponential gain factor]]. For example,
::{{FuncArg|rg}}=1.2 will brighten the red pixel values and
::{{FuncArg|gg}}=0.8 will darken the green pixel values.

:{{Par2|analyze|bool|false}}
::If true, '''RGBAdjust''' will print color channel statistics on the screen (see [[#analyze|example below]])
::*There are '''Maximum''' and '''Minimum''' values for all channels.
::*There is an '''Average''' and a '''Standard Deviation''' for all channels.
::*There is '''Loose Minimum''' and '''Loose Maximum''' which ignore the brightest and darkest 0.4% (1/256) pixels.
::{{AvsPluscon}} parameter is supported for 32 bit float color spaces as well, but loose min/max is based on a 16bit quantized data (loose min/max is based on an internal histogram)

:{{Par2|dither|bool|false}}
::If true, [[ordered dithering]] is applied when doing the adjustment.
::{{AvsPluscon}} parameter is ignored for 32 bit float color spaces

:{{Par2|conditional|bool|false}}
::{{AvsPluscon}} If true, the global variables "rgbadjust_xxx" with xxx = r, g, b, a, rb, gb, bb, ab, rg, gg, bg, ag are read each frame, and applied.
::It is possible to modify these variables using FrameEvaluate or ConditionalReader. (functionality similar to ColorYUV)

:{{Par2|condvarsuffix|string|""}}
:: {{AvsPluscon}} this parameter works similarly in ColorYUV, RGBAdjust, Overlay, ConditionalReader.
:: Allows multiple filter instances to use differently named conditional parameters, thus preventing collision and overwrite of variables which are used by different ConditionalReader instances.
:: See Conditional Variables section of http://avisynth.nl/index.php/ColorYUV.
:: How does it work: when reading the global variables, the "condvarsuffix" parameter is appended to the variable name.
:: E.g. ColorYUV will read "coloryuv_gain_y_a" instead of "coloryuv_gain_y" when condvarsuffix = "_a" is provided for ColorYUV.
:: In the matching ConditionalReader one have to use the modified name as well:

<div {{BoxWidthIndent|80|2}} >
ConditionalReader("coloryuvoffset.txt", "coloryuv_gain_y", false, CondVarSuffix = "_a") # "_a" is added here by parameter
ConditionalReader("rgbfix.txt", "rgbadjust_r", false, CondVarSuffix = "_1") # "_1" is added here by parameter
ConditionalReader("rgbfix2.txt", "rgbadjust_r", false, CondVarSuffix = "_2") # "_2" is added here by parameter
</div>

:: or specify the suffixed name directly:

<div {{BoxWidthIndent|76|2}} >
ConditionalReader("coloryuvoffset.txt", "coloryuv_gain_y_a", false) # "_a" is added here manually
</div>

== Notes ==
*All arguments default—leaves the clip untouched:
<div {{BoxWidthIndent|36|2}} >
RGBAdjust'''(1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1)
</div>

*Keep in mind ALL the channels are not scaled to accommodate changes to one—for that you should use [[Levels]].
:So doing something like:
<div {{BoxWidthIndent|24|2}} >
RGBAdjust(2, 1, 1, 1)
</div>
:will get you a whole lot of clipped red. If you WANT a whole lot of clipped red, there ya go - but if you want MORE red without clipping you'd do
<div {{BoxWidthIndent|36|2}} >
[[Levels]](0, 1, 255, 0, 128).RGBAdjust(2, 1, 1, 1)
</div>
:This would scale all the levels (and average luminance) by half, then double the red. Or more compact
<div {{BoxWidthIndent|24|2}} >
RGBAdjust(1.0, 0.5, 0.5, 1.0)
</div>
:This leaves the red and halves the green and blue.

*To invert the alpha channel
<div {{BoxWidthIndent|24|2}} >
RGBAdjust(a=-1.0, ab=255)
</div>
:Thus alpha pixels values become a=(255-a).
</div>

== Examples ==
<div style="max-width:62em" >
<div id="analyze" style="display:inline;font-size:50%;height:0;line-height:0;overflow:hidden;"></div>
*Demonstrating {{FuncArg|analyze}} output
<div {{BoxWidthIndent|24|2}} >
[[FFmpegSource|FFmpegSource2]]("[http://www.sintel.org/ sintel].mp4")
[[ConvertToRGB32]]
[[BicubicResize]](546, 272)
RGBAdjust(analyze=true)
[[File:RGBAdjust_Ex1.jpg]]
</div>
</div>

== Changes ==
{| border="1"
| {{AvsPluscon}} 3.7.1
| ''analyze'' for 32bit float color spaces
|-
| {{AvsPluscon}} r2915
| Added ''condvarsuffix''
|-
| {{AvsPluscon}} r2724
| Added 32 bit float.
Added ''conditional''
|-
| v2.60
| Added dither.
|-
| v2.56
| Added offsets, gamma, analyze.
|}

[[Category:Internal filters]]
[[Category:Levels and Chroma filters]]

Internal filters

2021-12-09T09:44:58Z

Pinterf: /* Color conversion and adjustment filters */ RGBAdjust to support 32 bit float

<div style="max-width:76em; min-width:48em">
The available (internal) filters are listed here and divided into categories. A short description is added, including the supported [[Color_spaces|color formats]] (and sample types for the audio filters). There are some functions which combine two or more clips in different ways. How the video content is calculated is described for each function, but [[filters_with_multiple_input_clips|here is a summary which explains which properties that the resulting clip will have]].

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

=== Source filters ===

These filters can read media files and return an AviSynth clip. See [[#Debug_filters|debug filters]] for non-file source filters.

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[AviSource]] / [[AviFileSource]] / [[OpenDMLSource]]
| Opens an AVI file.
| [[#Color_formats|All]]
|-
| [[DirectShowSource]]
| Opens a filename using [[DirectShow]].
| [[#Color_formats|All]]
|-
| [[ImageReader]] / [[ImageSource]] / [[ImageSourceAnim]]
| Reads in still or animated images. See [[#Export_filters|ImageWriter]].
| [[#Color_formats|All]]
|-
| [[Import]]
| Imports an AviSynth script into the current script.
| [[#Color_formats|All]]
|-
| [[SegmentedAviSource]] / [[SegmentedDirectShowSource]]
| Loads up to 100 avi files per argument.
| [[#Color_formats|All]]
|-
| [[WavSource]]
| Opens a WAV file or the audio of an AVI file.
| [[#Color_formats|All]]
|}

=== Color conversion and adjustment filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[ColorYUV]]
| Adjusts colors and luma independently.
| [[#Color_formats|YUV <small>{{Sup2|[''8-16bit'']}}</small>]]
|-
| [[ConvertBackToYUY2]]
| Converts a RGB clip back to YUY2.
| [[#Color_formats|RGB]]
|-
| [[ConvertToRGB]]
| Converts to RGB32 unless clip is RGB24.
| [[#Color_formats|All <small>{{Sup2|[''8bit'']}}</small>]]
|-
| [[ConvertToRGB24]] / [[ConvertToRGB32]]
| Converts to 8-bit [[Interleaved]] RGB24 / RGB32.
| [[#Color_formats|All <small>{{Sup2|[''8bit'']}}</small>]]
|-
| [[Convert|ConvertToRGB48]] / [[Convert|ConvertToRGB64]]
| {{AvsPluscon}} Converts to [[Deep_Color|16-bit]], [[Interleaved]] RGB48 / RGB64
| [[#Color_formats|All <small>{{Sup2|[''16bit'']}}</small>]]
|-
| [[Convert|ConvertToPlanarRGB]] /<br>[[Convert|ConvertToPlanarRGBA]]
| {{AvsPluscon}} Converts to [[Planar]] RGB(A) at [[Deep_Color|all bit depths]]
| [[#Color_formats|All]]
|-
| [[ConvertToYUY2]]
| Converts to 8-bit [[Interleaved]] [[YUY2]].
| [[#Color_formats|RGB24/32, YUV <small>{{Sup2|[''8bit'']}}</small>]]
|-
| [[ConvertToYV24]] / [[ConvertToYV16]] / <br>
[[ConvertToYV12]] / [[ConvertToY8]]
| Converts to 8-bit [[Planar]] YV24, YV16, YV12, Y-only.
| [[#Color_formats|All]]
|-
| [[Convert|ConvertToYUV444]] / [[Convert|ConvertToYUV422]] /<br>[[Convert|ConvertToYUV420]] /<br><span style="font-size:96%;letter-spacing:90%">[[Convert|ConvertToYUVA444]] / [[Convert|ConvertToYUVA422]] /<br>[[Convert|ConvertToYUVA420]]</span>
| {{AvsPluscon}} Converts to [[Planar]] YUV(A) at [[Deep_Color|all bit depths]]
| [[#Color_formats|All]]
|-
| [[Convert|ConvertToYUV411]]
| {{AvsPluscon}} Converts to 8-bit [[Planar]] [[YV411]]
| [[#Color_formats|All]]
|-
| [[FixLuminance]]
| Correct shifting vertical luma offset.
| YUY2
|-
| [[Greyscale]]/[[Grayscale]]
| Converts a video to greyscale (no color)
| [[#Color_formats|All]]
|-
| [[Invert]]
| Inverts selected color channels of a video.
| [[#Color_formats|All]]
|-
| [[Levels]]
| Scales and clamps the black and white levels, and adjusts the gamma.
| [[#Color_formats|All <small>{{Sup2|[''8-16bit'']}}</small>]]
|-
| [[Limiter]]
| Clips levels to within CCIR-601 range, and optionally highlights pixels outside that range.
| [[#Color_formats|YUV <small>{{Sup2|[''8-16bit'']}}</small>]]
|-
| [[MergeRGB]] / [[MergeARGB]]
| Select and combine a color channel from each of the input video clips.
| [[#Color_formats|All]]
|-
| [[MergeLuma]] / [[MergeChroma]]
| Merge (blend) chroma or luma from one video clip into another. There is an optional weighting, so a percentage between the two clips can be specified.
| [[#Color_formats|YUV]]
|-
| [[RGBAdjust]]
| Adjusts each color channel separately.
| [[#Color_formats|RGB <small>{{Sup2|[''8-32bit'']}}</small>]]
|-
| [[ShowRed]] / [[ShowGreen]] / [[ShowBlue]] / [[ShowAlpha]]
| Shows the selected channel of an (A)RGB clip.
| [[#Color_formats|RGB]]
|-
| [[SwapUV]]
| Swaps chroma channels.
| [[#Color_formats|YUV]]
|-
| [[Tweak]]
| Adjusts the hue, saturation, brightness, and contrast.
| [[#Color_formats|YUV]]
|-
| [[UToY]] / [[UToY8]] / [[VToY]] / [[VToY8]]
| Copies U or V chroma plane to the Y luma plane.
| [[#Color_formats|YUV]], except [[Y8]]
|-
| [[YToUV]]
| Puts the luma channels of two clips as U and V channels. Luma is now 50% grey.
| [[#Color_formats|YUV]]
|}

=== Overlay and Mask filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[ColorKeyMask]]
| Sets the alpha-channel (similar as Mask does) but generates it by comparing the color.
| [[#Color_formats|RGB32; RGB64 {{AvsPluscon2}}]],<br>[[#Color_formats|All Planar RGB {{AvsPluscon2}}]]
|-
| [[Layer]]
| Puts one clip on top of another using different layer (blend) modes and variable opacity. Supports alpha-channel transparency.
| [[#Color_formats|YUY2, RGB32]];<br>
[[#Color_formats|All]] except YV411 {{AvsPluscon2}}
|-
| [[Mask]]
| Applies an alpha-mask to a clip.
| [[#Color_formats|RGB32; RGB64 {{AvsPluscon2}}]],<br>[[#Color_formats|All Planar RGB {{AvsPluscon2}}]]
|-
| [[MaskHS]]
| This filter returns a mask (as Y8) of clip using a given hue and saturation range.
| [[#Color_formats|YUV]]
|-
| [[Merge]]
| Merge (blend) one video clip into another. There is an optional weighting, so a percentage between the two clips can be specified.
| [[#Color_formats|All]]
|-
| [[Overlay]]
| Puts one clip on top of another with optional XY displacement of the overlaying image, using different overlay (blend) modes and variable opacity. Uses a separate ''mask'' clip for transparency information.
| [[#Color_formats|All]] except YV411
|-
| [[ResetMask]]
| Applies an "all-opaque" alpha-mask to clip.
| [[#Color_formats|RGB32; RGB64 {{AvsPluscon2}}]],
[[#Color_formats|All Planar RGB {{AvsPluscon2}}]]
|-
| [[Subtract]]
| Shows the difference between the corresponding pixels of two clips.
| [[#Color_formats|All]]
|}

=== Geometric deformation filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[AddBorders]]
| Adds black or colored borders around the image.
| [[#Color_formats|All]]
|-
| [[Crop]]
| Crops excess pixels from each frame.
| [[#Color_formats|All]]
|-
| [[CropBottom]]
| Crops excess pixels from the bottom of each frame.
| [[#Color_formats|All]]
|-
| [[FlipHorizontal]] / [[FlipVertical]]
| Flips the video from left to right/upside-down.
| [[#Color_formats|All]]
|-
| [[Letterbox]]
| Blackens out (or colors out) the top and bottom (and optionally left and right) of each frame.
| [[#Color_formats|All]]
|-
| [[HorizontalReduceBy2]] / [[VerticalReduceBy2]] / [[ReduceBy2]]
| Reduces the size of each frame by half horizontally, vertically or in both directions.
| [[#Color_formats|All]]
|-
| [[BicubicResize]] / [[BilinearResize]] / [[BlackmanResize]] / [[GaussResize]] / [[LanczosResize]] / [[Lanczos4Resize]] / [[PointResize]] / [[SincResize]] / [[Spline16Resize]] / [[Spline36Resize]] / [[Spline64Resize]]
| Rescale the input video frames to an arbitrary new resolution, using different sampling algorithms.
| [[#Color_formats|All]]
|-
| [[SkewRows]]
| Skews (or deskews) the rows of a clip.
| RGB24, RGB32,<br>YUY2, Y8
|-
| [[TurnLeft]] / [[TurnRight]] / [[Turn180]]
| Rotates the clip 90 degrees counter-clockwise / 90 degrees clockwise.
| [[#Color_formats|All]]
|}

=== Pixel restoration filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[Blur]] / [[Sharpen]]
| Simple 3x3-kernel blurring/sharpening filter.
| [[#Color_formats|All]]
|-
| [[GeneralConvolution]]
| General 3x3 or 5x5 convolution matrix.
| [[RGB32]]
|-
| [[SpatialSoften]]
| Removes noise from a video clip by selectively blending pixels spatially.
| [[YUY2]]
|-
| [[TemporalSoften]]
| Removes noise from a video clip by selectively blending pixels temporally.
| All except [[RGB24]]<br>and [[Avisynthplus_color_formats|RGB48]] {{AvsPluscon2}}
|-
| [[FixBrokenChromaUpsampling]]
| The free Canopus DV Codec v1.00 upsamples the chroma channels incorrectly (although newer non-free versions appear to work fine). This filter compensates for it.
| YUY2
|}

=== Timeline editing filters ===

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

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

=== Interlace filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[AssumeFrameBased]] / [[AssumeFieldBased]]
| Forces frame-based or field-based material.
| [[#Color_formats|All]]
|-
| [[AssumeBFF]] / [[AssumeTFF]]
| Forces field order.
| [[#Color_formats|All]]
|-
| [[Bob]]
| Takes a clip and [[Wikipedia:Deinterlacing#Field_extension_deinterlacing|bob-deinterlaces]] it.
| [[#Color_formats|All]]
|-
| [[ComplementParity]]
| Changes top fields to bottom fields and vice-versa.
| [[#Color_formats|All]]
|-
| [[DoubleWeave]]
| Operates like [[Weave]], except that it produces double the number of frames by combining both the odd and even pairs of fields.
| [[#Color_formats|All]]
|-
| [[PeculiarBlend]]
| Blends each frame with the following frame in a peculiar way.
| YUY2
|-
| [[Pulldown]]
| Selects two out of every five frames of the source video.
| [[#Color_formats|All]]
|-
| [[SeparateColumns]] / [[SeparateRows]]
| Separates the columns or rows of each frame into new frames.
| [[#Color_formats|All]]
|-
| [[SeparateFields]]
| Splits each frame into its component top and bottom fields.
| [[#Color_formats|All]]
|-
| [[SwapFields]]
| Swaps the two fields in an interlaced frame.
| [[#Color_formats|All]]
|-
| [[Weave]]
| Combines fields together to produce interlaced frames.
| [[#Color_formats|All]]
|-
| [[WeaveColumns]] / [[WeaveRows]]
| Takes a clip and weaves sets of columns or rows together to produce composite frames.
| [[#Color_formats|All]]
|}

=== Audio processing filters ===

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

{{AvsPluscon}} automatic conversion is ''not'' performed. The new behavior is to raise an error when a sample type is not compatible. It is your responsibility to use [[ConvertAudio]] where needed.

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

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

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

=== Conditional and other meta filters ===

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

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[ConditionalFilter]] / [[FrameEvaluate]] / [[ScriptClip]] / [[ConditionalSelect]]
| ''ConditionalFilter'' returns source1 if some condition is met, otherwise it returns source2. ''ScriptClip/FrameEvaluate'' returns the clip which is returned by the function evaluated on every frame. ''ConditionalSelect'' returns one frame from several sources based on an integer evaluator.
| [[#Color_formats|All]]
|-
| [[ConditionalReader]]
| Import information from a text file, with different values for each frame - or a range of frames.
| [[#Color_formats|All]]
|-
| [[WriteFile]] / [[WriteFileIf]] / [[WriteFileStart]] / [[WriteFileEnd]]
| These filters evaluate expressions and output the results to a text-file.
| [[#Color_formats|All]]
|-
| [[Animate]] / [[ApplyRange]]
| ''Animate'' is a meta-filter which evaluates another filter with continuously varying arguments.
''ApplyRange'' 'is a special case of ''Animate'' where ''start_args'' = ''end_args''.
| [[#Color_formats|All]]
|-
| [[TCPServer]] / [[TCPSource]]
| Send clips over your network. You can connect several clients to the same machine.
| [[#Color_formats|All]]
|}

=== Export filters ===

These filters can write directly to media files.

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[ImageWriter]]
| Writes frames as images to your hard disk. See [[#Source_filters|ImageReader]].
| [[#Color_formats|All]]
|}

=== Debug filters ===

{| style="height:100px; width:95%" border="1" cellpadding="4" class="wikitable"
!width=25%| Filter
!width=50%| Description
!width=15%| Color format
|-
| [[BlankClip]] / [[Blackness]]
| Produces a solid color, silent video clip of the specified length (in frames).
| [[#Color_formats|All]]
|-
| [[ColorBars]] / [[ColorBarsHD]]
| Produce a video clip containing SMPTE colorbars scaled to any image size.
| RGB32, YUY2,<br>YV12, YV24
|-
| [[Compare]]
| Compares two clips and prints out information about the differences.
| [[#Color_formats|All]]
|-
| [[DumpFilterGraph]] / [[SetGraphAnalysis]]
| {{AvsPluscon}} This functions are for outputting the flow of filtering as a graph.
| [[#Color_formats|n/a]]
|-
| [[Echo]]
| Forces internal <tt>GetFrame</tt> calls to all input clips. Returns only first clip result.
| [[#Color_formats|All]]
|-
| [[Histogram]]
| A multipurpose audio/video analysis tool.
| [[#Color_formats|All]]
|-
| [[Info]]
| Prints out image and sound information.
| [[#Color_formats|All]]
|-
| [[MessageClip]]
| Produces a clip containing a text message.
| RGB32
|-
| [[Preroll]]
| Preroll the audio or video on non-linear access.
| [[#Color_formats|All]]
|-
| [[ShowFiveVersions]]
| Takes five video clips and combines them in a staggered arrangement from left to right.
| [[#Color_formats|All]]
|-
| [[ShowFrameNumber]] / [[ShowSMPTE]] / [[ShowTime]]
| Draws text on every frame indicating what number AviSynth thinks it is.
| [[#Color_formats|All]]
|-
| [[StackHorizontal]] / [[StackVertical]]
| Takes two or more video clips and displays them together in left-to-right/up-to-down order.
| [[#Color_formats|All]]
|-
| [[Subtitle]]
| Adds anti-aliased text to a range of frames.
| [[#Color_formats|All]]
|-
| [[Tone]]
| Generates a sound.
| Float
|-
| [[Version]]
| Generates a video clip with a short AviSynth version and copyright statement.
| RGB24
|}

{{HiddenAnchor|Color_formats}}

=== Footnotes ===

The above filters work with the following named '''[[Avisynthplus_color_formats|color formats]]'''.

{| style="height:100px; border="1" cellpadding="4" class="wikitable"
|-
!Name
!Formats
|-
| All
| RGB, YUV (detailed below)
|-
| [[RGB]] [[Interleaved]] 
| [[RGB24]], [[RGB32]] <small>{{Sup2|[''8bit'']}}</small><br>[[Avisynthplus_color_formats|RGB48, RGB64]] <small>{{Sup2|[''16bit'']}}</small> {{AvsPluscon2}}
|-
| [[RGB]] [[Planar]]
| [[Avisynthplus_color_formats|RGBP8, RGB'''A'''P8, RGBP'''10''', RGB'''A'''P10 etc]] {{AvsPluscon2}}  
|-
| [[YUV]]
| [[YUY2]] [[Interleaved]], YUV [[Planar]],<br>[[Avisynthplus_color_formats|YUVA Planar]] {{AvsPluscon2}}
|-
| YUV [[Planar]] 
| [[YV12]], [[YV24]]&Dagger;, [[YV16]]&Dagger;, [[YV411]]&Dagger;, [[Y8]]&Dagger; <br>[[Avisynthplus_color_formats|YUV444P8, YUV444P'''10''', YUV444P'''12''' etc]] {{AvsPluscon2}}
|-
| YUVA [[Planar]] 
| [[Avisynthplus_color_formats|YUV'''A'''444P8, YUV'''A'''444P'''10''', YUV'''A'''444P12 etc]] {{AvsPluscon2}}
|}

{| border="0"
|-
| colspan="2"|''Notes and exceptions.''
|-
| style="text-align:right;padding-right:0.5em;width:4.0em" |&Dagger;
| Not supported in AviSynth version 2.58 or below
|-
| style="text-align:right;padding-right:0.5em" |{{AvsPluscon2}}
| [[AviSynth%2B|AviSynth+]] color space only (Deep Color, Planar RGB, YUVA).
|-
| style="text-align:right;padding-right:0.5em" | <small>{{Sup2|[''8bit'']}}</small>
|   8-bit only {{AvsPluscon2}}
|-
| style="text-align:right;padding-right:0.5em" | <small>{{Sup2|[''16bit'']}}</small>
| 16-bit only {{AvsPluscon2}}
|-
| style="text-align:right;padding-right:0.5em" | <small>{{Sup2|[''8-16bit'']}}</small>
| 8, 10, 12, 14, 16 bit (excludes 32-bit floating-point) {{AvsPluscon2}}
|-
| style="text-align:right;padding-right:0.5em" |{{AvsPluscon}}
| [[AviSynth%2B|AviSynth+]] filter only.
|}

</div>

[[Category:AviSynth_Usage]]
[[Category:AviSynth_Syntax]]