Clip properties
From Avisynth wiki
(Difference between revisions)
Raffriff42 (Talk | contribs) (rearrange subcat's; IsRGB, IsYUV, IsPlanarRGB(A) notes) |
Raffriff42 (Talk | contribs) m (corrections) |
||
| Line 53: | Line 53: | ||
* ''bool'' clip.{{Term|IsYUV}} | * ''bool'' clip.{{Term|IsYUV}} | ||
: Returns true if the color format is [[YUV]], false otherwise. | : Returns true if the color format is [[YUV]], false otherwise. | ||
| − | : (note that {{Term|IsYUV}} returns ''false'' for a YUVA clip, and vice versa) | + | : (note that {{Term|IsYUV}} returns ''false'' for a [[Avisynthplus_color_formats|YUVA]] clip, and vice versa) |
* ''bool'' clip.{{Term|IsYUY2}} (clip) | * ''bool'' clip.{{Term|IsYUY2}} (clip) | ||
: Returns true if the color format is [[YUY2]], false otherwise. | : Returns true if the color format is [[YUY2]], false otherwise. | ||
| Line 75: | Line 75: | ||
: {{AvsPluscon}} Returns true if the color format is ''Y''-plane only, false otherwise. | : {{AvsPluscon}} Returns true if the color format is ''Y''-plane only, false otherwise. | ||
* ''bool'' clip.{{Term|IsYUVA}} | * ''bool'' clip.{{Term|IsYUVA}} | ||
| − | : {{AvsPluscon}} Returns true if the color format is | + | : {{AvsPluscon}} Returns true if the color format is [[Avisynthplus_color_formats|YUVA]], false otherwise. |
* ''bool'' clip.{{Term|IsRGB48}} | * ''bool'' clip.{{Term|IsRGB48}} | ||
: {{AvsPluscon}} Returns true if the color format is 16-bit RGB ([[Avisynthplus_color_formats|RGB48]]), false otherwise. | : {{AvsPluscon}} Returns true if the color format is 16-bit RGB ([[Avisynthplus_color_formats|RGB48]]), false otherwise. | ||
| Line 88: | Line 88: | ||
* ''bool'' clip.{{Term|IsPlanarRGBA}} | * ''bool'' clip.{{Term|IsPlanarRGBA}} | ||
: {{AvsPluscon}} Returns true if the color format is [[Planar]] RGBA, false otherwise. | : {{AvsPluscon}} Returns true if the color format is [[Planar]] RGBA, false otherwise. | ||
| + | : (note that {{Term|IsPlanarRGBA}} returns ''false'' for a Planar RGB clip, and vice versa) | ||
* ''bool'' clip.{{Term|HasAlpha}} | * ''bool'' clip.{{Term|HasAlpha}} | ||
| − | : {{AvsPluscon}} Returns true if the color format has an alpha | + | : {{AvsPluscon}} Returns true if the color format has an alpha channel; (RGBA or YUVA), false otherwise. |
* ''int'' clip.{{Term|ComponentSize}} | * ''int'' clip.{{Term|ComponentSize}} | ||
Revision as of 22:46, 29 October 2017
You can access a variety of clip properties in AviSynth scripts. For example, if the variable clip holds a video clip, then clip.Height is its height in pixels, clip.FrameCount is its length in frames, and so on.
Clip properties can be accessed like script variables, except that they are read-only (in C terminology, they cannot be L-values).
Contents |
The full list of properties:
Content Properties
- bool clip.HasAudio
- Returns true if the clip has audio, false otherwise.
- bool clip.HasVideo
- Returns true if the clip has video, false otherwise.
Video: Resolution
- int clip.Width
- Returns the width of the clip in pixels.
- int clip.Height
- Returns the height of the clip in pixels.
Video: Framerate and Duration
- int clip.FrameCount
- Returns the total number of video frames contained in the clip.
- float clip.FrameRate
- Returns approximate framerate. Video framerate is actually a ratio of two 32-bit integers;
- so for the precise number, use FrameRateNumerator and FrameRateDenominator.
- int clip.FrameRateNumerator
- Returns the framerate numerator.
- int clip.FrameRateDenominator
- Returns the framerate denominator.
Video: Interlacing
- bool clip.IsFieldBased
- Returns true if the clip is field-based. What this means is explained here.
- bool clip.IsFrameBased
- Returns true if the clip is frame-based. What this means is explained here.
- bool clip.GetParity([ int f ])
- Returns true if frame f (default 0) is the top field of a field-based clip, or if it is a full frame with top field first of a frame-based clip.
Video: Color Format
- bool clip.IsPlanar
- Returns true if the color format is Planar, false otherwise.
- bool clip.IsInterleaved
- Returns true if the color format is Interleaved, false otherwise.
- bool clip.IsRGB
- Returns true if the color format is RGB, false otherwise.
- (applies to all RGB clips, whether Planar or Interleaved, RGB or RGBA)
- bool clip.IsRGB24
- Returns true if the color format is RGB24, false otherwise.
- bool clip.IsRGB32
- Returns true if the color format is RGB32, false otherwise.
- bool clip.IsYUV
- Returns true if the color format is YUV, false otherwise.
- (note that IsYUV returns false for a YUVA clip, and vice versa)
- bool clip.IsYUY2 (clip)
- Returns true if the color format is YUY2, false otherwise.
- bool clip.IsY8 (from v2.60)
- Returns true if the color format is Y8, false otherwise.
- bool clip.IsYV12
- Returns true if the color format is YV12, false otherwise.
- bool clip.IsYV16 (from v2.60)
- Returns true if the clip color format is YV16, false otherwise.
- bool clip.IsYV24 (v2.60)
- Returns true if the color format is YV24, false otherwise.
- bool clip.IsYV411 (from v2.60)
- Returns true if the color format is YV411, false otherwise.
- bool clip.Is420
- AVS+ Returns true if the color format is 4:2:0, false otherwise.
- bool clip.Is422
- AVS+ Returns true if the color format is 4:2:2, false otherwise.
- bool clip.Is444
- AVS+ Returns true if the color format is 4:2:4, false otherwise.
- bool clip.IsY
- AVS+ Returns true if the color format is Y-plane only, false otherwise.
- bool clip.IsYUVA
- bool clip.IsRGB48
- bool clip.IsRGB64
- bool clip.IsPackedRGB
- AVS+ Returns true if the color format is Interleaved RGB (RGB24/32/48/64), false otherwise.
- bool clip.IsPlanarRGB
- AVS+ Returns true if the color format is Planar RGB, false otherwise.
- (note that IsPlanarRGB returns false for a Planar RGBA clip, and vice versa)
- bool clip.IsPlanarRGBA
- AVS+ Returns true if the color format is Planar RGBA, false otherwise.
- (note that IsPlanarRGBA returns false for a Planar RGB clip, and vice versa)
- bool clip.HasAlpha
- AVS+ Returns true if the color format has an alpha channel; (RGBA or YUVA), false otherwise.
- int clip.ComponentSize
- AVS+ Returns 1 for 8-bit formats, 2 for 10/12/14/16-bit formats, 4 for 32-bit float.
- int clip.NumComponents
- AVS+ Returns 1 for Y-only formats, 3 for RGB and YUV, 4 for RGBA and YUVA.
- int clip.BitsPerComponent
- AVS+ Returns bit depth per channel – 8, 10, 12, 14, 16 or 32.
- string clip.PixelType (from v2.60)
- Returns the pixel type as a string, eg "RGB32".
Audio
- int clip.AudioRate
- Returns the audio sample rate.
- int clip.AudioLength
- Returns the total number of audio samples, per audio channel.
- Be aware of possible overflow on extremely long clips (with >= 231 audio samples) – see Examples below.
- int clip.AudioLengthLo([ int m ]) (from v2.60)
- int clip.AudioLengthHi([ int d ]) (from v2.60)
- clip.AudioLengthLo returns the total number of audio samples, modulo m, which is 109 by default.
- clip.AudioLengthHi returns the total number of audio samples, divided by d, which is 109 by default.
- Therefore, assuming m==d, the (possibly 64-bit) total equals AudioLengthHi × m + AudioLengthLo.
- (see Examples below)
- float clip.AudioLengthF
- Returns the total number of audio samples as a float-point number.
- No overflow limit, but there is a possible precision limit – see Examples below.
- string clip.AudioLengthS (from v2.60)
- Returns the total number of audio samples as a string.
- float clip.AudioDuration (from v2.60)
- Returns the audio duration in seconds.
- int clip.AudioChannels
- Returns the number of audio channels.
- int clip.AudioBits
- Returns the audio bit depth, eg, 8, 16, 24 or 32.
- bool clip.IsAudioFloat
- Returns true if the audio format is Float.
- bool clip.IsAudioInt
- Returns true if the audio format is an integer type.
Examples
- Clip duration = 10 seconds. All AudioLength forms agree.
ColorBars(width=440, height=440) Trim(0, 299) Info Levels(0, 1.0, 255, 64, 255-64, coring=false) Subtitle( \ "\nAudioLength = " + String(AudioLength) \ + "\nAudioLengthS = '" + AudioLengthS + "'" \ + "\nAudioLengthF = " + String(AudioLengthF) \ + "\nAudioLengthLo= " + String(AudioLengthLo) \ + "\nAudioLengthHi= " + String(AudioLengthHi) \ , font="courier", text_color=$ffffff, size=32, align=4, lsp=0)
- Clip duration approximately 24 hours.
Integer AudioLength overloads (wraps around to a negative number), while the floating-point form has lost several digits of precision.
Note the AudioLengthHi / AudioLengthLo arithmetic:
- total = 4 × 109 + 147195848
- total = 4147195848
Back to AviSynth Syntax.
