Layer - Revision history

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

2025-01-15T14:21:23Z

‎Layer: Mention Avs+ documentation link

Reel.Deal: add link to avs+ documentation

2022-09-17T18:46:15Z

add link to avs+ documentation

Pinterf: /* Layer */ add rgb24/48 support

2020-02-07T09:51:26Z

‎Layer: add rgb24/48 support

Pinterf: /* Layer */ Avisynth+ 3.4 changes

2019-12-04T14:57:05Z

‎Layer: Avisynth+ 3.4 changes

Pinterf: /* ResetMask */ Avisynth+ additonal parameter

2019-02-05T16:22:16Z

‎ResetMask: Avisynth+ additonal parameter

Raffriff42: corrections etc

2017-04-28T11:27:48Z

corrections etc

Raffriff42: note AVS+ differences

2017-04-21T22:58:15Z

note AVS+ differences

Raffriff42: note supported color formats

2016-10-06T17:35:35Z

note supported color formats

Raffriff42: small example image for each blend mode; remove old examples

2016-08-29T11:14:31Z

small example image for each blend mode; remove old examples

Show changes

Raffriff42: one more touch-up

2016-08-22T22:15:50Z

one more touch-up

@@ Line 4: / Line 4: @@
 == Layer ==
 <div style="max-width:62em" >
 Layer (aka ''overlay'', ''blend'', ''merge'') two clips of possibly different sizes, but with the same color format.

@@ Line 142: / Line 142: @@
 == Mask ==
 <div style="max-width:62em" >
 Applies a defined alpha-mask to a clip, by converting [[RGB32]]-only {{FuncArg|mask_clip}} to greyscale and copying that greyscale information to the alpha channel of RGB32-only {{FuncArg|clip}}. In the alpha channel, "black" means transparent and "white" means opaque. For those of you who familiar with Photoshop masks, the concept is the same. In fact you can create a black and white photo in Photoshop, load it in your script and use it as a mask.
@@ Line 167: / Line 174: @@
 == ResetMask ==
 <div style="max-width:62em" >
 Applies an opaque (white) alpha channel to a clip. The alpha channel of an [[RGB32]] clip is not always well-defined, depending on the source (it may contain random data); this filter is a fast way to apply an all-white mask.
@@ Line 184: / Line 198: @@
 == ColorKeyMask ==
 <div style="max-width:62em" >
 Clears pixels in the alpha channel by comparing to a transparent {{FuncArg|color}} (default black).

@@ Line 8: / Line 8: @@
 For pixel-wise transparency information, the alpha channel of an RGBA ''overlay_clip'' is used as a mask.<br>
-{{AvsPluscon}} Before Avisynth+ 3.4.0 Layer was working only for RGB32 and YUY2. Filter "Overlay" was used primarily for YUV. Now Layer accepts practically all formats (no RGB24).<br>
+{{AvsPluscon}} Before Avisynth+ 3.4.0 Layer was working only for RGB32 and YUY2. Filter "Overlay" was used primarily for YUV. Now Layer accepts practically all formats (also RGB24/48 since v3.5).<br>
 Note that some modes can be similar to Overlay, but the two filters are still different.<br>
 Overlay accepts mask clip, Layer would use existing A plane.<br>

@@ Line 7: / Line 7: @@
 For pixel-wise transparency information, the alpha channel of an RGBA ''overlay_clip'' is used as a mask.<br>
 {{FuncDef
 |Layer( clip ''base_clip'', clip ''overlay_clip'' [, string ''op'', int ''level'', int ''x'', int ''y'', int ''threshold'', bool ''use_chroma'' ] )
 }}
@@ Line 14: / Line 27: @@
 :: The underlying clip, which determines the size and all other video and audio properties of the result.
 ::Color format must be [[YUY2]] or [[RGB32]].
-::{{AvsPluscon}} also supports [[RGB64]].
+::{{AvsPluscon}} supports all color spaces, except YV411.
 :{{Par2|overlay_clip|clip|}}
-:: The clip which is merged onto {{FuncArg|clip}}. If [[RGB32]], the alpha channel is used as a mask.
+:: The clip which is merged onto {{FuncArg|clip}}. If [[RGB32]] or other alpha-aware color space, the alpha channel is used as a mask.
 ::Color format must match {{FuncArg|base_clip}}.
 :{{Par2|op|string|"add"}}
