MaskTools2/Mt merge - Revision history

Reel.Deal: typo

2021-09-28T04:59:24Z

typo

Reel.Deal: add luma parameter notes and add "topleft" to cplace

2021-09-28T04:53:54Z

add luma parameter notes and add "topleft" to cplace

Pinterf: /* Description */ Formula for 10+ bit depths

2018-07-10T13:11:14Z

‎Description: Formula for 10+ bit depths

Pinterf: /* Syntax and Parameters */ New parameters 2.2.15-

2018-07-10T13:03:51Z

‎Syntax and Parameters: New parameters 2.2.15-

Pinterf: /* Description */ Update formula

2018-07-10T12:55:39Z

‎Description: Update formula

Reel.Deal: mt_merge

2014-10-27T02:43:09Z

mt_merge

New page

{{FilterCat4|External_filters|Plugin_functions|Other_filters|Support_filters}}
== Description ==
It's the backbone of the framework. It merges two clips according to the mask. The bigger the mask value, the more the second clip will be taken into account. 
The actual formula is: y = ((256 - m) * x1 + m * x2 + 128) / 256
 
 
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|mt_merge (clip, clip, clip, bool "luma", int "Y", int "U", int"V", string "chroma", int "offX", int "offY", int "w" int "h")}}
 
::{{Par2| |clip| }}
:::Input clip one.
 
::{{Par2| |clip| }}
:::Input clip two.
 
::{{Par2| |clip| }}
:::Mask input clip.
 
::{{Par2|luma|bool|false}}
:::luma is a special mode, where only the luma plane of the mask is used to process all three channels.
 
::{{Par2|Y|int|3}}
::{{Par2|U|int|2}}
::{{Par2|V|int|2}}
:::These three values describe the actual processing mode that is to be used on each plane / channel. Here is how the modes are coded :
::::*x = -255...0 : all the pixels of the plane will be set to -x.
::::*x = 1 : the plane will not be processed. That means the content of the plane after the filter is pure garbage.
::::*x = 2 : the plane of the first input clip will be copied.
::::*x = 3 : the plane will be processed with the processing the filter is designed to do.
::::*x = 4 : the plane of the second input clip will be copied.
:::U and V are defaulted to 2 (that way, the resulting clip contains the chroma of clip1, and looks right).
 
::{{Par2|chroma|string|""}}
:::When defined, the value contained in this string will overwrite the u & v processing modes.
:::This is a nice addition proposed by mg262 that makes the filter more user friendly. Allowed values for chroma are:
::::*"process" : set u = v = 3.
::::*"copy" or "copy first" : set u = v = 2.
::::*"copy second" : set u = v = 4.
::::*"xxx", where xxx is a number : set u = v = -xxx.
 
::{{Par2|offX|int|0}}
::{{Par2|offY|int|0}}
:::{{Template:FuncDef3|offX}} and {{Template:FuncDef3|offY}} are the top left coordinates of the box where the actual processing shall occur. Everything outside that box will be garbage.
 
::{{Par2|w|int|-1}}
::{{Par2|h|int|-1}}
:::{{Template:FuncDef3|w}} and {{Template:FuncDef3|h}} are the width and height of the processed box. -1 means that the box extends to the lower right corner of the video. That also means that default settings are meant to process the whole picture.
 
== Examples ==
mt_merge with default settings: (TO DO)
clip1 = original
clip2 = processed
mask = mask 
mt_merge(clip1, clip2, mask, Y=3, U=2, V=2, chroma="", w=-1, h=-1)
 
 
-----------------------------------------------
'''Back to [[MaskTools2#Filters|MaskTools2]] ←'''
-----------------------------------------------

@@ Line 46: / Line 46: @@
 :::*x = 4 : the plane of the second input clip will be copied.
 :::U, V and A are defaulted to 2 (that way, the resulting clip contains the chroma (alpha) of clip1, and looks right).
-:::Note: when <code>luma=true</code>, the <code>u</code> and <code>v</code>) parameters are overridden and set to <code>u=3, v=3</code> internally.
+:::Note: when <code>luma=true</code>, the <code>u</code> and <code>v</code> parameters are overridden and set to <code>u=3, v=3</code> internally.
 <br>
 ::{{Par2|chroma|string|""}}

@@ Line 2: / Line 2: @@
 == Description ==
 It's the backbone of the framework. It merges two clips according to the mask. The bigger the mask value, the more the second clip will be taken into account.<br/>
-Since v2.2.7: keep original pixels from clip1/2 when mask is exactly 0 or 255:<br>
+<br>For 8 bits the actual formula is:
-y = (m == 0) ? x1 : (m == 255) ? x2 : ((256 - m) * x1 + m * x2 + 128) / 256
+<br>y = ((256 - m) * x1 + m * x2 + 128) / 256
 <br>
 <br>

