Overlay - Revision history

Pinterf: Update for Avisynth+

2018-12-13T10:11:24Z

Update for Avisynth+

← Older revision		Revision as of 12:11, 13 December 2018
Line 6:		Line 6:
	*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).		*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).
	<div {{ListItemContinue}} >		<div {{ListItemContinue}} >
	{{AvsPluscon}} works a little differently ~~&ndash~~; see [[#use444\|{{FuncArg\|use444}}]], below.</div>		{{AvsPluscon}} works a little differently, no 4:4:4 conversion occurs for "blend", "luma" and "chroma" modes; see [[#use444\|{{FuncArg\|use444}}]], below.</div>

	*In general all clips are treated as full-range values. This means that numbers will not be clipped at TV range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is TV-range, you should convert it to full-range,or the mask will never be fully opaque.		*In general all clips are treated as full-range values. This means that numbers will not be clipped at TV range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is TV-range, you should convert it to full-range,or the mask will never be fully opaque.
Line 39:		Line 39:

	:{{Par2\|mask\|clip\|(full opacity)}}		:{{Par2\|mask\|clip\|(full opacity)}}
	::Optional ''transparency mask''. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. Must be 0-255 range. By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=false.		::Optional ''transparency mask''. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. Must be 0-255 range (in general: 0 - 2^N-1 range for N bits format). By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=false.

	:{{Par2\|opacity\|float\|1.0}}		:{{Par2\|opacity\|float\|1.0}}
Line 108:		Line 108:
	:{{Par2\|output\|string\|(input)}}		:{{Par2\|output\|string\|(input)}}
	::Set output colorspace. Possible values are "YV24", "YUY2", "YV12", "Y8", "RGB32" and "RGB24".		::Set output colorspace. Possible values are "YV24", "YUY2", "YV12", "Y8", "RGB32" and "RGB24".
			::{{AvsPluscon}} All 8-16 bits colorspaces e.g. "YUV420P14" and "RGB64"

	:{{Par2\|ignore_conditional\|bool\|false}}		:{{Par2\|ignore_conditional\|bool\|false}}
Line 118:		Line 119:
	:{{Par2\|use444\|bool\|true}}		:{{Par2\|use444\|bool\|true}}
	::{{AvsPluscon}} If set to false, '''Overlay''' uses conversionless mode where possible instead of going through YUV 4:4:4. However, for Luma and Chroma {{FuncArg\|mode}}s, RGB ''must'' be converted to YUV 4:4:4.		::{{AvsPluscon}} If set to false, '''Overlay''' uses conversionless mode where possible instead of going through YUV 4:4:4. However, for Luma and Chroma {{FuncArg\|mode}}s, RGB ''must'' be converted to YUV 4:4:4.
			:: default value is adaptive:
			:: false when mode="blend" and format is RGB
			:: false when mode="blend", "luma" or "chroma and format is YUV420/YUV422 (YV12/YV16). Original format is kept throughout the whole process, no 4:4:4 conversion occurs.
			:: true for all other cases (input is converted internally to 4:4:4)
	</div>		</div>

Line 123:		Line 128:
	== RGB considerations ==		== RGB considerations ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]], this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16-235 (this is the range used by all avisynth converters) to 0-255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:		[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]] (see AVS+ exceptions), this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16-235 (this is the range used by all avisynth converters) to 0-255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:
	* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0-255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).		* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0-255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).
	* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.		* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.
	* {{AvsPluscon}} ~~[[TODO]]~~		* {{AvsPluscon}} planar RGB formats are also supported besides 8 bit packed RGB formats and RGB48/RGB64.
			* {{AvsPluscon}} "blend" mode keeps original RGB format, no YUV intermediate conversion is used.

	===== ''Outputting RGB'' =====		===== ''Outputting RGB'' =====
	:It might be a good idea to let '''Overlay''' output YV24, even if your input colorspace is RGB, as this avoids a colorspace conversion back to RGB from YUV. You should however be aware that your material might be "overscaled", as mentioned above, if you use {{FuncArg\|pc_range}}=true. You can correct this by using <code>[[ColorYUV]](levels="pc->tv")</code> to convert back to 16-235 range.		:It might be a good idea to let '''Overlay''' output YV24 (or YUV444P10-16 in AVS+), even if your input colorspace is RGB, as this avoids a colorspace conversion back to RGB from YUV. You should however be aware that your material might be "overscaled", as mentioned above, if you use {{FuncArg\|pc_range}}=true. You can correct this by using <code>[[ColorYUV]](levels="pc->tv")</code> to convert back to 16-235 range (or equivalent ranges to 10+ bits).

	===== ''Inputting RGB for mask clip'' =====		===== ''Inputting RGB for mask clip'' =====
	:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in full-range, directly copied from the RGB values.		:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in full-range, directly copied from the RGB values.

	===== ''Using RGB32 alpha channel'' =====		===== ''Using RGB32, {{AvsPluscon}} RGB64 or planar RGBA alpha channel'' =====
	:'''Overlay''' ignores the ''alpha'' (transparency) channel in an [[RGB32]] clip. If you want the alpha, you can use something like <code>Overlay(kitten, mask=kitten.[[ShowAlpha]]("RGB32"))</code>. For maximum quality, it is recommended to extract the alpha as RGB.		:'''Overlay''' ignores the ''alpha'' (transparency) channel in an [[RGB32]] clip. If you want the alpha, you can use something like <code>Overlay(kitten, mask=kitten.[[ShowAlpha]]("RGB32"))</code>. For maximum quality, it is recommended to extract the alpha as RGB.

	===== ''Repeated overlays on RGB base clip'' =====		===== ''Repeated overlays on RGB base clip'' =====
	:When doing repeated partial overlays on an RGB base clip, the unchanged parts of the base clip will undergo a RGB→YV24→RGB conversion for each call to Overlay, producing a progressive loss of color accuracy. In these situations, it is better to convert the base clip to YV24 before doing the overlays and convert back to RGB afterwards.		:When doing repeated partial overlays on an RGB base clip, the unchanged parts of the base clip will undergo a RGB→YV24→RGB conversion for each call to Overlay, producing a progressive loss of color accuracy. In these situations, it is better to convert the base clip to 4:4:4 format (e.g. YV24) before doing the overlays and convert back to RGB afterwards.
	</div>		</div>