@@ Line 40: / Line 54: @@
 *RGB: &nbsp;[[File:Layer-Eq1.png]]
 *YUY2: [[File:Layer-Eq2.png]]
 |-
 |style="vertical-align:top"| ''subtract''
@@ Line 72: / Line 89: @@
 ::* 0 &ndash; no effect: {{FuncArg|base_clip}} is returned unchanged
 ::* 257 (256 for YUY2) &ndash; maximum strength
-::{{AvsPluscon}} [[Autoscale_parameter|autoscaled]] &ndash; works without changes at all bit depths.
+::{{AvsPluscon}} deprecated &ndash; use {{FuncArg|opacity}} instead.
 :{{Par2|x|int|0}}
@@ Line 80: / Line 97: @@
 :{{Par2|threshold|int|0}}
 ::Changes the transition point of {{FuncArg|op}} = "darken", "lighten."
 :{{Par2|use_chroma|bool|true}}
 ::Use chroma of the {{FuncArg|overlay_clip}}. Default=true. When false, only luma is used.
 ::Must be true for {{FuncArg|op}} = "darken", "lighten", "add."
@@ Line 97: / Line 127: @@
 :This means for full strength of operation, alpha has to be 255{{D}} and {{FuncArg|level}} has to be 257.
 ====Examples====
@@ Line 106: / Line 139: @@
 </div>
 </div>
 == Mask ==

@@ Line 138: / Line 138: @@
 {{FuncDef|ResetMask(clip ''clip'')}}
 :{{Par2|clip|clip|}}
 :: Source clip. Alpha channel will be set to opaque. Color format must be [[RGB32]].
 ::{{AvsPluscon}} also supports [[RGB64]], [[PlanarRGBA]] and [[YUVA]].
 == ColorKeyMask ==

@@ Line 14: / Line 14: @@
 :: The underlying clip, which determines the size and all other video and audio properties of the result.
 ::Color format must be [[YUY2]] or [[RGB32]].
-::{{AvsPluscon}} also supports [[RGB64]] and [[PlanarRGBA]].
+::{{AvsPluscon}} also supports [[RGB64]].
 :{{Par2|overlay_clip|clip|}}
@@ Line 34: / Line 34: @@
 [[File:Layer-example-add.png]]
 |style="vertical-align:top"| This is the default mode. Equivalent to [[Overlay]](mode="blend").<br>{{FuncArg|overlay_clip}} will be copied on top of the original, in proportion to {{FuncArg|level}}, and subject to the alpha channel. <br><br>The difference between {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}} is multiplied with alpha and added to {{FuncArg|base_clip}}.
-*alpha=0 &nbsp;&nbsp;&nbsp;&rarr; only {{FuncArg|base_clip}} visible
+*alpha=0{{D}} &nbsp;&nbsp;&nbsp;&rarr; only {{FuncArg|base_clip}} visible
-*alpha=128 &rarr; {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}} equally blended
+*alpha=128{{D}} &rarr; {{FuncArg|base_clip}} and {{FuncArg|overlay_clip}} equally blended
-*alpha=255 &rarr; only {{FuncArg|overlay_clip}} visible
+*alpha=255{{D}} &rarr; only {{FuncArg|overlay_clip}} visible
 Formula used :
 *RGB: &nbsp;[[File:Layer-Eq1.png]]
@@ Line 58: / Line 58: @@
 |style="vertical-align:top"| [[File:Layer-example-mul-rgb.png]]
 |style="vertical-align:top"| {{FuncArg|base_clip}} multiplied by {{FuncArg|overlay_clip}}. This will generally make the output darker.
