Internal functions - Revision history

Reel.Deal: add Array functions for AviSynth+

2021-12-10T08:50:42Z

add Array functions for AviSynth+

@@ Line 2,082: / Line 2,082: @@
   isAtLeast3_5_1 = IsVersionOrGreater(3,5,1)
 </div>
 </div>

Pinterf: /* Property get */ propGet for Clip value type

2021-12-09T10:04:20Z

Property get: propGet for Clip value type

← Older revision		Revision as of 12:04, 9 December 2021
Line 1,403:		Line 1,403:
	: A frame property can hold multiple values of the same type: it can be an array		: A frame property can hold multiple values of the same type: it can be an array
	: propGetAsArray returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)		: propGetAsArray returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)

			{{ScriptFunctionH5\|propGetClip\|{{AvsPluscon}}\|propGetClip(clip, string key_name[, integer "index", integer "offset"])}}
			: returns only if value is clip, throws an error otherwise (since 3.7.1)

	{{ScriptFunctionH5\|propGetAll\|{{AvsPluscon}}\|propGetAll(clip [, integer "offset"])}}		{{ScriptFunctionH5\|propGetAll\|{{AvsPluscon}}\|propGetAll(clip [, integer "offset"])}}

Pinterf: /* Property set */ propSet for Clip value type

2021-12-09T10:01:33Z

Property set: propSet for Clip value type

← Older revision		Revision as of 12:01, 9 December 2021
Line 1,358:		Line 1,358:
	::*clip c,		::*clip c,
	::*string key_name,		::*string key_name,
	::*direct value of supported ~~basic~~ types or a "function object"		::*direct value of supported types (integer, float, string, array, clip) or a "function object"
	::*int "mode": 0=replace (default), 1=append, 2=touch. There is no append mode for inserting a full array into the property.		::*int "mode": 0=replace (default), 1=append, 2=touch. There is no append mode for inserting a full array into the property.

Line 1,368:		Line 1,368:
	{{ScriptFunctionH5\|propSet\|{{AvsPluscon}}\|propSet(clip, string key_name, string value [, integer "mode"])}}		{{ScriptFunctionH5\|propSet\|{{AvsPluscon}}\|propSet(clip, string key_name, string value [, integer "mode"])}}
	{{ScriptFunctionH5\|propSet\|{{AvsPluscon}}\|propSet(clip, string key_name, array value)}}		{{ScriptFunctionH5\|propSet\|{{AvsPluscon}}\|propSet(clip, string key_name, array value)}}
			{{ScriptFunctionH5\|propSet\|{{AvsPluscon}}\|propSet(clip, string key_name, clip value [, integer "mode"])}}

	: The above four functions are setting a property by a directly passed values		: The above four functions are setting a property by a directly passed values
Line 1,376:		Line 1,377:
	{{ScriptFunctionH5\|propSetString\|{{AvsPluscon}}\|propSetString(clip, string key_name, function func_obj [, integer "mode"])}}		{{ScriptFunctionH5\|propSetString\|{{AvsPluscon}}\|propSetString(clip, string key_name, function func_obj [, integer "mode"])}}
	{{ScriptFunctionH5\|propSetArray\|{{AvsPluscon}}\|propSetArray(clip, string key_name, function func_obj [, integer "mode"])}}		{{ScriptFunctionH5\|propSetArray\|{{AvsPluscon}}\|propSetArray(clip, string key_name, function func_obj [, integer "mode"])}}
			{{ScriptFunctionH5\|propSetClip\|{{AvsPluscon}}\|propSetClip(clip, string key_name, function func_obj [, integer "mode"])}}
	: these setters accept only the specific type		: these setters accept only the specific type

Reel.Deal: /* Other property functions */ add avs version to propCopy

2021-10-25T20:04:20Z

Other property functions: add avs version to propCopy

