OverlayPlus - Revision history

Reel.Deal: v1.3.0

2022-10-27T14:37:45Z

v1.3.0

Reel.Deal: /* Syntax and Parameters */ typo

2022-01-09T04:17:57Z

‎Syntax and Parameters: typo

Reel.Deal: v1.2.0

2021-10-18T04:09:23Z

v1.2.0

Reel.Deal: v1.1.0 update

2021-09-23T05:06:47Z

v1.1.0 update

Reel.Deal: OverlayPlus (WIP)

2021-08-30T07:40:05Z

OverlayPlus (WIP)

New page

{{FilterCat5|External_filters|Scripts|Adjustment_filters|Layering|Deep_color_tools}}
{{Filter3
|1=reel.deel
|2=v1.0.0
|3=
|4=Layering
|5=
|6=}}
 
== Description ==
[[OverlayPlus]] is a layering scrip similar to [[Overlay]].
* 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]] 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].
 
 
== Requirements ==
* [x86] / [x64]: [[AviSynth+]]
* Supported color formats: All [[planar]] formats (8/10/12/14/16/32bit, Y/YUV/RGB with or without alpha) are supported.

==== Required Plugins ====
Latest version of the following plugins are recommended unless stated otherwise. 
*[[MaskTools2]]
 
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|function OverlayPlus (clip base, clip overlay, clip "mask", string "mode", float "opacity", int "x", int "y", bool "chroma", bool "mask_first_plane")
}}
 
::{{Par2| |clip| }}
:::Base clip must be planar Y, YUV, or RGB.
:::Properties such as dimensions, framerate, and length of the output clip will be the same as the base clip.
 
::{{Par2| |clip| }}
:::Overlay clip must be the same colorspace as the base clip.
:::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.
 