Line 300:		Line 306:
	== Changelog ==		== Changelog ==
	{\| border="1"		{\| border="1"
			\|-
			\| {{AvsPluscon}}
			\| Added 10-16 bit formats, incl. Planar RGB.
			\| Added 32 bit float support for "blend"
			\| Added 4:4:4 conversionless mode for "blend"
	\|-		\|-
	\| v2.6		\| v2.6

Raffriff42: tweak appearance

2017-04-23T09:05:53Z

tweak appearance

← Older revision		Revision as of 11:05, 23 April 2017
Line 25:		Line 25:
	{{Template:FuncDef		{{Template:FuncDef
	\|Overlay(clip ''clip'', clip ''overlay'' [, int ''x'', int ''y'', clip ''mask'', float ''opacity'', string ''mode'',<br>		\|Overlay(clip ''clip'', clip ''overlay'' [, int ''x'', int ''y'', clip ''mask'', float ''opacity'', string ''mode'',<br>
	bool ''greymask'', string ''output'', bool ''ignore_conditional'', bool ''pc_range'', bool ''use444'' ] ){{AvsPluscon}}		bool ''greymask'', string ''output'', bool ''ignore_conditional'', bool ''pc_range'', bool ''use444'' ] ) {{AvsPluscon}}
	}}		}}

Raffriff42: tweak appearance

2017-04-23T00:28:17Z

tweak appearance

← Older revision		Revision as of 02:28, 23 April 2017
Line 116:		Line 116:

	{{HiddenAnchor\|use444}}		{{HiddenAnchor\|use444}}
	:{{Par2\|use444\|bool\|true{{AvsPluscon}} }}		:{{Par2\|use444\|bool\|true}}
	::If set to false, '''Overlay''' uses conversionless mode where possible instead of going through YUV 4:4:4. However, for Luma and Chroma {{FuncArg\|mode}}s, RGB ''must'' be converted to YUV 4:4:4.		::{{AvsPluscon}} If set to false, '''Overlay''' uses conversionless mode where possible instead of going through YUV 4:4:4. However, for Luma and Chroma {{FuncArg\|mode}}s, RGB ''must'' be converted to YUV 4:4:4.
	</div>		</div>

Raffriff42: use Template:AvsPluscon for consistency

2017-04-22T04:39:30Z

use Template:AvsPluscon for consistency

← Older revision		Revision as of 06:39, 22 April 2017
Line 6:		Line 6:
	*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).		*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).
	<div {{ListItemContinue}} >		<div {{ListItemContinue}} >
	~~'''AVS+'''~~ works a little differently – see [[#use444\|{{FuncArg\|use444}}]], below.</div>		{{AvsPluscon}} works a little differently – see [[#use444\|{{FuncArg\|use444}}]], below.</div>

	*In general all clips are treated as full-range values. This means that numbers will not be clipped at TV range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is TV-range, you should convert it to full-range,or the mask will never be fully opaque.		*In general all clips are treated as full-range values. This means that numbers will not be clipped at TV range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is TV-range, you should convert it to full-range,or the mask will never be fully opaque.

Raffriff42: note AVS+ differences * WIP *

2017-04-22T00:20:53Z

note AVS+ differences *** WIP ***

← Older revision		Revision as of 02:20, 22 April 2017
Line 1:		Line 1:
			<div style="max-width:82em; min-width:42em;" >
			{{AvsStarFilter}}<div style="max-width:62em" >
			Puts clip {{FuncArg\|overlay}} on top of clip {{FuncArg\|base}} using different blend {{FuncArg\|modes}}, and with optional {{FuncArg\|x}},{{FuncArg\|y}} positioning, {{FuncArg\|mask}}ing and {{FuncArg\|opacity}}.
			</div>
	<div style="max-width:62em" >		<div style="max-width:62em" >
	~~Puts clip {{FuncArg\|overlay}} on top of clip~~ {{FuncArg\|base}} ~~using different blend~~ {{FuncArg\|~~modes~~}}, and ~~with optional~~ {{FuncArg\|x}},{{FuncArg\|y}} ~~positioning~~, {{~~FuncArg\|mask~~}}~~ing and~~ {{FuncArg\|~~opacity~~}}.		*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).
			<div {{ListItemContinue}} >
			'''AVS+''' works a little differently – see [[#use444\|{{FuncArg\|use444}}]], below.</div>

	*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).		*In general all clips are treated as full-range values. This means that numbers will not be clipped at TV range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is TV-range, you should convert it to full-range,or the mask will never be fully opaque.

	*In general all clips are treated as 0-~~255~~ values. This means that numbers will not be clipped at ~~CCIR-601~~ range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is 16-~~235~~, convert it to 0-~~255 – for example~~, ~~with [[ColorYUV]](levels="TV->PC") –~~ or the mask will never be fully opaque.

	*It is not recommended to do overlays on [[Interlaced_fieldbased\|interlaced]] material, unless you know what you are doing.		*It is not recommended to do overlays on [[Interlaced_fieldbased\|interlaced]] material, unless you know what you are doing.
Line 16:		Line 20:
	{{Template:FuncDef		{{Template:FuncDef
	\|Overlay(clip ''clip'', clip ''overlay'' [, int ''x'', int ''y'', clip ''mask'', float ''opacity'', string ''mode'',<br>		\|Overlay(clip ''clip'', clip ''overlay'' [, int ''x'', int ''y'', clip ''mask'', float ''opacity'', string ''mode'',<br>
	bool ''greymask'', string ''output'', bool ''ignore_conditional'', bool ''pc_range'' ] )		bool ''greymask'', string ''output'', bool ''ignore_conditional'', bool ''pc_range'' ] )
			}}

			{{Template:FuncDef
			\|Overlay(clip ''clip'', clip ''overlay'' [, int ''x'', int ''y'', clip ''mask'', float ''opacity'', string ''mode'',<br>
			bool ''greymask'', string ''output'', bool ''ignore_conditional'', bool ''pc_range'', bool ''use444'' ] ){{AvsPluscon}}
	}}		}}

Line 104:		Line 113:

	:{{Par2\|pc_range\|bool\|false}}		:{{Par2\|pc_range\|bool\|false}}
	::When set to true, this will make all internal RGB→YUV →RGB conversions assume that ~~luma~~ range ~~is 0-255~~ instead of default ~~16-235~~ range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations\|RGB considerations]] below.		::When set to true, this will make all internal RGB→YUV →RGB conversions assume that YUV sources are full-range instead of the default TV range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations\|RGB considerations]] below.

			{{HiddenAnchor\|use444}}
			:{{Par2\|use444\|bool\|true{{AvsPluscon}} }}
			::If set to false, '''Overlay''' uses conversionless mode where possible instead of going through YUV 4:4:4. However, for Luma and Chroma {{FuncArg\|mode}}s, RGB ''must'' be converted to YUV 4:4:4.
	</div>		</div>

