ConditionalReader - Revision history

Reel.Deal: add link to avs+ documentation

2022-09-18T03:18:52Z

add link to avs+ documentation

← Older revision		Revision as of 05:18, 18 September 2022
Line 1:		Line 1:
			<div {{BlueBox2\|40\|0\|3px solid purple}} >
			{{AvsPlusFullname}}<br>
			Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/conditionalreader.html https://avisynthplus.readthedocs.io]
			</div>


	Import information from a text file and assign a per-frame value to a script variable.		Import information from a text file and assign a per-frame value to a script variable.

Reel.Deal: /* File format */ typo

2022-02-25T10:25:44Z

File format: typo

← Older revision		Revision as of 12:25, 25 February 2022
Line 56:		Line 56:
	:::<code>DEFAULT <value></code>		:::<code>DEFAULT <value></code>
	:::This specifies the value to be used if there is no applicable {{BoldColor\|#4F81BD\|100\|''data''}} line for a given frame.		:::This specifies the value to be used if there is no applicable {{BoldColor\|#4F81BD\|100\|''data''}} line for a given frame.
	:::If you do not define a default, be sure to specify a value for all frames; otherwise your script variable could be be [[Internal functions/Defined\|undefined]] or take a random value.		:::If you do not define a default, be sure to specify a value for all frames; otherwise your script variable could be [[Internal functions/Defined\|undefined]] or take a random value.

	*An optional {{BoldColor\|#4F81BD\|100\|''offset''}} line may appear:		*An optional {{BoldColor\|#4F81BD\|100\|''offset''}} line may appear:
Line 81:		Line 81:
	:All {{BoldColor\|#4F81BD\|100\|''data''}} and {{BoldColor\|#4F81BD\|100\|''default''}} ''values'' must be valid for the defined {{BoldColor\|#4F81BD\|100\|''type''}}, as defined above, or an error will be raised.		:All {{BoldColor\|#4F81BD\|100\|''data''}} and {{BoldColor\|#4F81BD\|100\|''default''}} ''values'' must be valid for the defined {{BoldColor\|#4F81BD\|100\|''type''}}, as defined above, or an error will be raised.
	</div>		</div>


	== Examples ==		== Examples ==

Raffriff42: one more touch-up

2016-02-26T21:29:17Z

one more touch-up

← Older revision		Revision as of 23:29, 26 February 2016
Line 17:		Line 17:

	:{{Par2\|show\|bool\|false}}		:{{Par2\|show\|bool\|false}}
	::If ''true'', show ~~the~~ {{FuncArg\|variablename}} value at the current frame ~~(as determined by the file values) as a text overlay~~.		::If ''true'', show a text overlay with {{FuncArg\|variablename}}'s assigned value at the current frame.
	</div>		</div>

Line 23:		Line 23:
	== File format ==		== File format ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	*The file is plain text. It is not case sensitive. Each line stands alone. There are several different line types, as explained below.		*The file is plain text.
			**It is not case sensitive.
			**Each line stands alone.
			**There are several different ''line types'', as explained below.
			**Blank lines are ignored.

	*The file may begin with one or more optional {{BoldColor\|~~blue~~\|100\|''comment''}} lines:		*The file may begin with one or more optional {{BoldColor\|#4F81BD\|100\|''comment''}} lines:
	<div {{ListItemContinue}} >		<div {{ListItemContinue}} >
	Any line is ignored if the first non-whitespace character is '<tt>#</tt>' (hash), '<tt>;</tt>' (semicolon) or '<tt>%</tt>' (percent).		Any line is ignored if the first non-whitespace character is '<tt>#</tt>' (hash), '<tt>;</tt>' (semicolon) or '<tt>%</tt>' (percent).
Line 35:		Line 39:
	</div>		</div>

	*The first non-{{BoldColor\|~~blue~~\|100\|''comment''}} line should be a {{BoldColor\|~~blue~~\|100\|''type''}} line, which ~~sets~~ the ~~''value'' type for all~~ following ~~lines. There are four valid {{BoldColor\|blue\|100\|''type''}} lines~~:		*The first non-{{BoldColor\|#4F81BD\|100\|''comment''}} line should be a {{BoldColor\|#4F81BD\|100\|''type''}} line, which must be one of the following:
	:: <code>TYPE int</code>		:: <code>TYPE int</code>
	::: Tells '''ConditionalReader''' to expect decimal integer ''values''.		::: Tells '''ConditionalReader''' to expect decimal integer ''values''.
	::: (~~digits~~ <code>0-9</code>, optionally preceded with a '<code>+</code>' or '<code>-</code>' sign)		::: (Digits <code>0-9</code>, optionally preceded with a '<code>+</code>' or '<code>-</code>' sign)
	:: <code>TYPE float</code>		:: <code>TYPE float</code>
	::: Tells '''ConditionalReader''' to expect floating-point ''values''.		::: Tells '''ConditionalReader''' to expect floating-point ''values''.
	::: (~~decimal~~ number with '<code>.</code>' decimal point, and optionally followed by an '<code>E</code>' character and decimal exponent)		::: (Decimal number with '<code>.</code>' decimal point, and optionally followed by an '<code>E</code>' character and decimal exponent)
	:: <code>TYPE bool</code>		:: <code>TYPE bool</code>
	::: Tells '''ConditionalReader''' to expect boolean ''values''.		::: Tells '''ConditionalReader''' to expect boolean ''values''.
	::: ('<code>true</code>' or '<code>false</code>', '<code>T</code>' or '<code>F</code>', '<code>yes</code>' or '<code>no</code>', '<code>1</code>' or '<code>0</code>')		::: ('<code>true</code>' or '<code>false</code>', '<code>T</code>' or '<code>F</code>', '<code>yes</code>' or '<code>no</code>', '<code>1</code>' or '<code>0</code>')
	:: <code>TYPE string</code> (from v2.60)		:: <code>TYPE string</code> (from v2.60)
	::: (~~any~~ sequence of characters, including quote, backslash etc~~; a~~ line break ends the string)		::: (Any sequence of characters, including quote, backslash etc. A line break ends the string.)
	:The {{BoldColor\|~~blue~~\|100\|''type''}} line defines the {{BoldColor\|~~blue~~\|100\|''data''}} type to be parsed from this file and assigned to the variable {{FuncArg\|variablename}}. You must have one, and only one, {{BoldColor\|~~blue~~\|100\|''type''}} line per file, and it must come before any other lines, except for optional comments.		:The {{BoldColor\|#4F81BD\|100\|''type''}} line defines the {{BoldColor\|#4F81BD\|100\|''data''}} type to be parsed from this file and assigned to the variable {{FuncArg\|variablename}}. You must have one, and only one, {{BoldColor\|#4F81BD\|100\|''type''}} line per file, and it must come before any other lines, except for optional comments.

	*A {{BoldColor\|~~blue~~\|100\|''default''}} line should come next. It is optional but strongly suggested:		*A {{BoldColor\|#4F81BD\|100\|''default''}} line should come next. It is optional but strongly suggested:
	:::<code>DEFAULT <value></code>		:::<code>DEFAULT <value></code>
	:::This specifies the value to be used if there is no applicable {{BoldColor\|~~blue~~\|100\|''data''}} line for a given frame.		:::This specifies the value to be used if there is no applicable {{BoldColor\|#4F81BD\|100\|''data''}} line for a given frame.
	:::If you do not define a default, be sure to specify a value for all frames; otherwise your script variable could be be [[Internal functions/Defined\|undefined]] or take a random value.		:::If you do not define a default, be sure to specify a value for all frames; otherwise your script variable could be be [[Internal functions/Defined\|undefined]] or take a random value.

	*An optional {{BoldColor\|~~blue~~\|100\|''offset''}} line may appear:		*An optional {{BoldColor\|#4F81BD\|100\|''offset''}} line may appear:
	:::<code>OFFSET <integer-value></code> (from v2.60)		:::<code>OFFSET <integer-value></code> (from v2.60)
	:::When specified, this will add an offset adjustment to all frame numbers in the {{BoldColor\|~~blue~~\|100\|''data''}} lines below.		:::When specified, this will add an offset adjustment to all frame numbers in the {{BoldColor\|#4F81BD\|100\|''data''}} lines below.

	*Next come the {{BoldColor\|~~blue~~\|100\|''data''}} line(s), which set the per-frame value(s) to be assigned to the script variable. There are three styles:		*Next come the {{BoldColor\|#4F81BD\|100\|''data''}} line(s), which set the per-frame value(s) to be assigned to the script variable. There are three styles:

	::''Single-frame'' style:		::''Single-frame'' style:
Line 75:		Line 79:

	:Later data lines in the file overrule earlier ones. Styles may be mixed-and-matched; see the examples below.		:Later data lines in the file overrule earlier ones. Styles may be mixed-and-matched; see the examples below.
	:All {{BoldColor\|~~blue~~\|100\|''data''}} and {{BoldColor\|~~blue~~\|100\|''default''}} ''values'' must be valid for the defined {{BoldColor\|~~blue~~\|100\|''type''}}, as defined above, or an error will be raised.		:All {{BoldColor\|#4F81BD\|100\|''data''}} and {{BoldColor\|#4F81BD\|100\|''default''}} ''values'' must be valid for the defined {{BoldColor\|#4F81BD\|100\|''type''}}, as defined above, or an error will be raised.
	</div>		</div>

Raffriff42: one more touch-up

2016-02-25T14:03:19Z

one more touch-up

Show changes

Raffriff42: formatting, links, phrasing

2016-02-24T14:07:11Z

formatting, links, phrasing

Show changes

Raffriff42: added category

2015-11-08T15:46:55Z

added category

← Older revision		Revision as of 17:46, 8 November 2015
Line 228:		Line 228:

	[[Category:Internal filters]]		[[Category:Internal filters]]
			[[Category:Meta_filters]]
			[[Category:Runtime_filters]]

Raffriff42: touchup

2014-09-28T19:24:08Z

touchup

← Older revision		Revision as of 21:24, 28 September 2014
Line 80:		Line 80:

	''' White space ''' <br>		''' White space ''' <br>
	Leading white space (spaces and tabs) is ignored up the first non-whitespace character, and used ~~as a field separator thereafter~~ to ~~the end of~~ the line.		Leading white space (spaces and tabs) is ignored up the first non-whitespace character, and then it is used to separate elements on the line.

	''' Comments ''' <br>		''' Comments ''' <br>

Raffriff42: touchup

2014-09-28T19:18:48Z

touchup

← Older revision		Revision as of 21:18, 28 September 2014
Line 33:		Line 33:
	input_file:		input_file:
	comment_line* /* asterisk means zero or more */		comment_line* /* asterisk means zero or more */
	WS* 'TYPE' WS ( 'int' \| 'float' \| 'bool' \| 'string' )		WS* 'TYPE' WS ( 'int' \| 'float' \| 'bool' \| 'string' ) /* choose one */
	header		header
	data_line+ /* plus sign means one or more */		data_line+ /* plus sign means one or more */
Line 45:		Line 45:
	header: /* header = zero or more of the following in any order */		header: /* header = zero or more of the following in any order */
	(		(
	WS* 'DEFAULT' WS <type value>		WS* 'DEFAULT' WS <type value> /* legal value for TYPE */
	\| WS* 'OFFSET' WS <int ~~offset value~~>		\| WS* 'OFFSET' WS <int offset_value>
	\| WS*		\| WS*
	\| comment_line		\| comment_line
Line 53:		Line 53:
	data_line: /* data = one or more of the following in any order */		data_line: /* data = one or more of the following in any order */
	(		(
	WS* <int framenumber>		WS* <int framenumber> WS <type value>
	WS+ <type value>		\| WS* 'R' WS <int startframe> WS <int endframe> WS <type value>
	\| WS* 'R' WS <int startframe> WS <int endframe>		\| WS* 'I' WS <int startframe> WS <int endframe> WS <type startvalue> WS <type endvalue>
	WS+ <type value>
	\| WS* 'I' WS <int startframe> WS <int endframe>
	WS+ <type startvalue> WS <type endvalue>
	)		)

Raffriff42: touchup

2014-09-28T16:47:30Z

touchup

← Older revision		Revision as of 18:47, 28 September 2014
Line 32:		Line 32:
	The ConditionalReader input file format can be [[wikipedia:Backus–Naur_Form\|summarized]] as follows; see below for further explanation:		The ConditionalReader input file format can be [[wikipedia:Backus–Naur_Form\|summarized]] as follows; see below for further explanation:
	input_file:		input_file:
	comment_line* ('*~~' =~~ zero or more)		comment_line* /* asterisk means zero or more */
	'TYPE' WS ( 'int' \| 'float' \| 'bool' \| 'string' )		WS* 'TYPE' WS ( 'int' \| 'float' \| 'bool' \| 'string' )
	header		header
	data_line+ ~~('+' =~~ one or more)		data_line+ /* plus sign means one or more */

	comment_line:		comment_line:
	WS* ( '#' \| ';' \| '%' ) <any characters to end of line>		WS* ( '#' \| ';' \| '%' ) <ignore any characters to end of line>

	WS:		WS:
	( ' ' \| '\t' )*		( ' ' \| '\t' )+ /* WS = one or more spaces or tabs */

	header:		header: /* header = zero or more of the following in any order */
	(		(
	'DEFAULT' WS <type value>		WS* 'DEFAULT' WS <type value>
	\| 'OFFSET' WS <int offset value>		\| WS* 'OFFSET' WS <int offset value>
	\| WS*		\| WS*
	\| comment_line		\| comment_line
	)* ~~(zero or more in any order)~~		)*

	data_line:		data_line: /* data = one or more of the following in any order */
	(		(
	WS* <int framenumber>		WS* <int framenumber>
	WS <type value>		WS+ <type value>
	\| 'R' WS <int startframe> WS <int endframe>		\| WS* 'R' WS <int startframe> WS <int endframe>
	WS <type value>		WS+ <type value>
	\| 'I' WS <int startframe> WS <int endframe>		\| WS* 'I' WS <int startframe> WS <int endframe>
	WS <type startvalue> WS <type endvalue>		WS+ <type startvalue> WS <type endvalue>
	)		)


	The file is plain text. All separation is done by spaces, and newline indicates a new data set. It is not case sensitive!		The file is plain text. All separation is done by spaces, and newline indicates a new data set. It is '''not''' case sensitive!

	''' TYPE (int\|float\|bool\|string) ''' <br>		''' TYPE (int \| float \| bool \| string) ''' <br>
	You can only have one type of data in each file. Currently it is possible to have ''float'', ''int'', ''bool'' or (from v2.60) ''string'' values. You specify this by using the '''TYPE''' keyword. You should always start out by specifying the type of data, as nothing is saved until this keyword has been found. It is not possible to change type once it has been set!		You can only have one type of data in each file. Currently it is possible to have ''float'', ''int'', ''bool'' or (from v2.60) ''string'' values. You specify this by using the '''TYPE''' keyword. You should always start out by specifying the type of data, as nothing is saved until this keyword has been found. It is not possible to change type once it has been set!

Raffriff42: input file format - notes

2014-09-28T16:24:41Z

input file format - notes

@@ Line 26: / Line 26: @@
 | When set to true, the value given at this frame will be overlayed on the image.
 | false
-|}
+|}<br>
 == File format ==
 The file is plain text. All separation is done by spaces, and newline indicates a new data set. It is not case sensitive!
@@ Line 49: / Line 81: @@
 ''' I <startframe> <endframe> <startvalue> <stopvalue> ''' <br>
 This will interpolate between two values over a range of frames. This only works on int and float values. You should note that both start AND end-frame are included.
 == Types ==