← Older revision		Revision as of 22:04, 25 October 2021
Line 1,597:		Line 1,597:
	: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)		: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)

	{{ScriptFunctionH5\|propGetType\|{{AvsPluscon}}(v3.7\|propGetType(clip, string key_name [, integer "offset"])}}		{{ScriptFunctionH5\|propGetType\|{{AvsPluscon}}(v3.7.0)\|propGetType(clip, string key_name [, integer "offset"])}}
	: returns the type of the given key		: returns the type of the given key
	::*unset: 0		::*unset: 0
Line 1,606:		Line 1,606:
	::*frame: 5		::*frame: 5

	{{ScriptFunctionH5\|propCopy\|{{AvsPluscon}}\|propCopy(clip, clip [,bool "merge"])}}		{{ScriptFunctionH5\|propCopy\|{{AvsPluscon}}(v3.7.1)\|propCopy(clip, clip [,bool "merge"])}}
	: Copies the frame properties of the second clip to the first.		: Copies the frame properties of the second clip to the first.
	::*Parameter 'merge' (default false):		::*Parameter 'merge' (default false):

Reel.Deal: /* Property get */ add note: propGetXXX functions can now be called as normal functions, outside runtime. (AviSynth v3.7.1)

2021-10-25T20:02:29Z

Property get: add note: propGetXXX functions can now be called as normal functions, outside runtime. (AviSynth v3.7.1)

@@ Line 1,538: / Line 1,538: @@
      return last
    })
 </div>

Reel.Deal: /* Other property functions */ add propCopy

2021-10-25T19:52:32Z

Other property functions: add propCopy

← Older revision		Revision as of 21:52, 25 October 2021
Line 1,578:		Line 1,578:
	: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)		: returns the key name for the Nth property (zero based, 0<=index<propNumKeys)

	{{ScriptFunctionH5\|propGetType\|{{AvsPluscon}}\|propGetType(clip, string key_name [, integer "offset"])}}		{{ScriptFunctionH5\|propGetType\|{{AvsPluscon}}(v3.7\|propGetType(clip, string key_name [, integer "offset"])}}
	: returns the type of the given key		: returns the type of the given key
	::*unset: 0		::*unset: 0
Line 1,586:		Line 1,586:
	::*clip: 4		::*clip: 4
	::*frame: 5		::*frame: 5

			{{ScriptFunctionH5\|propCopy\|{{AvsPluscon}}\|propCopy(clip, clip [,bool "merge"])}}
			: Copies the frame properties of the second clip to the first.
			::*Parameter 'merge' (default false):
			:::*when false: exact copy (original target properties will be lost)
			:::*when true: keeps original properties, appends all parameters from source but overwrite if a parameter with the same name already exists.

	== Script functions ==		== Script functions ==

Pinterf: /* Property get */ propGetAll fix

2021-03-26T15:52:09Z

Property get: propGetAll fix

← Older revision		Revision as of 17:52, 26 March 2021
Line 1,399:		Line 1,399:

	{{ScriptFunctionH5\|propGetAsArray\|{{AvsPluscon}}\|propGetAsArray(clip, string key_name[, integer "index", integer "offset"])}}		{{ScriptFunctionH5\|propGetAsArray\|{{AvsPluscon}}\|propGetAsArray(clip, string key_name[, integer "index", integer "offset"])}}
	: returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)		: A frame property can hold multiple values of the same type: it can be an array
			: propGetAsArray returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)

	{{ScriptFunctionH5\|propGetAll\|{{AvsPluscon}}\|~~propGetAsArray~~(clip [, integer "offset"])}}		{{ScriptFunctionH5\|propGetAll\|{{AvsPluscon}}\|propGetAll(clip [, integer "offset"])}}
	~~: returns an array. For a single property array size will be 1. (only in array-aware AviSynth+ versions)~~
	: Returns all frame properties in an array of [key-value] pairs. Array size will be 'numProps'		: Returns all frame properties in an array of [key-value] pairs. Array size will be 'numProps'
	: Each key-value pair is contained in a two dimensional subarray.		: Each key-value pair is contained in a two dimensional subarray.

