Filter SDK/InvertNeg - Revision history

Reel.Deal: add Optimization and HDB section

2023-01-29T06:41:03Z

add Optimization and HDB section

← Older revision		Revision as of 08:41, 29 January 2023
Line 309:		Line 309:

	See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)		See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)

			=== Optimization and HDB Support ===

			The [https://forum.doom9.org/showthread.php?t=184726 HBD/Optimization Doom9 thread] (starts at post #11) discusses how to optimize and add high bitdepth support to the InvertNeg filter.

	[[Category:FilterSDK]]		[[Category:FilterSDK]]

Admin: /* A variation as an in place filter */

2016-12-27T21:16:40Z

A variation as an in place filter

← Older revision		Revision as of 23:16, 27 December 2016
Line 243:		Line 243:
	=== A variation as an in place filter ===		=== A variation as an in place filter ===

	The Invert filter could easily do its work in a single buffer, rather than copying from one buffer to another. Here's a new implementation of GetFrame that does this.		The Invert filter could easily do its work in a single buffer, rather than copying from one buffer to another. Here's a new implementation of GetFrame that does this:

	#include <windows.h>		#include <windows.h>

Admin: /* Line by line breakdown */

2016-12-23T15:55:26Z

Line by line breakdown

← Older revision		Revision as of 17:55, 23 December 2016
Line 71:		Line 71:
	=== Line by line breakdown ===		=== Line by line breakdown ===

	Here's a line-by-line breakdown of InvertNeg.cpp.		Here's a line-by-line breakdown of InvertNeg.cpp:

	#include "avisynth.h"		#include "avisynth.h"

Admin: typo

2015-09-06T22:06:06Z

typo

← Older revision		Revision as of 00:06, 7 September 2015
Line 208:		Line 208:
	extern "C" __declspec(dllexport) const char* __stdcall AvisynthPluginInit3(IScriptEnvironment* env, const AVS_Linkage* const vectors) {		extern "C" __declspec(dllexport) const char* __stdcall AvisynthPluginInit3(IScriptEnvironment* env, const AVS_Linkage* const vectors) {

	This is the only function which gets exported from the DLL. It is called by the script function LoadPlugin the first time this plugin in loaded in a particular script. If several scripts are open at once and more than one of them loads this plugin, ~~AvisynthPluginInit2~~ may be called more than once with different IScriptEnvironments. Therefore:		This is the only function which gets exported from the DLL. It is called by the script function LoadPlugin the first time this plugin in loaded in a particular script. If several scripts are open at once and more than one of them loads this plugin, AvisynthPluginInit3 may be called more than once with different IScriptEnvironments. Therefore:

	* You should not save the env parameter in a global variable.		* You should not save the env parameter in a global variable.

Admin at 20:57, 25 August 2015

2015-08-25T20:57:35Z

← Older revision		Revision as of 22:57, 25 August 2015
Line 223:		Line 223:
	As promised, we now call AddFunction to let Avisynth know of the existence of our filter. This function takes four arguments: the name of the new script function; the parameter-type string; the C++ function implementing the script function; and the user_data cookie.		As promised, we now call AddFunction to let Avisynth know of the existence of our filter. This function takes four arguments: the name of the new script function; the parameter-type string; the C++ function implementing the script function; and the user_data cookie.

	The parameter-type string ~~is similar to the corresponding entity in [[VirtualDub]], except that~~:		The parameter-type string can be specified as follows:

	* No return type is given. Function return values are not type-checked; you can return anything you like.		* No return type is given. Function return values are not type-checked; you can return anything you like.
	* ~~There~~ are ~~more types~~: ~~along with '~~i~~'nt and '~~s~~'tring you can specify '~~b~~'ool, 'f'loat, and 'c'lip.~~		* The following types are available:
			** c - clip
			** i - integer
			** f - float
			** s - string
			** b - boolean
	* You can follow any type with '*' or '+' to indicate "zero or more" or "one or more" respectively. In this case all the matching arguments will be gathered into a sub-array.		* You can follow any type with '*' or '+' to indicate "zero or more" or "one or more" respectively. In this case all the matching arguments will be gathered into a sub-array.
	:: For example, if your type string is "is+f", then the integer argument will be args[0], the string arguments will be args[1][0], args[1][1], etc. (and there will be args[1].ArraySize() of them), and the float argument will be args[2].		: For example, if your type string is "is+f", then the integer argument will be args[0], the string arguments will be args[1][0], args[1][1], etc. (and there will be args[1].ArraySize() of them), and the float argument will be args[2].
	* '.' matches a single argument of any type. To match multiple arguments of any type, use ".*" or ".+".		* '.' matches a single argument of any type. To match multiple arguments of any type, use ".*" or ".+".
	* You can have named arguments, by specifying the name in [brackets] before the type. Named arguments are also optional arguments; if the user omits them, they will be of the undefined type instead of the type you specify. For convenience, AVSValue offers a set of As...() functions which take default values. See avisynth.h.		* You can have named arguments, by specifying the name in [brackets] before the type. Named arguments are also optional arguments; if the user omits them, they will be of the undefined type instead of the type you specify. For convenience, AVSValue offers a set of As...() functions which take default values. See avisynth.h.
Line 234:		Line 239:
	return "InvertNeg sample plugin";		return "InvertNeg sample plugin";

	The return value of ~~AvisynthPluginInit~~ is a string which can contain any message you like, such as a notice identifying the version and author of the plugin. This string becomes the return value of LoadPlugin, and will almost always be ignored. You can also just return 0 if you prefer.		The return value of AvisynthPluginInit3 is a string which can contain any message you like, such as a notice identifying the version and author of the plugin. This string becomes the return value of LoadPlugin, and will almost always be ignored. You can also just return 0 if you prefer.

	=== A variation as an in place filter ===		=== A variation as an in place filter ===

Admin at 20:47, 6 October 2014

2014-10-06T20:47:29Z

← Older revision		Revision as of 22:47, 6 October 2014
Line 101:		Line 101:
	PVideoFrame InvertNeg::GetFrame(int n, IScriptEnvironment* env) {		PVideoFrame InvertNeg::GetFrame(int n, IScriptEnvironment* env) {

	This method is called to make our filter produce frame n of its output. The second argument, env, is for our purposes simply a callback suite. It is actually implemented in Avisynth by a class called ScriptEnvironment. One [[Cplusplus_API#IScriptEnvironment\|instance of this class]] is created for each opened AVS script, so there may sometimes be several instances active at once. It is important that the callback functions be called through the proper instance. A particular instance of your class will only be used in one ScriptEnvironment, but different instances might be used in different ScriptEnvironments.		This method is called to make our filter produce frame n of its output. The second argument, env, is for our purposes simply a callback suite. It is actually implemented in Avisynth by a class called ScriptEnvironment. One [[Filter_SDK/Cplusplus_API#IScriptEnvironment\|instance of this class]] is created for each opened AVS script, so there may sometimes be several instances active at once. It is important that the callback functions be called through the proper instance. A particular instance of your class will only be used in one ScriptEnvironment, but different instances might be used in different ScriptEnvironments.

	InvertNeg::InvertNeg(PClip _child, IScriptEnvironment* env) :		InvertNeg::InvertNeg(PClip _child, IScriptEnvironment* env) :
Line 297:		Line 297:
	}		}

	The key difference between this version of the function and the original version is the presence of the [[Cplusplus_API#MakeWritable\|MakeWritable]] callback. This is necessary because this time "we don't know where that source frame has been." Someone else in the filter chain may be holding a reference to it, in which case we won't be allowed to write to it.		The key difference between this version of the function and the original version is the presence of the [[Filter_SDK/Cplusplus_API#MakeWritable\|MakeWritable]] callback. This is necessary because this time "we don't know where that source frame has been." Someone else in the filter chain may be holding a reference to it, in which case we won't be allowed to write to it.

	=== Old versions ===		=== Old versions ===

Admin at 20:33, 6 October 2014

2014-10-06T20:33:18Z

Raffriff42: Filter_SDK -> FilterSDK

2014-09-19T04:39:00Z

Filter_SDK -> FilterSDK

← Older revision		Revision as of 06:39, 19 September 2014
Line 305:		Line 305:
	See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)		See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)

	[[Category:~~Filter_SDK~~]]		[[Category:FilterSDK]]

Raffriff42: Category:Filter_SDK

2014-09-19T03:53:22Z

Category:Filter_SDK

← Older revision		Revision as of 05:53, 19 September 2014
Line 304:		Line 304:

	See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)		See more about the modifications for AviSynth 2.5 in the [[Filter_SDK/Two-Five_SDK\|AviSynth Two-Five SDK]]. (need to adjust the two-five version using the code above ...)

			[[Category:Filter_SDK]]

Admin at 15:36, 3 January 2014

2014-01-03T15:36:07Z

← Older revision		Revision as of 17:36, 3 January 2014
Line 204:		Line 204:
	const AVS_Linkage *AVS_linkage = 0;		const AVS_Linkage *AVS_linkage = 0;

	This declares and initializes the server pointers static storage [[AVS_Linkage]].		This declares and initializes the server pointers static storage [[Filter_SDK/AVS_Linkage\|AVS_Linkage]].

	extern "C" __declspec(dllexport) const char* __stdcall AvisynthPluginInit3(IScriptEnvironment* env, const AVS_Linkage* const vectors) {		extern "C" __declspec(dllexport) const char* __stdcall AvisynthPluginInit3(IScriptEnvironment* env, const AVS_Linkage* const vectors) {

← Older revision		Revision as of 22:33, 6 October 2014
Line 81:		Line 81:
	class InvertNeg : public GenericVideoFilter {		class InvertNeg : public GenericVideoFilter {

	An Avisynth filter is simply a C++ class implementing the [[Cplusplus_API#IClip\|IClip]] interface. More about classes can be found in this [http://www.cplusplus.com/doc/tutorial/classes tutorial]. IClip has four pure virtual methods: [[Cplusplus_API#GetVideoInfo\|GetVideoInfo]], [[Cplusplus_API#GetFrame\|GetFrame]], [[Cplusplus_API#GetParity\|GetParity]], and [[Cplusplus_API#GetAudio\|GetAudio]].		An Avisynth filter is simply a C++ class implementing the [[Filter_SDK/Cplusplus_API#IClip\|IClip]] interface. More about classes can be found in this [http://www.cplusplus.com/doc/tutorial/classes tutorial]. IClip has four pure virtual methods: [[Filter_SDK/Cplusplus_API#GetVideoInfo\|GetVideoInfo]], [[Filter_SDK/Cplusplus_API#GetFrame\|GetFrame]], [[Filter_SDK/Cplusplus_API#GetParity\|GetParity]], and [[Filter_SDK/Cplusplus_API#GetAudio\|GetAudio]].

	The class GenericVideoFilter is a simple do-nothing filter defined in avisynth.h. It derives from IClip and implements all four methods. Most filters can inherit from GenericVideoFilter rather than directly from IClip; this saves you from having to implement methods that you don't care about, like GetAudio in this example. More about inheritance can be found in this [http://www.cplusplus.com/doc/tutorial/inheritance tutorial]. In our case two functions are defined in the class: the constructor (InvertNeg()) and GetFrame.		The class GenericVideoFilter is a simple do-nothing filter defined in avisynth.h. It derives from IClip and implements all four methods. Most filters can inherit from GenericVideoFilter rather than directly from IClip; this saves you from having to implement methods that you don't care about, like GetAudio in this example. More about inheritance can be found in this [http://www.cplusplus.com/doc/tutorial/inheritance tutorial]. In our case two functions are defined in the class: the constructor (InvertNeg()) and GetFrame.
Line 112:		Line 112:
	}		}

	"vi" is a protected member of GenericVideoFilter. It is a structure of type [[Cplusplus_API/VideoInfo\|VideoInfo]], and it contains information about the clip (like frame size, frame rate, pixel format, audio sample rate, etc.). In our example, when the image format of the clip is not planar or the colorspace of the clip is not YUV, an error is returned using [[Cplusplus_API#ThrowError\|ThrowError]]. As of writing this document there is no planar RGB, but that might very well change in the future.		"vi" is a protected member of GenericVideoFilter. It is a structure of type [[Filter_SDK/Cplusplus_API/VideoInfo\|VideoInfo]], and it contains information about the clip (like frame size, frame rate, pixel format, audio sample rate, etc.). In our example, when the image format of the clip is not planar or the colorspace of the clip is not YUV, an error is returned using [[Cplusplus_API#ThrowError\|ThrowError]]. As of writing this document there is no planar RGB, but that might very well change in the future.

	PVideoFrame src = child->GetFrame(n, env);		PVideoFrame src = child->GetFrame(n, env);
Line 151:		Line 151:
	Any buffer you get from NewVideoFrame is guaranteed to be writable (as long as you only assign it to one PVideoFrame!). Our filter's dst came from NewVideoFrame, so we can safely call dst->GetWritePtr(). However, frames you get from other clips via GetFrame may not be writable, in which case GetWritePtr() will return a null pointer.		Any buffer you get from NewVideoFrame is guaranteed to be writable (as long as you only assign it to one PVideoFrame!). Our filter's dst came from NewVideoFrame, so we can safely call dst->GetWritePtr(). However, frames you get from other clips via GetFrame may not be writable, in which case GetWritePtr() will return a null pointer.

	There is an [[Cplusplus_API#IsWritable\|IsWritable]]() method which you can call to find out if a buffer is writable or not, and there's a [[Cplusplus_API#MakeWritable\|MakeWritable]] callback to ensure that it is.		There is an [[Filter_SDK/Cplusplus_API#IsWritable\|IsWritable]]() method which you can call to find out if a buffer is writable or not, and there's a [[Filter_SDK/Cplusplus_API#MakeWritable\|MakeWritable]] callback to ensure that it is.

	src_pitch = src->GetPitch(planes[p]);		src_pitch = src->GetPitch(planes[p]);
Line 192:		Line 192:
	AVSValue is a variant type which can hold any one of the following: a boolean value (true/false); an integer; a floating-point number; a string; a video clip (PClip); an array of AVSValues; or nothing ("undefined"). You can test which one it is with the methods IsBool(), IsInt(), IsFloat(), IsString(), IsClip(), IsArray(), and Defined() (which returns true if the AVSValue is not "undefined"). You can get the value with AsBool(), AsInt(), etc. For arrays, you can use the ArraySize() method to get the number of elements, and [] indexing to get the elements themselves. For convenience, IsFloat() and AsFloat() will work with integers also. But boolean values are not treated as numeric (unlike C).		AVSValue is a variant type which can hold any one of the following: a boolean value (true/false); an integer; a floating-point number; a string; a video clip (PClip); an array of AVSValues; or nothing ("undefined"). You can test which one it is with the methods IsBool(), IsInt(), IsFloat(), IsString(), IsClip(), IsArray(), and Defined() (which returns true if the AVSValue is not "undefined"). You can get the value with AsBool(), AsInt(), etc. For arrays, you can use the ArraySize() method to get the number of elements, and [] indexing to get the elements themselves. For convenience, IsFloat() and AsFloat() will work with integers also. But boolean values are not treated as numeric (unlike C).

	The name "Create_InvertNeg" is arbitrary. This function will actually be known as "InvertNeg" in scripts, because that's the name we pass to [[Cplusplus_API#AddFunction\|AddFunction]] below.		The name "Create_InvertNeg" is arbitrary. This function will actually be known as "InvertNeg" in scripts, because that's the name we pass to [[Filter_SDK/Cplusplus_API#AddFunction\|AddFunction]] below.

	return new InvertNeg(args[0].AsClip(), env);		return new InvertNeg(args[0].AsClip(), env);