Line 113:		Line 126:
	* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0-255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).		* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0-255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).
	* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.		* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.
			* {{AvsPluscon}} [[TODO]]

	===== ''Outputting RGB'' =====		===== ''Outputting RGB'' =====
Line 118:		Line 132:

	===== ''Inputting RGB for mask clip'' =====		===== ''Inputting RGB for mask clip'' =====
	:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in 0-~~255~~ range, directly copied from the RGB values.		:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in full-range, directly copied from the RGB values.

	===== ''Using RGB32 alpha channel'' =====		===== ''Using RGB32 alpha channel'' =====
Line 296:		Line 310:
	\| Initial Release.		\| Initial Release.
	\|}		\|}
			</div>

	[[Category:Internal filters]]		[[Category:Internal filters]]
	[[Category:Layering]]		[[Category:Layering]]

Raffriff42: small example image for each blend mode

2016-08-29T11:25:49Z

small example image for each blend mode

← Older revision		Revision as of 13:25, 29 August 2016
Line 37:		Line 37:
	:{{Par2\|mode\|string\|"blend"}}		:{{Par2\|mode\|string\|"blend"}}
	::Defines how your {{FuncArg\|overlay}} should be blended with your base image.		::Defines how your {{FuncArg\|overlay}} should be blended with your base image.
	::{\| class="wikitable" style="max-width:60em!important"		<div style="max-width:56em;margin:0 0 0 3.5em" >
			{\| class="wikitable" style="max-width:60em!important"
			! Mode
			! Example
			! Description
	\|-		\|-
	\| ~~'''Mode'''~~		\|style="vertical-align:top"\| Blend
	\| ~~'''Description'''~~		\|[[File:Layer-base-Lena.png]] [[File:Layer-over-grad.png]]

			[[File:Overlay-example-blend.png]]
			\|style="vertical-align:top"\| The default mode: ordinary blending in proportion to {{FuncArg\|opacity}}.
	\|-		\|-
	\| ~~Blend~~		\|style="vertical-align:top"\| Add
	\| ~~The default mode~~: ~~ordinary blending in proportion~~ to {{~~FuncArg\|opacity~~}}.		\|style="vertical-align:top"\| [[File:Overlay-example-add.png]]
			\|style="vertical-align:top"\| Add the overlay video to the base video, making the video brighter. To make this as comparable to RGB, overbright luma areas are influencing chroma and making them more white.{{Clarify}}
	\|-		\|-
	\| ~~Add~~		\|style="vertical-align:top"\| Subtract
	\| Add ~~the overlay video to the base video, making~~ the video ~~brighter. To make this as comparable to RGB, overbright luma areas are influencing chroma and making them more white~~.~~{{Clarify}}~~		\|style="vertical-align:top"\| [[File:Overlay-example-subtract.png]]
			\|style="vertical-align:top"\| The opposite of ''Add''. Make the video darker.
	\|-		\|-
	\| ~~Subtract~~		\|style="vertical-align:top"\| Multiply
	\| ~~The opposite of ''Add''~~. ~~Make~~ the ~~video darker~~.		\|style="vertical-align:top"\| [[File:Overlay-example-multiply.png]]
			\|style="vertical-align:top"\| Darkens the image in proportion to {{FuncArg\|overlay}} lightness.
	\|-		\|-
	\| ~~Multiply~~		\|style="vertical-align:top"\| Chroma
	\| ~~Darkens~~ the image ~~in proportion to {{FuncArg\|overlay}} lightness~~.		\|style="vertical-align:top"\| [[File:Overlay-example-chroma.png]]
			\|style="vertical-align:top"\| Overlay only the color information of the overlay clip on to the base image.
	\|-		\|-
	\| ~~Chroma~~		\|style="vertical-align:top"\| Luma
	\| Overlay only the ~~color~~ information of the overlay clip on to the base image.		\|style="vertical-align:top"\| [[File:Overlay-example-luma.png]]
			\|style="vertical-align:top"\| Overlay only the luminosity information of the overlay clip on to the base image.
	\|-		\|-
	\| ~~Luma~~		\|style="vertical-align:top"\| Lighten
	\| Overlay only ~~the luminosity information of the overlay clip on to~~ the base image.		\|style="vertical-align:top"\| [[File:Overlay-example-lighten.png]]
			\|style="vertical-align:top"\| Use {{FuncArg\|overlay}} only where it is lighter than the base image.
	\|-		\|-
	\| ~~Lighten~~		\|style="vertical-align:top"\| Darken
	\| Use {{FuncArg\|overlay}} only where it is ~~lighter~~ than the base image.		\|style="vertical-align:top"\| [[File:Overlay-example-darken.png]]
			\|style="vertical-align:top"\| Use {{FuncArg\|overlay}} only where it is darker than the base image.
	\|-		\|-
	\| ~~Darken~~		\|style="vertical-align:top"\| SoftLight
	\| ~~Use~~ {{FuncArg\|overlay}} ~~only where it~~ is darker than the ~~base~~ image.		\|style="vertical-align:top"\| [[File:Overlay-example-softlight.png]]
			\|style="vertical-align:top"\| Lighten or darken the base clip, based on {{FuncArg\|overlay}} luma. Where {{FuncArg\|overlay}} luma is darker than 128, the output will be darker. Where {{FuncArg\|overlay}} luma is lighter than 128, the output will be lighter. This is useful for adding shadows to an image. Pure black or white in the {{FuncArg\|overlay}} produces a distinctly darker or lighter area, but unlike ''HardLight'', does not result in pure black or white output.
	\|-		\|-
	\| ~~SoftLight~~		\|style="vertical-align:top"\| HardLight
	\| Lighten or darken the base clip, based on {{FuncArg\|overlay}} luma. Where {{FuncArg\|overlay}} luma is darker than 128, the output will be darker. Where {{FuncArg\|overlay}} luma is lighter than 128, the output will be lighter~~. This is useful for adding shadows to an image~~. Pure black or white in the {{FuncArg\|overlay}} ~~produces a distinctly darker or lighter area, but unlike ''HardLight'', does not result~~ in pure black or white output.		\|style="vertical-align:top"\| [[File:Overlay-example-hardlight.png]]
			\|style="vertical-align:top"\| Lighten or darken the base clip, based on {{FuncArg\|overlay}} luma. Where {{FuncArg\|overlay}} luma is darker than 128, the output will be darker. Where {{FuncArg\|overlay}} luma is lighter than 128, the output will be lighter. Pure black or white in the {{FuncArg\|overlay}} results in pure black or white in the output.
	\|-		\|-
	\| ~~HardLight~~		\|style="vertical-align:top"\| Difference
	\| ~~Lighten or darken~~ the ~~base~~ clip~~, based on {{FuncArg\|~~overlay~~}} luma~~. ~~Where {{FuncArg\|overlay}} luma~~ is ~~darker than 128~~, ~~the output will be darker. Where {{FuncArg\|overlay}}~~ luma ~~is lighter than~~ 128~~, the output will be lighter~~. ~~Pure black or white in~~ the ~~{{FuncArg\|overlay}} results in~~ pure ~~black~~ or ~~white in the output~~.		\|style="vertical-align:top"\| [[File:Overlay-example-difference.png]]
			\|style="vertical-align:top"\| Display the difference between the clip and the overlay. Note that like [[Subtract]], a difference of zero is displayed as grey, but with luma=128 instead of 126. If you want the pure difference, use mode="Subtract" or add [[ColorYUV]](off_y=-128).
	\|-		\|-
	\| ~~Difference~~		\|style="vertical-align:top"\| Exclusion
	\| Display the difference between the clip and the overlay. Note that like [[Subtract]], a difference of zero is displayed as grey, but with luma=128 instead of 126. If you want the pure difference, use mode="~~Subtract~~" ~~or add~~ [[~~ColorYUV~~]]~~(off_y=-128).~~		\|style="vertical-align:top"\| [[File:Overlay-example-exclusion.png]]
	\|-		\|style="vertical-align:top"\| Invert the image based on the luminosity of the overlay image. Blending with white inverts the base color values; blending with black produces no change.
	~~\| Exclusion~~
	\| Invert the image based on the luminosity of the overlay image. Blending with white inverts the base color values; blending with black produces no change.
	\|}		\|}

