Non-clip functions - Revision history

Raffriff42: make redirect

2014-09-17T02:00:15Z

make redirect

Raffriff42: /* String(var [, format-string]) */ delete previous note, add link to other String( )

2014-09-16T13:30:18Z

String(var [, format-string]): delete previous note, add link to other String( )

← Older revision		Revision as of 15:30, 16 September 2014
Line 259:		Line 259:
	Findstr("AviSynth", "syn") = 4		Findstr("AviSynth", "syn") = 4

	=====String(var [, ~~format-string~~])=====		=====String(var [, String format_string])=====
	::v2		::v2

	:Converts a variable to a string. String arguments are passed along unchanged; booleans are converted to "true" or "false"; numbers (ints or floats) are formatted as described below; all other value types are converted to the empty string.		:Converts a variable to a string. String arguments are passed along unchanged; booleans are converted to "true" or "false"; numbers (ints or floats) are formatted as described below; all other value types are converted to the empty string.

	:~~format-string~~: optional, sets number of decimal places; must be of the form <code>"%'''x'''.'''y'''f"</code>		:'''format_string''': optional, sets number of decimal places; must be of the form <code>"%'''x'''.'''y'''f"</code>
	::* where '''x''' is the minimum width in characters (including decimal point)		::* where '''x''' is the minimum width in characters (including decimal point)
	::* and '''y''' is the number of digits to the right of the decimal point.		::* and '''y''' is the number of digits to the right of the decimal point.
	::* ~~format-string '~~'~~must~~'' ~~start with "~~%"		::* format_string must start with '''%''' and end with '''f'''.
	~~::* format-string~~ '~~'should~~'' end with "f~~" (~~other [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] ~~suffixes ''may'' work, but behavior is undefined)~~		::* other [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] formatting flags are available; see [[Internal_functions/Conversion_functions\|Conversion functions]].
	::* if ''var'' is not a number and a format-string is given, output is the empty string.		::* if ''var'' is not a number and a format string is given, output is the empty string.

	::''TODO the information above (citation: [http://avisynth2.cvs.sourceforge.net/viewvc/avisynth2/avisynth/src/core/parser/script.cpp?view=markup#l857 script.cpp]) partially disagrees with that on page [[Internal_functions/Conversion_functions\|Conversion functions]]; need to determine which is more correct.''		:The format string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.

	:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.

	:''Examples:''		:''Examples:''

Raffriff42: /* String(var [, format-string]) */ citation

2014-09-16T13:14:25Z

String(var [, format-string]): citation

← Older revision		Revision as of 15:14, 16 September 2014
Line 271:		Line 271:
	::* if ''var'' is not a number and a format-string is given, output is the empty string.		::* if ''var'' is not a number and a format-string is given, output is the empty string.

	:'''TODO~~'''~~ the information above disagrees with that on page [[Conversion_functions\|Conversion functions]]; need to determine which is more correct.		::''TODO the information above (citation: [http://avisynth2.cvs.sourceforge.net/viewvc/avisynth2/avisynth/src/core/parser/script.cpp?view=markup#l857 script.cpp]) partially disagrees with that on page [[Internal_functions/Conversion_functions\|Conversion functions]]; need to determine which is more correct.''

	:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.		:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.

Raffriff42: add missing function Hex( ); note String( ) doc conflict

2014-09-16T13:08:06Z

add missing function Hex( ); note String( ) doc conflict

← Older revision		Revision as of 15:08, 16 September 2014
Line 270:		Line 270:
	::* format-string ''should'' end with "f" (other [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] suffixes ''may'' work, but behavior is undefined)		::* format-string ''should'' end with "f" (other [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] suffixes ''may'' work, but behavior is undefined)
	::* if ''var'' is not a number and a format-string is given, output is the empty string.		::* if ''var'' is not a number and a format-string is given, output is the empty string.

			:'''TODO''' the information above disagrees with that on page [[Conversion_functions\|Conversion functions]]; need to determine which is more correct.

	:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.		:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.
Line 297:		Line 299:
	Chr(802) # also returns the quote character (802 % 256 = 34)		Chr(802) # also returns the quote character (802 % 256 = 34)
	Chr(-990) # also returns the quote character (-990 % 256 = 34, in unsigned 32 bit math)		Chr(-990) # also returns the quote character (-990 % 256 = 34, in unsigned 32 bit math)

			=====Hex(int)=====
			::v2.07

			: Converts a numerical value to its hexadecimal value. See [[Colors]] for more information on specifying colors.
			: ''Examples:''
			Hex (10824234) = "A52A2A"

	=====Time(string)=====		=====Time(string)=====

Raffriff42: conditional operations subsection

2014-09-16T04:53:55Z

conditional operations subsection

← Older revision		Revision as of 06:53, 16 September 2014
Line 435:		Line 435:
	:Sets the directory from which AviSource, LoadPlugin, etc. are referenced. This is primarily for easy loading of source clips, etc. Does not affect plugin autoloading. Return value: 0 if successful, -1 otherwise. v2		:Sets the directory from which AviSource, LoadPlugin, etc. are referenced. This is primarily for easy loading of source clips, etc. Does not affect plugin autoloading. Return value: 0 if successful, -1 otherwise. v2

	~~:''~~Conditional Operations~~:''~~		== Conditional Operations ==

	~~```[```~~''~~var~~''~~```=]```''boolean expression~~'' ? ~~''iftrue value or operation'' : ''ifelse value or operation''~~		('''TODO''' - move to another page?)

	=====~~nop~~()=====		=====Ternary expression (condition ? a : b)=====

	:~~v2.07 null result primarily for~~ if-~~then~~-else operation ~~above where ifelse is not desired~~		:Syntax:
			::[''var''=] ''boolean expression'' '''?''' ''if-true value or operation'' '''<nowiki>:</nowiki>''' ''if-else value or operation''

	:(~~nop~~ primarily ~~to be used against non~~-~~variable / non~~-~~clip functions such as import and loadplugin)~~		:''Examples:''

			(IsRGB) '''?''' RGBAdjust(analyze=true) ''':''' ColorYUV(analyze=true)
			ConvertToYV12(matrix=(Height>500) '''?''' "Rec709" ''':''' "Rec601")
			HasAudio '''?''' Last ''':''' AudioDub(WavSource("music.wav"))

			=====Nop()=====

			:::v2.07
			:Null operation; primarily for if-then-else operation above where an 'else' value is not desired - for example, conditional [[Import]] or [[LoadPlugin]].

	:''Example:''		:''Example:''

	VersionNumber<2.07 ? [[Import]]("patches.avs") : ~~nop~~()		VersionNumber<2.07 ? [[Import]]("patches.avs") : Nop()

	=====Select(int index, val ''item0'' ~~```~~[~~```~~,''item1''...~~```~~]~~```~~)=====		=====Select(int index, val ''item0'' [,''item1''...])=====
	::v2.07		::v2.07

Line 458:		Line 468:
	:You can define and call your own functions in AVS scripts as shown below. [[Script_grammar\|Script Grammar]] within a function is identical to that of a script at large. The function can return any clip or variable type. The format is generally as follows:		:You can define and call your own functions in AVS scripts as shown below. [[Script_grammar\|Script Grammar]] within a function is identical to that of a script at large. The function can return any clip or variable type. The format is generally as follows:

	function ''function_name''(~~```~~[~~```~~''var_type'' ''var_name'' ~~```~~[,...]~~```~~)		function ''function_name''([''var_type'' ''var_name'' [,...])
	{		{
	''function commands''		''function commands''

Raffriff42: String( ) - partial clarification

2014-09-16T04:06:40Z

String( ) - partial clarification

← Older revision		Revision as of 06:06, 16 September 2014
Line 259:		Line 259:
	Findstr("AviSynth", "syn") = 4		Findstr("AviSynth", "syn") = 4

	=====String(~~float / int~~)=====		=====String(var [, format-string])=====
	::v2		::v2

	:Converts a ~~number~~ to a string.		:Converts a variable to a string. String arguments are passed along unchanged; booleans are converted to "true" or "false"; numbers (ints or floats) are formatted as described below; all other value types are converted to the empty string.

	:''~~Example~~:''		:format-string: optional, sets number of decimal places; must be of the form <code>"%'''x'''.'''y'''f"</code>
	[[Subtitle]]( "~~Clip height is~~ " + String(~~last~~.~~height~~) )		::* where '''x''' is the minimum width in characters (including decimal point)
			::* and '''y''' is the number of digits to the right of the decimal point.
			::* format-string ''must'' start with "%"
			::* format-string ''should'' end with "f" (other [http://www.tutorialspoint.com/c_standard_library/c_function_sprintf.htm sprintf] suffixes ''may'' work, but behavior is undefined)
			::* if ''var'' is not a number and a format-string is given, output is the empty string.

			:The format-string is also useful for '''right-justifying numbers''' - enforcing a minimum width, padded with leading spaces.

			:''Examples:''
			## floating point examples
			Subtitle( "PI=" + String(PI, "%0.0f") ) # "PI=3"
			Subtitle( "PI=" + String(PI, "%2.0f") ) # "PI= 3"
			Subtitle( "PI=" + String(PI, "%3.2f") ) # "PI=3.14"
			Subtitle( "PI=" + String(PI, "%0.5f") ) # "PI=3.14159"
			Subtitle( "PI=" + String(PI, "%6.3f") ) # "PI= 3.142"
			## integer examples
			Subtitle( "'" + String(32, "%0f") + "'" ) # result: '32.000000'
			Subtitle( "'" + String(32, "%0.0f") + "'" ) # result: '32'
			Subtitle( "'" + String(32, "%3.0f") + "'" ) # result: ' 32'
			Subtitle( "'" + String(32, "%8.0f") + "'" ) # result: ' 32'

	=====Chr(int)=====		=====Chr(int)=====

Raffriff42: all functions in subheads

2014-09-16T02:35:48Z

all functions in subheads

Show changes

Raffriff42: Chr - fix my typo

2014-09-15T20:14:23Z

Chr - fix my typo

← Older revision		Revision as of 22:14, 15 September 2014
Line 247:		Line 247:
	Chr(34) # returns the quote character		Chr(34) # returns the quote character
	Chr(802) # also returns the quote character (802 % 256 = 34)		Chr(802) # also returns the quote character (802 % 256 = 34)
	Chr(-990) # also returns the quote character (-990 % 256 = 34, in unsigned 16 bit math)		Chr(-990) # also returns the quote character (-990 % 256 = 34, in unsigned 32 bit math)

	Time(string) '''v2.51'''		Time(string) '''v2.51'''

Raffriff42: Chr - clarification

2014-09-15T12:40:16Z

Chr - clarification

← Older revision		Revision as of 14:40, 15 September 2014
Line 240:		Line 240:
	Chr(int) '''v2.51'''		Chr(int) '''v2.51'''

	Returns the ~~ASCII~~ character.		Returns the Windows character in the system code page (for computers in the West, usually [https://en.wikipedia.org/wiki/Windows-1252 Windows-1252]).

			Valid input range 0-255; values outside that range are wrapped around (modulo 256).

	'''Example:'''		'''Example:'''
	Chr(34) returns the quote character		Chr(34) # returns the quote character
			Chr(802) # also returns the quote character (802 % 256 = 34)
			Chr(-990) # also returns the quote character (-990 % 256 = 34, in unsigned 16 bit math)

	Time(string) '''v2.51'''		Time(string) '''v2.51'''

Admin: removed GetMTMode/SetMTMode functions

2013-07-08T20:39:40Z

removed GetMTMode/SetMTMode functions

@@ Line 356: / Line 356: @@
 From v2.5.8, setting this to zero just returns the current Memory Max value. In the 2.5 series the default Memory Max value is 25% of the free physical memory, with a minimum of 16MB. From rev 2.5.8 RC4, the default Memory Max is also limited to 512MB.
 SetPlanarLegacyAlignment (clip, bool): Set alignment mode for planar frames. v2.5.6
@@ Line 373: / Line 372: @@
 SetWorkingDir (string): Sets the directory from which AviSource, LoadPlugin, etc. are referenced. This is primarily for easy loading of source clips, etc. Does not affect plugin autoloading. Return value: 0 if successful, -1 otherwise. v2
 '''Conditional Operations:'''