User:Raffriff42/Utils-r41 Quick Reference - Revision history

Raffriff42: update, formatting

2017-11-26T08:27:07Z

update, formatting

Raffriff42: typo

2017-11-25T20:36:15Z

typo

Raffriff42: updates & corrections

2017-11-25T20:32:48Z

updates & corrections

Raffriff42: v2017-11-20 condensed summary

2017-11-24T18:55:31Z

v2017-11-20 condensed summary

Show changes

Raffriff42: update

2017-10-03T10:36:24Z

update

Raffriff42: typoe

2017-06-09T08:52:29Z

typoe

Raffriff42: update

2017-05-29T06:29:33Z

update

Raffriff42: uodate

2017-05-27T18:36:42Z

uodate

Raffriff42: update

2017-05-15T11:02:18Z

update

Raffriff42: remove dead scnf

2017-05-14T20:58:14Z

remove dead scnf

@@ Line 1: / Line 1: @@
 <div style="max-width:62em" >
-==== {{AvsPluscon}} utilities ====
+{{BoldColor|#4F81BD|120|{{Template:AvsPluscon}} utilities}}
 :Download: '''[[media:Utils-r41.avsi|Utils-r41.avsi]]'''
 <br>
-==== Some of the most useful functions (a short selection) ====
+{{BoldColor|#4F81BD|120|Some of the most useful functions (a short selection)}}
 ===== sc8x =====
 :* [[Autoscale_parameter|Autoscale]] filter arguments to [[Deep_Color|high bit depth]]; scale an 8-bit value for target clip {{FuncArg|T}}.
@@ Line 18: / Line 20: @@
 </div>
 ===== ToRGB =====
 :* Convert from anything to planar RGB[A]
@@ Line 166: / Line 169: @@
 </div>
 ===== LevelsPlus =====
 :* Scale [[D_Notation|0-255]]{{D}} [[Levels]] arguments to current bit depth.
@@ Line 180: / Line 184: @@
 </div>
 ===== ScaleSize =====
 :* Switch (or fade) between three [[Resize]] clips depending on scale factor.
@@ Line 211: / Line 216: @@
   ## @ mode     - Expand method: (extend|mirror|blur|border)
   ##               default/fallback="border"
   ## @ dx, dy   - Shift output in x/y direction. Positive = right/down. Default 0.
   ##              Note output shift rounded to nearest mod-2 unless 'mod'=1.
@@ Line 216: / Line 223: @@
   function CropEx(clip C, float wid, float hgt, int "mod",
   \             int "border", string "mode",
-  \             int "dx", int "dy", bool "debug")
+  \             int "align", int "dx", int "dy", bool "debug")
 </div>
 ===== EvalShow =====
 :* [[Internal_functions/Eval#Eval|Evaluate]] a script snippet; display the script and its result on screen.
@@ Line 297: / Line 305: @@
-==== File history ====
+{{BoldColor|#4F81BD|120|File history}}
 :see [[File:Utils-r41.avsi]].
 </div>
@@ Line 312: / Line 316: @@
 [[Category:Borders_and_Cropping]]
 [[Category:Deep_color_tools]]

@@ Line 7: / Line 7: @@
 ==== Some of the most useful functions (a short selection) ====
-===== sc8f =====
+===== sc8x =====
 :* [[Autoscale_parameter|Autoscale]] filter arguments to [[Deep_Color|high bit depth]]; scale an 8-bit value for target clip {{FuncArg|T}}.
 :: For example, if clip {{FuncArg|C}}'s bit depth = 10, <span style="font-size:104%"><code>C.sc8x('''255''')</code></span>&nbsp;==&nbsp;<span style="font-size:96%">''255''&nbsp;×&nbsp;2<sup>(''10''-8)</sup>&nbsp;==&nbsp;1023</span>.

@@ Line 8: / Line 8: @@
 ===== sc8f =====
-:* Scale an 8-bit value for target clip {{FuncArg|T}}
+:* [[Autoscale_parameter|Autoscale]] filter arguments to [[Deep_Color|high bit depth]]; scale an 8-bit value for target clip {{FuncArg|T}}.
-:: [[Autoscale_parameter|Autoscale]] filter arguments to [[Deep_Color|high bit depth]]. Used in ''eg'', [[#LevelsPlus|LevelsPlus]].
-:: This function provides the basis for two others which are more useful in practice (see full script):
-::*'''sc8x''' &ndash; int result, clamped to legal range
-::*'''sc8s''' &ndash; string result, suitable for use in [[MaskTools2|MaskTools]] expressions
 :: For example, if clip {{FuncArg|C}}'s bit depth = 10, <span style="font-size:104%"><code>C.sc8x('''255''')</code></span>&nbsp;==&nbsp;<span style="font-size:96%">''255''&nbsp;×&nbsp;2<sup>(''10''-8)</sup>&nbsp;==&nbsp;1023</span>.
 <div {{BoxWidthIndent|56|2}} >
-  ## @ T  - clip with target bit depth
+  ## @ T - clip with target bit depth
-  ## @ f  - argument; 0_255 scale
+  ## @ returns int for int formats, float for 32-bit float
- ## @ cx - if true, clamp output to legal range
- ## @ returns float if not clamped;
- ##   else returns int for int formats, float for float
   ##
-  function sc8f(clip T, float f, bool "cx")
+  function sc8x(clip T, float f)
 </div>
@@ Line 139: / Line 133: @@
 <div {{BoxWidthIndent|56|2}} >
   ##  Properties matched:
-  ##  number of channels (see note), bit depth,
+  ##  number of channels (see note), bit depth, sample rate
- ##     sample rate (if allowresample=true)
   ##
   ## AudioChannels handling:
@@ Line 177: / Line 170: @@
 :: {{FuncArg|coring}}=''false'' by default.
 <div {{BoxWidthIndent|56|2}} >
   function LevelsPlus(clip C,
-  \             int input_low, float gamma, int input_high,
+  \             float input_low, float gamma, float input_high,
-  \             int output_low, int output_high,
+  \             float output_low, float output_high,
-  \             bool "coring", bool "dither")
+  \             bool "coring", bool "dither", bool "chroma")
 </div>
@@ Line 186: / Line 183: @@
 :* Switch (or fade) between three [[Resize]] clips depending on scale factor.
 :: Resizers may be user-specified; default resizers are [[#remove_gamma|gamma-aware]].
-::* default 'small' (< 65%) resizer: gamma-aware <tt>[[BicubicResize]] (b=-0.5, c=0.25)</tt>
+::* default 'small' (< 65%) resizer: gamma-aware <tt>[[Resize#BicubicResize|BicubicResize]] (b=-0.5, c=0.25)</tt>
-::* default 'medium'&nbsp;&nbsp; resizer:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; gamma-aware <tt>[[Spline64Resize]]</tt>
+::* default 'medium'&nbsp;&nbsp; resizer:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; gamma-aware <tt>[[Resize#Spline_based_resizers|Spline64Resize]]</tt>
-::* default 'large' (> 133%) resizer: gamma-aware <tt>[[GaussResize]] (p=50)</tt>
+::* default 'large' (> 133%) resizer: gamma-aware <tt>[[Resize#GaussResize|GaussResize]] (p=50)</tt>
 <div {{BoxWidthIndent|56|2}} >
   ## @ fwid  - new width
@@ Line 251: / Line 248: @@
 ===== ScopeR =====
-:* Show waveform + vectorscope; accepts RGB
+:* Show waveform + vectorscope; accepts RGB or YUV
-:: Rotates waveform 90&deg; CCW and makes brighter; rotates vector 180&deg;.
+:: Rotate waveform 90&deg; CCW and make brighter; rotate vector 180&deg;.
 <div {{BoxWidthIndent|56|2}} >
   ## @ shrink - if true, shrink clip+scopes & add side borders so output size = input;
@@ Line 269: / Line 266: @@
 ===== ScopeY =====
 :* Simple waveform + vector scope. Accepts 8-bit, YUV only.
-:: Rotates waveform 90&deg; CCW and makes brighter; rotates vector 180&deg;.
+:: Rotate waveform 90&deg; CCW and make brighter; rotate vector 180&deg;.
 <div {{BoxWidthIndent|56|2}} >
   ## @ shrink - if true, shrink clip+scopes & add side borders so
@@ Line 288: / Line 285: @@
 ===== HistogramTurn =====
 :* Classic [[Histogram]], waveform on top (or on bottom); supports RGB
-:: Rotates waveform 90&deg; CCW and makes brighter.
+:: Rotate waveform 90&deg; CCW and make brighter.
 <div {{BoxWidthIndent|56|2}} >
   ## @ parade - if true (default), show RGB waveforms side-by-side;

@@ Line 4: / Line 4: @@
 __TOC__
 === String functions ===
@@ Line 56: / Line 62: @@
 {{FuncDef|f2c(float f)}}
 : Scale "normal" float arguments to [[ColorYUV]]'s ''gain_x'', ''gamma_x'' & ''cont_x''
 {{FuncDefH4|_gcd}}
@@ Line 182: / Line 192: @@
 }}
 : Scale 0-255 [[Levels]] arguments to current bit depth
 {{FuncDefH4|OverlayAligned}}
@@ Line 223: / Line 249: @@
 : Switch (or fade) between three [[Resize]] clips depending on scale factor
 : Calls 'private' resizers ''ScaleSize_small'', ''ScaleSize_medium'' and ''ScaleSize_large'' by default, but you can specify other resizers.
 {{FuncDefH4|CropPanTilt}}
@@ Line 233: / Line 263: @@
 {{FuncDefH4|CropEx}}
-{{FuncDef|CropEx(clip C, float wid, float hgt, [int ''mod'', <br>
+{{FuncDef|CropEx(clip C, float wid, float hgt, <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''border'', string ''mode'', bool ''debug''])}}
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [int ''mod'', int ''border'', string ''mode'', bool ''debug''])}}
 : Symmetrically crop or expand a clip to ensure it is a certain size, with size forced to mod-4, mod-8 etc
 {{FuncDefH4|Shift}}

@@ Line 147: / Line 147: @@
 {{FuncDefH4|PC2TV}}
 {{FuncDef|PC2TV(clip C)}}
-: PC-&gt;TV
+: PC-&gt;TV: convert levels from 'PC' (black=0{{D}}, white=255{{D}}) to 'TV' (black=16{{D}}, white=235{{D}})
 {{FuncDefH4|TV2PC}}
 {{FuncDef|TV2PC(clip C(}}
-: TV-&gt;PC
+: TV-&gt;PC: convert levels from 'TV' (black=16{{D}}, white=235{{D}}) to 'PC' (black=0{{D}}, white=255{{D}})
 {{FuncDefH4|stack_to_wid}}
@@ Line 217: / Line 217: @@
 {{FuncDef|ScaleSize(clip C, float factor, int mod, <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''sm'', string ''med'', string ''lg'', <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; float ''thrSm'', float ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}<br>
 {{FuncDef|ScaleSize(clip C, float fwid, float fhgt, int mod, <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''sm'', string ''med'', string ''lg'', <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; float ''thrSm'', float ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}
 : Switch (or fade) between three [[Resize]] clips depending on scale factor
 : Calls 'private' resizers ''ScaleSize_small'', ''ScaleSize_medium'' and ''ScaleSize_large'' by default, but you can specify other resizers.

@@ Line 144: / Line 144: @@
 {{FuncDef|YUV2GBR(clip C, [clip ''A'', bool ''rgb32''])}}
 : Transport YV24 in RGB &ndash;  Y=>G, U=>B, V=>R
 {{FuncDefH4|stack_to_wid}}
@@ Line 158: / Line 166: @@
 {{FuncDefH4|remove_gamma}}
-{{FuncDef|remove_gamma(clip C, [bool ''enable''])}}
+{{FuncDef|remove_gamma(clip C, [bool ''enable'', int ''mode''])}}
 : Remove [[wikipedia:Gamma_correction|gamma transfer function]] (if bit depth > 8) for linear-light processing.
 {{FuncDefH4|restore_gamma}}
-{{FuncDef|restore_gamma(clip C, [bool ''enable''])}}
+{{FuncDef|restore_gamma(clip C, [bool ''enable'', int ''mode''])}}
 : Apply [[wikipedia:Gamma_correction|standard gamma transfer function]] (if bit depth > 8)
@@ Line 209: / Line 217: @@
 {{FuncDef|ScaleSize(clip C, float factor, int mod, <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''sm'', string ''med'', string ''lg'', <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident''])}}<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}<br>
 {{FuncDef|ScaleSize(clip C, float fwid, float fhgt, int mod, <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [string ''sm'', string ''med'', string ''lg'', <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident''])}}
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int ''thrSm'', int ''thrLg'', bool ''fade'', bool ''ident'', bool ''gamma''])}}
 : Switch (or fade) between three [[Resize]] clips depending on scale factor
 {{FuncDefH4|CropPanTilt}}
@@ Line 275: / Line 284: @@
 {{FuncDefH4|VideoScopes}}
-{{FuncDef|VideoScopes(clip C, [bool ''squeeze''])}}
+{{FuncDef|VideoScopes(clip C, [bool ''shrink'', bool ''vector'', string ''matrix'', bool ''parade''])}}
-: Show waveform + vectorscope; accepts RGB;
+: Show waveform on top plus optional vectorscope; accepts RGB.
 {{FuncDefH4|Analyze}}

@@ Line 109: / Line 109: @@
 === Utility filters ===
 ----
 {{FuncDefH4|MatchColorFormat}}
 {{FuncDef|MatchColorFormat(clip C, clip T, [string ''matrix'', bool ''matchbits'', bool ''dither''])}}
@@ Line 178: / Line 198: @@
 === Crop, resize and transform filters ===
 ----
 {{FuncDefH4|Cropd}}
 {{FuncDef|Cropd(clip C, int x, int y, int wid, int hgt, [bool ''align'', int ''mod''])}}
@@ Line 231: / Line 255: @@
 {{FuncDef|EvalShow(clip C, string s, [bool ''bypass'', float ''size'', int ''align''])}}
 : Execute a script snippet; show script & result on screen
 {{FuncDefH4|ShowMask}}
@@ Line 256: / Line 276: @@
 {{FuncDefH4|VideoScopes}}
 {{FuncDef|VideoScopes(clip C, [bool ''squeeze''])}}
-: Show waveform + vectorscope; accepts RGB
+: Show waveform + vectorscope; accepts RGB;
 {{FuncDefH4|Analyze}}

@@ Line 109: / Line 109: @@
 === Utility filters ===
 ----
 {{FuncDefH4|MatchColorFormat}}
 {{FuncDef|MatchColorFormat(clip C, clip T, [string ''matrix'', bool ''matchbits'', bool ''dither''])}}
@@ Line 182: / Line 178: @@
 === Crop, resize and transform filters ===
 ----
 {{FuncDefH4|ScaleSize}}
 {{FuncDef|ScaleSize(clip C, float factor, int mod, <br>
@@ Line 243: / Line 243: @@
 {{FuncDefH4|ColorbarsHD2}}
-{{FuncDef|ColorbarsHD2([int ''width'', int ''height'', bool ''rgb_out'', int ''bits_out'', bool ''dither''])}}
+{{FuncDef|ColorbarsHD2(clip T, [float ''tonedb''])}} <br>
-: Return [[ColorBarsHD]] with small changes (1280x720, TV-range, 29.97 fps, 1 hour long, audio tone @ -18dB, 48kz)
+{{FuncDef|ColorbarsHD2([int ''width'', int ''height'', bool ''rgb_out'', <br>
 {{FuncDefH4|Grayramp}}

@@ Line 94: / Line 94: @@
 {{FuncDef|scbs(int bits_in, int bits_out, float f, [int ''decimals''])}}
 : Scale a value from one bit depth to another; string result
 {{FuncDefH4|sc8f}}