Raffriff42: /* See also */ added

2016-02-14T00:16:40Z

Raffriff42: one more touch-up

2016-02-13T22:34:49Z

one more touch-up

← Older revision		Revision as of 00:34, 14 February 2016
Line 4:		Line 4:
	*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).		*Input clips ({{FuncArg\|base}}, {{FuncArg\|overlay}} and {{FuncArg\|mask}}) are converted to [[YV24]] internally. The output is re-converted to the input colorspace (or to the {{FuncArg\|output}} colorspace, if specified).

	*In general all clips are treated as 0~~–~~255 values. This means that numbers will not be clipped at CCIR-601 range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is 16~~–~~235, convert it to 0~~–~~255 – for example, with [[ColorYUV]](levels="TV->PC") – or the mask will never be fully opaque.		*In general all clips are treated as 0-255 values. This means that numbers will not be clipped at CCIR-601 range; you may use [[Limiter]] for this task afterwards. If your {{FuncArg\|mask}} is 16-235, convert it to 0-255 – for example, with [[ColorYUV]](levels="TV->PC") – or the mask will never be fully opaque.

	*It is not recommended to do overlays on [[Interlaced_fieldbased\|interlaced]] material, unless you know what you are doing.		*It is not recommended to do overlays on [[Interlaced_fieldbased\|interlaced]] material, unless you know what you are doing.
