Clip properties - Revision history

Raffriff42: AudioDuration tweak

2017-11-04T11:31:52Z

AudioDuration tweak

Raffriff42: move PixelType; AudioDuration notes

2017-11-02T14:00:31Z

move PixelType; AudioDuration notes

Admin: typo

2017-10-29T22:44:20Z

typo

Raffriff42: corrections

2017-10-29T21:46:42Z

corrections

Raffriff42: rearrange subcat's; IsRGB, IsYUV, IsPlanarRGB(A) notes

2017-10-27T00:24:23Z

rearrange subcat's; IsRGB, IsYUV, IsPlanarRGB(A) notes

Show changes

Raffriff42: add AVS+ information

2017-04-23T13:18:41Z

add AVS+ information

Raffriff42: add link

2016-03-13T10:47:43Z

add link

Raffriff42: /* Examples */ code

2016-03-12T20:11:48Z

‎Examples: code

Raffriff42: note re: AudioLengthHi, AudioLengthLo

2016-03-12T14:35:56Z

note re: AudioLengthHi, AudioLengthLo

Raffriff42: typo

2016-03-12T13:26:40Z

typo

@@ Line 104: / Line 104: @@
 ==== Audio ====
-<div style="width:50em; padding:1em; margin-left:0.5em; margin-bottom:1em; line-height:150%; border:1px solid black">
+<div style="width:55em; padding:1em; margin-left:0.5em; margin-bottom:1em; line-height:150%; border:1px solid black">
-'''Audio Duration: Precision vs. Convenience'''
+'''Audio Duration Notes'''
-The easiest way to get a clip’s duration in seconds is {{FuncArg|AudioDuration}}. However, due to the limits of single-precision, floating-point math, the duration of very long clips starts to lose ''precision''; see the [[#Examples|Examples]] below for an illustration. There is an alternative,  {{FuncArg|AudioLength}}, which returns the exact number of audio samples: divide by {{FuncArg|AudioRate}} and you have the precise duration. However, this is limited by the range a of 32-bit integer; with a long enough clip, the result wraps around to a negative number! There are two ways around this: first, {{FuncArg|AudioLengthS}} returns the exact number of audio samples as a string; and second, {{FuncArg|AudioLengthLo}} and {{FuncArg|AudioLengthHi}} together can store the full 64-bit value.
+The easiest way to get a clip’s duration in seconds is {{Term|AudioDuration}}. However, due to the limits of 32-bit floating-point math, the result is very close (within milliseconds per 24-hour day), but not exact.
 </div>
 * ''int'' clip.{{Term|AudioRate}}

@@ Line 21: / Line 21: @@
 ==== Video: Framerate and Duration ====
 * ''int'' clip.{{Term|FrameCount}}
 : Returns the total number of video frames contained in the clip.
@@ Line 40: / Line 41: @@
 ==== Video: Color Format ====
 * ''bool'' clip.{{Term|IsPlanar}}
 : Returns true if the color format is [[Planar]], false otherwise.
@@ Line 99: / Line 103: @@
 : {{AvsPluscon}} Returns bit depth per channel &ndash; 8, 10, 12, 14, 16 or 32.
-* ''string'' clip.{{Term|PixelType}} (from v2.60)
+==== Audio ====
-: Returns the pixel type as a string, ''eg'' "RGB32".
+<div style="width:50em; padding:1em; margin-left:0.5em; margin-bottom:1em; line-height:150%; border:1px solid black">
-==== Audio ====
+The easiest way to get a clip’s duration in seconds is {{FuncArg|AudioDuration}}. However, due to the limits of single-precision, floating-point math, the duration of very long clips starts to lose ''precision''; see the [[#Examples|Examples]] below for an illustration. There is an alternative,  {{FuncArg|AudioLength}}, which returns the exact number of audio samples: divide by {{FuncArg|AudioRate}} and you have the precise duration. However, this is limited by the range a of 32-bit integer; with a long enough clip, the result wraps around to a negative number! There are two ways around this: first, {{FuncArg|AudioLengthS}} returns the exact number of audio samples as a string; and second, {{FuncArg|AudioLengthLo}} and {{FuncArg|AudioLengthHi}} together can store the full 64-bit value.
 * ''int'' clip.{{Term|AudioRate}}
 : Returns the audio sample rate.
 * ''int'' clip.{{Term|AudioLength}}
 : Returns the total number of audio samples, per audio channel.
-: Be aware of possible overflow on extremely long clips (with >= 2<sup>31</sup> audio samples) &ndash; see [[#Examples|Examples]] below.
-* ''int'' clip.{{Term|AudioLengthLo([ int ''m'' ])}}  (from v2.60)
-* ''int'' clip.{{Term|AudioLengthHi([ int ''d'' ])}}  (from v2.60)
-: clip.{{Term|AudioLengthLo}} returns the total number of audio samples, modulo {{Term|''m''}}, which is 10<sup>9</sup> by default.
-: clip.{{Term|AudioLengthHi}} returns the total number of audio samples, divided by {{Term|''d''}}, which is 10<sup>9</sup> by default.
-: Therefore, assuming {{Term|''m''}}=={{Term|''d''}}, the (possibly 64-bit) total equals {{Term|AudioLengthHi}} × {{Term|''m''}} + {{Term|AudioLengthLo}}.
-: (see [[#Examples|Examples]] below)
 * ''float'' clip.{{Term|AudioLengthF}}
 : Returns the total number of audio samples as a float-point number.
@@ Line 119: / Line 120: @@
 * ''string'' clip.{{Term|AudioLengthS}} (from v2.60)
 : Returns the total number of audio samples as a string.
-* ''float'' clip.{{Term|AudioDuration}} (from v2.60)
+* ''int'' clip.{{Term|AudioLengthLo([ int ''m'' ])}}  (from v2.60)
-: Returns the audio duration in seconds.
+* ''int'' clip.{{Term|AudioLengthHi([ int ''d'' ])}}  (from v2.60)
 * ''int'' clip.{{Term|AudioChannels}}
 : Returns the number of audio channels.

@@ Line 71: / Line 71: @@
 : {{AvsPluscon}} Returns true if the color format is 4:2:2, false otherwise.
 * ''bool'' clip.{{Term|Is444}}
-: {{AvsPluscon}} Returns true if the color format is 4:2:4, false otherwise.
+: {{AvsPluscon}} Returns true if the color format is 4:4:4, false otherwise.
 * ''bool'' clip.{{Term|IsY}}
 : {{AvsPluscon}} Returns true if the color format is ''Y''-plane only, false otherwise.

@@ Line 53: / Line 53: @@
 * ''bool'' clip.{{Term|IsYUV}}
 : 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)
 : 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.
 * ''bool'' clip.{{Term|IsYUVA}}
-: {{AvsPluscon}} Returns true if the color format is any [[Avisynthplus_color_formats|YUVA]], false otherwise.
+: {{AvsPluscon}} Returns true if the color format is [[Avisynthplus_color_formats|YUVA]], false otherwise.
 * ''bool'' clip.{{Term|IsRGB48}}
 : {{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}}
 : {{AvsPluscon}} Returns true if the color format is [[Planar]] RGBA, false otherwise.
 * ''bool'' clip.{{Term|HasAlpha}}
-: {{AvsPluscon}} Returns true if the color format has an alpha channe; (RGBA or YUVA), false otherwise.
+: {{AvsPluscon}} Returns true if the color format has an alpha channel; (RGBA or YUVA), false otherwise.
 * ''int'' clip.{{Term|ComponentSize}}

@@ Line 4: / Line 4: @@
 The full list of properties:
 * ''int'' clip.{{Term|Width}}
 : Returns the width of the clip in pixels.
 * ''int'' clip.{{Term|Height}}
 : Returns the height of the clip in pixels.
 * ''int'' clip.{{Term|FrameCount}}
 : Returns the total number of video frames contained in the clip.
@@ Line 17: / Line 20: @@
 * ''int'' clip.{{Term|FrameRateDenominator}}
 : Returns the framerate denominator.
 * ''int'' clip.{{Term|AudioRate}}
 : Returns the audio sample rate.
@@ Line 43: / Line 48: @@
 * ''bool'' clip.{{Term|IsAudioInt}}
 : Returns true if the audio format is an integer type.
 * ''bool'' clip.{{Term|IsRGB}}
 : Returns true if the color format is [[RGB]], false otherwise.
@@ Line 63: / Line 70: @@
 * ''bool'' clip.{{Term|IsYV411}} (from v2.60)
 : Returns true if the color format is [[YV411]], false otherwise.
 * ''string'' clip.{{Term|PixelType}} (from v2.60)
 : Returns the pixel type as a string, ''eg'' "RGB32".
 * ''bool'' clip.{{Term|IsFieldBased}}
 : Returns true if the clip is ''field-based''. What this means is explained [[Interlaced_fieldbased|'''here''']].

@@ Line 89: / Line 89: @@
   [[Levels]](0, 1.0, 255, 64, 255-64, coring=false)
   [[Subtitle]](
-  \   "\nAudioLength  = "  + String(AudioLength)
+  \   "\nAudioLength  = "  + [[Internal_functions#String|String]](AudioLength)
   \ + "\nAudioLengthS = '" + AudioLengthS + "'"
   \ + "\nAudioLengthF = " + String(AudioLengthF)

@@ Line 89: / Line 89: @@
   [[Levels]](0, 1.0, 255, 64, 255-64, coring=false)
   [[Subtitle]](
-  \   "\n"
+  \   "\nAudioLength  = "  + String(AudioLength)
- \ + "AudioLength  = "  + String(AudioLength)  + "\n"
+  \ + "\nAudioLengthS = '" + AudioLengthS + "'"
-  \ + "AudioLengthS = '" + String(AudioLengthS) + "'\n"
+  \ + "\nAudioLengthF = " + String(AudioLengthF)
-  \ + "AudioLengthF = " + String(AudioLengthF) + "\n"
+  \ + "\nAudioLengthLo= " + String(AudioLengthLo)
-  \ + "AudioLengthLo= " + String(AudioLengthLo) + "\n"
+  \ + "\nAudioLengthHi= " + String(AudioLengthHi)
-  \ + "AudioLengthHi= " + String(AudioLengthHi) + "\n"
   \ , font="courier", text_color=$ffffff, size=32, align=4, lsp=0)
 </div>
@@ Line 106: / Line 105: @@
 <div {{BoxWidthIndent|24|2}} >
   [[ColorBars]](width=440, height=440)
   [[Loop]](24)
   ...
 </div>

@@ Line 77: / Line 77: @@
 * ''bool'' clip.{{Term|HasVideo}}
 : Returns true if the clip has video, false otherwise.
@@ Line 106: / Line 105: @@
 </div>
 :[[File:AudioLength-24hr.png]]