View source for OverlayPlus

{{FilterCat5|External_filters|Scripts|Adjustment_filters|Layering|Deep_color_tools}}
{{Filter3
|1=reel.deel
|2=v1.3.0
|3=[https://github.com/Reel-Deal/AviSynthPlus-Scripts/blob/main/overlayplus.avsi overlayplus.avsi]
|4=Layering 
|5=
|6=[https://forum.doom9.org/showthread.php?t=183185 Doom9 Forum]}}
<br>
== Description ==
[[OverlayPlus]] is a layering scrip similar to AviSynth's internal [[Overlay]].  It features:
* 33 blend modes.
* RGB colorspaces are processed without converting to YUV.
* YUV420/YUV422 colorspaces are processed without converting to YUV444.
* OverlayPlus in RGB produces results that are consistent with Photoshop and Gimp.
<!--*OverlayPlus produces different results than Overlay in both YUV and RGB (except blend)
**AviSynth's Overlay always converts the input to YUV444 and uses additional formulas on the chroma channels.
**The softlight mode in AviSynth's Overlay is actually grainmerge, and Overlay's hardlight is actually linearlight.-->

[[OverlayPlus]] is mainly a port of [https://github.com/HomeOfVapourSynthEvolution/havsfunc/blob/master/havsfunc.py#L5397 VapourSynth's Overlay script] by HolyWu with some additional blending modes from [https://forum.doom9.org/showthread.php?t=183003 Overlay_MTools]. Blending mode "multiply128" was taken from [https://github.com/FFmpeg/FFmpeg/blob/master/libavfilter/blend_modes.c FFmpeg].
<br>
<br>
== Requirements ==
* [x86] / [x64]: [[AviSynth+]]
* Supported color formats: all [[planar]] and [[interleaved]] colorspaces are supported except YV411.
<br>
==== Required Plugins ====
Latest version of the following plugins are recommended unless stated otherwise.<br>
*[[MaskTools2]]
<br>
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|OverlayPlus (clip base, clip overlay, clip "mask", string "mode", float "opacity", int "x", int "y", bool "chroma", bool "mask_first_plane", string "cplace", string "chromaresample")
}}
<br>
::{{Par2| |clip| }}
:::Base clip; all [[planar]] and [[interleaved]] colorspaces are supported except YV411. Output will always be planar YUV or RGB.
:::Properties such as dimensions, framerate, and length of the output clip will be the same as the base clip.
:::Alpha channel is copied from the base clip (if applicable).
:::*'''Note''': OverlayPlus accepts mismatched colorspaces provided that they are in the same color family and bit depth.<br>For example the base clip can be RGB32 and the overlay clip RGBP8/RGBAP8 or vice versa.<br>Or in YUV the base clip can be YUVA420P16 and the overlay clip can be YUV420P16.
<br>
::{{Par2| |clip| }}
:::Overlay clip must be the same colorspace as the base clip or can be mismatched as stated in the note.
:::Overlay clip does not have to be the same dimensions as the base clip. 
:::*If the dimensions of the overlay clip are smaller, it will be top left aligned and padded accordingly.
:::*If the dimensions of the overlay clip are greater, it will be cropped at the bottom and right sides accordingly. 
<br>
::{{Par2|mask|clip|undefined}}
:::Optional transparency mask to use for the overlay clip.
:::Mask clip must be in full range (for example, 0-255 for 8 bit, 0-65535 for 16bit, 0.0-1.0 for 32bit float). 
:::The darker the pixel, the more transparent the overlay clip will be; black (0) pixel means full transparency. 
:::Mask clip must be the same colorspace as the base clip or can be mismatched as stated in the note.
:::Mask clip must have the same dimensions as the overlay clip.
:::If <code>mask_first_plane=true</code>, then the mask clip can be any colorspace but needs to have the same bitdepth as the base clip.
:::If the base clip is RGB or YUV444, an RGB or YUV444 mask can be used interchangeably, provided they are the same bitdepth.
<br>
::{{Par2|mode|string|"blend"}}
:::Blend mode.
::::{|class="wikitable" style="height:100px; width:240px; border="1" cellpadding="4"
|-
!width=15%| GROUP
!width=85%| BLEND MODE
|-
|Simple
|average, blend (normal)
|-
|Darken
|burn (colorburn), darken, linearburn, multiply, multiply128
|-
|Lighten
|add (lineardodge), dodge (colordodge), lighten, linearadd (hypot), screen
|-
|Mix
|hardlight, hardmix, interpolation, linearlight, overlay, pinlight, softburn, softdodge, softlight, softlight2, vividlight
|-
|Difference
|difference, divide, exclusion, extremity, grainextract, grainmerge, linearsubtract, negation, phoenix, subtract
|-
! colspan="2"| Names in parenthesis are aliases that can also be used.
|}
<br>
::{{Par2|opacity|float|1.0}}
:::Blend transparency; the range is from 0.0 to 1.0, where 0.0 is transparent and 1.0 is fully opaque.
<br>
::{{Par2|x|int|0}}
::{{Par2|y|int|0}}
:::Horizontal and vertical placement of the overlay image on the base clip, in pixels. Can be positive or negative.
:::For subsampled colorspaces such as YUV420 both <code>x</code> and <code>y</code> must be [[modulo|mod2]]. For YUV422 only <code>x</code> must be mod2. 
:::<code>x=0, y=0</code> equals alignment at the top left corner of the frame.
<br>
::{{Par2|chroma|bool|false}}
:::YUV chroma processing:
:::*True : process chroma planes
:::*False : copy chroma planes from base clip
:::For RGB all planes are always processed.
<br>
::{{Par2|mask_first_plane|bool|true}}
:::When set to true, the first plane of the the mask clip will be used as a mask for all channels.
:::In other words, the luma (Y) channel on YUV or the red channel on RGB will be used as a mask.
:::This parameter is ignored when the mask clip is not defined.
<br>
::{{Par2|cplace|string|"mpeg2"}}
:::Chroma location placement to use on the mask when resizing the chroma channels.
:::Only applicable when mask clip is defined, <code>mask_first_plane=true</code> and for YUV420 colorspaces only.
:::*"mpeg1" : also known as "center", "jpeg" and "chromaloc type 1" chroma placement.
:::*"mpeg2" : also known as "left" and "chromaloc type 0" chroma placement, most consumer SD/HD formats use this.
:::*"top_left" : also known as "chromaloc type 2"; used on UHD formats.
<br>
::{{Par2|chromaresample|string|"bicubic"}}
:::Resizer to use on the mask chroma planes.
:::Only applicable when mask clip is defined, <code>mask_first_plane=true</code> and for YUV420/422 colorspaces only.
:::Available options: <code>"point", "bilinear", "bicubic", "lanczos", "lanczos4", "blackman", "spline16", "spline36", "spline64", "gauss" and "sinc"</code>
:::Default: "bicubic"
<br>

== Examples == 
<pre>
base    = Blankclip(color=$FFFFFF, pixel_type="RGBP8")
overlay = Colorbars(pixel_type="RGBP8")
mask    = Blankclip(color=$000000, pixel_type="RGBP8").Subtitle("AviSynth", size=150, align=5)

OverlayPlus(base, overlay, mask, mode="blend", opacity=1)
</pre>
<br>
== Changelog ==
 Version      Date            Changes<br>
 1.3.0        2022/10/24      - Fix green stripe bug on subsampled colorspaces due to padding in the mask
                              - Added "chromaresample" parameter<br>
 1.2.0        2021/09/27      - mask_first_plane is ignored if the mask clip is a Y grayscale clip
                              - The chroma parameter now defaults to false for YUV clips
                              - Padding and cropping stage is bypassed when not needed
                              - A single frame mask is used when mask clip is undefined
                              - Correct output when all the following conditions are true: 
                               * mask is not defined, opacity=1.0, x=0, y=0, and overlay clip is a smaller dimension than the base clip
                              - If the base clip is RGB or YUV444, the mask clip can be either YUV444 or RGB<br>
 v1.1.0       2021/09/10      - Add support for all interleaved colorspaces (RBG24/32/48/64 and YUY2)
                              - Copy alpha channel from base clip when available
                              - Fix wrong output when opacity=1.0 and mask was not used and x or y > 0 
                              - Add "cplace" parameter
                              - Cosmetics and other minor improvements<br>
 v1.0.0       2021/09/02      - Public release
<br>

== External Links ==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Averaging.2FLayering.2FMasking|External Filters]] &larr;'''