Line 29:		Line 29:
	::Define the placement of the overlay image on the base clip, in pixels. Can be positive or negative.		::Define the placement of the overlay image on the base clip, in pixels. Can be positive or negative.

	:{{Par2\|mask\|clip\|}}		:{{Par2\|mask\|clip\|(full opacity)}}
	::Optional transparency mask. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=false.		::Optional ''transparency mask''. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. Must be 0-255 range. By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=false.
	~~::''There is no default, but not specifying is equivalent to supplying a 255 clip.''~~

	:{{Par2\|opacity\|float\|1.0}}		:{{Par2\|opacity\|float\|1.0}}
Line 90:		Line 89:

	:{{Par2\|pc_range\|bool\|false}}		:{{Par2\|pc_range\|bool\|false}}
	::When set to true, this will make all internal RGB→YUV →RGB conversions assume that luma range is 0~~–~~255 instead of default 16~~–~~235 range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations\|RGB considerations]] below.		::When set to true, this will make all internal RGB→YUV →RGB conversions assume that luma range is 0-255 instead of default 16-235 range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations\|RGB considerations]] below.
	</div>		</div>

Line 96:		Line 95:
	== RGB considerations ==		== RGB considerations ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]], this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16~~–~~235 (this is the range used by all avisynth converters) to 0~~–~~255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:		[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]], this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16-235 (this is the range used by all avisynth converters) to 0-255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:
	* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0~~–~~255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).		* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0-255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).
	* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.		* When NOT doing a colorspace conversion on output. If the output colorspace (RGB vs. YUV) is different from the input, the scale will be wrong. If {{FuncArg\|pc_range}}=true, and input is RGB, while output is YUY2, the YUY2 will have an invalid range, and not CCIR-601 range.