Pinterf: /* Global Options */ SetMemoryMax avs+ with device syntax

2021-02-10T16:56:52Z

Global Options: SetMemoryMax avs+ with device syntax

← Older revision		Revision as of 18:56, 10 February 2021
Line 394:		Line 394:
	: Sets the maximum memory that AviSynth uses (in MB) to the value of {{FuncArg\|amount}}. Setting 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.		: Sets the maximum memory that AviSynth uses (in MB) to the value of {{FuncArg\|amount}}. Setting 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.
	: The default Memory Max is also limited to 512MB.		: The default Memory Max is also limited to 512MB.
	: In Avisynth+ this limit for default Memory Max is 1024MB for 32 bits and 4096MB on the x64 version		: {{AvsPluscon}}In Avisynth+ this limit for default Memory Max is 1024MB for 32 bits and 4096MB on the x64 version
	: DefaultMemoryMax = minimum(physical_memory / 4, secondary_memory_max_limit)		: DefaultMemoryMax = minimum(physical_memory / 4, secondary_memory_max_limit)
	: for classic Avisynth see the table below		: for classic Avisynth see the table below
Line 423:		Line 423:
	SetMemoryMax(128)		SetMemoryMax(128)
	</div>		</div>

			:{{AvsPluscon}}{{FuncDef\|SetMemoryMax(int, int “type”, int “index”)}}
			:With additional arguments for devices such as GPUs. Memory usage is managed individually for devices such as GPUs.
			<br>
			::{{Par2\|\|int\|}}
			:::Device (including CPU) memory limit (MB)
			::{{Par2\|type\|int\|}}
			:::Device type. The following values are available:
			::::DEV_TYPE_CPU: CPU (default)
			::::DEV_TYPE_CUDA: GPU
			::{{Par2\|index\|int\|}}
			:::Device number. Same as onCUDA device_index. Only 0 for DEV_TYPE_CPU.
			:::Default value: 0



	<div style="max-width:62em" >		<div style="max-width:62em" >

Pinterf: /* Other property functions */ edit propShow

2020-12-12T14:05:12Z

Other property functions: edit propShow

← Older revision		Revision as of 16:05, 12 December 2020
Line 1,544:		Line 1,544:
	==== Other property functions ====		==== Other property functions ====
	{{ScriptFunctionH5\|propShow\|{{AvsPluscon}}\|propShow(clip, integer "size", bool "showtype")}}		{{ScriptFunctionH5\|propShow\|{{AvsPluscon}}\|propShow(clip, integer "size", bool "showtype")}}
	: ~~The filter is not a runtime function but is shown here.~~ This debug filter lists all frame properties on screen.		: This debug filter lists all frame properties on screen.
	: Listing appears as a name = value list. Arrays values are ~~put~~ between [ and ]		: Listing appears as a name = value list. Arrays values are displayed between [ and ]
	: Top line contains the number of properties. If no properties found, nothing is displayed.		: Top line contains the number of properties. If no properties found, nothing is displayed.
	:* {{FuncArg\|clip}} (required) specifies clip.		:* {{FuncArg\|clip}} (required) specifies clip.

Pinterf: /* Functions for frame properties */ update, extend

2020-12-12T14:03:33Z

Functions for frame properties: update, extend