@@ Line 32: / Line 32: @@
 <br>
 ::{{Par2|luma|bool|false}}
-:::luma is a special mode, where only the luma plane of the mask is used to process all three channels.
+:::<code>luma</code> is a special mode, where only the the first plane (luma or red plane) of the mask is used to process all three channels.
 <br>
 ::{{Par2|Y|int|3}}
@@ Line 39: / Line 40: @@
 ::{{Par2|A|int|2}}
 :::These values describe the actual processing mode that is to be used on each plane / channel. Here is how the modes are coded :
-::::*x = -255...0 : all the pixels of the plane will be set to -x. (-255..0 range can of course differ when non-8 bit video formats are used)
+:::*x = -255...0 : all the pixels of the plane will be set to -x. (-255..0 range can of course differ when non-8 bit video formats are used)
-::::*x = 1 : the plane will not be processed. That means the content of the plane after the filter is pure garbage.
+:::*x = 1 : the plane will not be processed. That means the content of the plane after the filter is pure garbage.
-::::*x = 2 : the plane of the first input clip will be copied.
+:::*x = 2 : the plane of the first input clip will be copied.
-::::*x = 3 : the plane will be processed with the processing the filter is designed to do.
+:::*x = 3 : the plane will be processed with the processing the filter is designed to do.
-::::*x = 4 : the plane of the second input clip will be copied.
+:::*x = 4 : the plane of the second input clip will be copied.
 :::U, V and A are defaulted to 2 (that way, the resulting clip contains the chroma (alpha) of clip1, and looks right).
 <br>
 ::{{Par2|chroma|string|""}}
 :::When defined, the value contained in this string will overwrite the u & v processing modes.
 :::This is a nice addition proposed by mg262 that makes the filter more user friendly. Allowed values for chroma are:
-::::*"process" : set u = v = 3.
+:::*"process" : set u = v = 3.
-::::*"copy" or "copy first" : set u = v = 2.
+:::*"copy" or "copy first" : set u = v = 2.
-::::*"copy second" : set u = v = 4.
+:::*"copy second" : set u = v = 4.
-::::*"xxx", where xxx is a number : set u = v = -xxx.
+:::*"xxx", where xxx is a number : set u = v = -xxx.
 <br>
 ::{{Par2|offX|int|0}}
@@ Line 63: / Line 66: @@
 <br>
 ::{{Par2|cplace|string|"mpeg2"}}
 :::*"mpeg1" : Simple block averaging (e.g. average 2x2 pixels to a single YV12 chroma mask)
 :::*"mpeg2" : default
-:: Since v2.2.15.
+:::*"topleft" : only for 4:2:0 videos. (added in v2.2.27)
-:: Parameter defines chroma placement hint for 4:2:0 and 4:2:2 formats.
 <br>

@@ Line 11: / Line 11: @@
 == [[Script variables|Syntax and Parameters]] ==
-:{{Template:FuncDef|mt_merge (clip, clip, clip, bool "luma", int "Y", int "U", int"V", string "chroma", int "offX", int "offY", int "w" int "h")}}
+:{{Template:FuncDef|mt_merge (clip, clip, clip, bool "luma", int "Y", int "U", int "V", string "chroma", int "offX", int "offY", int "w", int "h")}}
 <br>
 ::{{Par2| |clip| }}
@@ Line 28: / Line 30: @@
 ::{{Par2|U|int|2}}
 ::{{Par2|V|int|2}}
-:::These three values describe the actual processing mode that is to be used on each plane / channel. Here is how the modes are coded :
+::{{Par2|A|int|2}}
-::::*x = -255...0 : all the pixels of the plane will be set to -x.
+:::These values describe the actual processing mode that is to be used on each plane / channel. Here is how the modes are coded :
 ::::*x = 1 : the plane will not be processed. That means the content of the plane after the filter is pure garbage.
 ::::*x = 2 : the plane of the first input clip will be copied.
 ::::*x = 3 : the plane will be processed with the processing the filter is designed to do.
 ::::*x = 4 : the plane of the second input clip will be copied.
-:::U and V are defaulted to 2 (that way, the resulting clip contains the chroma of clip1, and looks right).
+:::U, V and A are defaulted to 2 (that way, the resulting clip contains the chroma (alpha) of clip1, and looks right).
 <br>
 ::{{Par2|chroma|string|""}}
@@ Line 52: / Line 55: @@
 :::{{Template:FuncDef3|w}} and {{Template:FuncDef3|h}} are the width and height of the processed box. -1 means that the box extends to the lower right corner of the video. That also means that default settings are meant to process the whole picture.
 <br>
 == Examples ==
 mt_merge with default settings: (TO DO)