Line 104:		Line 103:

	===== ''Inputting RGB for mask clip'' =====		===== ''Inputting RGB for mask clip'' =====
	:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in 0~~–~~255 range, directly copied from the RGB values.		:An RGB {{FuncArg\|mask}} clip may behave a bit oddly if it contains color information. If you use a greyscale mask, or if you leave {{FuncArg\|greymask}}=true, you will get the result you would expect. Note that {{FuncArg\|mask}} values are never scaled, so it will automatically be in 0-255 range, directly copied from the RGB values.

	===== ''Using RGB32 alpha channel'' =====		===== ''Using RGB32 alpha channel'' =====
	:'''Overlay''' ~~will never use~~ the alpha channel ~~given~~ in an [[RGB32]] clip. If you want ~~to extract~~ the alpha ~~channel from an RGB32 clip~~ you can use ~~the [[ShowAlpha]] command — for example,~~ <code>Overlay(kitten, mask=kitten.ShowAlpha)</code>. For ~~maintaining~~ maximum quality it is recommended to extract the alpha as RGB.		:'''Overlay''' ignores the ''alpha'' (transparency) channel in an [[RGB32]] clip. If you want the alpha, you can use something like <code>Overlay(kitten, mask=kitten.[[ShowAlpha]]("RGB32"))</code>. For maximum quality, it is recommended to extract the alpha as RGB.

	===== ''Repeated overlays on RGB base clip'' =====		===== ''Repeated overlays on RGB base clip'' =====
Line 116:		Line 115:
	== Conditional Variables ==		== Conditional Variables ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	The global variables '''~~OL_opacity_offset~~''', '''~~OL_x_offset~~''' and '''~~OL_y_offset~~''' are evaluated for each frame. The values may be set using [[FrameEvaluate]], or they may be read from a file using [[ConditionalReader]] – see example [[#ConditionalReader\|below]].		The global variables '''ol_opacity_offset''', '''ol_x_offset''' and '''ol_y_offset''' are evaluated for each frame. The values may be set using [[FrameEvaluate]], or they may be read from a file using [[ConditionalReader]] – see example [[#ConditionalReader\|below]].

	These values, after evaluation, will be added to the relevant filter parameters — for example, if you specify {{FuncArg\|x}}=100 as a filter parameter, and '''ol_x_offset'''=50, the {{FuncArg\|overlay}} clip will be positioned at x=150. This behaviour can be disabled by using {{FuncArg\|ignore_conditional}}=true.		These values, after evaluation, will be added to the relevant filter parameters — for example, if you specify {{FuncArg\|x}}=100 as a filter parameter, and '''ol_x_offset'''=50, the {{FuncArg\|overlay}} clip will be positioned at x=150. This behaviour can be disabled by using {{FuncArg\|ignore_conditional}}=true.
Line 192:		Line 191:
	\|}		\|}

	A tolerance of 60 is used here because the blue is not entirely uniform. Near the black rectangles the blue is given by ~~R23 G22 B124~~ – probably due to the compression artifacts of '''blue.jpg'''.		A tolerance of 60 is used here because the blue is not entirely uniform. Near the black rectangles the blue is given by R=23,G=22,B=124 – probably due to the compression artifacts of '''blue.jpg'''.

