Avisynth wiki - User contributions [en]

DeBarrel

2019-06-19T13:11:49Z

Soreepeong: Removed space between negative sign and actual number (Between - 0.5 to 0.5 -> Between -0.5 to 0.5)

{{FilterCat4|External_filters|Plugins|Adjustment_filters|Transformation}}

{{Filter3
|1=[http://www.avisynth.nl/users/vcmohan/ V.C.Mohan]
|2=30 Dec 2016
|3= [http://www.avisynth.nl/users/vcmohan/movePlus/movePlus.7z movePlus.7z]
|4= External filters
|5= [https://www.gnu.org/licenses/gpl-3.0.en.html GPLv3]
|6=[https://forum.doom9.org/showthread.php?t=136083&highlight=DeBarrel Original DeBarrel plugin], [https://forum.doom9.org/showthread.php?t=174163 movePlus]
}}

 
== Description ==

Corrects Barrel type or Pin Cushion type distortions in an image that result in due to camera lens projecting image on to a flat film or sensor array. [http://www.avisynth.nl/users/vcmohan/movePlus/Barrel.html Full Description]

 
== Requirements ==
* AviSynth+ r2347 or later

 
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef| Barrel (clip, float "a", float "b", float "c", bool "pin", float "vh", bool "test", float "ea", float "eb", float "ec", int "nsteps", Int "frame", Int "color", bool "ind", bool "ypin", float "ya", float "yb", float "yc", float "yea", float "yeb", float "yec")}}
 
::{{Par2| |clip| }}
::: Input clip
 
::{{Par2|a|float|0.005}}
::: Coefficient a (xa in independent mode and start val in test mode)
::::* Between -0.5 and 0.5
 
::{{Par2|b|float|0.005}}
::: Coefficient b (xb in independent mode and start val in test mode)
::::* Between -0.5 and 0.5
 
::{{Par2|c|float|0.005}}
::: Coefficient c (xc in independent mode and start val in test mode)
::::* Between -0.5 and 0.5
 
::{{Par2|pin|bool|false}}
::: Whether to correct pin cushion or barrel type distortion
::::* true = pin
::::* false = barrel
 
::{{Par2|vh|bool|1.0}}
::: Vertical to horizontal distortion ratio
::::* Between 0.1 and 10
 
::{{Par2|test|bool|false}}
::: Whether in test mode
::::* true = test
::::* false = normal
 
::{{Par2|ea|float|0.05}}
::: End value of coefficient a in test mode (xea in independent mode)
::::* Between -0.5 and 0.5
 
::{{Par2|eb|float|0.05}}
::: End value of coefficient b in test mode (xeb in independent mode)
::::* Between -0.5 and 0.5
 
::{{Par2|ec|float|0.05}}
::: End value of coefficient c in test mode (xec in independent mode)
::::* Between -0.5 and 0.5
 
::{{Par2|nsteps|int|20}}
::: Number of steps for variation (test mode only)
::::* Between 0 and 100
 
::{{Par2|frame|Int|0}}
::: Input frame number for over lay (test mode only)
::::* Within input clip
 
::{{Par2|color|Int|0}}
::: Color of dots in test mode and left out borders in normal
::::* In RRGGBB format
 
::{{Par2|ind|bool|false}}
::: Whether x and y have independent coefficients
::::* true for independent
::::* false for pin cushion or barrel
 
::{{Par2|ypin|bool|false}}
::: Whether Y direction has pin cushion distortion?
::::* true for pin cushion
::::* false for barrel
 
::{{Par2|ya|float|0.05}}
::: Value of coefficient ya (start value in test mode )
::::* Between -0.5 and 0.5
 
::{{Par2|yb|float|0.05}}
::: Value of coefficient yb (start value in test mode)
::::* Between -0.5 and 0.5
 
::{{Par2|yc|float|0.05}}
::: Value of coefficient yc (start value in test mode)
::::* Between -0.5 and 0.5
 
::{{Par2|yea|float|0.05}}
::: End value of coefficient ya (test mode only)
::::* Between -0.5 and 0.5
 
::{{Par2|yeb|float|0.05}}
::: End value of coefficient yb (test mode only)
::::* Between -0.5 and 0.5
 
::{{Par2|yec|float|0.05}}
::: End value of coefficient yc (test mode only)
::::* Between -0.5 and 0.5

 

== Examples ==

blankclip(width = 720, height = 480, pixel_type = "RGB32", color = $ffffff, length = 10)
grid()
Barrel()

Pin Cushion Distortion
Barrel(a = 0.005, b = 0.005, c = 0.005, pin = false)

 
-----------------------------------------------
'''Back to [[External_filters|External Filters]] ←'''

AnimeIVTC

2016-12-08T03:57:05Z

Soreepeong: Add "IVTC" Category

{{Filter
|thetoof
|2.00
|[[http://forum.doom9.org/showthread.php?t=138305&highlight=AnimeIVTC| Doom9 Thread (original)]][[http://forum.doom9.org/showthread.php?p=1673928| Doom9 Thread (mod)]]
|[[:Category:IVTC|IVTC]] & [[:Category:Decimation|Decimation]]
|
|[[http://creativecommons.org/licenses/by-sa/3.0/| CreativeCommons BY-SA 3.0]]}}

== Abstract ==

 '''Author:''' thetoof '''Version:''' 2.00 '''Discussion:''' [http://forum.doom9.org/showthread.php?t=138305 forum.doom9.org] '''Category:''' IVTC & Decimation 
=== Requirements: ===
 Put all the .dll/.avsi in the "plugins" folder of avisynth. You can get them all [[#V.29_Download|here]].

* TIVTC, TDeint and TMM by tritical [http://forum.doom9.org/showthread.php?t=82264 link]
* nnEDI2 by tritical [http://forum.doom9.org/showthread.php?t=147695 link]
* nnEDI3* by tritical [http://forum.doom9.org/showthread.php?t=147695 link] or for avs 2.6 [http://forum.doom9.org/showthread.php?t=170083 link]
* EEDI2 by tritical, multithreaded version by foxyshadis [http://web.missouri.edu/~kes25c/ link]
* EEDI3* by tritical [[Eedi3|link]]
* yadifmod by tritical [http://avisynth.org.ru/yadif/yadif.html link]
* TGMCmod by thetoof (in 7z archive), original version by Didée here - [http://forum.doom9.org/showthread.php?p=1158000#post1158000 link]
* QTGMC* by -Vit- - [[QTGMC|link]]
* MVTools2 by Fizick [[MVTools|link]]
* RemoveGrain and Repair by kassandro [[RemoveGrain|link]]
* MaskTools by Manao [[MaskTools|link]]
* MaskTools2 by Manao [[MaskTools2|link]]
* Vinverse by tritical (original script by Didée) [http://bengal.missouri.edu/~kes25c/vinverse.zip link]
* MedianBlur by tsp [http://www.avisynth.nl/users/tsp/|link]
* srestore by MOmonster [[Srestore|link]]
* Average by mg262 [http://forum.doom9.org/showthread.php?p=1129919#post1129919 link]
* ReduceFlicker by kassandro [http://home.arcor.de/kassandro/ReduceFlicker/ReduceFlicker.htm link]
* SangNom by MarcFD [[SangNom|link]]
* Toon by Soulhunter (original script by mf, speedups by Didée) [http://forum.doom9.org/showthread.php?t=131454 link]
* Lsfmod by LaTo [http://avisynth.org/mediawiki/LSFmod link], original version by Didée here [http://avisynth.org/mediawiki/LimitedSharpen link]
* aWarpSharp and Toon rewrites by SEt [http://forum.doom9.org/showthread.php?t=147285 link]
* Microsoft Visual C [http://www.microsoft.com/downloads/details.aspx?FamilyID=200b2fd9-ae1a-4a14-984d-389c36f85647&DisplayLang=en link]
* AvsRecursion by kassandro (put in your system32 folder for 32-bit systems... or SysWOW64 for 64-bit systems) [http://home.arcor.de/kassandro/AvsRecursion/AvsRecursion.htm link]
* daa3* [http://avisynth.nl/images/Daa3.avsi]
* and of course, AnimeIVTC by thetoof ;-)

: * required for mod ver..

== I) About anime telecining ==

# Particularities of anime:
- While a film is shot at 24 frames per second (fps), anime is animated at 24fps so there is not necessarily motion on every frame.
- When there is not a lot of movement, it can be displayed at lower framerates like 8 or 12 fps with duplicate(s) of every frame to maintain a constant framerate of 24fps.
- To create the illusion of faster movement, different parts of the image can move at different framerates. In this situation, the image is divided into 2 parts and there are many possible combinations of "intra-frame variable framerate". This is not constant throughout the episode/movie since it changes depending on the amount of motion to be displayed.
- CG animation at 30 fps is sometimes used in anime, so you can also have sequences with movement on every frame without any interlacing nor blends.
- The credits can be truly interlaced to make them run faster without being juddery and unreadable, thus leaving more room for the show.
- The credits can also be at the full progressive framerate on top of the telecined background.

# Basic concepts:
Soft telecine - the stream is encoded at 24 fps and the pulldown is applied during playback.
Hard telecine - your source was telecined before being encoded on the DVD (or before airing).
Double hard telecine - your source has at least one of the "intra-frame variable framerate" situations and the telecining was applied separately on each part of the frame, so the pattern is not constant and many frames are interlaced.
Field blended norm-conversion - Instead of going back to 24fps (film rate), the video streams are directly converted from NTSC (29.97fps) to PAL (25fps) or vice versa, creating ugly fieldblending (looks like DHT when inspecting a frame).
Hybrid - mix of 24t (24 fps displayed at 30 through telecining) and 30p (progressive movement on every frame)
Truly interlaced - each frame contains half the information of two frames, which means that you can bob it to 60p and see movement on every single frame, without any interlacing or blending.
Progressive - No interlacing whatsoever at the full framerate.
3:2 pattern - This pattern repeats itself from the very beginning to the very end of your clip: 3 progressive frames followed by 2 interlaced ones.
VFR - Variable Frame Rate - The sections of the clip run at different framerates, thus allowing to have less frames for the same movement. The duplicates are removed and played during the same amount of time as if there was the original amount of frames.
Lossless rendering pass - Save the file as uncompressed YV12 or Lagarith to apply the script only once and make subsequent filtering/encoding faster. It takes a lot of disk space: around 5GB for a 22 minutes clip @ 23.976fps with Lagarith and 20GB with uncompressed YV12.

# Examples:
Double Hard Telecine - At first, your source may look like a typical Hard Telecined one, but after a more thorough inspection, you'll see that it's actually a DHT one: same source, different high motion scene.
Interlaced on top of telecined (can be hard or double hard) - In this case, it was a hard telecined source. Image
Obviously, since there's no pattern in DHT and interlacing on every frame with pure interlaced material, regular IVTC will output blends and jerkiness.

Apply TComb ''before ''AnimeIVTC if you need to correct dotcrawl.

It is NOT* recommended to use animeivtc with multithreading and/or calling it multiple times in a script. If you want to multithread it, see the [[#examples example scripts|examples example scripts]] below.

: * can be done in mention cases [http://forum.doom9.org/showthread.php?p=1673928 here].

== II) Function descriptions ==

* [[#General settings|General settings]]
* [[#Interlaced or progressive credits|Interlaced or progressive credits]]
* [[#Mode=1 (Hard telecined)|Mode=1 (Hard telecined)]]
* [[#Mode=2 (Field-blended)|Mode=2 (Field-blended)]]
* [[#Mode=3 (Double hard telecined)|Mode=3 (Double hard telecined)]]
* [[#hybrid Mode=4 (Hybrid)|hybrid Mode=4 (Hybrid)]]
<code>AnimeIVTC</code> (<var>clip i, int "mode", int "aa", int "precision", int "killcomb", int "cache", bool "ifade", float "sfthr"*, bool "sfshow"* , bool "chrfix" , bool "blend" , bool "normconv" , int "pattern" , int "pass", bool "rendering" , int "bbob", int "cbob", string "edimode", int "degrain", int "omode" , int "cthresh"* , int "blockx"* , int "blocky"* , int "MI"* , int "tfmm"* , int "pp"* , int "metric"* , int "micmatching"* , int "i1", int "i2", int "e1", int "e2", int "e3", int "p1", int "p2" , bool "dchr"* , bool "palf"* , bool "tcfv1"* , bool "nvfr"* , bool "real30p"* , bool "autoAssuf"* , int "ediandnn"* , bool "o3025cfr"* , int "overlap", int "pel", int "search", bool "nnedi3pel"** , string "credconv" , bool "mode22"* , clip "ediext"* , string "bob4p"* , clip "extbob"* , string "extbobf"* , bool "repwithtdeint"* , float "dark", int "thin", int "sharp", int "smooth", bool "stabilize", int "tradius", int "aapel", int "aaov", int "aablk", string "aatype"</var>)
: * in mod ver. only.
: ** nnedi2pel in original ver..
=== General parameters ===
<var>mode</var> : Required parameter. Defines the function's behavior
** 1 : Hard telecined
** 2 : Field blended
** 3 : Double hard telecine
** 4 : Hybrid
''chrfix'' : Use to correct chroma swap between fields (to find out, apply bob() on your clip and examine the frames. If at some point the chroma of a frame is in the other and vice-versa, the issue is present).
** True
** False (default)
''ifade'' : Detects and corrects interlaced fade-ins. Use for mode=1 or 4 since the clip is bobbed in mode=2 and 3.
** True
** False (default for speed concerns, but enabling it can be safer)
<var>ediandnn</var> : to chose method. it's almost only about quality vs speed.
** 1 : nnedi3 (default)
** 2 : eedi3
** 3 : eedi3+nnedi3
''cache'' : Sets amount of frames to cache for all functions using scriptclip to prevent seeking issues frame order mess-up with temporal filters. Using too much will result in crashing, so use less if you get memory issues.
** 0 to inf. (default=10)
<var>killcomb</var> : Removes any residual combing. Use for mode=1 or 4 since the clip is bobbed in mode=2 and 3.
** 0 : No combing removal (default)
** 1 : Combing removal with vinverse()
** 2 : Slower, but more aggressive combing removal by using mcbob's method
** 3 : Even slower, but better detail preservation and sharpness. Same as aa=3 [daa()]
<var>aa</var> : Antialiasing. None is necessarily better than the others, but one is more adapted to your needs.
[Images/aliased.jpg without][Images/anti-aliasing.jpg with]
** -1: Compare by interleaving the different aa options
** 0 : No aa
** 1 : EEDI2() based aa [can be called externally as ediaa()]
** 2 : Average of a spatial interpolations of each fields contra-sharpening [can be called externally as daa()]
** 3 : Edge targeted Sangnom() aa leaving the rest of the frame untouched - watch out for detail loss... if you can spare some additionnal processing time, take a look at aa=4 [can be called externally as maa()]
** 4 : Line darkening, warp sharpening, edge targeted aa, limited sharpening and temporal stabilizing [can be called externally as SharpAAMCmod()]
'''The following options are meant for aa=4''' [SharpAAMCmod()]
<var>aatype</var> : Select the filter used for aa
** "Sangnom" (default)
** "EEDI2" (slower, but sometimes has better detail preservation than Sangnom)
<var>dark</var> : Line darkening strength by using Toon
** 0 to 1 (default=0.2)
<var>thin</var> : Higher = thinner lines by using warpsharp
** default = 10
<var>sharp</var> : Post-sharpening strength of LSFmod
** 0 to inf. (default = 150)
<var>smooth</var> : Post-softening strength of LSFmod
** 0 to 100 (default = 100)
** -1 = The function will (try to) autocalculate a good value
<var>stabilize</var> : Edge stabilizing through motion compensation with MDegrain's temporal averaging - use if the edges are unstable (trembling, flickering...) or as a edge-directed smart soothe().
** True
** False (default)
<var>tradius</var> : Temporal radius (# of frames*2 1) of the stabilization.
** 0 to 3 (default=2)
<var>aapel</var> : Supersampling factor for motion vector calculations when using stabilize=true. Higner = better, but slower
** 1, 2 or 4 (default=1)
<var>aablk</var> : Size of the blocks for motion vector calculations when using stabilize=true. Larger blocks are less sensitive to noise, are faster, but also less accurate.
** 4, 8 or 16 (default=8 for SD and 16 for HD)
<var>aaov</var> : Overlap of the blocks for motion vector calculation when using stabilize=true. Higner = better, but slower
** Must be even and up to half <var>aablk</var> (default=4 for SD and 8 for HD)

=== Interlaced or progressive credits ===
<var>i1/i2/p1/p2/e1/e2/e3</var> : Give the frame numbers to the function so that each section is processed correctly. Use your '''source''''s frame numbers. You do not have to specify all of them. Example - a bit of the telecined episode interlaced opening credits episode progressive ending credits next episode preview. Use ''e1=w,i1=x,e2=y,p1=z,e3=a''.
** ''i1'' Last frame of the 1st interlaced section of the clip
** ''i2'' Last frame of the 2nd interlaced section of the clip
** ''p1'' Last frame of the 1st progressive section of the clip
** ''p2'' Last frame of the 2nd progressive section of the clip
** ''e1'' Last frame of the 1st telecined/double hard telecined/field blended/hybrid section of the clip
** ''e2'' Last frame of the 2nd telecined/double hard telecined/field blended/hybrid section of the clip
** ''e3'' Last frame of the 3rd telecined/double hard telecined/field blended/hybrid section of the clip
<var>omode</var> : Determines the output framerate
** 1 : Converts the credits to the framerate of the episode to maintain a Constant Frame Rate. Mandatory for norm conversions.
** 2 : Credits are maintained at 29.97 fps (half their full temporal resolution) to create a [[VFR|Variable Frame Rate]] clip. '''Intended for mkv files.'''
<var>credconv</var> : Determines how the credits will be converted for '''''omode=1'''''''''
** "mocomp" : Use motion-compensation. Use when you have low motion backgrounds to get a blend free and stable clip.
** "blend" : Blend frames together to reduce framerate (ugly and fast, but can lead to less disturbing artifacts when you have a high motion background)''''''
** "Drop"* : Drop frames to reduce framerate creds into 24t (ugly and fast, will lead to stuttery motion)''''''
: * in mod ver. only.
<var>overlap</var> : Overlap of the blocks for motion vector calculation. Higner = better, but slower. '''Use for "mocomp"'''.
** 0, 2 or 4 for SD (default=4)
** 0, 2, 4, 6 or 8 for HD (default=8)
<var>pel</var> : Supersampling factor for motion vector calculation. Higner = better, but slower. '''Use for "mocomp"'''.
** 1, 2 or 4 (default=2)
<var>search</var> : Have fun testing. 4 and 5 are usually better than 2 for roughly the same speed. '''Use for "mocomp"'''.
** 2 (Logarithmic search, also named Diamond Search)
** 3 (Exhaustive search) - slowest, but best results SAD-wise (basically the mo-comp is done by calculating the sum of absolute differences between blocks to determine if it is the same element moving or a different one) Attempt at lame joke: no, we're not talking about this here... [http://en.wikipedia.org/wiki/Sexual_arousal_disorder SAD]
** 4 (Hexagon search - similar to x264) (default)
** 5 (Uneven Multi Hexagon search - similar to x264)
<var>nnedi3pel</var> : Use nnEDI3 for interpolation. True = usually better. '''Use for "mocomp"'''.
** true
** false (default)
<var>pass</var> : Creating a VFR clip requires two passes. The file you must use for your final encode/subsequent filtering must be the one generated by pass=2.''' Use for omode=2'''.
** 1 : Open with vdub, file-run video analysis pass, wait until the end, close vdub OR do a rendering pass (saving the filtered clip in a lossless (i.e. with Lagarith or HuffYUV) avi file for further use to avoid computing the same thing twice - once for analysis and another to decimate) (default)
** 2 : Reload the same script with pass=2. Use the new avi file as source if you did a rendering pass. After all subsequent filtering, encode. Then, take the "timecode.txt" file and add it as the timecode for the video stream in mkvmerge.
<var>rendering</var> : If you did a rendering pass , this will only be VFR decimation based on the files written by pass=1.''' Use for omode=2 and pass=2.'''
** True (you did a rendering pass and only want to decimate in pass=2)
** False (you did not create any intermediate file) (default)
<var>cbob</var> : Higher = slower, but more precise... Here, it's ''almost'' about quality vs speed. '''Use for interlaced credits'''.
** 0 : Fastest, TDeint alone
** 1 : Better (TDeint + ediandnn for interpolation)
** 2 : Even better (TDeint + ediandnn + motion mask)
** 3 : Alternate (Yadifmod + ediandnn for interpolation)
** 4 : Most stable bobber around - QTGMC. Slow. (default)
<var>edimode</var> : Tells which filter to use for spatial interpolation with''' ''cbob=4'''''. The "best" one depends on your source. '''Use for interlaced credits'''.
** see EdiMode in [http://avisynth.nl/index.php/QTGMC#Interpolation QTGMC]
** edimode = ediandnn by default in mod ver. unless you set EdiMode
<var>degrain</var> : Temporal radius (# of frames to use * 2 1) for the final degraining step with''' ''cbob=4'''''. Higher = slower more noise removal more stable. '''Use for interlaced credits'''.
** 1 (default)
** 2
** 3

=== Hard telecine (mode=1) ===
<var>precision</var> : Higher = slower, but more precise... Here, it's may about quality vs speed.
** 0 : Fastest, tfm only
** 1 : Better (uses tfm + ediandnn to deinterlace)
** 2 : Even better (tfm + Tdeint + ediandnn for interpolation)
** 3 : Optimal (tfm + Tdeint + ediandnn + motion mask) (default)
** 4 : same as 3 but no blend
** 5 : tfm + yadifmod + ediandnn
** 6 : tfm + Tdeint + motion mask
** 7 : use extbobf\extbob with SelectEven to back to original fps (no blend)
** 8 : for already half extbobf\extbob fps
''blend'' : If you have a case of blend telecine, or blend-deinterlacing of telecined footage. 3:2 pattern - 3 clear, 2 blended. Weight must be 50/50.
** True
** False (default)

=== Field blended (mode=2) ===
<var>bbob</var> : Higher = slower, but more precise... Here, it's ''almost'' only about quality vs speed. Mo-comp is not recommended for blended material, but I left in case you have stability issues with the other bobbers.
** 0 : Fastest, TDeint alone
** 1 : Better (TDeint + nnedi3 for interpolation)
** 2 : Even better (TDeint + nnedi3 motion mask)
** 3 : Alternate (Yadifmod + nnedi3 for interpolation) (default)
** 4 : Most stable bobber around - QTGMC. Slow.
<var>edimode</var> : Tells which filter to use for spatial interpolation with''' ''cbob=4'''''. The "best" one depends on your source.
** same as [http://avisynth.nl/index.php?title=AnimeIVTC#Interlaced_or_progressive_credits cbob]
<var>degrain</var> : Temporal radius (# of frames to use * 2 1) for the final degraining step with''' ''cbob=4'''''. Higher = slower more noise removal more stable.
** 1 (default)
** 2
** 3
''normconv'' : Set to true if your source was blend-converted from PAL to NTSC or vice-versa.
** True : Change framerate to 25fps if your source is NTSC or to 23.976fps if it's PAL
** False : Keep 25fps if source is PAL and 23.976 if source is NTSC (default)

=== Double hard telecine (mode=3) ===
<var>cbob</var> : Higher = slower, but more precise... Here, it's ''almost'' about quality vs speed. '''Use for interlaced credits'''.
** 0 : Fastest, TDeint alone
** 1 : Better (TDeint + ediandnn for interpolation)
** 2 : Even better (TDeint + ediandnn + motion mask)
** 3 : Alternate (Yadifmod + ediandnn for interpolation)
** 4 : Most stable bobber around - QTGMC. Slow. (default)
<var>edimode</var> : Tells which filter to use for spatial interpolation with''' ''cbob=4'''''. The "best" one depends on your source. '''Use for interlaced credits'''.
** see EdiMode in [http://avisynth.nl/index.php/QTGMC#Interpolation QTGMC]
** edimode = ediandnn by default in mod ver.
<var>degrain</var> : Temporal radius (# of frames to use * 2 1) for the final degraining step with''' ''cbob=4'''''. Higher = slower more noise removal more stable.
** 1 (default)
** 2
** 3
<var>pattern</var> : Tells the function how to decimate to 23.976 fps.
** 0 Safest. Uses TDecimate. (default)
** -1 Compare 1 to 5.
** 1 to 5 If your source has a fixed pattern, finding it with -1 and using the appropriate one will be faster and visually better, but as soon as there's a change, everything will be a mess. Be careful.

=== Hybrid (mode=4) ===
<var>precision</var> : Higher = slower, but more precise... Here, it's may about quality vs speed.
** 0 : Fastest, tfm only
** 1 : Better (uses tfm + ediandnn to deinterlace)
** 2 : Even better (tfm + Tdeint + ediandnn for interpolation)
** 3 : Optimal (tfm + Tdeint + ediandnn + motion mask) (default)
** 4 : same as 3 but no blend
** 5 : tfm + yadifmod + ediandnn
** 6 : tfm + Tdeint + motion mask
** 7 : use extbobf\extbob with SelectEven to back to original fps (no blend)
** 8 : for already half extbobf\extbob fps
<var>omode</var> : Determines the output framerate
** 1 : Converts the 30p sections to 24p by blending frames together to maintain a Constant Frame Rate.
** 2 : 30p sections are maintained at 29.97 fps to create a [[VFR|Variable Frame Rate]] clip. '''Intended for mkv files.'''
<var>pass</var> : Creating a VFR clip requires two passes. Rendering passes are only recommended when you have interlaced or progressive credits or when ''ifade=true''. You will not see the results of killcomb and aa in pass=1. The file you must use for your final encode/subsequent filtering must be the one generated by pass=2.''' Use for omode=2'''.
** 1 : Open with vdub, file-run video analysis pass, wait until the end, close vdub OR do a rendering pass (saving the filtered clip in a lossless (i.e. with Lagarith or HuffYUV) avi file for further use to avoid computing the same thing twice - once for analysis and another to decimate) (default)
** 2 : Reload the same script with pass=2. Use the new avi file as source if you did a rendering pass. After all subsequent filtering, encode. Then, take the "timecode.txt" file and add it as the timecode for the video stream in mkvmerge.
<var>rendering</var> : If you did a rendering pass , this will only be VFR decimation based on the files written by pass=1.''' Use for omode=2 and pass=2.'''
** True (you did a rendering pass and only want to decimate in pass=2)
** False (you did not create any intermediate file) (default)

== III) Examples ==
AnimeIVTC is quite easy to use... if you have questions after reading this manual, please post in the AnimeIVTC thread.
Here is a way to multithread it, but you can use the concept in many different ways (loading from different hard drives outputting to different hard drives and so forth). I only used 3 threads because more was too much for the source HDD, even when writing to 4 different ones. Do NOT use for VFR encodes, where analysis and decimation must be done in one shot.
<nowiki>
xxxsource("file.ext")
threads = 3
s=AnimeIVTC([settings])
a=s.trim(0,int(framecount(s)/threads))
b=s.trim(int(framecount(s)/threads) 1,int(framecount(s)/threads-1))
c=s.trim(int(framecount(s)/threads-1) 1,0)
a #load this script in vdub and save as rendering1, then change a to b and save as rendering2, ideally on a different HDD... etc etc

#then, for further processing or encoding, load your different files and splice them, such as:
#a=avisource(rendering1 file with path)
#b=avisource(rendering2 file with path)
a b .....
</nowiki>
 
== IV) Revisions ==

2.00 Released 2010-01-07 by thetoof

** v2 because of the syntax changes
** Compatibility with MVtools2
** Compatibility with srestore for field blended
** New (and better) decimation for dht
** The user will determine the end frames of every sections in case of progressive/interlaced credits and the rest will all be done internally (no need to switch between the checks since it was a pain)
** Handling of the blend-decimation of hybrid sections in omode=1
** More aa and killcomb options
** New parameter to fix chroma swap between fields
** New parameter to fix blend telecine
** New parameter to fix interlaced fade-ins
** The modes are "re-thought" : mode=1 (hard telecine) mode=2 (field blended) mode=3 (double hard telecine) mode=4 (hybrid) At the moment you define a frame # for interlaced or progressive credits, the function adapts itself
** Memory usage decreased for a few modes
** No need to specify the region of your source (done internally) Single parameter added (bool "normconv") to go from one to another
** More accurate external pelclip with nnedi2 for optimal motion vectors calculation
** Rewriting of the function from scratch to prevent memory waste and other issues (I had patched with a few tricks here and there which made it harder to read. It's almost all gone now)
** Maybe a few other things I'll add when I remember what I changed in the last year or so ;)
1.06 Released 2008-10-08 by thetoof
** Fixed bug when using mode=6 with the checks
** Faster aa=4 when settings=0
** Fixed mt=false issues
** Fixed 1/2-pel registration error between the original and antialiased clip, due to EEDI2 for aa=1
** Fixed bug where edge masking was disabled with mc=false
** Added aatype argument to aa=4 (use sangnom or eedi2 for anti-aliasing)
** aapel's default is now 1 (faster)
** re-added idx for aa=4 (faster)
** Removed useless messages in the checks
** Changed AssumeFPS with ChangeFPS for region conversions
** Added RequestLinear call after cdeblend to prevent false "hey, it's not deblending well" assumptions when seeking
** Added AvsRecursion & aWarpsharp to the requirements archive
** Added corrected TempGaussMC_beta1mod
** Updated the docs to include the info on how to combine the lossless rendering pass and the analysis pass with vfr decimation
1.05 Released 2008-09-18 by thetoof
** Added string "edimode"
** Added int "degrain"
** Fixed typos in the docs
** Removed ineffective error message about the external audio file
** Added the plugins needed for aa=4 bob/precision=3 in the "requirements" archive & list
1.04 Released 2008-09-17 by thetoof
** Fixed check=3 and check=10 to be compatible with the new add-ons
** Corrected typo in the error message asking to specify the omode
** Disabled aa comparison when using one of the check=x
** nnedipel's default is now false
** Changed the order of the filters so that all the stream (not only the ivtced sections) can be processed with killcomb and aa
** Fixed syntax errors with mode=7
1.03 Released 2008-09-16 by thetoof
** Fixed bug when splicing clips at different framerates
** Fixed bug where frames were lost to decimation in mode=6
** Fixed bug causing the "tfm.txt" file to be overwritten every time the script was loaded
** Fixed idx values in the MVAnalyse and MVFlowFPS calls
** Use of 2 different pelclips if prefiltered clip is used before motion vectors calculation to prevent b0rked output
** Removed omode=3 for optimal vfr decimation
** Less memory usage by using a named clip for all the blankclips
** Changed syntax to be compatible with the newest version of mrestore
** Faster blends and duplicates detection for decimate=5 by using dclip=i.bob().reduceflicker(strength=1) in mrestore
** Replaced nnediaa with ediaa for better aliasing removal (aa=1)
** Added functions in the script to fix "There is no function named iseven/isodd" bug
** Added "MT" parameter to use with the multithreaded version of MVTools
** Added support for fieldblended PAL & norm-conversion restoration
** Added support for 30p credits on top of telecined background
** New check function to get the frame numbers of the 30p sections (check=0)
** New check function to see the prefiltered clip of the 30p sections (check=9)
** Argument "pureint" changed to "mix"
** 15 new "mix" modes for all the possibilities for 30p and 30i credits
** Replaced decimate=0 with pass=0
** New AA function by Mystery Keeper (aa=4)
** Re-added the possibility to use killcomb=0, but default remains 1
** Changed "precision"'s default to 3 for all modes
** Cosmetic changes
** Included TempGaussMC_beta1mod in the requirements package to make bob=3 work with the new "MT" parameter
** Docs update formatting improvement, reformulation here and there...
1.02 Released 2008-06-19 by thetoof
** No more "HD" setting (done automatically)
** Vinverse can't be removed from the filter chain, resulting in a speed improvement (killcomb=0 doesn't exist anymore)
** Decimate=0 can be used with any mode as a preparation to mode=7 (run a lossless rendering pass of decimate=0 and then load the resulting file with mode=7) for compressibility improvement through VFR
1.01 Released 2008-06-12 by thetoof
** Correction of syntax errors for mode=7
1.00 Released 2008-06-01 by thetoof
** Initial release of the function. 
== V) Download ==

=== [http://www.mediafire.com/download.php?kjjlukmmdzj Download AnimeIVTC 1.6 & all necessary plugins (7z/2.48 MB)] ===

=== [http://www.mediafire.com/download/go4earhv7ju3btc/AnimeIVTC+Requeriments+v2.7z Download AnimeIVTC 2.0 & all necessary plugins (7z/1.65 MB)] ===

=== [http://pastebin.com/Z1vqnPev AnimeIVTC 2.0 2015-10-28 mod] ===

=== [http://www.mediafire.com/download/flq1s9nobrh81w7/AnimeIVTC_en_espa%C3%B1ol_v2.00.pdf AnimeIVTC_en_español_v2.00.pdf] by Overdrive80 ===

[[Category:External filters]]
[[Category:IVTC]]
[[Category:Decimation]]

FFmpegSource

2016-05-31T03:07:09Z

Soreepeong: Added possible workaround when FFVS cannot seek accurately for mpegts streams

{{FilterCat|External_filters|Plugins|Source_filters}}
{{Filter5
|1={{Author/Myrsloik}}, et al.
|2=v2.22
|3=[http://github.com/FFMS/ffms2/releases FFMS2 v2.22]
|4=[http://forum.doom9.org/member.php?u=135430 10bithack version]
|5=[http://github.com/FFMS/ffms2/blob/master/doc/ffms2-avisynth.md User Manual]
|6=Source filters
|7=[http://opensource.org/licenses/MIT MIT] / binary is [http://www.gnu.org/licenses/gpl.txt GPLv3]
|8=[http://forum.doom9.org/showthread.php?t=127037 Doom9 Thread]}}

== Description ==
<div style="max-width:62em" >
Opens files using [http://www.ffmpeg.org/ FFmpeg] and nothing else. May be frame accurate on good days. The source is MIT licensed and can be obtained from the [http://github.com/FFMS/ffms2/ GitHub repository]. The precompiled binary is GPL3 licensed.
 
</div>
== Requirements ==
<div style="max-width:62em" >
* AviSynth 2.6.0 or [http://sourceforge.net/projects/avisynth2/ greater]
* Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]] 
:([[High_bit-depth_Support_with_Avisynth#Importing_High_Bit-depth_Video_into_AviSynth|10-bit formats]] are supported with the 10bithack version - see alternate download above)
</div>
== Limitations ==
<div style="max-width:62em" >
*Because of LAVF's demuxer, most raw streams (such as elementary h264 and other mpeg video streams) will fail to work properly.

*'''FFAudioSource''' will have to remake any index implicitly created by '''FFVideoSource''' and therefore code like
<div {{ListItemContinue}} >
  <code>AudioDub( FFVideoSource(X), FFAudioSource(X) )</code> 
will require two indexing passes. Apart from the time consumed this is harmless. To work around it open the audio first: 
  <code>A = FFAudioSource(X)</code> 
  <code>V = FFVideoSource(X)</code> 
  <code>AudioDub(V, A)</code> 
('''FFmpegSource2''' does this for you with a single function call) or use '''FFIndex''', like so: 
  <code>FFIndex(X)</code> 
  <code>AudioDub( FFVideoSource(X), FFAudioSource(X) )</code>.
</div>
*Interlaced H.264 mostly works these days, but seeking may occasionally result in corruption.
*Transport Streams will not decode reliably without {{FuncArg|seekmode}} -1.
*Open-GOP H.264 will sometimes produces corruption when seeking.
</div>
== Known Issues ==
<div style="max-width:62em" >
(''NOTE this section does not appear in the [http://github.com/FFMS/ffms2/blob/master/doc/ffms2-avisynth.md latest documentation] and may be obsolete'')
* Interlaced H.264 is decoded in an odd way; each field gets its own full-height frame and the fieldrate is reported as the framerate, and furthermore one of the fields (odd or even) may "jump around". To get the correct behavior, you can try setting {{FuncArg|fpsnum}} and {{FuncArg|fpsden}} so that the framerate is halved (may or may not work). This issue is caused by libavcodec.
</div>
== Compatibility ==
<div style="max-width:62em" >
===Video===

*AVI, MKV, MP4, FLV: Frame accurate
*WMV: Frame accurate(?) but avformat seems to pick keyframes relatively far away
*OGM: Frame accurate(?)
*VOB, MPG: Seeking seems to be off by one or two frames now and then
*M2TS, TS: Seeking seems to be off a few frames here and there
**As MP4 container supports MPEG2/4 video stream, when seeking is off, you can try copying the stream to MP4 container (maybe without audio.) With FFmpeg: <code>ffmpeg -i file.m2ts -c:v copy -an file.mp4</code>. You might have to specify <code>-fflags +genpts</code> before <code>-i</code>.
*Image files: Most formats can be opened if seekmode=-1 is set, no animation support

===Audio===

Seeking should be sample-accurate with most codecs in AVI, MKV, MP4 and FLV.

Decoding linearly will almost always give correct results, and forward-seeks from trimming should result in at most a few hundred samples of corruption.
 
</div>
== Indexing and You ==
<div style="max-width:62em" >
Before '''FFMS2''' can open a file, it must be indexed first so that keyframe/sample positions are known and seeking is easily accomplished. This is done automatically when using '''FFVideoSource''' or '''FFAudioSource''', but if you want to you can invoke the indexing yourself by calling '''FFIndex''', or by running <tt>ffmsindex.exe</tt>. By default the index is written to a file so it can be reused the next time you open the same file, but this behavior can be turned off if desired.

If you wonder why '''FFMS2''' takes so long opening files, the indexing is the answer. If you want a progress report on the indexing, you can use the supplied <tt>ffmsindex.exe</tt> command line program.
 
</div>
== Function Reference ==
<div style="max-width:62em" >
=== FFmpegSource2 ===
{{FuncDef|FFmpegSource2(string ''source'' [, int ''vtrack'', int ''atrack'' , 
     bool ''cache'', string ''cachefile'', int ''fpsnum'', int ''fpsden'', 
     int ''threads'', string ''timecodes'', int ''seekmode'', bool ''overwrite'', 
     int ''width'', int ''height'', string ''resizer'', string ''colorspace'', 
     int ''rffmode'', int ''adjustdelay'', bool ''utf8'', string ''varprefix'' ] )
}}

:{{Par2|source|string|(required)}}
::Path of the file to be opened.

:{{Par2|vtrack|int|-1}}
::The video track number to open, as seen by the relevant demuxer. Track numbers start from zero, and are guaranteed to be continous (i.e. there must be a track 1 if there is a track 0 and a track 2). {{FuncArg|vtrack}}=-1 (the default) means open the first video track. Note that this filter's idea about what ''track'' has what ''number'' may be completely different from what some other application might think.

:{{Par2|atrack|int|-2}}
::The audio track to open. {{FuncArg|atrack}}=-1 means select the first available track. {{FuncArg|atrack}}=-2 (the default) means audio is disabled.

:{{Par2|cache|bool|true}}
::If set to true (the default), this filter will first check if the {{FuncArg|cachefile}} contains a valid index, and if it does, that index will be used. If no index is found, all video tracks will be indexed, and the indexing data will be written to {{FuncArg|cachefile}} afterwards. If set to false, this filter will not look for an existing index file; instead all video tracks will be indexed when the script is opened, and the indexing data will be discarded after the script is closed; you will have to index again next time you open the script.

:{{Par2|cachefile|string|source + ".ffindex"}}
::The filename of the index file (where the indexing data is saved). Defaults to <tt>sourcefilename.ffindex</tt>.

:{{Par2|fpsnum|int|-1}}
:{{Par2|fpsden|int|1}}
::Controls the framerate of the output; used for VFR to CFR conversions. If {{FuncArg|fpsnum}} is less than or equal to zero (the default), the output will contain the same frames that the input did, and the frame rate reported to Avisynth will be set based on the input clip's average frame duration. If {{FuncArg|fpsnum}} is greater than zero, this filter will force a constant frame rate, expressed as a rational number where {{FuncArg|fpsnum}} is the numerator and {{FuncArg|fpsden}} is the denominator. This may naturally cause dropped or duplicated frames to achieve the desired frame rate, and the output is not guaranteed to have the same number of frames that the input did.

:{{Par2|threads|int|-1}}
::The number of decoding threads to request from [http://ffmpeg.org/libavcodec.html '''libavcodec''']. Setting it to less than or equal to zero means it defaults to the number of logical CPUs as reported by Windows. Note that this setting might be completely ignored under a number of conditions; most commonly because a lot of decoders actually do not support multithreading. Default -1.

:{{Par2|timecodes|string|""}}
::Filename to write [http://matroska.org/technical/specs/notes.html Matroska v2 timecodes] for the opened video track. If the file exists, it will be truncated and overwritten. Set to the empty string to disable timecodes writing (this is the default).

:{{Par2|seekmode|int|1}}
::Controls how seeking is done. Mostly useful for getting uncooperative files to work. Valid modes are:
::*-1: Linear access without rewind; i.e. will throw an error if each successive requested frame number isn't bigger than the last one. Only intended for opening images but might work on well with some obscure video format.
::*0: Linear access (i.e. if you request frame n without having requested all frames from 0 to n-1 in order first, all frames from 0 to n will have to be decoded before n can be delivered). The definition of slow, but should make some formats "usable".
::*1: Safe normal (the default). Bases seeking decisions on the keyframe positions reported by libavformat.
::*2: Unsafe normal. Same as mode 1, but no error will be thrown if the exact seek destination has to be guessed.
::*3: Aggressive. Seeks in the forward direction even if no closer keyframe is known to exist. Only useful for testing and containers where libavformat doesn't report keyframes properly.

:{{Par2|overwrite|bool|false}}
::If set to true, this filter will reindex the source file and overwrite the index file even if the index file already exists and is valid. Mostly useful for trackmask changes and testing.

:{{Par2|width|int|-1}}
:{{Par2|height|int|-1}}
::Sets the resolution of the output video, in pixels. Setting either dimension to less than or equal to zero (which is the default) means the resolution of the first decoded video frame is used for that dimension. These parameters are mostly useful because FFMS2 supports video streams that change resolution mid-stream; since Avisynth does not, these parameters are used to set single resolution for the output.

:{{Par2|resizer|string|"BICUBIC"}}
::The resizing algorithm to use if rescaling the image is necessary. If the video uses subsampled chroma but your chosen output colorspace does not, the chosen resizer will be used to upscale the chroma planes, even if you did not request an image rescaling. The available choices are <code>FAST_BILINEAR</code>, <code>BILINEAR</code>, <code>BICUBIC</code> (default), <code>X</code>, <code>POINT</code>, <code>AREA</code>, <code>BICUBLIN</code>, <code>GAUSS</code>, <code>SINC</code>, <code>LANCZOS</code> and <code>SPLINE</code>. Note that <code>SPLINE</code> is completely different from Avisynth's builtin Spline [[Resize|resizers]].

:{{Par2|colorspace|string|""}}
::Convert the output from whatever it was to the given colorspace, which can be one of <code>YV12</code>, <code>YUY2</code>, <code>RGB24</code> or <code>RGB32</code>. Setting this to an empty string (the default) means keeping the same colorspace as the input.

:{{Par2|rffmode|int|0}}
::Controls how RFF flags in the video stream are treated (RFF = ''Repeat First Field''; used in 3:2 pulldown[http://wayback.archive.org/web/20150120040340/http://msdn.microsoft.com/en-us/library/windows/desktop/aa367729%28v=vs.85%29.aspx]). In other words, it's equivalent to the "field operation" mode switch in [[DVD2AVI]]/[[DGIndex]]. Valid modes are:
::*0: Ignore all flags (the default mode).
::*1: Honor all pulldown flags.
::*2: Equivalent to DVD2AVI's "force film" mode.
::Note that using modes 1 or 2 will make FFMS2 throw an error if the video stream has no RFF flags at all. When using either of those modes, it will also make the output be assumed as CFR, disallow vertical scaling and disallow setting the output colorspace. <code>FFPICT_TYPE</code> will also not be set as the output is a combination of several frames. Other subtle behavior changes may also exist.

:{{Par2|adjustdelay|int|-1}}
::Controls how audio delay is handled, i.e. what happens if the first audio sample in the file doesn't have a timestamp of zero. The following arguments are valid:
::*-3: No adjustment is made; the first decodable audio sample becomes the first sample in the output.
::*-2: Samples are created (with silence) or discarded so that sample 0 in the decoded audio starts at time zero.
::*-1: Samples are created (with silence) or discarded so that sample 0 in the decoded audio starts at the same time as frame 0 of the first video track. This is the default, and probably what most people want.
::*Any integer >= 0: Same as -1, but adjust relative to the video track with the given track number instead. If the provided track number isn't a video track, an error is raised.
::-2 obviously does the same thing as -1 if the first video frame of the first video track starts at time zero. In some containers this will always be the case, in others (most notably 188-byte MPEG TS) it will almost never happen.

:{{Par2|utf8|bool|false}}
::If set to true, this filter will assume that the .avs script is encoded as UTF-8 and therefore interpret all filenames as UTF-8 encoded strings. This makes it possible to open files with odd filenames that otherwise would not be openable.

::'''NOTE:''' You must make sure you save the .avs file without a BOM (byte-order marker) or Avisynth will refuse to open it. Notepad will write a BOM, so use something else.

::You should also note that setting this parameter incorrectly will cause all file openings to fail unless your filenames are exclusively 7-bit ASCII compatible.

:{{Par2|varprefix|string|""}}
::A string that is added as a prefix to all [[#Exported_AviSynth_variables|exported]] Avisynth variables. This makes it possible to differentiate between variables from different clips.

* Note, ''FFMS2'' is a shorter name (added in v2.22) for ''FFmpegSource2''. The syntax is the same for both.

=== Other Functions ===
For complete documentation see the [http://github.com/FFMS/ffms2/blob/master/doc/ffms2-avisynth.md#function-reference FFMS2 GitHub page].
{{PluginFilterTable2}}
{{PluginFilterRow|FFmpegSource|FFIndex|
Indexes a number of tracks in a given source file and writes the index file to disk, where it can be picked up and used by <tt>FFVideoSource</tt> or <tt>FFAudioSource</tt>.
|
}}
{{PluginFilterRow|FFmpegSource|FFAudioSource|
Opens audio. Invokes indexing of all tracks if no valid index file is found, or if the requested track isn't present in the index.
|
}}
{{PluginFilterRow|FFmpegSource|FFVideoSource|
Opens video. Will invoke indexing of all video tracks (but no audio tracks) if no valid index file is found.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFmpegSource2|
A convenience function that combines the functionality of '''FFVideoSource''' and '''FFAudioSource''' (see above).
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFMS2|
A shorter '''FFmpegSource2''' alias, this feature was added in v2.22.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFImageSource|
A convenience alias for '''FFVideoSource''', with the options set optimally for using it as an image reader. Disables caching and seeking for maximum compatiblity.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFSetLogLevel|
Sets the FFmpeg logging level, i.e. how much diagnostic spam it prints to STDERR.
|
}}
{{PluginFilterRow|FFmpegSource|FFGetLogLevel|
Returns the current log level, as an integer.
|
}}
{{PluginFilterRow|FFmpegSource|FFGetVersion|
Returns the '''FFMS2''' version, as a string.
|
}}
{{PluginFilterRowNote|
'''Note''': the following functions are provided by <tt>[http://raw.githubusercontent.com/FFMS/ffms2/master/etc/FFMS2.avsi FFMS2.avsi]</tt> and are not available unless that script has been imported or [[Plugins#Plugin_Autoload_and_Name_Precedence|autoloaded]].
}}
{{PluginFilterRow|FFmpegSource|FFFormatTime|
A helper function used to format a time given in milliseconds into a h:mm:ss.ttt string. Used internally by '''FFInfo'''.
|
}}
{{PluginFilterRow|FFmpegSource|FFInfo|
A helper function similar to Avisynth's internal [[Info|Info()]] function; shows general information about the current frame.
|
}}
|}
</div>

== Exported AviSynth variables ==
<div style="max-width:62em" >
All variable names are prefixed by the {{FuncArg|varprefix}} argument to the respective '''FFVideoSource''' or '''FFAudioSource''' call that generated them.

'''NOTE''': these exported variables are mostly [[Runtime_environment|Runtime variables]], requiring [[ScriptClip]] etc to read them.
 
 
<code>'''FFSAR_NUM, FFSAR_DEN, FFSAR'''</code>

The playback aspect ratio specified by the container. <tt>FFSAR_NUM</tt> and <tt>FFSAR_DEN</tt> make up the rational number of the ratio; <tt>FFSAR</tt> is only provided for convenience and may not be set in case it cannot be calculated (i.e. if <tt>FFSAR_DEN</tt> is zero).
 
 

<code>'''FFCROP_LEFT, FFCROP_RIGHT, FFCROP_TOP, FFCROP_BOTTOM'''</code>

The on-playback cropping specified by the container.
 
 

<code>'''FFCOLOR_SPACE'''</code>

The colorimetry the input claims to be using. Only meaningful for YUV inputs. The source for this variable is a metadata flag that can arbitrarily be set or manipulated at will by incompetent users or buggy programs without changing the actual video content, so blindly trusting its correctness is not recommended.

The value is exported as a cryptic numerical constant that matches the values in the MPEG-2 specification. You can find the gory details in the FFMS2 API documentation, but the important ones are:
<div {{BoxWidthIndent|56|1}} >
0: RGB (usually indicates the stream isn't actually YUV, but RGB flagged as YUV)
1: ITU-R Rec.709
2: Unknown or unspecified
5 and 6: ITU-R Rec.601
</div>
<code>'''FFCOLOR_RANGE'''</code>

The color range the input video claims to be using. Much like <tt>FFCOLOR_SPACE</tt>, the source for this variable is a metadata flag that can freely be set to arbitrary values, so trusting it blindly might not be a good idea.

Note that using <tt>SWScale</tt>() or the width/height/colorspace parameters to '''FFVideoSource''' may under some circumstances change the output color range.
<div {{BoxWidthIndent|56|1}} >
0: Unknown/unspecified
1: Limited range (usually 16-235)
2: Full range (0-255)
</div>
<code>'''FFPICT_TYPE'''</code>

The picture type of the most recently requested frame as the ASCII number of the character listed below. Use <tt>Chr</tt>() to convert it to an actual letter in AviSynth. Use {{FuncArg|after_frame}}<tt>=true</tt> in AviSynth's conditional scripting for proper results. Only set when {{FuncArg|rffmode}}<tt>=0</tt>. The FFmpeg source definition of the characters:
<div {{BoxWidthIndent|56|1}} >
I: Intra
P: Predicted
B: Bi-dir predicted
S: S(GMC)-VOP MPEG4
i: Switching Intra
p: Switching Predicted
b: FF_BI_TYPE (no good explanation available)
?: Unknown
</div>
<code>'''FFVFR_TIME'''</code>

The actual time of the source frame in milliseconds. Only set when no type of CFR conversion is being done ({{FuncArg|rffmode}} and {{FuncArg|fpsnum}} left at their defaults).
 
 
<code>'''FFCHANNEL_LAYOUT'''</code>

The audio channel layout of the audio stream. This is exported as a very cryptic integer that is constructed in the same way as the <tt>dwChannelMask</tt> property of the Windows <tt>WAVEFORMATEXTENSIBLE</tt> struct. If you don't know what a <tt>WAVEFORMATEXTENSIBLE</tt> is or what the <tt>dwChannelMask</tt> does, don't worry about it.
 
 
<code>'''FFVAR_PREFIX'''</code>

The variable prefix of the last called FFMS source function. Note that this is a global variable.
 
 
==C Plugin==
The C plugin supports the additional [[planar]] colorspaces in AviSynth 2.6. Also starting with <tt>r940+64</tt> it removes the Matroska demuxer too. This means that the *only* demuxer this build of FFMS2 uses is LAVF. The test this time is whether VP8 (and maybe VP9) bearing WebM files can be used correctly with the LAVF demuxer. 
*'''Discussion''' - [http://forum.doom9.org/showthread.php?p=1762372#post1762372 Doom9 Thread]

*'''Download''' - [http://www.mediafire.com/download/k3yoexl7xsvqv3m/ffms2_r1110%2B98-avs%2Bvsp.7z FFMS2 C-plugin r1110+98]

'''Note:''' C-plugins must be loaded using [[Plugins#LoadCPlugin|LoadCPlugin]].
 
</div>

== External Links ==
<div style="max-width:62em" >
*[http://forum.doom9.org/showthread.php?t=127037 Doom9 Forum] - FFmpegSource discussion.
*[http://github.com/FFMS/ffms2 GitHub] - Source code repository.
 
</div>
-----------------------------------------------
'''Back to [[External_filters#Source_Filters|External Filters]] ←'''