← Older revision		Revision as of 16:03, 12 December 2020
Line 1,248:		Line 1,248:
	== Functions for frame properties ==		== Functions for frame properties ==
	<div style="max-width:62em" >		<div style="max-width:62em" >
	: Core and concept ported from VapourSynth		: Core and concept ported from VapourSynth.
	: Frame properties are per-frame data ~~which can only be read and written within runtime functions. e.g~~. Source or other filters can ~~feed~~ useful data into frame properties such as information on colorimetry.		: Frame properties are per-frame data. Source or other filters can store useful data into frame properties such as information on colorimetry.
	: Imagine them as an array of zero or more elements of PropertyName=Value		: Imagine them as an array of zero or more elements of PropertyName=Value
	<br>		: Reading them is possible only by runtime functions.
	: At the moment (v3.6.~~2test4~~) Avisynth+ only ~~provides~~ the necessary framework for handling such properties. None of its internal functions (such as color space converters) set or work upon frame property values.		: <br>
	: There are already filters (like avsresize) and source plugins that are already using frame properties, Avisynth+ core will ~~use them i~~ the future as well.		: Note:
	<br>		: At the moment (v3.6.2test7) Avisynth+ provides only the necessary framework for handling (set, read, clear, pass) such properties. None of its internal functions (such as color space converters) set or work upon frame property values.
	: Frame property getter ~~and setter~~ functions are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ScriptClip]]). ~~They~~ are allowed in [[FrameEvaluate]] but since it does not return an altered frame, writing a frame property there has zero effect.		: There are already filters (like avsresize) and source plugins that are already using frame properties. Avisynth+ core will rely on frame in the future as well.
	:* frame properties are key-value~~(s)~~ pairs		: <br>
			: Developer info:
			: On filter level the set of frame properties should be copied from a previous (or specific) input frame. When filter is using env->MakeWritable in its GetFrame method this happens automatically.
			: But a simple env->NewVideoFrame means a dead-end for frame property passing mechanism. So filter must either use env->NewVideoFrameP which has an additional parameter: a source frame of the frame properties.
			: Or frame properties have to be copied later, programatically by the copyFrameProps ScriptEnvironment function.
			: For compatibility reasons NewVideoFrameP should be called adaptively instead of the traditional NewVideoFrame: usable after detecting Avisynth interface version 8 (NewVideoFrameP was introduced in v8).
			: What happens if this copy is not done properly? Then the filter is a dead-end for frame properties since NewVideoFrame constructs new frame with no frame properties. All old filters will behave like this.<br>
			: <br>
			: Frame property getter functions are evaluated at every frame. They can be used inside the scripts passed to runtime filters ([[ScriptClip]]).<br>
			: Frame property setters can be called both at script level and in runtime. When a property is set on script level it will be constant along the lifetime of the whole clip, unless it is changed in runtime, inside ScriptClip.
			: Though using property setter functions are allowed in [[FrameEvaluate]] but since it does not return an altered frame, writing a frame property there has zero effect.<br>
			: <br>
			:* frame properties are stored as key-value pairs
	:** Key is an alphanumeric identifier.		:** Key is an alphanumeric identifier.
	:** Values can be of single value or array of type		:** Values can be of single value or array of type
	:*** 64 bit ~~integers~~ (32 bit integer when converted to AVSValue inside Avisynth+, AVSValue limitation)		:*** 64 bit integer (32 bit integer when converted to AVSValue inside Avisynth+, AVSValue limitation)
	:*** 64 bit ~~doubles~~ (32 bit float when converted to AVSValue inside Avisynth+, AVSValue limitation)		:*** 64 bit double (32 bit float when converted to AVSValue inside Avisynth+, AVSValue limitation)
	:*** ~~strings~~ (or data) with given length. ~~strings~~ are null terminated		:*** string (or byte data) with given length. Strings are null terminated.
	:*** frame ~~references~~ (PVideoFrame)		:*** frame reference (PVideoFrame)
	:*** clip ~~references~~ (PClip)		:*** clip reference (PClip)
	:* property setting has 3 modes: 0-replace 1-append 2-touch (see AVSPropAppendMode in avisynth.h)::		:* property setting has 3 modes: 0-replace 1-append 2-touch (see AVSPropAppendMode in avisynth.h)::
	:** 0 - single value for that key is replaced		:** 0 - single value for that key is replaced