Raffriff42: one more touch-up

2016-02-13T22:14:40Z

one more touch-up

← Older revision		Revision as of 00:14, 14 February 2016
Line 34:		Line 34:

	:{{Par2\|opacity\|float\|1.0}}		:{{Par2\|opacity\|float\|1.0}}
	::Set {{FuncArg\|overlay}} transparency. The value is from 0.0 to 1.0, where 0.0 is transparent and 1.0 is fully opaque ~~(if no mask is used)~~. This value is multiplied by {{FuncArg\|mask}} luminance to form the final opacity.		::Set {{FuncArg\|overlay}} transparency. The value is from 0.0 to 1.0, where 0.0 is transparent and 1.0 is fully opaque. This value is multiplied by {{FuncArg\|mask}} luminance to form the final opacity.

	:{{Par2\|mode\|string\|"blend"}}		:{{Par2\|mode\|string\|"blend"}}
	::Defines how your ~~clip~~ should be ~~overlaid on~~ your image.		::Defines how your {{FuncArg\|overlay}} should be blended with your base image.
	::{\| class="wikitable" style="max-width:60em!important"		::{\| class="wikitable" style="max-width:60em!important"
	\|-		\|-
Line 44:		Line 44:
	\|-		\|-
	\| Blend		\| Blend
	\| The default mode~~. When~~ opacity ~~is 1.0 and there is no mask the overlay image will be copied on top of the original. Ordinary transparent blending is used otherwise~~.		\| The default mode: ordinary blending in proportion to {{FuncArg\|opacity}}.
	\|-		\|-
	\| Add		\| Add
Line 50:		Line 50:
	\|-		\|-
	\| Subtract		\| Subtract
	\| The opposite of Add. Make the video darker.		\| The opposite of ''Add''. Make the video darker.
	\|-		\|-
	\| Multiply		\| Multiply
Line 68:		Line 68:
	\|-		\|-
	\| SoftLight		\| SoftLight
	\| Lighten or darken the base clip, based on ~~the light level of the~~ overlay ~~clip~~. ~~If the~~ overlay luma is darker than 128, the ~~base image~~ will be darker. ~~If the~~ overlay luma is lighter than 128, the ~~base image~~ will be lighter. This is useful for adding shadows to an image. ~~Painting with pure~~ black or white produces a distinctly darker or lighter area, but (unlike ''HardLight'') does not result in pure black or white.		\| Lighten or darken the base clip, based on {{FuncArg\|overlay}} luma. Where {{FuncArg\|overlay}} luma is darker than 128, the output will be darker. Where {{FuncArg\|overlay}} luma is lighter than 128, the output will be lighter. This is useful for adding shadows to an image. Pure black or white in the {{FuncArg\|overlay}} produces a distinctly darker or lighter area, but unlike ''HardLight'', does not result in pure black or white output.
	\|-		\|-
	\| HardLight		\| HardLight
	\| Lighten or darken the base clip, based on ~~the light level of the~~ overlay ~~clip~~. ~~If the~~ overlay luma is darker than 128, the ~~base image~~ will be darker. ~~If the~~ overlay luma is lighter than 128, the ~~base image~~ will be lighter. ~~This is useful for adding shadows to an image. Painting with pure~~ black or white results in pure black or white.		\| Lighten or darken the base clip, based on {{FuncArg\|overlay}} luma. Where {{FuncArg\|overlay}} luma is darker than 128, the output will be darker. Where {{FuncArg\|overlay}} luma is lighter than 128, the output will be lighter. Pure black or white in the {{FuncArg\|overlay}} results in pure black or white in the output.
	\|-		\|-
	\| Difference		\| Difference
Line 81:		Line 81:

	:{{Par2\|greymask\|bool\|true}}		:{{Par2\|greymask\|bool\|true}}
	::Specifies whether {{FuncArg\|}} chroma should be used for chroma transparency. ~~Not generally recommended~~. External filters like [[mSharpen]] and [[Masktools]] are able to export proper chroma maps.		::Specifies whether {{FuncArg\|}} chroma should be used for chroma transparency. Generally you want to leave this alone. External filters like [[mSharpen]] and [[Masktools]] are able to export proper chroma maps.

	:{{Par2\|output\|string\|(input)}}		:{{Par2\|output\|string\|(input)}}
Line 87:		Line 87:

	:{{Par2\|ignore_conditional\|bool\|false}}		:{{Par2\|ignore_conditional\|bool\|false}}
	::Ignore any given conditional (~~frame-by-frame~~) variables. See the [[#Conditional Variables]] section for more information.		::Ignore any given ''conditional'' ([[Runtime_environment\|runtime]]) variables. See the [[#Conditional Variables\|Conditional Variables]] section for more information.

	:{{Par2\|pc_range\|bool\|false}}		:{{Par2\|pc_range\|bool\|false}}
	::When set to true, this will make all internal RGB→YUV →RGB conversions assume that luma range is 0–255 instead of default 16–235 range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations]] below.		::When set to true, this will make all internal RGB→YUV →RGB conversions assume that luma range is 0–255 instead of default 16–235 range. It is only recommended to change this setting if you know what you are doing. See [[#RGB considerations\|RGB considerations]] below.
	</div>		</div>

Line 96:		Line 96:
	== RGB considerations ==		== RGB considerations ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	~~This may give you an explanation of why '''Overlay''' behaves like it does when it is given one or more RGB sources.~~

	[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]], this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16–235 (this is the range used by all avisynth converters) to 0–255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:		[[RGB]] inputs are accepted. However, as '''Overlay''' converts internally to [[YV24]], this will lead to an RGB→YUV conversion. There are two modes for this conversion, toggled by the {{FuncArg\|pc_range}} parameter. This parameter will extend the YUV range from 16–235 (this is the range used by all avisynth converters) to 0–255. There are some cases where enabling {{FuncArg\|pc_range}} is a good idea:
	* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0–255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).		* When overlaying an RGB clip using the ''add'', ''subtract'' or ''multiply'' modes, the range of the overlay clip is better, if it is 0–255, since this will enable completely dark areas not to influence the result (instead of adding 16 to every value).

Raffriff42: typo

2016-02-13T21:56:36Z

typo

← Older revision		Revision as of 23:56, 13 February 2016
Line 30:		Line 30:

	:{{Par2\|mask\|clip\|}}		:{{Par2\|mask\|clip\|}}
	::Optional transparency mask. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=~~true~~.		::Optional transparency mask. Must be the same size as {{FuncArg\|overlay}}. Where {{FuncArg\|mask}} is darker, {{FuncArg\|overlay}} will be more transparent. By default only the greyscale (luma) components are used, but this can be overridden with {{FuncArg\|greymask}}=false.
	::''There is no default, but not specifying is equivalent to supplying a 255 clip.''		::''There is no default, but not specifying is equivalent to supplying a 255 clip.''

← Older revision		Revision as of 02:16, 14 February 2016
Line 246:		Line 246:

	thus the dot moves in the following way: (20,20)→(250,350)→(400,40). It's also possible to do this using script variables in place of text files, with [[Animate]].		thus the dot moves in the following way: (20,20)→(250,350)→(400,40). It's also possible to do this using script variables in place of text files, with [[Animate]].
			</div>


			== See also ==
			<div style="max-width:62em" >
			* [[Merge]], [[MergeChroma]] and [[MergeLuma]] – simple blending in any colorspace.
			<div {{ListItemContinue}} >
			Base and overlay colorspaces must match.
			</div>
			* [[Layer]], which supports YUY2 and RGB32 without internal conversion. Supports RGB32 alpha-channel masking.
			<div {{ListItemContinue}} >
			Base and overlay colorspaces must match.
			</div>
			* [[Uu_mt_blend\|uu_mt_blend]], which does not support masking, but supports YV12, RGB24 and RGB32 blending without internal conversion.
			<div {{ListItemContinue}} >
			Base and overlay colorspaces must match. Wide selection of blend modes. Most blend modes work best in RGB.
			</div>
			* [[Fusion]], which uses image pyramids to blend clips together; most often used in the creation of [[Wikipedia:High-dynamic-range_imaging\|HDR]] images and image stitching.

			* and more – see [[External_filters#Averaging.2FLayering.2FMasking\|External Filters: Averaging/Layering/Masking]]
	</div>		</div>

Overlay - Revision history

Pinterf: Update for Avisynth+

Raffriff42: tweak appearance

Raffriff42: tweak appearance

Raffriff42: use Template:AvsPluscon for consistency

Raffriff42: note AVS+ differences *** WIP ***

Raffriff42: small example image for each blend mode

Raffriff42: /* See also */ added

Raffriff42: one more touch-up

Raffriff42: one more touch-up

Raffriff42: typo

Raffriff42: note AVS+ differences * WIP *