::{{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.
:::Mask clip must have the same dimensions as the overlay clip.
:::If <code>mask_first_plane=true</code>, then the mask clip can be planar Y, YUV or RBG but needs to have the same bitdepth as the base clip.
 
::{{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, 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.
|}
 
::{{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.
 
::{{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.
 
::{{Par2|chroma|bool|true}}
:::YUV chroma processing:
:::*True : process chroma planes
:::*False : copy chroma planes from base clip
:::For RGB all planes are always processed.
 
::{{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.
 

== Examples ==
TODO:
[[AviSource]]("blah.avi")
 
== Changelog ==
Version Date Changes 
v1.0.0 2021/08/xx - Public release.
 

== External Links ==
 
 
-----------------------------------------------
'''Back to [[External_filters#Averaging.2FLayering.2FMasking|External Filters]] ←'''

@@ Line 2: / Line 2: @@
 {{Filter3
 |1=reel.deel
-|2=v1.2.0
+|2=v1.3.0
-|3=[https://files.videohelp.com/u/223002/overlayplus-v1.2.0.avsi overlayplus-v1.2.0.avsi]
+|3=[https://github.com/Reel-Deal/AviSynthPlus-Scripts/blob/main/overlayplus.avsi overlayplus.avsi]
 |4=Layering
 |5=
@@ Line 18: / Line 18: @@
 **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://ffmpeg.org/doxygen/trunk/libavfilter_2vf__blend_8c_source.html FFmpeg (line #298)].
+[[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>
@@ Line 30: / Line 30: @@
 <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")
+:{{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>
@@ Line 97: / Line 97: @@
 :::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.
 <br>
 ::{{Par2|cplace|string|"mpeg2"}}
 :::Chroma location placement to use on the mask when resizing the chroma channels.
-:::Only applicable when <code>mask_first_plane=true</code> and for YUV420 or YUV422 colorspaces only.
+:::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.
-:::*"topleft" : also known as "chromaloc type 2"; used on UHD formats and only available for YUV 4:2:0 colorspaces.
+:::*"top_left" : also known as "chromaloc type 2"; used on UHD formats.
 <br>
@@ Line 117: / Line 124: @@
 == Changelog ==
   Version      Date            Changes<br>
 .2.0        2021/09/27      - mask_first_plane is ignored if the mask clip is a Y grayscale clip
-                               - The chroma paramater now defaults to false for YUV clips
+                               - 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

@@ Line 30: / Line 30: @@
 <br>
 == [[Script variables|Syntax and Parameters]] ==
-:{{Template:FuncDef|function OverlayPlus (clip base, clip overlay, clip "mask", string "mode", float "opacity", int "x", int "y", bool "chroma", bool "mask_first_plane", string "cplace")
+:{{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")
 }}
 <br>

@@ Line 2: / Line 2: @@
 {{Filter3
 |1=reel.deel
-|2=v1.1.0
+|2=v1.2.0
-|3=[https://files.videohelp.com/u/223002/overlayplus-v1.1.0.avsi overlayplus-v1.1.0.avsi]
+|3=[https://files.videohelp.com/u/223002/overlayplus-v1.2.0.avsi overlayplus-v1.2.0.avsi]
 |4=Layering
 |5=
@@ Line 52: / Line 52: @@
 :::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.
 <br>
 ::{{Par2|mode|string|"blend"}}
@@ Line 87: / Line 88: @@
 :::<code>x=0, y=0</code> equals alignment at the top left corner of the frame.
 <br>
-::{{Par2|chroma|bool|true}}
+::{{Par2|chroma|bool|false}}
 :::YUV chroma processing:
 :::*True : process chroma planes
@@ Line 116: / Line 117: @@
 == Changelog ==
   Version      Date            Changes<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

@@ Line 2: / Line 2: @@
 {{Filter3
 |1=reel.deel
-|2=v1.0.0
+|2=v1.1.0
-|3=
+|3=[https://files.videohelp.com/u/223002/overlayplus-v1.1.0.avsi overlayplus-v1.1.0.avsi]
 |4=Layering
 |5=
-|6=}}
+|6=[https://forum.doom9.org/showthread.php?t=183185 Doom9 Forum]}}
 <br>
 == Description ==
-[[OverlayPlus]] is a layering scrip similar to [[Overlay]].
+[[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)
-[[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].
+**AviSynth's Overlay always converts the input to YUV444 and uses additional formulas on the chroma channels.
 <br>
 <br>
 == Requirements ==
 * [x86] / [x64]: [[AviSynth+]]
-* Supported color formats: All [[planar]] formats (8/10/12/14/16/32bit, Y/YUV/RGB with or without alpha) are supported.
+* 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>
@@ Line 27: / Line 30: @@
 <br>
 == [[Script variables|Syntax and Parameters]] ==
-:{{Template:FuncDef|function OverlayPlus (clip base, clip overlay, clip "mask", string "mode", float "opacity", int "x", int "y", bool "chroma", bool "mask_first_plane")
+:{{Template:FuncDef|function OverlayPlus (clip base, clip overlay, clip "mask", string "mode", float "opacity", int "x", int "y", bool "chroma", bool "mask_first_plane", string "cplace")
 }}
 <br>
 ::{{Par2| |clip| }}
-:::Base clip must be planar Y, YUV, or RGB.
+:::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.
 <br>
 ::{{Par2| |clip| }}
-:::Overlay clip must be the same colorspace as the base 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 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.
+:::*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}}
@@ Line 44: / Line 49: @@
 :::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.
+:::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 planar Y, YUV or RBG but needs to have the same bitdepth as the base 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.
 <br>
 ::{{Par2|mode|string|"blend"}}
@@ Line 62: / Line 67: @@
 |-
 |Lighten
-|add (lineardodge), dodge (colordodge), lighten, linearadd, screen
+|add (lineardodge), dodge (colordodge), lighten, linearadd (hypot), screen
 |-
 |Mix
@@ Line 90: / Line 95: @@
 ::{{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.
 <br>
 == Examples ==
-TODO:
+<pre>
- [[AviSource]]("blah.avi")
+base    = Blankclip(color=$FFFFFF, pixel_type="RGBP8")
 <br>
 == Changelog ==
   Version      Date            Changes<br>
-  v1.0.0       2021/08/xx      - Public release.
+ v1.1.0       2021/09/10      - Add support for all interleaved colorspaces (RBG24/32/48/64 and YUY2)
 <br>