View source for FrameRateConverter

{{FilterCat5|External_filters|Plugins|Plugins_x64|Adjustment_filters|Frame_Rate_Conversion}}
{{Filter3
|[https://github.com/mysteryx93 mysteryx93]
|v1.3
|[https://github.com/mysteryx93/FrameRateConverter/releases FrameRateConverter-v1.3.zip]
|Frame Rate Converters
|
|6=[https://forum.doom9.org/showthread.php?t=174793 Doom9 Forum]}}
== Description == 
Script and plugin set to increase the frame rate with interpolation and fine artifact removal.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.6.0]
* [x64]: [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]


====Required Plugins====
Latest versions of the following filters are recommended unless stated otherwise.<br>

*FrameRateConverter.dll
*[[MaskTools2]]
*[[MVTools]]
*[[GRunT]] - for debug only
<br>

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

===FrameRateConverter.avsi===
Script containing <code>FrameRateConverter()</code> and <code>InterpolateDoubles()</code> functions.
<br>
<br>
==== FrameRateConverter ====
:{{Template:FuncDef|FrameRateConverter (clip C, int "NewNum", int "NewDen", string "Preset", int "BlkSize", int "BlkSizeV", bool "FrameDouble", string "Output", bool "Debug", clip "Prefilter", int "MaskThr", int "MaskOcc", int "SkipThr", int "BlendOver", int "SkipOver", bool "Stp", int "Dct", int "DctRe", int "BlendRatio")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2|NewNum|int| }}
:::The new framerate numerator (if FrameDouble = false, default = 60).
<br>
::{{Par2|NewDen|int| }}
:::The new framerate denominator (if FrameDouble = false, default = 1)
<br>
::{{Par2|Preset|string|"normal"}}
:::The speed/quality preset: [ <code>"slowest" | "slower" | "slow" | "normal" | "fast" | "faster" | "anime"</code> ]
<br>
::{{Par2|BlkSize|int| }}
:::The block size; available sizes are 6, 8, 12, 16, 24, 32, 48 and 64.
:::Defaults for 4/3 video of height:
:::*0-359:  8
:::*360-749: 12
:::*750-1199: 16
:::*1200-1699: 24
:::*1600-2160: 32
<br>
::{{Par2|BlkSizeV|int|BlkSize}}
:::The vertical block size. (default = BlkSize)
<br>
::{{Par2|FrameDouble|bool|true}}
:::Whether to double the frame rate and preserve original frames (default = true)
<br>
::{{Par2|Output|string|"auto"}}
:::Output mode [ <code>"auto" | "flow" | "over" | "none" | "raw" | "mask" | "skip" |" diff" | "stripe"</code>  ] (default = "auto")
:::auto=normal artifact masking; flow=interpolation only; over=mask as cyan overlay, stripes mask as yellow; none=ConvertFPS only; raw=raw mask; 
:::mask=mask only; skip=mask used to Skip; diff=mask where alternate interpolation is better; stripe=mask used to cover stripes.
<br>
::{{Par2|Debug|bool|false}}
:::Whether to display AverageLuma values of Skip, Mask and Raw. (Default = false)
<br>
::{{Par2|Prefilter|clip|none}}
:::Specifies a prefilter such as RgTools' RemoveGrain(21). Recommended only when not using a denoiser (Default=none)
<br>
::{{Par2|MaskThr|int|120}}
:::The threshold where a block is considered bad, between 0 and 255. Smaller = stronger.
:::0 to disable artifact masking. (Default = 120)
<br>
::{{Par2|MaskOcc|int|105}}
:::Occlusion mask threshold, between 0 and 255. 0 to disable occlusion masking. (Default = 105)
<br>
::{{Par2|SkipThr|int|55}}
:::The threshold where a block is counted for the skip mask, between 0 and 255. Smaller = stronger.
:::Must be smaller (stronger) than MaskThr. (Default = 55)
<br>
::{{Par2|BlendOver|int|70}}
:::Try fallback block size when artifacts cover more than specified threshold, or 0 to disable.
:::If it fails again, it will revert to frame blending. (default = 70)
<br>
::{{Par2|SkipOver|int|210}}
:::Skip interpolation of frames when artifacts cover more than specified threshold,  or 0 to disable. (Default = 210)
<br>
::{{Par2|Stp|bool|true}}
:::Whether to detect and blend stripes (default=true)
<br>
::{{Par2|Dct|int|0}}
:::Overrides DCT parameter for MAnalyse (default: Normal=0, Slow=4, Slowest=1)
<br>
::{{Par2|DctRe|int|0}}
:::Overrides DCT parameter for MRecalculate (default: Fast=0, Normal=4, Slowest=1)
<br>
::{{Par2|BlendRatio|int|40}}
:::Changes the blend ratio used to fill artifact zones. 0 = frame copy and 100 = full blend.
:::Other values provide a result in-between to eliminate ghost effects. Default = 40.
<br>
==== InterpolateDoubles ====
Replace double frames with interpolated frames using FrameRateConverter.
<br>
<br>
:{{Template:FuncDef|InterpolateDoubles (clip C, float "Thr", bool "Show", string "Preset", int "BlkSize", int "BlkSizeV", int "MaskThr", int "MaskOcc", int "SkipThr", int "BlendOver", int "SkipOver", bool "Stp", int "Dct", int "DctRe")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2|Thr|float|0.1 }}
:::Frames will be replaced when Luma difference with previous frame is greater than threshold (default=0.1)
<br>
::{{Par2|Show|bool|false}}
:::If true, "FRAME FIXED" will be written on replaced frames (default=false)
<br>
::'''All other parameters are the same as <code>FrameRateConverter()</code>.'''
<br>
-------------------------------
===FrameRateConverter.dll===
Plugin containing <code>StripeMask()</code>, <code>ContinuousMask()</code>, <code>ConvertFpsLimit()</code>, and <code>ConditionalFilterMT</code> functions.
<br>
<br>
====StripeMask====
Builds a mask detecting horizontal and vertical straight lines and patterns, as MvTools tends to fail in such areas.
<br>
<br>
:{{Template:FuncDef|StripeMask (clip, int "blksize", int "blksizev", int "overlap", int "overlapv", int "thr", int "Comp", int "CompV", int "str", int "strf", bool "lines")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2|blksize|int|16}}
::{{Par2|blksizev|int|blksize}}
:::The horizontal and vertical block size. (default: BlkSize=16, BlkSizeV=BlkSize)
<br>
::{{Par2|overlap|int|blksize/4}}
::{{Par2|overlap|int|blksize/4}}
:::How many pixels to overlap between blocks, generally between 1/4 and 1/2 of block size. (default = BlkSize/4)
<br>
::{{Par2|thr|int|26}}
:::Dynamic content gives blended (grey) line averages while lines and stripes have contrast between average values. This specifies the contrast threshold where a line average is taken for calculations. A lower value gives a stronger and more sensitive mask. (default = 26)
<br>
::{{Par2|Comp|int| }}
::{{Par2|CompV|int| }}
:::How many lines averages to compare with each other. (default = 2 with BlkSize<16 and 3 with BlkSize>=16)
<br>
::{{Par2|str|int|255}}
:::The value to set on the mask when a pattern is detected, between 0 and 255. (default = 255)
<br>
::{{Par2|strf|int|0}}
:::If > 0, calculates the next frame and set its patterns to this value, between 0 and 255. (default = 0)
<br>
::{{Par2|lines|bool|false}}
:::If true, display the raw contrast lines being used for calculations. If false, the pattern areas between those lines will be marked. (default = false)
<br>
<br>
====ContinuousMask====

<br>
:{{Template:FuncDef|ContinuousMask (clip, int "radius")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2|radius|int|16}}
:::Radius must be above 1.
<br>
<br>
====ConvertFpsLimit====
Same as [[FPS#ConvertFPS|ConvertFps]] but with an extra parameter.
<br>
<br>
:{{Template:FuncDef|ConvertFpsLimit (clip, int numerator, int denominator, int "zone", int "vbi", int "ratio")}}
<br>
::{{Par2| |clip| }}
:::Input clip.
<br>
::{{Par2| |int|}}
::{{Par2| |int|}}
:::The new framerate is set to numerator divided by denominator. 
<br>
::{{Par2|zone|int|-1}}
:::If specified, puts the filter into ''Switch mode''. Must be greater or equal to zero. If zero, the filter will perform a hard switch, that is, it will immediately display the next frame below the switch line. If greater than zero, specifies the height (in lines) of the transition zone, where one frame is gradually blended into the next.
<br>
::{{Par2|vbi|int|0}}
:::If specified in ''Switch mode'', specifies that the filter should apply a timing correction for the vertical blanking interval (VBI). Integer number greater than zero, indicating the height of the VBI of the target frames, in lines.
<br>
::{{Par2|ratio|int|100}}
:::Changes the blend ratio. 0 = frame copy and 100 = full blend. Other values provide a result in-between to eliminate ghost effects. Default = 100.
<br>
<br>
====ConditionalFilterMT====
Avisynth+ MT provides great capabilities to process videos. However, conditional functions are not compatible with MT (multi-threading) due to design limitations. To work around this problem, this class provides a subset of conditional features that will work with MT mode.
<br>
<br>
:Currently supported: [[ConditionalFilter]]

:{{Template:FuncDef|ConditionalFilterMT (clip testclip, clip source1, clip source2, string expression1, string expression2, string expression3, bool "show")}}
<br>
Example: this will apply blur to all frames with AverageLuma < 50
<pre>
vid = AviSource("Source.avi")
vid_blur = vid.Blur(1.5)
ConditionalFilterMT(vid, vid_blur, vid, "AverageLuma", "lessthan", "50")
Prefetch(4)
</pre>
<br>
All the standard function expressions are supported. However, only a single plain function name is supported -- no expression. Do not include parenthesis.
<code>
:*AverageLuma
:*AverageChromaU
:*AverageChromaV
:*RGBDifference
:*LumaDifference
:*ChromaUDifference
:*ChromaVDifference
:*YDifferenceFromPrevious
:*UDifferenceFromPrevious
:*VDifferenceFromPrevious
:*RGBDifferenceFromPrevious
:*YDifferenceToNext
:*UDifferenceToNext
:*VDifferenceToNext
:*RGBDifferenceToNext
:*YPlaneMax
:*YPlaneMin
:*YPlaneMedian
:*UPlaneMax
:*UPlaneMin
:*UPlaneMedian
:*VPlaneMax
:*VPlaneMin
:*VPlaneMedian
:*YPlaneMinMaxDifference
:*UPlaneMinMaxDifference
:*VPlaneMinMaxDifference
</code>
Functions comparing two clips will compare testclip with source1. Some functions have threshold and offset parameters. These parameters are not currently supported and are left at 0.
<br>
<br>

== Examples ==
[[TODO]]
<br>
<br>
==Changelog==
See https://github.com/mysteryx93/FrameRateConverter/blob/master/ChangeLog.txt
<br>
<br>
==External Links ==
*[https://github.com/mysteryx93/FrameRateConverter GitHub] - Source code repository.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Frame_Rate_Conversion|External Filters]] &larr;'''