-*alpha=0 &nbsp;&nbsp;&nbsp;&rarr; only {{FuncArg|base_clip}} visible.
+*alpha=0{{D}} &nbsp;&nbsp;&nbsp;&rarr; only {{FuncArg|base_clip}} visible.
-*alpha=255 &rarr; approx. the same luminance as {{FuncArg|base_clip}} but with the colors of {{FuncArg|overlay_clip}}.
+*alpha=255{{D}} &rarr; approx. the same luminance as {{FuncArg|base_clip}} but with the colors of {{FuncArg|overlay_clip}}.
 See [http://docs.gimp.org/2.8/en/gimp-concepts-layer-modes.html#layer-mode-multiply GIMP: Multiply]
 |-
@@ Line 72: / Line 72: @@
 ::* 0 &ndash; no effect: {{FuncArg|base_clip}} is returned unchanged
 ::* 257 (256 for YUY2) &ndash; maximum strength
 :{{Par2|x|int|0}}
@@ Line 90: / Line 91: @@
 There are some differences in the behaviour and the allowed parameter depending on the color format and the operation; here are the details:
-*There is no mask (alpha channel) in [[YUY2]], so the alpha channel is assumed to be fully opaque (255) everywhere.
+*There is no mask (alpha channel) in [[YUY2]], so the alpha channel is assumed to be fully opaque (255{{D}}) everywhere.
 *In [[RGB32]] the {{FuncArg|overlay_clip}} alpha channel is multiplied with {{FuncArg|level}}, so the resulting alpha is
 :: (alpha * {{FuncArg|level}} + 1) / 256.
-:This means for full strength of operation, alpha has to be 255 and {{FuncArg|level}} has to be 257.
+:This means for full strength of operation, alpha has to be 255{{D}} and {{FuncArg|level}} has to be 257.
@@ Line 119: / Line 120: @@
 :{{Par2|mask_clip|clip|}}
-:: Alpha-mask source, as described above. Size must match {{FuncArg|clip}}.
+:: Alpha-mask source, as described above. Size and color format must match {{FuncArg|clip}}.
-:: Color format be [[RGB32]].
 ====Examples====
@@ Line 141: / Line 141: @@
 :{{Par2|clip|clip|}}
 :: Source clip. Alpha channel will be set to opaque. Color format must be [[RGB32]].
-::{{AvsPluscon}} also supports [[RGB64]] and [[PlanarRGBA]].
+::{{AvsPluscon}} also supports [[RGB64]], [[PlanarRGBA]] and [[YUVA]].
 </div>
@@ Line 149: / Line 149: @@
 Clears pixels in the alpha channel by comparing to a transparent {{FuncArg|color}} (default black).
-Each pixel with a color differing less than ({{FuncArg|tolB}},{{FuncArg|tolR}},{{FuncArg|tolG}}) (default 10) is set to transparent (black); otherwise it is left unchanged &ndash; note, it is NOT set to opaque (white). That's why you might need '''ResetMask''' before applying this filter. This behaviour allows an aggregate mask to be constructed with multiple calls to '''ColorKeyMask'''.
+Each pixel with a color differing less than ({{FuncArg|tolB}},{{FuncArg|tolR}},{{FuncArg|tolG}}) (default 10{{D}}) is set to transparent (black); otherwise it is left unchanged &ndash; note, it is NOT set to opaque (white). That's why you might need '''ResetMask''' before applying this filter. This behaviour allows an aggregate mask to be constructed with multiple calls to '''ColorKeyMask'''.
 When {{FuncArg|tolR}} or {{FuncArg|tolG}} are not set, they get the value of {{FuncArg|tolB}} by default. Normally you start with a '''ResetMask''', then chain a few calls to '''ColorKeyMask''' to cause transparent holes where each color of interest occurs. See [[Overlay]] for examples.
@@ Line 162: / Line 162: @@
 ::Transparent color. Default black.
-:{{Par2|tolB|int|10}}
+:{{Par2|tolB|int|10{{Template:D}}}}
 :{{Par2|tolG|int|(tolB)}}
 :{{Par2|tolR|int|(tolB)}}

@@ Line 151: / Line 151: @@
 <div {{BoxWidthIndent|58|1.5}} ><div style="font-size:80%">
   lena=[[ImageSource]]("[[:File:Lenna.png|Lenna.png]]", pixel_type="RGB32").[[BicubicResize]](256, 256)
-  grad=[[GraMaMa]](lena.[[ConvertToYV12]], 3, 0, 0, [[Internal functions/Round|Round]](1.3*lena.Width))
+ \   .ConvertToYUY2
-  \  .[[ConvertToYUY2]]
+  grad=GraMaMa(lena.ConvertToYV12, 3, 0, 0, Round(1.3*lena.Width))
-  \  .[[Subtitle]]("TEXT\n", size=32, text_color=[[Colors|$ff000000]], halo_color=$ebebeb, align=5, lsp=0, font_angle=180.0)
+  \  .ConvertToYUY2
   \  .Subtitle("TEXT\n", size=32, text_color=$ff000000, halo_color=$404040, align=5, lsp=0)
-  \  .[[Invert]]
+  \  .Invert
-  \  .[[ColorYUV]](off_u=-60, off_v=-60)
+  \  .ColorYUV(off_u=-60, off_v=-60)
   return [[StackVertical]](
   \   StackHorizontal(