Avisynth wiki - User contributions [en]

MVTools

2022-08-16T01:05:02Z

Kogarou: Changed the latest docs link to an online previewer of the git HTML file.

{{FilterCat5|External_filters|Plugins|Plugins_x64|Other_filters|Support_filters}}
[[Category:Deep_color_tools]]
{{Filter
|Manao, Fizick, Tsp, TSchniede, SEt, cretindesalpes, pinterf
|v2.7.39
|'''[https://github.com/pinterf/mvtools/releases mvtools-2.7.39-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-.

'''Latest documentation: 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]]. '''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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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. 
| [[YV12]], [[YUY2]], 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. 
| [[YV12]], [[YUY2]], 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]], 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]], 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.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. 
|-
|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 
|-
|2.7.28
|20180323
|pinterf
|Fix: in MDegrain1-6/N allow Y8 input for out16 parameter 
|-
|2.7.27
|20180318
|pinterf
|Fix: MDepan: use zerow parameter. The parameter had no effect probably since it had been introduced. 
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) 
|-
|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). 
Faster: special 10 bit SAD functions instead of the generic 10-16bit one. 
|-
|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. 
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 
MSuper: import 8 bit sse2 interpolators from mvtools-vs. Extend them for 10-16bits (faster super clip). Some filters are still todo. 
MSuper: support 32bit float clips, which can be used later by MDegrains (but not for MAnalyse) 
MDegrains: allow degraining clip with different bit depth from vectors. Clip and Super must be the same bit depth 
MDegrains: consistently use limit and limitC, 255 do nothing, otherwise scale 0-254 value to the current bit-depth range 
Overlaps: more correct internal rounding for 8 bits 
Overlaps: round for 16bits 
Overlaps: 32bit float (but still use the original 11 bit window constants) 
Project: change from yasm to nasm. 
|-
|2.7.24
|20171205
|pinterf
|Fix: MFlowBlur: possible access violation crash when nPel>1 
New: MScaleVect parameter 'bits'. e.g. Analyze 8 bit clips, use their vectors for 16 bits 
Move project to VS2017 
|-
|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) 
|-
|2.7.22
|20170830
|pinterf
|Misc: Stop using version suffix .22 
Fix: [DCT 8x8@8bit] garbage on x64: internal assembly code did not save xmm6/xmm7 
Fix: [DCT 8x8@8bit] safe multithreading for integer DCT (8x8 block size, 8 bit video): assembly had a single working buffer. 
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) 
Mod: fftw conversion constant of sqrt(2)/2 is more accurate (was:0.707), 16 bit formats may benefit (by feisty2) 
Fix: SSE4 assembly instructions in x64, broke on non-SSE4 processors 
|-
|2.7.21.22
|20170629
|pinterf
|Mod: [MMask] Faster: request source frame only for kind=5. 
|-
|2.7.20.22
|2017.05.26
|pinterf
|Fix: [MMask] greyscale input resulted in AV when filter exiting 
|-
|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 
Mod: [MMask] Faster: request source frame only for kind=5. 
Fix: [MxxxxFPS,MMask]: MakeVectorOcclusionMaskTime garbage in bottom blocks 
Fix: [MMask] bottom padding garbage for padded frame dimension 
Fix: [MMask] proper 10+ bits scene change values (for default: 1023, 4095, 16383, 65535. Was: 65535). Parameter is still in 8-bit range 
Fix: [MRecalculate] prevent overflow during thSAD scaling in 16 bits or large block sizes (32, 48...) 
Fix: [DepanEstimate] Sometimes giving wrong motion instead of scene change detection. Bug only existed in previous pfmod builds. 
Fix: [MAnalyze] Possible overflow in MAnalyze 8 bit, block size 48x48 and above. Overflow-safe predictor recalc for big block sizes. 
New: [General] Add block size 12x3 for SAD, allow 6x24 
List of available block sizes 
- 64x64, 64x48, 64x32, 64x16 
- 48x64, 48x48, 48x24, 48x12 
- 32x64, 32x32, 32x24, 32x16, 32x8 
- 24x48, 24x24, 24x32, 24x12, 24x6 
- 16x64, 16x32, 16x16, 16x12, 16x8, 16x4, 16x2 
- 12x48, 12x24, 12x16, 12x12, 12x6, 12x3 
- 8x32, 8x16, 8x8, 8x4, 8x2, 8x1 
- 6x24, 6x12, 6x6, 6x3 
- 4x8, 4x4, 4x2 
- 3x6, 3x3 
- 2x4, 2x2 
Mod: [Internal] Reorganized 10-16 bit SAD simd intrinsics, faster 8-12% for BlkSize 12-32 
|-
|2.7.18.22
|2017.05.12
|pinterf
|Fix: 10-16 bit: DCT buffer possible overflow 
Fix: DCT is fast again for non 8x8 blocksizes. Regression since 2.7.5.22. 
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) 
New: MAnalyze, MRecalculate new parameter: "scaleCSAD" integer, default 0. 
Fine tune chroma SAD weight relative to luma SAD. 
ScaleCSAD values for luma:chroma SAD ratio 
* -2: 4:0.5 
* -1: 4:1 
* 0: 4:2 (default, same as the native ratio for YV12) 
* 1: 4:4 
* 2: 4:8 
New: Block sizes 64, 48, 24, 12, 6. 
MAnalyze/MRecalculate new block sizes (SATD support mod4 sizes) 
Note: some smaller block sizes can only be available in 4:4:4 formats, due to block size division (chroma subsampling) 
New: All block sizes are supported in MDegrain1-6, MDegrainN, and MScaleVect 
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 
For some block sizes AVX2 and SSE4 is supported (AVX2 if reported under AviSynth+) e.g. BlkSize 32 is faster now. 
New: MMask SAD Mask to give identical weights for other-than-YV12 formats, e.g. for YV24 
|-
|2.7.17.22
|2017.04.26
|pinterf
|Fix: Regression in 2.7.16.22: MDegrain right pixel artifacts on non-modulo 16 widths 
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) 
|-
|2.7.16.22
|2017.04.23
|pinterf
|Fix: MMask 10-16 bits 
Fix: MRecalculate 14-16 bits passed nSCD1=999999 internally which caused overflow (scene change problems later) 
Fix is done by clamping SCD1 to 8*8*(255-0) (maximum value of sum of SADs on a 8x8 block) 
Misc: MDegrainX 8 bits: internal 16 bit buffer to 8 bits: SSE2 
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) 
|-
|2.7.15.22
|2017.03.16
|pinterf
|Fix: 16 bit SAD for non-AVX code path 
Misc: MDegrain1-6: add error on lsb_flag=true for non-8 bit sources 
|-
|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) 
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) 
|-
|2.7.13.22
|2017.02.01
|pinterf
|Fix: MDegrain1-6,N 10-16 bit thSCD scaling 
Fix: MVShow: tolerance scaling for 10-16 bits 
|-
|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 
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) 
|-
|2.7.11.22
|2017.01.16
|pinterf
|New: MDegrain6 
Mod: MDegrain1-6 SSE4 for 10-16 bit (was: C. 3-5% gain, wasn't bottleneck) 
|-
|2.7.10.22
|2016.12.28
|pinterf
|Fix: for YV12 the debug info text chroma part was positioned at wrong place 
|-
|2.7.9.22
|2016.12.20
|pinterf
|Apply 2.5.11.9-svp analysis speedup, mainly when chroma is involved 
|-
|2.7.8.22
|2016.12.18
|pinterf
|Fix: YUY2 input access violation (regression after 2.7.0.22d) - Fixed also in Depan.dll 
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 
|-
|2.7.7.22
|2016.12.14
|pinterf
|Optimizing 8 bits 
speed: change some 8 bit SAD functions for the better 
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 
speed: more __forceinlines for helping the compiler 
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 
|-
|2.7.6.22
|2016.12.04
|pinterf
|fix: sumLumaChange underflow (used for dct=2,6,9) (regression during 16 bit support) 
fix: MeanLumaChange scale for 10-16 bits (used for dct=2,6,9) 
fix: Mask fix: 8 bit mask resizer bug in SIMD intrinsics (regression on inline asm -> SIMD transition) 
Fix: dctmode=1,2: pixel distance was not corrected for 16 bit pixel sizes 
speed: Let's help VS2015 with some __forceinline directives to recognize the truth. 
speed: Misc optimizations throughout the code (bit shifts instead of div or mul) 
speed: FFTW DCT: C code replaced with SIMD SSE2/SSE4 (FloatToBytes, BytesToFloat) 
speed: 16 bit SAD: a few optimizations in SSE2, AVX-coded SSE2 and AVX2 codepath 
VS2015 compiler: /MT -> /MD (from static to dynamic dlls - now it reallys need VS2015 redistributables) 
|-
|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. 
Fix for MSCDetection: scene change filler pixel default value was always 0 (2.7.1.22 regression) 
MCompensate: possible bugfix bottom padding UV 
Fix SAD for 10-16 bit depths for horizontal block sizes >= 16 
Fix nSCD2 (Scene change threshold block count %) (2.7.1.22 regression) 
MBlockFPS: overlap fixes (right columns and bottom lines) 
MBlockFPS: overlap fix: missing copy buffer to output 
|-
|2.7.1.22
|2016.10.20
|pinterf
|YV16 and YV24 avaliable 
dct modes >= 5 now use SATD again (so far it was in dead code, contrary to 2.5.13.1 remarks) 
New: MDegrain4, MDegrain5 
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) 
Inline assembly rewritten to intrinsics -> 64 bit build is possible in VS2015 (External assembly untouched) 
|-
|2.7.0.22
|2016.04.29
|pinterf
|Integrate Fizick's upstream changes of 2.5.11.22 
|-
|2.7.0.1
|2016.03.31
|pinterf
|MVTools-pfmod 
2.6.0.5 x64 capable version ported under AviSynth 2.6 API 
Fixed access violation in MDepan 
Fixed access violation in x64 asm code 
Built with Visual Studio 2015 Community Edition, v140_xp toolset 
Compiler: Intel C++ 16 (because of inline 64 bit asm code) 
See [https://forum.doom9.org/showthread.php?t=173356 discussion] and [https://github.com/pinterf/mvtools/tree/mvtools-pfmod GitHub page] for more information. 
|-
|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. 
MDegrainN: fixed systematic crash in multithreading mode. 
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. 
MCompensate: added multi-compensation mode for easy use with temporal filters. 
MAnalyse, MSuper, MCompensate, MDegrainN: added multithreading (but partially, not for all code paths) using AVSTP. 
MAnalyse: fixed a corruption of the global motion vector. 
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. 
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. 
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. 
MAnalyse: Added the "multi" mode for MDegrainN. 
MAnalyse: Documented the negative delta values and fixed some functions accordingly. 
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]
 
 
== 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++.
 
==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.

Fmtconv

2022-07-06T03:18:45Z

Kogarou: I keep forgetting to click the preview button

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/ fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV, YCoCg, YDzDx and ICtCp in 4:4:4, 4:2:2, 4:2:0 and 4:1:1 chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focussed primarily on quality and exactness rather than execution speed. This does not mean it is slow or unoptimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.
See [https://htmlpreview.github.io/?https://github.com/EleonoreMizo/fmtconv/blob/master/doc/fmtconv.html doc/fmtconv.html on github] for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2|c|clip}}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip}}
:::Input clip.
 
::{{Par2|mat|string|(undefined)}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip}}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip}}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations.
:::Graphical examples of chroma placements can be found [https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png in the github].
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-07-06T03:14:19Z

Kogarou: Small update to the description

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/ fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

Fmtconv is a format-conversion plug-in for the Vapoursynth and Avisynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV, YCoCg, YDzDx and ICtCp in 4:4:4, 4:2:2, 4:2:0 and 4:1:1 chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focussed primarily on quality and exactness rather than execution speed. This does not mean it is slow or unoptimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.
See [https://htmlpreview.github.io/?https://github.com/EleonoreMizo/fmtconv/blob/master/doc/fmtconv.html doc/fmtconv.html on github] for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations.
:::Graphical examples of chroma placements can be found [https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png in the github].
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-07-06T01:45:33Z

Kogarou: fixing the book's link

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/ fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations.
:::Graphical examples of chroma placements can be found [https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png in the github].
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-07-03T18:14:02Z

Kogarou: Another minor edit

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/ fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations.
:::Graphical examples of chroma placements can be found [https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png in the github].
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-07-03T18:09:17Z

Kogarou: Small edit to the colorspace subsampling example

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/ fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations:
:::Graphical examples of chroma placements can be found in the github: [https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png]
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-06-27T21:53:00Z

Kogarou: DL link fixed

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/tag/r29 fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations:
Chroma placement
(image:https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png)
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-06-27T21:50:29Z

Kogarou: plugin version update

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r29
|3=[https://github.com/EleonoreMizo/fmtconv/releases/download/r29/fmtconv-r29.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|4}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations:
Chroma placement
(image:https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png)
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the [[Internal_functions#Field|_Field]] property in all the frames.
:::*2 : Automatic detection, depends on the [[Internal_functions#FieldBased|_FieldBased]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the [[Internal_functions#Field|_Field]] frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-06-27T21:45:45Z

Kogarou: finished fmtc_resample (!!)

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r24
|3=[https://github.com/EleonoreMizo/fmtconv/releases fmtconv-r24.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|(undefined)}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|(undefined)}}
::{{Par2|matd|bool|(undefined)}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|0}}
::{{Par2|sy|arrayf|0}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|0}}
::{{Par2|sh|arrayf|0}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|0}}
::{{Par2|scaleh|float|0}}
::{{Par2|scalev|float|0}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.
 
::{{Par2|impulse|arrayf|(undefined)}}
::{{Par2|impulseh|arrayf|impulse}}
::{{Par2|impulsev|arrayf|impulse}}
:::Offers the possibility to create your own kernel (useful for convolutions). Add your coefficents in the array. The number of coefficients must be odd. The curve is linearly interpolated between the provided points. You can oversample the impulse by setting kovrspl to a value > 1. To activate the custom kernel, set kernel="impulse".
 
::{{Par2|taps|arrayi|4}}
::{{Par2|tapsh|arrayi|taps}}
::{{Par2|tapsv|arrayi|taps}}
:::Some kernels have a variable number of sample points, given by this parameter. Actually this counts half the number of lobes (or equivalent); in case of downscaling, the actual number of sample points may be greater than the specified value. Range: 1–128
 
::{{Par2|a1|arrayf|(undefined)}}
::{{Par2|a2|arrayf|(undefined)}}
::{{Par2|a3|arrayf|(undefined)}}
 
::{{Par2|a1h|arrayf|a1}}
::{{Par2|a2h|arrayf|a2}}
::{{Par2|a3h|arrayf|a3}}
 
::{{Par2|a1v|arrayf|a1}}
::{{Par2|a2v|arrayf|a2}}
::{{Par2|a3v|arrayf|a3}}
:::Specific parameters, depending on the selected kernel.
 
::{{Par2|kovrspl|int|1}}
:::Specifies here how many times the kernel is oversampled when you provide a custom impluse response. ≥ 1.
 
::{{Par2|fh|arrayf|1}}
::{{Par2|fv|arrayf|1}}
:::Horizontal and vertical frequency factors, also known as inverse kernel support. They are multipliers on the theoretical kernel cutoff frequency in both directions. Values below 1.0 spatially expand the kernel and blur the picture. Values over 1.0 shrink the kernel and let higher frequencies pass. The result will look sharper but more aliased. The multiplicator is applied after the kernel scaling in case of downsizing. Negative values force the processing, even if the horizontal size doesn’t change. The filter will use the absolute parameter value.
 
::{{Par2|cnorm|bool|true}}
:::If set to true, the impulse sum is normalised to 1 for each pixel. This is the normal behaviour when resizing, to make sure the energy is constant for all pixels. If you use the resizer as a convolution engine, it is advised to disable the normalisation.
 
::{{Par2|total|arrayf|0}}
::{{Par2|totalh|arrayf|total}}
::{{Par2|totalv|arrayf|total}}
:::When cnorm is activated, these parameters specify the normalisation value for the corresponding kernel. 0 means that the normalisation value is the sum of the coefficients. The Masktools’mt_convolution function has a single parameter for this use: total = totalh × totalv. Because the convolution is computed with floating point data, there is no saturation of intermediate results, therefore the balance between totalh and totalv is not important, only their product will be taken into account. Note that because kernels are single-dimention, the “parent” total parameter here is the sum of the coefficients for each direction, not the product of totalh and totalv.
 
::{{Par2|invks|arrayb|false}}
::{{Par2|invksh|arrayb|invks}}
::{{Par2|invksv|arrayb|invks}}
:::Set these parameter to True to activate the kernel inversion mode for the specified direction (use invks for both). Inverting the kernel allows to “undo” a previous upsizing by compensating the loss in high frequencies, giving a sharper and more accurate output than classic kernels, closer to the original. This is particularly useful for clips upscaled with a bilinear kernel. All the kernel-related parameters specify the kernel to undo. The target resolution must be as close as possible to the initial resolution. The kernel inversion is mainly intended to downsize an upscaled picture. Using it for upsizing will not restore details but will give a sligthly sharper look, at the cost of a bit of aliasing and ringing. This mode is somewhat equivalent to the debilinear plug-in but works with a different principle.
 
::{{Par2|invkstaps|arrayi|(4)}}
::{{Par2|invkstapsh|arrayi|invkstaps}}
::{{Par2|invkstapsv|arrayi|invkstaps}}
:::In kernel inversion mode (invks=True), this parameter sets the number of taps for the inverted kernel. Use it as a tradeof between softness and ringing. Range: 1–128
 
::{{Par2|csp|string|(undefined)}}
:::Can only change the bitdepth and the data type (integer or float). Only 16-bit integer (xxxP16) and 32-bit float data types are allowed.
:::The format is a string with the same kind of content as the result from BuildPixelType or the pixel_type parameter from BlankClip.
 
::{{Par2|css|string|(undefined)}}
:::Destination chroma subsampling, for YUV (and YCoCg) colorspaces. Supersedes the chroma subsampling from csp. You can also specify the subsampling with the predefined values or with a two-digit string. The first digit for the horizontal subsampling, and the second for the vertical subsampling. Only power-of-2 numbers are allowed. For example "41" is equivalent to 4:1:1 and "22" to 4:2:0.
 
:::The predefined values are:
:::*"444" or "4:4:4" 4:4:4, no chroma subsampling.
:::*"422" or "4:2:2" 4:2:2, horizontal 2x chroma subsampling.
:::*"420" or "4:2:0" 4:2:0, horizontal and vertical 2x chroma subsampling.
:::*"411" or "4:1:1" 4:1:1, horizontal 4x chroma subsampling.
 
::{{Par2|planes|arrayf|all}}
:::This array decribes how each plane should be processed. It’s similar to the y, u and v parameters in Masktools 2.
:::*−65535 to +0.5 : All the pixels of the plane will be set to −x (the opposite of the specified value). The range depends on the output data type. Remember, in floating-point YUV, the chroma planes range from −0.5 to +0.5.
:::*1 : The plane will not be processed. This means that the content of the output plane is pure garbage.
:::*2 : The plane of the input clip will be copied and possibly cropped. Areas out of the input picture are left unprocessed (garbage). Range (full or TV) conversions are ignored.
:::*3 : The plane will be processed (default).
:::The parameter can also be specified as a string. See the planes parameter from the fmtc_bitdepth function for more details.
 
::{{Par2|fulls|int|(depends)}}
::{{Par2|fulld|int|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the Y’Cb’Cr’ chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|center|arrayb|true}}
:::Like the Avisynth standard resizers, this resizer preserves the position of the picture center. Disable this parameter if you may want to resize by preserving the top-left corner position. Similarly, if you are convolving without resizing, setting it to false ensures you that the same kernel will be applied to all pixels.
 
::{{Par2|cplace|arrayb|"mpeg2"}}
::{{Par2|cplaces|arrayb|cplace}}
::{{Par2|cplaced|arrayb|cplace}}
:::Placement of the chroma samples. cplaces specifies the source clip only, cplaced the destination clip. Can be one of these strings:
:::*"MPEG1", "JPEG" "center" : 4:2:0 subsampling used in MPEG-1 and JPEG. Chroma samples are located on the center of each group of 4 pixels.
:::*"MPEG2", "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.
:::*"DV" : For 4:2:0 modes, it’s 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", "tl" : Chroma samples are located on the top-left luma sample of each pixel group.
:::The chroma placement is ignored when center is set to False or kernel to "point". You’ll find below an overview of common chroma placement and subsampling combinations:
Chroma placement
(image:https://raw.githubusercontent.com/EleonoreMizo/fmtconv/master/doc/colorspace-subsampling.png)
 
::{{Par2|interlaced|int|2}}
::{{Par2|interlacedd|int|(interlaced)}}
:::Specifies if the clip is made of frames or fields. interlacedd overrides interlaced for output.
:::*0 : Frames are progressive content.
:::*1 : Frames are actually the separated fields of an interlaced stream. Specify tff or provide the _Field property in all the frames.
:::*2 : Automatic detection, depends on the _FieldBased frame property. If not found, the frame is considered progressive.
 
::{{Par2|tff|int|2}}
::{{Par2|tffd|int|tff}}
:::When processing interlaced content, specifies the field parity. tffd overrides tff for output.
:::*0 : Bottom field first (BFF). This means all even fields are top, and all odd fields are bottom.
:::*1 : Top field first (TFF). This means all even fields are bottom, and all odd fields are top.
:::*2 : Automatic detection, depends on the _Field frame property. If not found, the frame is considered progressive.
 
::{{Par2|flt|bool|false}}
:::Flag to force floating point operations. When set to False, integer operations are used, but only if both input and output formats are integer. If it’s not the case, floating point operations are silently used as fallback.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set. −1: automatic (no limitation), 0: , 1: , .
:::*-1 : automatic (no limitation).
:::*0 : default instruction set only (depends on the compilation settings).
:::*1 : limit to SSE2.
:::*10 : limit to AVX2.
 

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-06-27T19:16:57Z

Kogarou: small additions to fmtc_resample

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r24
|3=[https://github.com/EleonoreMizo/fmtconv/releases fmtconv-r24.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|undefined}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|undefined}}
::{{Par2|matd|bool|undefined}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.
 
::{{Par2|sx|arrayf|(0)}}
::{{Par2|sy|arrayf|(0)}}
:::Coordinate of the top-left corner of the picture sub-area used as source for the resizing. They can be fractional. If negative, the picture is extended by replicating the left pixel column.
:::These parameters are arrays, so it’s possible to specify a different value for each plane. The last value is used for the unspecified planes. The coordinates are always related to the pixel dimensions, you don’t need to scale them with the chroma subsampling.
 
::{{Par2|sw|arrayf|(0)}}
::{{Par2|sh|arrayf|(0)}}
:::Size in pixels of the sub-area to resize. They can be fractional. If 0, the area has the same size as the source clip. If negative, they define coordinates relative to the bottom-right corner, in a Crop-like manner. These parameters are arrays like sx and sy.
 
::{{Par2|scale|float|(0)}}
::{{Par2|scaleh|float|(0)}}
::{{Par2|scalev|float|(0)}}
:::Use these parameters to set relative dimensions, > 0. For example scale=0.5 will halve the picture size. The computed dimensions will be compatible with the destination chroma subsampling. Zero is ignored.
 
::{{Par2|kernel|string|"spline36"}}
:::Kernel used by the resizer. Possible values are:
:::*"point" : Nearest neighbour interpolation. Same as [[Resize#PointResize|PointResize]].
:::*"rect", "box" : Box filter.
:::*"linear", "bilinear": Bilinear interpolation. Same as [[Resize#BilinearResize|BilinearResize]].
:::*"cubic", "bicubic" : Bicubic interpolation. Same as [[Resize#BicubicResize|BicubicResize]]. The b and c variables are mapped on a1 and a2 and are both set to 1/3 by default.
:::*"lanczos" : Sinc function windowed by the central lobe of a sinc. Use taps to specify its impulse length. Same as [[Resize#LanczosResize|LanczosResize]].
:::*"blackman" : Blackman-Harris windowed sinc. Use taps to control its length. Same as [[Resize#BlackmanResize|BlackmanResize]].
:::*"blackmanminlobe" : Another kind of Blackman windowed sinc, with a bit less ringing. Use taps for you know what.
:::*"spline16" : Standard cubic spline based kernel, 4 sample points. Same as [[Resize#Spline_based_resizers|Spline16Resize]].
:::*"spline36" : Spline, 6 sample points. Same as [[Resize#Spline_based_resizers|Spline36Resize]].
:::*"spline64" : Spline, 8 sample points. Same as [[Resize#Spline_based_resizers|Spline64Resize]].
:::*"spline" : Generic natural cubic splines, number of sample points is twice the taps parameter, so you can use taps = 6 to get a more or less Spline144Resize equivalent.
:::*"gauss", "gaussian" : Gaussian kernel. The p parameter is mapped on a1 and controls the curve width. The higher p, the sharper. It is set to 30 by default. This resizer is the same as [[Resize#GaussResize|GaussResize]], but taps offers a control on the filter impulse length. For low p values (soft and blurry), it’s better to increase the number of taps to avoid truncating the gaussian curve too early and creating artifacts.
:::*"sinc" : Truncated sinc function. Use taps to control its length. Same as [[Resize#SincResize|SincResize]].
:::*"impulse" : Custom kernel. See the impulse parameter.

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-05-13T20:30:51Z

Kogarou: smaller additions, need a break

{{FilterCat6|External_filters|Plugins|Plugins_x64|Adjustment_filters|Resizers|Deep_color_tools}}
{{Filter3
|1={{Author/cretindesalpes}}
|2=r24
|3=[https://github.com/EleonoreMizo/fmtconv/releases fmtconv-r24.zip]
|4=Resize
|5=Open source
|6=[https://forum.doom9.org/showthread.php?t=183139 Doom9 Forum]
}}
 
== Description ==
[[fmtconv]] is a format-conversion plug-in for the VapourSynth and AviSynth+ video processing engines. It does:

*Resizing.
*Bitdepth conversion with dithering.
*Colorspace conversion (matrix, transfer characteristics and chromatic adaptation).

It supports:

*Pixel data types: 8-–12-, 14- and 16-bit integer, 32-bit float.
*Colorspaces: RGB, Y, YUV in 4:4:4, 4:2:2, 4:2:0, 4:1:1 and YCgCo with the same chroma subsampling factors.
*Progressive and interlaced content.

Fmtconv is focused primarily on quality and exactness rather than execution speed. This does not mean it is slow or un-optimized, but fmtconv is clearly not on par with the fastest equivalent 8-bit filters.

See doc/fmtconv.html for more information.
 
 
== Requirements ==
* [[AviSynth+]] 3.7.0 x86/x64
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32-bit, YUV/RGB with or without alpha).
 

== Information, [[Script variables|Syntax and Parameters]] for fmtc_bitdepth ==
Bitdepth conversion with optional dithering.

Dithering is performed when meeting at least one of these conditions:
*Reducing the bitdepth of integer data, or converting from float to integer.
*Doing a full-range ↔ TV-range conversion between integer formats, because the resulting values haven’t an exact representation.

Video compression seems to retrain better pure ordered (Bayer) dithering. Therefore this is the recommended method to avoid color banding in 8 bit signals, unless you encode at high bitrates. If you don’t care about video compression, error diffusion, void and cluster and quasirandom sequence methods give the most accurate results. To avoid discontinuities between purely flat areas and dithered areas (also called noise modulation), you can add a bit of noise, ideally in triangular distribution.

The internal noise generator is deterministic and will give the same result each run.

The internal processing is done in floating point as soon as the input is floating point or a range conversion is detected.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_bitdepth (clip c, int "bits", bool "flt", string "planes", bool "fulls", bool "fulld", int "dmode", float "ampo",float "ampn",bool "dyn", bool "staticnoise", int "cpuopt", int "patsize", bool "tpdfo", bool "tpdfn",bool "corplane")}}
 
::{{Par2| |clip| }}
:::Input clip.
 
::{{Par2|bits|int|-1}}
:::Destination bitdepth. A negative value means that the parameter is left undefined.
 
::{{Par2|flt|bool|undefined}}
:::Set it to 1 to convert to float, and to 0 for integer data. As long as only 32-bit floating point data is supported, you don’t need to specify the bitdepth for a float conversion.
 
::{{Par2|planes|string|"all"}}
:::A list of planes to process. The content of an unprocessed plane should be considered as garbage.
:::This is a string made of concatenated substrings for each plane, in any order. The planes are identified by their index, as well as the following aliases:
:::*"0", "y", "r" Y or red
:::*"1", "u", "g" U or green
:::*"2", "v", "b" V or blue
:::*"3", "a" Alpha channel
:::*"all" All the planes
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|fulls}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for RGB and YCoCg colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
:::Alpha planes are always processed as full-range.

 
::{{Par2|dmode|int|3}}
:::Dithering mode, when applicable.

:::*0: Ordered dithering (Bayer matrix).
:::*1: No dither, round to the closest value.
:::*2: Round, may be a bit faster but possibly less accurate.
:::*3: Sierra-2-4A error diffusion, aka “Filter Lite”. Quick and excellent quality, similar to Floyd-Steinberg.
:::*4: Stucki error diffusion. Preserves delicate edges better but distorts gradients.
:::*5: Atkinson error diffusion. Generates distinct patterns but keeps clean the flat areas (noise modulation).
:::*6: Classic Floyd-Steinberg error diffusion, modified for serpentine scan (avoids worm artefacts).
:::*7: [https://web.archive.org/web/20180627075311/http://www.iro.umontreal.ca/~ostrom/publications/publications_abstracts.html#SIGGRAPH01_VarcoeffED Ostromoukhov error diffusion]. Slow, available only for integer input at the moment. Avoids usual F-S artefacts.
:::*8: Void and cluster halftone dithering. This is a way to generate blue-noise dither and has a much better visual aspect than ordered dithering.
:::*9: Dither using [https://web.archive.org/web/20211029094035/http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ quasirandom sequences]. Good intermediated between Void and cluster and error diffusion algorithms.

:::When using error-diffusion dithering on interlaced content, you should separate the fields first before converting them.
 
::{{Par2|ampo|float|1.0}}
:::The ordered dither peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. On error diffusion algorithms, it increases the collected error amount, helping to extend the range of the dithering while preserving its natural pattern (especially Atkinson’s). This gives a better looking result than just adding noise.
 
::{{Par2|ampn|float|0.0}}
:::The noise peak-to-peak amplitude, depends on the target bitdepth. ≥ 0. Currently, the maximum value is 4. The noise is added before dithering. It reduces the SNR but a small amount may give a better, more uniform visual appearance.
 
::{{Par2|dyn|bool|false}}
:::Indicates if the ordered dither pattern is dynamic (True) or static (False). If dynamic, the pattern is changed or rotated each frame.
 
::{{Par2|staticnoise|bool|false}}
:::If set to true, the noise generated with ampn is static and remains the same every frame.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2
 
::{{Par2|patsize|int|32}}
:::Width of the pattern used in the Void and cluster algorithm.
:::*The only valid values are power of 2 ranging from 4 to 1024: 4, 8, 16, 32, 64, 128, 256, 512 and 1024.
 
::{{Par2|tpdfo|bool|false}}
:::Set it to true to enable the triangular probability distribution function (TPDF) for halftone-based dithering algorithms. It has no effect on error diffusion methods. 0 is the standard rectangular distribution (RPDF).
:::Note that when triangular distribution is enabled, the maximum halftone amplitude is multiplied by 1.414 at constant ampo.
 
::{{Par2|tpdfn|bool|false}}
:::Same as tpdfo, but for the additive noise part. TPDF noise looks more natural than RPDF noise, and is a crude approximation of a gaussian noise, with a bounded amplitude. Maximum noise amplitude is multiplied by 1.414 at constant ampn, so the introduced noise power is kept approximately constant.
 
::{{Par2|corplane|bool|false}}
:::Set it to true to keep the dither and noise patterns correlated for all the planes. When processing a RGB picture, it helps to prevent colored noise on grey features.

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix ==
Colorspace conversion or simple cross-plane matrix.

For Y’Cb’Cr’ and Y’Co’Cg’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

When the destination color family (R’G’B’, Y’Cb’Cr’ or Y’Co’Cg’) is not specified (via col_fam or csp), the function tries to deduce it from the matrix settings and the source color family. If it cannot be deduced, the color family remains unchanged.

Please note that this function doesn’t do conversions based on the color primaries. The R’G’B’ data are always relative to their specified standard. For example, converting Y’Cb’Cr’ data straight from BT.2020 to BT.709 doesn’t make sense as these colorspaces are defined with different primaries. For meaningful results, convert to R’G’B’ then to linear RGB and use primaries to perform the intermediary conversion.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if the fulld parameter has been explicitely defined. If the destination colorspace is a standardized one (as deduced from the specified matrix), the [[Internal_functions#_Matrix|_Matrix]] and [[Internal_functions#_ColorRange|_ColorRange]] properties are set, otherwise they are deleted from the frame.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.

The [[Internal_functions#ColorRange|_ColorRange]] frame property is set if at least one of the fulls or fulld parameter has been explicitely defined.
 
:{{Template:FuncDef|fmtc_matrix (clip c, string mat, string mats, string matd, bool fulls, bool fulld, arrayf coef, string csp, string col_fam, int bits, int singleout, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
 
::{{Par2|mat|string|-1}}
:::Predefined matrix for conversions to and from R’G’B’. The direction is deduced from the specified input and output colorspaces. Possible values are:
:::*"601": ITU-R BT.601 / ITU-R BT.470-2 / SMPTE 170M. For Standard Definition content.
:::*"709": ITU-R BT.709. For High Definition content.
:::*"2020": ITU-R BT.2020, non constant luminance mode. For UHDTV content.
:::*"2100": ITU-R BT.2100, non constant luminance mode. For UHDTV content.
:::*"240": SMPTE 240M
:::*"FCC",
:::*"470-525": FCC Title 47
:::*"YCoCg",
:::*"YCgCo": Y’Co’Cg’
:::*"YDzDx": Y’D’ZD’X, SMPTE ST 2085
:::*"RGB": R’G’B’. Identity, no cross-plane calculations.
 
::{{Par2|mats|bool|undefined}}
::{{Par2|matd|bool|undefined}}
:::Source and destinations matrices for YUV. Use both when you want to do a conversion between BT.601 and BT.709. Values are the same as mat, with the addition of:
:::*"LMS": Intermediate colorspace for ICTCP transforms. The LMS colorspace is conveyed on RGB planes.
:::*"ICtCp_PQ": ITU-R BT.2100-2 ICTCP with perceptual quantization (PQ).
:::*"ICtCp_HLG": ITU-R BT.2100-2 ICTCP with hybrid log-gamma transfer function (HLG).
 
:::When using one of these additional values, make sure to set the other mats or matd with "RGB" to clarify the conversion direction. ICTCP transforms from R’G’B’ require the following steps:
:::*Convert from R’G’B’ to linear BT.2100 RGB with transfer then possibly primaries.
:::*Convert from linear BT.2100 RGB to linear LMS using matrix with "LMS".
:::*Convert from linear LMS to L’M’S’ using transfer with "2084" or "hlg".
:::*Convert from L’M’S’ to ICTCP using matrix with "ICtCp_PQ" or "ICtCp_HLG", respectively.
:::For the inverse conversion, reverse the steps. Beware, chromatic information for pixels of the highest luminance range cannot be represented in integer ICTCP and will be clipped because of the large matrix coefficients.
 
::{{Par2|fulls|bool|(depends)}}
::{{Par2|fulld|bool|(depends)}}
:::Indicates if the clip is full-range (True) or TV-range (False). fulls is for input, fulld for output. Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
:::The default value depends on the colorspace. For example, full-range is assumed for R’G’B’ and Y’Co’Cg’ colorspaces. Others are assumed TV-range. These parameters are mainly intended to guide conversions between integer and floating-point data. They can also be used for range conversions. Pixel values are not clipped during a conversion between two TV-range formats.
 
::{{Par2|coef|arrayf|(undefined)}}
:::A list of 12 coefficients for a custom matrix. The coefficients should be scaled assuming the input is floating point, even if the actual input is integer. This means luma and R’G’B’ signals range from 0 to 1, and chroma signals from −0.5 to +0.5. Coefficients are listed by rows. Each row is terminated with a fourth coefficient, the additive constant (still in floating-point range). This means the matrix is actually 4×3 and during the multiplication, the input column-vector has an implicit 1 appended to its end. For example, with an R’G’B’ input:

+- -+ +- -+ +- -+
| Y | | c0 c1 c2 c3 | | R | Y = R × c0 + G × c1 + B × c2 + c3
| Cb| = | c4 c5 c6 c7 | × | G | Cb = R × c4 + G × c5 + B × c6 + c7
| Cr| | c8 c9 c10 c11 | | B | Cr = R × c8 + G × c9 + B × c10 + c11
+- -+ +- -+ | 1 |
+- -+

::List can be an array of float values if supported by the scripting language, or a string containing the values printed and separated with spaces.
 
::{{Par2|csp|string|(undefined)}}
:::The destination format. It cannot change the data type (integer or float) nor the chroma subsampling. If the colorspace family is set to Y, single-plane processing is enabled. The output plane is selected with singleout (0 if not specified). Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|col_fam|string|(undefined)}}
:::Explicit specification of the destination color family, as Vapoursynth constant. Supersedes the color family from csp. You can only specify colorspace with the same number of planes as the input clip.
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. However you cannot reduce the bitdepth, only keep it constant or increase it. Supersedes the bitdepth from csp.
 
::{{Par2|singleout|int|-1}}
:::Enable single-plane processing. This is useful to obtain only the luma from an R’G’B’ input, for example. The parameter is the plane index, ranging from 0 to 2. A negative value specifies that all planes should be processed. If singleout is ≥ 0, it supersedes the colorspace family specified in csp.
:::Note: when extracting a chroma plane, results between int with TV range and float data type may slightly differ. This is because in float, a neutral chroma (0%) is converted to the exact value of a medium gray (50%). In integer, the chroma output value is mapped 1–1 to the luma channel. However in TV-range, medium gray is not located exactly at the half of the data range, it lies slightly below.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_matrix2020cl ==
Colorspace conversion using the ITU-R BT.2020 constant luminance matrix.

The function converts between linear RGB and Y’Cb’Cr’ colorspaces. This conversion cannot be achieve with a classic linear matrix. The output colorspace, hence the direction of the conversion, is automatically deduced from the input colorspace.

For Y’Cb’Cr’ colorspaces, 4:4:4 is required (no chroma subsampling). To process a subsampled colorspace, you must convert it to 4:4:4 first.

The RGB colorspace is always 16 bits when using integers, or 32 bits in float. The output is not dithered, therefore you should output at a higher bitdepth than the input and dither afterward with bitdepth to avoid potential banding.

Please note that the RGB content is always assumed to be linear light. The BT.2020 gamma curve is used in both directions. When operating on floating point data, the function uses the 12-bit variant of the scaling coefficients.

The [[Internal_functions#Matrix|_Matrix]], [[Internal_functions#ColorSpace|_ColorSpace]] and [[Internal_functions#Transfer|_Transfer]] frame properties are set according to the transformation. The [[Internal_functions#ColorRange|_ColorRange]] property is set if the full parameter has been explicitely defined.

If an alpha channel is present in both the source and destination colorspaces, it is copied and its bitdepth is possibly adapted to the destination format. If there is no alpha channel in the source, full opacity is assumed. If there is no alpha channel in the destination, the plane is lost.
 
:{{Template:FuncDef|fmtc_matrix2020cl (clip c, bool full, string csp, int bits, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::For RGB, only 16-bit clips are supported
 
::{{Par2|full|bool|false}}
:::Indicates if the Y’Cb’Cr’ clip is full-range (True) or TV-range (False). Reference black and white have different values depending on the range. In 8 bits, pixel values scale from 0 to 255 in full range, and 16 to 235 in TV-range (16 to 240 for the YUV chroma planes). This value has no meaning for float data.
 
::{{Par2|csp|string|(undefined)}}
:::It must be compatible with what is logically expected as output (RGB or YUV). It cannot change the data type (integer or float) nor the chroma subsampling. If the output is integer RGB, the bitdepth must be 16. Only planar colorspaces are allowed.
:::The format is a string with the same kind of content as the result from [[Internal_functions#BuildPixelType | BuildPixelType]] or the pixel_type parameter from BlankClip. For example: "RGBP48", "YV12", "YUV444PS"…
 
::{{Par2|bits|int|(undefined)}}
:::Explicit specification of the destination bitdepth. The only allowed values are 8, 10, 12, 14, 16 and 32. They are restricted by the output data type and format (16 bits for integer RGB). Supersedes the bitdepth from csp.
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)

== Information, [[Script variables|Syntax and Parameters]] for fmtc_primaries ==
Performs a gamut conversion given a set of three primary colors and a reference white to another set of primary colors and a target reference white. Illuminant conversions are done using the Bradford method.

Pixel values are left intact after the transform, they are not bound to the target gamut and could be invalid colors. However, when using 16-bit unsigned integer they are clipped to representable data values.

All colors are given in xyY colorspace, with their x and y coordinates.

You must supply the full description of the original and target gamuts, with the built-in presets or by setting individual components.

Please note that this function does not work at the same level as matrix. The latter converts between gamma-compressed RGB and YUV-like colorspaces, while primaries operates on linear RGB colorspaces exclusively, whose specifications are given by the primaries. For more details, see [https://web.archive.org/web/20220306120040/http://poynton.ca/PDFs/Guided_tour.pdf|Charles Poynton, A Guided Tour of Color Space, 1997].

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_primaries (clip c, arrayf rs, arrayf gs, arrayf bs,arrayf ws, arrayf rd, arrayf gd, arrayf bd, arrayf wd, string prims, string primd, int cpuopt)}}
::{{Par2|c|clip| }}
:::Input clip.
:::Supported colorspaces are 16- or 32-bit linear RGB. You should use the transfer function to convert between linear RGB and gamma-compressed R’G’B ’colorspaces.
 
::{{Par2|rs|array|(undefined)}}
::{{Par2|gs|array|(undefined)}}
::{{Par2|bs|array|(undefined)}}
::{{Par2|ws|array|(undefined)}}
:::Primaries for the source colorspace as red, green, blue and reference white. Each variable contains two components, x and y, in this order. The y value cannot be null.
:::Parameters can be arrays of two float values if supported by the scripting language, or strings containing both values printed and separated with a space.
 
::{{Par2|rd|array|(undefined)}}
::{{Par2|gd|array|(undefined)}}
::{{Par2|bd|array|(undefined)}}
::{{Par2|wd|array|(undefined)}}
:::Primaries for the target colorspace. If not specified, the value is copied from the source colorspace.
 
::{{Par2|prims|string|(undefined)}}
::{{Par2|primd|string|(undefined)}}
:::Primaries presets for the source and destination colorspaces. Superseded by individual r, g, b and w settings. Possible values are:

Value |Primary |x |y |Description
--------------+--------------+---------+---------+--------------
"709" or |R |0.640, 0.330 |ITU-R BT.709-5
"1361" or |G |0.300, 0.600 |ITU-R BT.1361
"61966-2-1" or|B |0.150, 0.060 |IEC 61966-2-1 (sRGB or sYCC)
"61966-2-4" or|W(65) |0.3127, 0.3290 |IEC 61966-2-4
"hdtv" or | | |Annex B of SMPTE RP 177 (1993)
"srgb" or | | |
--------------+--------------+---------+---------+--------------
"470m" or |R |0.670, 0.330 |ITU-R BT.470-6 System M (historical)
"ntsc" |G |0.210, 0.710 |NTSC (1953)
|B |0.140, 0.080 |FCC
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"470m93" or |R |0.670, 0.330 |ITU-R BT.470-6 System M — Japan (NTSC-J)
"ntscj" |G |0.210, 0.710 |
|B |0.140, 0.080 |
|W (9305K) |0.2848, 0.2932 |
--------------+--------------+---------+---------+--------------
"470bg" or |R |0.640, 0.330 |ITU-R BT.470-6 System B, G (historical)
"601-625" or |G |0.290, 0.600 |ITU-R BT.601-6 625
"1358-625" or |B |0.150, 0.060 |ITU-R BT.1358 625
"1700-625" or |W (65) |0.3127, 0.3290 |ITU-R BT.1700 625 PAL and 625 SECAM
"pal" or | | |
"secam" | | |
--------------+--------------+---------+---------+--------------
"170m" or |R |0.630, 0.340 |SMPTE 170M (2004)
"240m" or |G |0.310, 0.595 |SMPTE 240M (1999)
"601-525" or |B |0.155, 0.070 |ITU-R BT.601-6 525
"1358-525" or |W (65) |0.3127, 0.3290 |ITU-R BT.1358 525
"1700-525" | | |ITU-R BT.1700 NTSC
--------------+--------------+---------+---------+--------------
"filmc" |R (Wratten 25)|0.681, 0.319 |Generic film (colour filters using Illuminant C)
|G (Wratten 58)|0.243, 0.692 |
|B (Wratten 47)|0.145, 0.049 |
|W (C) |0.3100, 0.3160 |
--------------+--------------+---------+---------+--------------
"2020" or |R |0.70792, 0.29203 |ITU-R BT.2020
"2100" or |G |0.17024, 0.79652 |ITU-R BT.2100
"uhdtv" |B |0.13137, 0.04588 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"61966-2-2" or|R |0.640, 0.330 |IEC 61966-2-4 (scRGB)
"scrgb" |G |0.300, 0.600 |
|B |0.150, 0.060 |
|W (65) |0.31271, 0.32902 |
--------------+--------------+---------+---------+--------------
"adobe98" |R |0.640, 0.330 |Adobe RGB (1998)
|G |0.210, 0.710 |
|B |0.150, 0.060 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"adobewide" |R |0.73469, 0.26531 |Adobe Wide Gamut RGB
|G |0.11416, 0.82621 |
|B |0.15664, 0.01770 |
|W (50) |0.34567, 0.35850 |
--------------+--------------+---------+---------+--------------
"apple" |R |0.625, 0.265 |Apple RGB
|G |0.280, 0.826 |
|B |0.155, 0.018 |
|W (65) |0.31271 0.32902 |
--------------+--------------+---------+---------+--------------
"photopro" or |R |0.7347, 0.2653 |PhotoPro
"romm" |G |0.1596, 0.8404 |ROMM
|B |0.0366, 0.0001 |
|W (50) |0.34567 0.35850 |
--------------+--------------+---------+---------+--------------
"ciergb" |R |0.7347, 0.2653 |CIE RGB (1931)
|G |0.2738, 0.7174 |
|B |0.1666, 0.0089 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"ciexyz" |R |1.0, 0.0 |CIE XYZ (1931)
|G |0.0, 1.0 |
|B |0.0, 0.0 |
|W (E) |1 / 3, 1 / 3 |
--------------+--------------+---------+---------+--------------
"p3dci" |R |0.680, 0.320 |SMPTE ST 2113 P3-DCI
|G |0.265, 0.690 |SMPTE RP 431-2
|B |0.150, 0.060 |
|W |0.314, 0.351 |
--------------+--------------+---------+---------+--------------
"p3d65" |R |0.680, 0.320 |SMPTE ST 2113 P3-D65
|G |0.265, 0.690 |SMPTE EG 432-1
|B |0.150, 0.060 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p3d60" |R |0.680, 0.320 |ACES P3-D60
|G |0.265, 0.690 |
|B |0.150, 0.060 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"3213" |R |0.630, 0.340 |EBU Tech. 3213-E
|G |0.295, 0.605 |
|B |0.155, 0.077 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"aces" |R |0.7347, 0.2653 |ACES
|G |0.0, 1.0 |SMPTE ST 2065-1
|B |0.0001, -0.077 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"ap1" |R |0.713, 0.293 |ACEScc/ACESproxy AP1
|G |0.165, 0.830 |
|B |0.128, -0.044 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"sgamut" or |R |0.730, 0.280 |Sony S-Gamut
"sgamut3" |G |0.140, 0.855 |Sony S-Gamut3
|B |0.100, -0.050 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"sgamut3cine" |R |0.766, 0.275 |Sony S-Gamut3.Cine
|G |0.225, 0.800 |
|B |0.089, -0.087 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"alexa" |R |0.6840, 0.3130 |Arri ALEXA
|G |0.2210, 0.8480 |
|B |0.0861, -0.1020 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"vgamut" |R |0.730, 0.280 |Panasonic V-Gamut
|G |0.165, 0.840 |
|B |0.100, -0.03 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"p22" |R |0.625, 0.340 |Sony P22
|G |0.280, 0.595 |
|B |0.280, 0.070 |
|D(93) |0.28315, 0.29711 |
--------------+--------------+---------+---------+--------------
"fs" |R |0.7347, 0.2653 |Free Scale-gamut
|G |0.140, 0.860 |
|B |0.100, −0.02985 |
|W (65) |0.31272, 0.32903 |
--------------+--------------+---------+---------+--------------
"davinci" |R |0.8000, 0.3130 |DaVinci wide gamut
|G |0.1682, 0.9877 |
|B |0.0790, −0.1155 |
|W (65) |0.3127, 0.3290 |
--------------+--------------+---------+---------+--------------
"dragon" |R |0.75304, 0.32783 |DRAGONcolor
|G |0.29957, 0.70070 |
|B |0.07964, -0.05494 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"dragon2" |R |0.75304, 0.32783 |DRAGONcolor2
|G |0.29957, 0.70070 |
|B |0.14501, 0.05110 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red" |R |0.69975, 0.32905 |REDcolor
|G |0.30426, 0.62364 |
|B |0.13491, 0.03472 |
|W (60) |0.32168, 0.03472 |
--------------+--------------+---------+---------+--------------
"red2" |R |0.87868, 0.32496 |REDcolor2
|G |0.30089, 0.67905 |
|B |0.09540, −0.02939 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red3" |R |0.70118, 0.32901 |REDcolor3
|G |0.30060, 0.68379 |
|B |0.10815, −0.00869 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"red4" |R |0.70118, 0.32901 |REDcolor4
|G |0.30060, 0.68379 |
|B |0.14533, 0.05162 |
|W (60) |0.32168, 0.33767 |
--------------+--------------+---------+---------+--------------
"redwide" |R |0.780308, 0.304253 |REDWideGamutRGB
|G |0.121595, 1.493994 |
|B |0.095612, −0.084589|
|W (65) |0.3217, 0.3290 |
:::Note: the values above were inserted in the wiki manually. In case of doubt, you should check the official docs first and foremost.
 
::{{Par2|cpuopt|int|-1}}
:::Limits the CPU instruction set.
:::*−1: automatic (no limitation)
:::*0: default instruction set only (depends on the compilation settings)
:::*1: limit to SSE2
:::*7: limit to AVX
:::*10: limit to AVX2

== Information, [[Script variables|Syntax and Parameters]] for fmtc_resample ==
Resizes the planes of a clip. This function can change the chroma subsampling.

Output is always 16-bit integer (default for integer input) or 32-bit float. Use fmtc.bitdepth to convert the result to a lower bitdepth. It is possible to select the internal precision: float, or 16-bit integers with a 32-bit accumulator for the convolution. Internal conversion from float or 32-bit integers to 16 bits is done by quick rounding (no dithering). The integer operation path is available only when input and output formats are integer too.

The function can resize interlaced content, but only if presented as separated, interleaved fields. It uses the [[Internal_functions#Field|_Field]] and [[Internal_functions#FieldBased|_FieldBased]] frame properties to detect interlaced content and field parity, maintaining the correct chroma and luma relative positions. If this automatic detection is not desired, you can specify manually the interlaced and tff parameters. Simple intra-field deinterlacing (“bob”) can be achieved this way, by specifying scalev=2.

Excepted impulse*, array parameters allow to specify plane-specific values. When specifying less than 3 values, the last specified value will be reused for the next planes. However planes works slightly differently, check the related paragraph for details.

Arrays can be specified as values printed in a string and separated with spaces.

*Note: field resizing is not always the best way to handle interlaced content, especially for upscales. You’ll probably have better results by using a “smart” deinterlacer (making use of temporal information and anti-aliasing), resizing the progressive content at double rate then reinterlacing. Simple field resampling is more or less equivalent to this method, using a naive bob.

Interlacing parameters are automatically detected with global clip information which can be overriden by frame properties.

The function can also be used to compute horizontal and vertical convolutions. If you do so, don’t forget to set:

*fh or fv to −1 to make sure the clip is processed even if its size doesn’t change;
*cnorm to false to avoid automatic kernel normalisation if your impulse is already normalised, or specify total if the normalisation factor is not the sum of the impulse;
*and center to False to keep the desired spacing between the sampling points.

The function handles the following frame properties:

Property |Read condition |Write condition
-----------------+-------------------------------+----------------------------
_FieldBased |Automatic interlacing detection|Interlaced content
_Field |Interlaced content |Interlaced content
_ChromaLocation |(none) |Depends on cplace parameters
_ColorRange |(none) |fulld is explicitly set

The [[Internal_functions#Primaries|_Primaries]] frame property is set or deleted, depending on the target gamut.
 
:{{Template:FuncDef|fmtc_resample (clip c, int w, int h, arrayf sx, arrayf sy, arrayf sw, arrayf sh, float scale, float scaleh, float scalev, string kernel, string kernelh, string kernelv, arrayf impulse, arrayf impulseh, arrayf impulsev, arrayi taps, arrayi tapsh, arrayi tapsv, arrayf a1, arrayf a2, arrayf a3, arrayf a1h, arrayf a2h, arrayf a3h, arrayf a1v, arrayf a2v, arrayf a3v, int kovrspl, arrayf fh, arrayf fv, bool cnorm, arrayf total, arrayf totalh, arrayf totalv, arrayb invks, arrayb invksh, arrayb invksv, arrayi invkstaps, arrayi invkstapsh, arrayi invkstapsv, string csp, string css, arrayf planes, int fulls, int fulld, arrayb center, string cplace, string cplaces, string cplaced, int interlaced, int interlacedd, int tff, int tffd, bool flt, int cpuopt)}}
::{{Par2|c|clip| }}
:::Clip to be resized
:::Supports all the mentioned input formats at the top + 9-bit YUV (YUV410).
::{{Par2|w|int|(undefined)}}
::{{Par2|h|int|(undefined)}}
:::New picture width and height in pixels, > 0. If not specified, it will keep the original dimensions. The dimensions must be compatible with the destination chroma subsampling. They take precedence over the scale, scaleh and scalev parameters.

==Examples==
[[TODO]]
 
 
== Changelog ==
See GitHub release page.
 
 

== External Links ==
*[https://github.com/EleonoreMizo/fmtconv GitHub] - Source code repository.

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

Fmtconv

2022-05-13T20:04:29Z

Kogarou: table completed!

Fmtconv

2022-05-13T18:42:04Z

Kogarou: more additions, WIP

Fmtconv

2022-05-13T16:02:20Z

Kogarou: filling the page with a load of stuff, saving WIP changes in case of dataloss

MVTools2/MSuper

2021-11-07T20:02:45Z

Kogarou: Fixing the Eedi3 link

[[Category:Plugin_Filters]]
[[Category:Support_filters]]
'''Back to [[MVTools#Filters|MVTools2]] ←'''
-------------------------------------------------

== Description ==
Gets a source clip and prepares a special '''Super''' clip with multilevel (hierarchical scaled) frames data. The Super clip is used by both [[MAnalyse]] and motion compensation (client) functions. 
The audio properties of the Super clip are used to store and transfer its parameters (specifically ''num_audio_samples''), therefore any existing audio is killed in the Super clip. That is one of reasons why you can additionally use a source clip with client functions. You may have a look to the Super clip yourself (it has a normal format). 
Supported formats: Y, YUV and planar RGB (8-32) bits, and YUY2. You can use a different Super clip to generate vectors with MAnalyze and a different Super clip format for the actual action. This enables support for planar RGB with MFlowFPS, and lets MDegrain work with 32 bit float input clips.

== Syntax and Parameters ==
{{FuncDef|MSuper (clip, int "hpad", int "vpad", int "pel", int "levels", bool "chroma", 
      int "sharp", int "rfilter", clip "pelclip", bool "isse", bool "planar", bool "mt") }}

:{{Par2|hpad|int|8}}
::Horizontal padding added to source frame (both left and right). A small padding is added for more correct motion estimation near frame borders.

:{{Par2|vpad|int|8}}
::Vertical padding added to source frame (both top and bottom), for the same reason as ''hpad''.

:{{Par2|pel|int|2}}
::Motion estimation accuracy. Value can only be 1, 2 or 4.
:::*1 : means precision to the pixel.
:::*2 : means precision to half a pixel.
:::*4 : means precision to quarter of a pixel, produced by spatial interpolation (more accurate but slower and not always better due to big level scale step).

:{{Par2|levels|int|0}}
::Number of hierarchical levels for super clip frames. [[MAnalyse]] needs all levels, but for other client functions a single, finest level is enough (coarser levels are not used). 0 is auto (all possible levels are produced).

:{{Par2|chroma|bool|true}}
::When true, process chroma planes too. False for luma only.

:{{Par2|sharp|int|2}}
::Sub-pixel interpolation method for when {{FuncArg|pel}} == 2 || 4.
:::*0 : soft interpolation (bilinear).
:::*1 : bicubic interpolation (4 tap Catmull-Rom)
:::*2 : sharper Wiener interpolation (6 tap, similar to Lanczos).

:{{Par2|rfilter|int|2}}
::Hierarchical levels smoothing and reducing (halving) filter.
:::* 0 : simple 4 pixels averaging like unfiltered [[SimpleResize]] (old method)
:::* 1 : triangle (shifted) filter like [[ReduceBy2]] for more smoothing (decreased aliasing)
:::* 2 : triangle filter like [[BilinearResize]] for even more smoothing
:::* 3 : quadratic filter for even more smoothing
:::* 4 : cubic filter like [[BicubicResize]](b=1,c=0) for even more smoothing

:: You may also try to apply some external filter to the''superclip'' or its coarse bottom part (by appropriate crop and overlay).

:{{Par2|pelclip|clip| }}
::Optional upsampled source clip for using instead of internal sub-pixel interpolation (for {{FuncArg|pel}} > 1).
::Pixels at rows and columns positions multiple to {{FuncArg|pel}} (0,2,4,... for {{FuncArg|pel}}=2) (without padding) must be original source pixels; other pixels must be interpolated.

::Example for {{Template:FuncDef|pel}}=2:
<div {{BoxWidthIndent|60|6}} >
MSuper(..., pel=2, pelclip=LanczosResize(width*2,height*2,src_left=0.25, src_top=0.25))
</div>
::Another useful filter for {{FuncArg|pelclip}} is the [[Eedi3]] edge-directed resampler.
::Recent note: it is true for luma, but is not exactly corresponded to chroma pixels positions of internal '''MVTools''' interpolation. Nevertheless, vectors and motion compensation are quite similar for usual clips, same chroma would be with ''src_left=0.5'' for YUY2 and additionally ''src_top=0.5'' for YV12.{{Clarify}}

== Examples ==
[[TODO]]

------------------------------------------------
'''Back to [[MVTools#Filters|MVTools2]] ←'''

MVTools2/MSuper

2021-11-07T20:01:19Z

Kogarou: Update to the description and parameters

[[Category:Plugin_Filters]]
[[Category:Support_filters]]
'''Back to [[MVTools#Filters|MVTools2]] ←'''
-------------------------------------------------

== Description ==
Gets a source clip and prepares a special '''Super''' clip with multilevel (hierarchical scaled) frames data. The Super clip is used by both [[MAnalyse]] and motion compensation (client) functions. 
The audio properties of the Super clip are used to store and transfer its parameters (specifically ''num_audio_samples''), therefore any existing audio is killed in the Super clip. That is one of reasons why you can additionally use a source clip with client functions. You may have a look to the Super clip yourself (it has a normal format). 
Supported formats: Y, YUV and planar RGB (8-32) bits, and YUY2. You can use a different Super clip to generate vectors with MAnalyze and a different Super clip format for the actual action. This enables support for planar RGB with MFlowFPS, and lets MDegrain work with 32 bit float input clips.

== Syntax and Parameters ==
{{FuncDef|MSuper (clip, int "hpad", int "vpad", int "pel", int "levels", bool "chroma", 
      int "sharp", int "rfilter", clip "pelclip", bool "isse", bool "planar", bool "mt") }}

:{{Par2|hpad|int|8}}
::Horizontal padding added to source frame (both left and right). A small padding is added for more correct motion estimation near frame borders.

:{{Par2|vpad|int|8}}
::Vertical padding added to source frame (both top and bottom), for the same reason as ''hpad''.

:{{Par2|pel|int|2}}
::Motion estimation accuracy. Value can only be 1, 2 or 4.
:::*1 : means precision to the pixel.
:::*2 : means precision to half a pixel.
:::*4 : means precision to quarter of a pixel, produced by spatial interpolation (more accurate but slower and not always better due to big level scale step).

:{{Par2|levels|int|0}}
::Number of hierarchical levels for super clip frames. [[MAnalyse]] needs all levels, but for other client functions a single, finest level is enough (coarser levels are not used). 0 is auto (all possible levels are produced).

:{{Par2|chroma|bool|true}}
::When true, process chroma planes too. False for luma only.

:{{Par2|sharp|int|2}}
::Sub-pixel interpolation method for when {{FuncArg|pel}} == 2 || 4.
:::*0 : soft interpolation (bilinear).
:::*1 : bicubic interpolation (4 tap Catmull-Rom)
:::*2 : sharper Wiener interpolation (6 tap, similar to Lanczos).

:{{Par2|rfilter|int|2}}
::Hierarchical levels smoothing and reducing (halving) filter.
:::* 0 : simple 4 pixels averaging like unfiltered [[SimpleResize]] (old method)
:::* 1 : triangle (shifted) filter like [[ReduceBy2]] for more smoothing (decreased aliasing)
:::* 2 : triangle filter like [[BilinearResize]] for even more smoothing
:::* 3 : quadratic filter for even more smoothing
:::* 4 : cubic filter like [[BicubicResize]](b=1,c=0) for even more smoothing

:: You may also try to apply some external filter to the''superclip'' or its coarse bottom part (by appropriate crop and overlay).

:{{Par2|pelclip|clip| }}
::Optional upsampled source clip for using instead of internal sub-pixel interpolation (for {{FuncArg|pel}} > 1).
::Pixels at rows and columns positions multiple to {{FuncArg|pel}} (0,2,4,... for {{FuncArg|pel}}=2) (without padding) must be original source pixels; other pixels must be interpolated.

::Example for {{Template:FuncDef|pel}}=2:
<div {{BoxWidthIndent|60|6}} >
MSuper(..., pel=2, pelclip=LanczosResize(width*2,height*2,src_left=0.25, src_top=0.25))
</div>
::Another useful filter for {{FuncArg|pelclip}} is the [[EEDI3]] edge-directed resampler.
::Recent note: it is true for luma, but is not exactly corresponded to chroma pixels positions of internal '''MVTools''' interpolation. Nevertheless, vectors and motion compensation are quite similar for usual clips, same chroma would be with ''src_left=0.5'' for YUY2 and additionally ''src_top=0.5'' for YV12.{{Clarify}}

== Examples ==
[[TODO]]

------------------------------------------------
'''Back to [[MVTools#Filters|MVTools2]] ←'''

MVTools

2021-11-07T19:59:22Z

Kogarou: Addition of mt to the common parameters along a suggestion

{{FilterCat5|External_filters|Plugins|Plugins_x64|Other_filters|Support_filters}}
[[Category:Deep_color_tools]]
{{Filter
|Manao, Fizick, Tsp, TSchniede, SEt, cretindesalpes, pinterf
|v2.7.39
|'''[https://github.com/pinterf/mvtools/releases mvtools-2.7.39-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-.

'''Latest documentation: 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]]. '''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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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. 
| [[YV12]], [[YUY2]], 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. 
| [[YV12]], [[YUY2]], 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]], 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]], 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.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. 
|-
|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 
|-
|2.7.28
|20180323
|pinterf
|Fix: in MDegrain1-6/N allow Y8 input for out16 parameter 
|-
|2.7.27
|20180318
|pinterf
|Fix: MDepan: use zerow parameter. The parameter had no effect probably since it had been introduced. 
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) 
|-
|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). 
Faster: special 10 bit SAD functions instead of the generic 10-16bit one. 
|-
|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. 
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 
MSuper: import 8 bit sse2 interpolators from mvtools-vs. Extend them for 10-16bits (faster super clip). Some filters are still todo. 
MSuper: support 32bit float clips, which can be used later by MDegrains (but not for MAnalyse) 
MDegrains: allow degraining clip with different bit depth from vectors. Clip and Super must be the same bit depth 
MDegrains: consistently use limit and limitC, 255 do nothing, otherwise scale 0-254 value to the current bit-depth range 
Overlaps: more correct internal rounding for 8 bits 
Overlaps: round for 16bits 
Overlaps: 32bit float (but still use the original 11 bit window constants) 
Project: change from yasm to nasm. 
|-
|2.7.24
|20171205
|pinterf
|Fix: MFlowBlur: possible access violation crash when nPel>1 
New: MScaleVect parameter 'bits'. e.g. Analyze 8 bit clips, use their vectors for 16 bits 
Move project to VS2017 
|-
|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) 
|-
|2.7.22
|20170830
|pinterf
|Misc: Stop using version suffix .22 
Fix: [DCT 8x8@8bit] garbage on x64: internal assembly code did not save xmm6/xmm7 
Fix: [DCT 8x8@8bit] safe multithreading for integer DCT (8x8 block size, 8 bit video): assembly had a single working buffer. 
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) 
Mod: fftw conversion constant of sqrt(2)/2 is more accurate (was:0.707), 16 bit formats may benefit (by feisty2) 
Fix: SSE4 assembly instructions in x64, broke on non-SSE4 processors 
|-
|2.7.21.22
|20170629
|pinterf
|Mod: [MMask] Faster: request source frame only for kind=5. 
|-
|2.7.20.22
|2017.05.26
|pinterf
|Fix: [MMask] greyscale input resulted in AV when filter exiting 
|-
|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 
Mod: [MMask] Faster: request source frame only for kind=5. 
Fix: [MxxxxFPS,MMask]: MakeVectorOcclusionMaskTime garbage in bottom blocks 
Fix: [MMask] bottom padding garbage for padded frame dimension 
Fix: [MMask] proper 10+ bits scene change values (for default: 1023, 4095, 16383, 65535. Was: 65535). Parameter is still in 8-bit range 
Fix: [MRecalculate] prevent overflow during thSAD scaling in 16 bits or large block sizes (32, 48...) 
Fix: [DepanEstimate] Sometimes giving wrong motion instead of scene change detection. Bug only existed in previous pfmod builds. 
Fix: [MAnalyze] Possible overflow in MAnalyze 8 bit, block size 48x48 and above. Overflow-safe predictor recalc for big block sizes. 
New: [General] Add block size 12x3 for SAD, allow 6x24 
List of available block sizes 
- 64x64, 64x48, 64x32, 64x16 
- 48x64, 48x48, 48x24, 48x12 
- 32x64, 32x32, 32x24, 32x16, 32x8 
- 24x48, 24x24, 24x32, 24x12, 24x6 
- 16x64, 16x32, 16x16, 16x12, 16x8, 16x4, 16x2 
- 12x48, 12x24, 12x16, 12x12, 12x6, 12x3 
- 8x32, 8x16, 8x8, 8x4, 8x2, 8x1 
- 6x24, 6x12, 6x6, 6x3 
- 4x8, 4x4, 4x2 
- 3x6, 3x3 
- 2x4, 2x2 
Mod: [Internal] Reorganized 10-16 bit SAD simd intrinsics, faster 8-12% for BlkSize 12-32 
|-
|2.7.18.22
|2017.05.12
|pinterf
|Fix: 10-16 bit: DCT buffer possible overflow 
Fix: DCT is fast again for non 8x8 blocksizes. Regression since 2.7.5.22. 
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) 
New: MAnalyze, MRecalculate new parameter: "scaleCSAD" integer, default 0. 
Fine tune chroma SAD weight relative to luma SAD. 
ScaleCSAD values for luma:chroma SAD ratio 
* -2: 4:0.5 
* -1: 4:1 
* 0: 4:2 (default, same as the native ratio for YV12) 
* 1: 4:4 
* 2: 4:8 
New: Block sizes 64, 48, 24, 12, 6. 
MAnalyze/MRecalculate new block sizes (SATD support mod4 sizes) 
Note: some smaller block sizes can only be available in 4:4:4 formats, due to block size division (chroma subsampling) 
New: All block sizes are supported in MDegrain1-6, MDegrainN, and MScaleVect 
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 
For some block sizes AVX2 and SSE4 is supported (AVX2 if reported under AviSynth+) e.g. BlkSize 32 is faster now. 
New: MMask SAD Mask to give identical weights for other-than-YV12 formats, e.g. for YV24 
|-
|2.7.17.22
|2017.04.26
|pinterf
|Fix: Regression in 2.7.16.22: MDegrain right pixel artifacts on non-modulo 16 widths 
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) 
|-
|2.7.16.22
|2017.04.23
|pinterf
|Fix: MMask 10-16 bits 
Fix: MRecalculate 14-16 bits passed nSCD1=999999 internally which caused overflow (scene change problems later) 
Fix is done by clamping SCD1 to 8*8*(255-0) (maximum value of sum of SADs on a 8x8 block) 
Misc: MDegrainX 8 bits: internal 16 bit buffer to 8 bits: SSE2 
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) 
|-
|2.7.15.22
|2017.03.16
|pinterf
|Fix: 16 bit SAD for non-AVX code path 
Misc: MDegrain1-6: add error on lsb_flag=true for non-8 bit sources 
|-
|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) 
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) 
|-
|2.7.13.22
|2017.02.01
|pinterf
|Fix: MDegrain1-6,N 10-16 bit thSCD scaling 
Fix: MVShow: tolerance scaling for 10-16 bits 
|-
|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 
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) 
|-
|2.7.11.22
|2017.01.16
|pinterf
|New: MDegrain6 
Mod: MDegrain1-6 SSE4 for 10-16 bit (was: C. 3-5% gain, wasn't bottleneck) 
|-
|2.7.10.22
|2016.12.28
|pinterf
|Fix: for YV12 the debug info text chroma part was positioned at wrong place 
|-
|2.7.9.22
|2016.12.20
|pinterf
|Apply 2.5.11.9-svp analysis speedup, mainly when chroma is involved 
|-
|2.7.8.22
|2016.12.18
|pinterf
|Fix: YUY2 input access violation (regression after 2.7.0.22d) - Fixed also in Depan.dll 
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 
|-
|2.7.7.22
|2016.12.14
|pinterf
|Optimizing 8 bits 
speed: change some 8 bit SAD functions for the better 
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 
speed: more __forceinlines for helping the compiler 
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 
|-
|2.7.6.22
|2016.12.04
|pinterf
|fix: sumLumaChange underflow (used for dct=2,6,9) (regression during 16 bit support) 
fix: MeanLumaChange scale for 10-16 bits (used for dct=2,6,9) 
fix: Mask fix: 8 bit mask resizer bug in SIMD intrinsics (regression on inline asm -> SIMD transition) 
Fix: dctmode=1,2: pixel distance was not corrected for 16 bit pixel sizes 
speed: Let's help VS2015 with some __forceinline directives to recognize the truth. 
speed: Misc optimizations throughout the code (bit shifts instead of div or mul) 
speed: FFTW DCT: C code replaced with SIMD SSE2/SSE4 (FloatToBytes, BytesToFloat) 
speed: 16 bit SAD: a few optimizations in SSE2, AVX-coded SSE2 and AVX2 codepath 
VS2015 compiler: /MT -> /MD (from static to dynamic dlls - now it reallys need VS2015 redistributables) 
|-
|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. 
Fix for MSCDetection: scene change filler pixel default value was always 0 (2.7.1.22 regression) 
MCompensate: possible bugfix bottom padding UV 
Fix SAD for 10-16 bit depths for horizontal block sizes >= 16 
Fix nSCD2 (Scene change threshold block count %) (2.7.1.22 regression) 
MBlockFPS: overlap fixes (right columns and bottom lines) 
MBlockFPS: overlap fix: missing copy buffer to output 
|-
|2.7.1.22
|2016.10.20
|pinterf
|YV16 and YV24 avaliable 
dct modes >= 5 now use SATD again (so far it was in dead code, contrary to 2.5.13.1 remarks) 
New: MDegrain4, MDegrain5 
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) 
Inline assembly rewritten to intrinsics -> 64 bit build is possible in VS2015 (External assembly untouched) 
|-
|2.7.0.22
|2016.04.29
|pinterf
|Integrate Fizick's upstream changes of 2.5.11.22 
|-
|2.7.0.1
|2016.03.31
|pinterf
|MVTools-pfmod 
2.6.0.5 x64 capable version ported under AviSynth 2.6 API 
Fixed access violation in MDepan 
Fixed access violation in x64 asm code 
Built with Visual Studio 2015 Community Edition, v140_xp toolset 
Compiler: Intel C++ 16 (because of inline 64 bit asm code) 
See [https://forum.doom9.org/showthread.php?t=173356 discussion] and [https://github.com/pinterf/mvtools/tree/mvtools-pfmod GitHub page] for more information. 
|-
|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. 
MDegrainN: fixed systematic crash in multithreading mode. 
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. 
MCompensate: added multi-compensation mode for easy use with temporal filters. 
MAnalyse, MSuper, MCompensate, MDegrainN: added multithreading (but partially, not for all code paths) using AVSTP. 
MAnalyse: fixed a corruption of the global motion vector. 
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. 
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. 
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. 
MAnalyse: Added the "multi" mode for MDegrainN. 
MAnalyse: Documented the negative delta values and fixed some functions accordingly. 
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]
 
 
== 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++.
 
==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.

MVTools

2021-11-04T20:17:29Z

Kogarou: Update to the main page of mvtools2 as per the latest docs + removal of legacy info

{{FilterCat5|External_filters|Plugins|Plugins_x64|Other_filters|Support_filters}}
[[Category:Deep_color_tools]]
{{Filter
|Manao, Fizick, Tsp, TSchniede, SEt, cretindesalpes, pinterf
|v2.7.39
|'''[https://github.com/pinterf/mvtools/releases mvtools-2.7.39-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-.

'''Latest documentation: 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.

== Filters ==
{{PluginFilterTable}}
|-
{{PluginFilterRow|MVTools2|MSuper|
Get source clip and prepare special "super" clip with multilevel (hierarchical scaled) frames data.
| [[YV12]], [[YUY2]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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]], 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. 
| [[YV12]], [[YUY2]], 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. 
| [[YV12]], [[YUY2]], 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]], 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]], 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.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. 
|-
|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 
|-
|2.7.28
|20180323
|pinterf
|Fix: in MDegrain1-6/N allow Y8 input for out16 parameter 
|-
|2.7.27
|20180318
|pinterf
|Fix: MDepan: use zerow parameter. The parameter had no effect probably since it had been introduced. 
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) 
|-
|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). 
Faster: special 10 bit SAD functions instead of the generic 10-16bit one. 
|-
|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. 
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 
MSuper: import 8 bit sse2 interpolators from mvtools-vs. Extend them for 10-16bits (faster super clip). Some filters are still todo. 
MSuper: support 32bit float clips, which can be used later by MDegrains (but not for MAnalyse) 
MDegrains: allow degraining clip with different bit depth from vectors. Clip and Super must be the same bit depth 
MDegrains: consistently use limit and limitC, 255 do nothing, otherwise scale 0-254 value to the current bit-depth range 
Overlaps: more correct internal rounding for 8 bits 
Overlaps: round for 16bits 
Overlaps: 32bit float (but still use the original 11 bit window constants) 
Project: change from yasm to nasm. 
|-
|2.7.24
|20171205
|pinterf
|Fix: MFlowBlur: possible access violation crash when nPel>1 
New: MScaleVect parameter 'bits'. e.g. Analyze 8 bit clips, use their vectors for 16 bits 
Move project to VS2017 
|-
|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) 
|-
|2.7.22
|20170830
|pinterf
|Misc: Stop using version suffix .22 
Fix: [DCT 8x8@8bit] garbage on x64: internal assembly code did not save xmm6/xmm7 
Fix: [DCT 8x8@8bit] safe multithreading for integer DCT (8x8 block size, 8 bit video): assembly had a single working buffer. 
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) 
Mod: fftw conversion constant of sqrt(2)/2 is more accurate (was:0.707), 16 bit formats may benefit (by feisty2) 
Fix: SSE4 assembly instructions in x64, broke on non-SSE4 processors 
|-
|2.7.21.22
|20170629
|pinterf
|Mod: [MMask] Faster: request source frame only for kind=5. 
|-
|2.7.20.22
|2017.05.26
|pinterf
|Fix: [MMask] greyscale input resulted in AV when filter exiting 
|-
|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 
Mod: [MMask] Faster: request source frame only for kind=5. 
Fix: [MxxxxFPS,MMask]: MakeVectorOcclusionMaskTime garbage in bottom blocks 
Fix: [MMask] bottom padding garbage for padded frame dimension 
Fix: [MMask] proper 10+ bits scene change values (for default: 1023, 4095, 16383, 65535. Was: 65535). Parameter is still in 8-bit range 
Fix: [MRecalculate] prevent overflow during thSAD scaling in 16 bits or large block sizes (32, 48...) 
Fix: [DepanEstimate] Sometimes giving wrong motion instead of scene change detection. Bug only existed in previous pfmod builds. 
Fix: [MAnalyze] Possible overflow in MAnalyze 8 bit, block size 48x48 and above. Overflow-safe predictor recalc for big block sizes. 
New: [General] Add block size 12x3 for SAD, allow 6x24 
List of available block sizes 
- 64x64, 64x48, 64x32, 64x16 
- 48x64, 48x48, 48x24, 48x12 
- 32x64, 32x32, 32x24, 32x16, 32x8 
- 24x48, 24x24, 24x32, 24x12, 24x6 
- 16x64, 16x32, 16x16, 16x12, 16x8, 16x4, 16x2 
- 12x48, 12x24, 12x16, 12x12, 12x6, 12x3 
- 8x32, 8x16, 8x8, 8x4, 8x2, 8x1 
- 6x24, 6x12, 6x6, 6x3 
- 4x8, 4x4, 4x2 
- 3x6, 3x3 
- 2x4, 2x2 
Mod: [Internal] Reorganized 10-16 bit SAD simd intrinsics, faster 8-12% for BlkSize 12-32 
|-
|2.7.18.22
|2017.05.12
|pinterf
|Fix: 10-16 bit: DCT buffer possible overflow 
Fix: DCT is fast again for non 8x8 blocksizes. Regression since 2.7.5.22. 
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) 
New: MAnalyze, MRecalculate new parameter: "scaleCSAD" integer, default 0. 
Fine tune chroma SAD weight relative to luma SAD. 
ScaleCSAD values for luma:chroma SAD ratio 
* -2: 4:0.5 
* -1: 4:1 
* 0: 4:2 (default, same as the native ratio for YV12) 
* 1: 4:4 
* 2: 4:8 
New: Block sizes 64, 48, 24, 12, 6. 
MAnalyze/MRecalculate new block sizes (SATD support mod4 sizes) 
Note: some smaller block sizes can only be available in 4:4:4 formats, due to block size division (chroma subsampling) 
New: All block sizes are supported in MDegrain1-6, MDegrainN, and MScaleVect 
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 
For some block sizes AVX2 and SSE4 is supported (AVX2 if reported under AviSynth+) e.g. BlkSize 32 is faster now. 
New: MMask SAD Mask to give identical weights for other-than-YV12 formats, e.g. for YV24 
|-
|2.7.17.22
|2017.04.26
|pinterf
|Fix: Regression in 2.7.16.22: MDegrain right pixel artifacts on non-modulo 16 widths 
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) 
|-
|2.7.16.22
|2017.04.23
|pinterf
|Fix: MMask 10-16 bits 
Fix: MRecalculate 14-16 bits passed nSCD1=999999 internally which caused overflow (scene change problems later) 
Fix is done by clamping SCD1 to 8*8*(255-0) (maximum value of sum of SADs on a 8x8 block) 
Misc: MDegrainX 8 bits: internal 16 bit buffer to 8 bits: SSE2 
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) 
|-
|2.7.15.22
|2017.03.16
|pinterf
|Fix: 16 bit SAD for non-AVX code path 
Misc: MDegrain1-6: add error on lsb_flag=true for non-8 bit sources 
|-
|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) 
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) 
|-
|2.7.13.22
|2017.02.01
|pinterf
|Fix: MDegrain1-6,N 10-16 bit thSCD scaling 
Fix: MVShow: tolerance scaling for 10-16 bits 
|-
|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 
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) 
|-
|2.7.11.22
|2017.01.16
|pinterf
|New: MDegrain6 
Mod: MDegrain1-6 SSE4 for 10-16 bit (was: C. 3-5% gain, wasn't bottleneck) 
|-
|2.7.10.22
|2016.12.28
|pinterf
|Fix: for YV12 the debug info text chroma part was positioned at wrong place 
|-
|2.7.9.22
|2016.12.20
|pinterf
|Apply 2.5.11.9-svp analysis speedup, mainly when chroma is involved 
|-
|2.7.8.22
|2016.12.18
|pinterf
|Fix: YUY2 input access violation (regression after 2.7.0.22d) - Fixed also in Depan.dll 
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 
|-
|2.7.7.22
|2016.12.14
|pinterf
|Optimizing 8 bits 
speed: change some 8 bit SAD functions for the better 
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 
speed: more __forceinlines for helping the compiler 
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 
|-
|2.7.6.22
|2016.12.04
|pinterf
|fix: sumLumaChange underflow (used for dct=2,6,9) (regression during 16 bit support) 
fix: MeanLumaChange scale for 10-16 bits (used for dct=2,6,9) 
fix: Mask fix: 8 bit mask resizer bug in SIMD intrinsics (regression on inline asm -> SIMD transition) 
Fix: dctmode=1,2: pixel distance was not corrected for 16 bit pixel sizes 
speed: Let's help VS2015 with some __forceinline directives to recognize the truth. 
speed: Misc optimizations throughout the code (bit shifts instead of div or mul) 
speed: FFTW DCT: C code replaced with SIMD SSE2/SSE4 (FloatToBytes, BytesToFloat) 
speed: 16 bit SAD: a few optimizations in SSE2, AVX-coded SSE2 and AVX2 codepath 
VS2015 compiler: /MT -> /MD (from static to dynamic dlls - now it reallys need VS2015 redistributables) 
|-
|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. 
Fix for MSCDetection: scene change filler pixel default value was always 0 (2.7.1.22 regression) 
MCompensate: possible bugfix bottom padding UV 
Fix SAD for 10-16 bit depths for horizontal block sizes >= 16 
Fix nSCD2 (Scene change threshold block count %) (2.7.1.22 regression) 
MBlockFPS: overlap fixes (right columns and bottom lines) 
MBlockFPS: overlap fix: missing copy buffer to output 
|-
|2.7.1.22
|2016.10.20
|pinterf
|YV16 and YV24 avaliable 
dct modes >= 5 now use SATD again (so far it was in dead code, contrary to 2.5.13.1 remarks) 
New: MDegrain4, MDegrain5 
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) 
Inline assembly rewritten to intrinsics -> 64 bit build is possible in VS2015 (External assembly untouched) 
|-
|2.7.0.22
|2016.04.29
|pinterf
|Integrate Fizick's upstream changes of 2.5.11.22 
|-
|2.7.0.1
|2016.03.31
|pinterf
|MVTools-pfmod 
2.6.0.5 x64 capable version ported under AviSynth 2.6 API 
Fixed access violation in MDepan 
Fixed access violation in x64 asm code 
Built with Visual Studio 2015 Community Edition, v140_xp toolset 
Compiler: Intel C++ 16 (because of inline 64 bit asm code) 
See [https://forum.doom9.org/showthread.php?t=173356 discussion] and [https://github.com/pinterf/mvtools/tree/mvtools-pfmod GitHub page] for more information. 
|-
|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. 
MDegrainN: fixed systematic crash in multithreading mode. 
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. 
MCompensate: added multi-compensation mode for easy use with temporal filters. 
MAnalyse, MSuper, MCompensate, MDegrainN: added multithreading (but partially, not for all code paths) using AVSTP. 
MAnalyse: fixed a corruption of the global motion vector. 
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. 
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. 
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. 
MAnalyse: Added the "multi" mode for MDegrainN. 
MAnalyse: Documented the negative delta values and fixed some functions accordingly. 
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]
 
 
== 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++.
 
==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.