CombinePlanes

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
m (typo)
(add RemoveAlphaPlane, AddAlphaPlane)
Line 1: Line 1:
 
<div style="max-width:82em; min-width:42em;" >
 
<div style="max-width:82em; min-width:42em;" >
{{AvsPlusFilter}}Combines planes of source clip(s) into a target clip. Similar to ShufflePlanes in Vapoursynth. Performs the functionality of [[SwapUV]], [[YToUV]], [[MergeChroma]], [[MergeRGB]] and more.
+
{{AvsPlusFilter}}
 
</div>
 
</div>
 
 
 
__TOC__
 
__TOC__
  
==== Syntax and Parameters ====
 
 
<div style="max-width:62em; min-width:42em;" >
 
<div style="max-width:62em; min-width:42em;" >
 +
<!-- ==== Syntax and Parameters ==== -->
 +
==== CombinePlanes ====
 +
Merges planes of source clip(s) into a target clip. <br>
 +
It is similar to ''ShufflePlanes'' in Vapoursynth. Performs the functionality of [[SwapUV]], [[YToUV]], [[MergeChroma]], [[MergeRGB]] and more.
 +
 
{{FuncDef|CombinePlanes(clip, <br>  
 
{{FuncDef|CombinePlanes(clip, <br>  
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''planes'', string ''source_planes'', string ''pixel_type'', clip ''sample_clip'' ] )}}
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''planes'', string ''source_planes'', string ''pixel_type'', clip ''sample_clip'' ] )}}
Line 39: Line 41:
 
::If supplied, output {{FuncArg|pixel_type}} will match that of {{FuncArg|sample_clip}}.
 
::If supplied, output {{FuncArg|pixel_type}} will match that of {{FuncArg|sample_clip}}.
  
 +
==== RemoveAlphaPlane ====
 +
Removes the RGB or YUV alpha plane.<br>
 +
If no alpha plane was present, nothing is changed.
 +
 +
{{FuncDef|RemoveAlphaPlane(clip)}}
 +
 +
==== AddAlphaPlane ====
 +
Adds an opaque RGB or YUV alpha plane, or copies the alpha from a {{FuncArg|mask}} clip.<br>
 +
If an alpha plane was present, it is replaced.
 +
 +
{{FuncDef|AddAlphaPlane(clip, clip ''mask'' ] )}}
 +
 +
:{{Par2||clip|}}
 +
::Source clip(s). 
 +
 +
:{{Par2|mask|clip|}}
 +
::If supplied, the alpha plane from {{FuncArg|mask}} is copied to the resulting clip.
 
</div>
 
</div>
 +
 
==== Examples ====
 
==== Examples ====
 
<div style="max-width:62em; min-width:42em;" >
 
<div style="max-width:62em; min-width:42em;" >

Revision as of 11:36, 23 April 2017

AVS+
This feature is specific to AviSynthPlus.

It is not supported in other AviSynth versions.

Contents


CombinePlanes

Merges planes of source clip(s) into a target clip.
It is similar to ShufflePlanes in Vapoursynth. Performs the functionality of SwapUV, YToUV, MergeChroma, MergeRGB and more.

CombinePlanes(clip,
      [string planes, string source_planes, string pixel_type, clip sample_clip ] )

CombinePlanes(clip, clip,
      [string planes, string source_planes, string pixel_type, clip sample_clip ] )

CombinePlanes(clip, clip, clip,
      [string planes, string source_planes, string pixel_type, clip sample_clip ] )

CombinePlanes(clip, clip, clip, clip,
      [string planes, string source_planes, string pixel_type, clip sample_clip ] )

clip   =
Source clip(s). At least one is required. Up to four clips are accepted.
Each clip defines a color plane in the output, as defined by the planes and source_planes arguments.
If the clip count is less than the given planes defined, then the last available clip is used as a source for all later planes.
string  planes = ""
The target plane order (e.g. "YVU", "YYY", "RGB"); missing target planes will be undefined in the target.
string  source_planes = "YUVA" or "RGBA"
The source plane order, defaulting to "YUVA" or "RGBA" depending on the video format.
Source clips can even be mixed from greyscale, YUV, YUVA or planar RGB(A) — the only rule being that the relevant source plane character should match with the clip format, respectively.
string  pixel_type =
Set color format of the returned clip. Supports all AVS+ color formats.
clip  sample_clip =
If supplied, output pixel_type will match that of sample_clip.

RemoveAlphaPlane

Removes the RGB or YUV alpha plane.
If no alpha plane was present, nothing is changed.

RemoveAlphaPlane(clip)

AddAlphaPlane

Adds an opaque RGB or YUV alpha plane, or copies the alpha from a mask clip.
If an alpha plane was present, it is replaced.

AddAlphaPlane(clip, clip mask ] )

clip   =
Source clip(s).
clip  mask =
If supplied, the alpha plane from mask is copied to the resulting clip.

Examples

#combine greyscale clips into YUVA clip
U8 = source.UToY8()
V8 = source.VToY8()
Y8 = source.ConvertToY()
A8 = source.AddAlphaPlane(128).AToY8()
CombinePlanes(Y8, U8, V8, A8, planes="YUVA", source_planes="YYYY", 
\               sample_clip=source) #pixel_type="YUV444P8"
# Copy planes between planar RGB(A) and YUV(A) without any conversion
# yuv 4:4:4 <-> planar rgb
source = last.ConvertBits(32) # 4:4:4
cast_to_planarrgb = CombinePlanes(source, planes="RGB", source_planes="YUV", 
\               pixel_type="RGBPS")
# get back a clip identical with "source"
cast_to_yuv = CombinePlanes(cast_to_planarrgb, planes="YUV", source_planes="RGB", 
\               pixel_type="YUV444PS")
#create a black and white planar RGB clip using Y channel
#source is a YUV clip
grey = CombinePlanes(source, planes="RGB", source_planes="YYY", 
\               pixel_type="RGBP8")
#copy luma from one clip, U and V from another
#source is the template
#sourceY is a Y or YUV clip
#sourceUV is a YUV clip
grey = CombinePlanes(sourceY, sourceUV, planes="YUV", 
\               source_planes="YUV", sample_clip = source)

Changes

20161110 first added
Personal tools