Plugins

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
(some reformatting)
(formatting, links, phrasing)
Line 1: Line 1:
== Commands for Loading Plugins ==
+
<div style="max-width:62em" >
With these functions you can add external filters to AviSynth.
+
With these functions you can add external filters (DLLs) to the AviSynth script environment.
 
+
__TOC__
  
 
===LoadPlugin===
 
===LoadPlugin===
Loads one or more external AviSynth plugins (DLLs).
+
Loads one or more standard (C++) AviSynth plugins.
 +
<div {{BoxWidthIndent|38|1}} >
 +
LoadPlugin ("filename" [, ...])
 +
</div>
 +
*{{FuncArg|filename}} is the path of the '''.DLL''' file(s).  
  
LoadPlugin ("filename" [, ...])
 
  
 
===LoadCPlugin===
 
===LoadCPlugin===
Loads so called AviSynth C-plugins (DLLs). C-plugins are created on pure C language and use special "AviSynth C API" (unlike ordinary Avisynth plugins which are created with MS C++). C-plugins must be loaded with LoadCPlugin() or Load_Stdcall_Plugin(). Please note that Load_Stdcall_Plugin() is an alias for LoadCPlugin().  
+
Loads so-called AviSynth ''C-plugins''. C-plugins are created in pure C (unlike ordinary Avisynth plugins which are created with MS C++), use a special ''C API'', and must be loaded with '''LoadCPlugin'''.  
 
+
<div {{BoxWidthIndent|38|1}} >
 
  LoadCPlugin ("filename" [, ...])
 
  LoadCPlugin ("filename" [, ...])
 
  Load_Stdcall_Plugin ("filename" [, ...])
 
  Load_Stdcall_Plugin ("filename" [, ...])
 +
</div>
 +
*{{FuncArg|filename}} is the path of the '''.DLL''' file(s).
 +
*The plugin's documentation should advise you if '''LoadCPlugin''' is needed.<br>
 +
*'''Load_Stdcall_Plugin''' is merely an ''alias'' or alternate name.
  
Kevin provides a LoadCPlugin.dll that overloads the LoadCPlugin() verb to support plugins compiled using the C subroutine calling sequence, use Load_Stdcall_Plugin() to load stdcall calling sequence plugins when using Kevins version. Advice: keep these plugins outside your auto plugin loading directory to prevent crashes. ([http://forum.doom9.org/showthread.php?s=&threadid=58840 Doom9 discussion]), ([http://kevin.atkinson.dhs.org/avisynth_c/ AVISynth C API by Kevin A.)]
 
  
 
===LoadVirtualDubPlugin ===
 
===LoadVirtualDubPlugin ===
 
+
Loads a plugin written for [[VirtualDub]]. These are distributed as special DLLs with the file extension '''.VDF'''.  
This loads a plugin written for [[VirtualDub]]. "filename" is the name of the .vdf file. After calling this function, the filter will be known as "filtername" in AviSynth. VirtualDub filters only supports [[RGB32]]. If the video happens to be in RGB24-format, then you must use [[ConvertToRGB32]] ([[ConvertToRGB]] won't suffice).
+
<div {{BoxWidthIndent|38|1}} >
 
+
 
  LoadVirtualDubPlugin ("filename", "filtername", preroll)
 
  LoadVirtualDubPlugin ("filename", "filtername", preroll)
 +
</div>
 +
*{{FuncArg|filename}} is the path of the '''.VDF''' file.
 +
*{{FuncArg|filtername}} is the name given to the plugin function after loading in AviSynth.
 +
*Some filters' output depends on previous frames; for these, {{FuncArg|preroll}} should be set to a suitable number.
 +
*VirtualDub filters support only [[RGB32]].
 +
*Usage example ([http://trevlac.us/colorCorrection/ ColorTools]) &ndash; see [http://forum.doom9.org/showthread.php?t=72634 '''here'''] (doom9).
 +
*See [[FAQ_using_virtualdub_plugins|FAQ using Virtualdub plugins]] for more information.
  
Some filters output depends on previous frames; for those preroll should be set to at least the number of frames the filter needs to pre-process to fill its buffers and/or updates its internal variables.
 
  
 
===LoadVFAPIPlugin===
 
===LoadVFAPIPlugin===
This allows you to use VFAPI plugins (TMPGEnc import plugins).
+
Loads [[Vfapi|VFAPI]] plugins (''eg'', [[TMPGEnc]] import plugins).
 
+
<div {{BoxWidthIndent|38|1}} >
 
  LoadVFAPIPlugin ("filename", "filtername")
 
  LoadVFAPIPlugin ("filename", "filtername")
 +
</div>
 +
*{{FuncArg|filename}} is the path of the '''.DLL''' file.
 +
*{{FuncArg|filtername}} is the name given to the plugin function after loading in AviSynth.
 +
*The plugin's documentation should advise you if '''LoadVFAPIPlugin''' is needed.
 +
</div>
  
  
 +
=== Plugin Autoload and Name Precedence ===
 +
<div style="max-width:62em" >
 +
It is possible to put all plugins and script files with [[User_defined_script_functions|user-defined functions]] or (global) [[Script_variables|variables]] in an ''autoload directory'', from which all files with the extension '''.AVSI''' and '''.DLL''' are loaded [[The_script_execution_model/Sequence_of_events|at startup]], then unloaded and reloaded dynamically as the script needs them.
  
== Plugin Autoload and Name Precedence v2 ==
+
'''.AVSI''' scripts in this directory should only contain function definitions and global variables; they should not have a main processing section (else strange errors may occur). It also is not recommended to put other files in that directory.
  
It is possible to put all plugins and script files with [[User_defined_script_functions|user-defined functions]] or (global) [[Script_variables|variables]] in a directory from where all files with the extension .AVSI (v2.08, v2.5, the type was .AVS in v2.05-2.07) and .DLL are loaded at startup, unloaded and then loaded dynamically as the script needs them.
+
The directory is stored in the registry. You can use double-clicking a .REG-file with the following lines to set the path (of course inserting your actual path):
 
+
<div {{BoxWidthIndent|38|1}} >
.AVSI scripts in this directory should only contain function definitions and global variables, no main processing section (else strange errors may occur), it also is not recommended to put other files in that directory.
+
 
+
The directory is stored in the registry (the registry key has changed for v2.5). You can use double-clicking a .REG-file with the following lines to set the path (of course inserting your actual path):
+
+
 
  REGEDIT4
 
  REGEDIT4
 
   
 
   
 
  [HKEY_LOCAL_MACHINE\SOFTWARE\Avisynth]
 
  [HKEY_LOCAL_MACHINE\SOFTWARE\Avisynth]
 
  "plugindir2_5"="c:\\program files\\avisynth 2.5\\plugins"
 
  "plugindir2_5"="c:\\program files\\avisynth 2.5\\plugins"
 
+
</div>
 
The order in which function names take precedence is as follows:
 
The order in which function names take precedence is as follows:
  
# user-defined function (always have the highest priority)
+
# User-defined function (always have the highest priority)
# plugin-function (higher priority than built-in, will override a built-in function)
+
# Plugin (external) function (higher priority than built-in)
# built-in function
+
# Built-in (internal) function
  
Inside those groups the function loaded at last takes precedence; there is no error in a namespace conflict.
+
Inside those groups the function loaded ''last'' takes precedence; there is no error in a namespace conflict.<br>
 +
It follows that there is no harm in loading the same plugin more than once.{{Dubious|Talk:Plugins#Loading_same_plugin_more_than_once}}
 +
</div>
  
 +
=== Plugin Autoload and Conflicting Function Names ===
 +
<div style="max-width:62em" >
 +
A problem that may arise when multiple plugins have functions with the same name. You won't know which function will be called in your script, as this will depend on loading order. To call a particular function in this situation, AviSynth's <tt>DLLName_function()</tt> feature automatically creates ''prefix aliases''; so for example, '''foo.dll''''s <tt>bar()</tt> function may be called as <tt>foo_bar()</tt>. This works both for auto-loaded plugins and for plugins loaded with [[LoadPlugin]].
  
== Plugin Autoload and Conflicting Function Names v2.55 ==
+
Suppose you have the plugins '''mpeg2dec.dll''' and '''mpeg2dec3.dll''' in your autoload directory;<br>
 
+
if you want to load a '''.d2v''' file with '''mpeg2dec.dll''' (which outputs [[YUY2]]):
Starting from v2.55 there is DLLName_function() support. The problem is that two plugins can have different functions which are named the same. To call the needed one, DLLName_function() support is added. It auto-generates the additional names both for auto-loaded plugins and for plugins loaded with LoadPlugin.
+
<div {{BoxWidthIndent|38|1}} >
 
+
  # using mpeg2source from [[External_plugins_old#Source_Filters|mpeg2dec.dll]]
'''Some examples:'''
+
 
+
# using fielddeinterlace from decomb510.dll
+
AviSource("D:\captures\jewel.avi")
+
decomb510_fielddeinterlace(blend=false)
+
 
+
Suppose you have  the plugins mpeg2dec.dll and mpeg2dec3.dll in your auto plugin dir, and you want to load a d2v file with mpeg2dec.dll (which outputs YUY2):
+
 
+
  # using mpeg2source from mpeg2dec.dll
+
 
  mpeg2dec_mpeg2source("F:\From_hell\from_hell.d2v")
 
  mpeg2dec_mpeg2source("F:\From_hell\from_hell.d2v")
 +
</div>
 +
or with '''mpeg2dec3.dll''' (which outputs [[YV12]]):
 +
<div {{BoxWidthIndent|38|1}} >
 +
# using mpeg2source from [[External_plugins_old#Source_Filters|mpeg2dec3.dll]]
 +
mpeg2dec3_mpeg2source("F:\From_hell\from_hell.d2v")
 +
</div>
 +
</div>
  
or with mpeg2dec3.dll (which outputs YV12):
 
 
# using mpeg2source from mpeg2dec3.dll
 
mpeg2dec3_mpeg2source("F:\From_hell\from_hell.d2v")
 
  
 
----
 
----

Revision as of 19:04, 12 March 2016

With these functions you can add external filters (DLLs) to the AviSynth script environment.

Contents


LoadPlugin

Loads one or more standard (C++) AviSynth plugins.

LoadPlugin ("filename" [, ...])
  • filename is the path of the .DLL file(s).


LoadCPlugin

Loads so-called AviSynth C-plugins. C-plugins are created in pure C (unlike ordinary Avisynth plugins which are created with MS C++), use a special C API, and must be loaded with LoadCPlugin.

LoadCPlugin ("filename" [, ...])
Load_Stdcall_Plugin ("filename" [, ...])
  • filename is the path of the .DLL file(s).
  • The plugin's documentation should advise you if LoadCPlugin is needed.
  • Load_Stdcall_Plugin is merely an alias or alternate name.


LoadVirtualDubPlugin

Loads a plugin written for VirtualDub. These are distributed as special DLLs with the file extension .VDF.

LoadVirtualDubPlugin ("filename", "filtername", preroll)
  • filename is the path of the .VDF file.
  • filtername is the name given to the plugin function after loading in AviSynth.
  • Some filters' output depends on previous frames; for these, preroll should be set to a suitable number.
  • VirtualDub filters support only RGB32.
  • Usage example (ColorTools) – see here (doom9).
  • See FAQ using Virtualdub plugins for more information.


LoadVFAPIPlugin

Loads VFAPI plugins (eg, TMPGEnc import plugins).

LoadVFAPIPlugin ("filename", "filtername")
  • filename is the path of the .DLL file.
  • filtername is the name given to the plugin function after loading in AviSynth.
  • The plugin's documentation should advise you if LoadVFAPIPlugin is needed.


Plugin Autoload and Name Precedence

It is possible to put all plugins and script files with user-defined functions or (global) variables in an autoload directory, from which all files with the extension .AVSI and .DLL are loaded at startup, then unloaded and reloaded dynamically as the script needs them.

.AVSI scripts in this directory should only contain function definitions and global variables; they should not have a main processing section (else strange errors may occur). It also is not recommended to put other files in that directory.

The directory is stored in the registry. You can use double-clicking a .REG-file with the following lines to set the path (of course inserting your actual path):

REGEDIT4

[HKEY_LOCAL_MACHINE\SOFTWARE\Avisynth]
"plugindir2_5"="c:\\program files\\avisynth 2.5\\plugins"

The order in which function names take precedence is as follows:

  1. User-defined function (always have the highest priority)
  2. Plugin (external) function (higher priority than built-in)
  3. Built-in (internal) function

Inside those groups the function loaded last takes precedence; there is no error in a namespace conflict.
It follows that there is no harm in loading the same plugin more than once.[dubious – discuss]

Plugin Autoload and Conflicting Function Names

A problem that may arise when multiple plugins have functions with the same name. You won't know which function will be called in your script, as this will depend on loading order. To call a particular function in this situation, AviSynth's DLLName_function() feature automatically creates prefix aliases; so for example, foo.dll's bar() function may be called as foo_bar(). This works both for auto-loaded plugins and for plugins loaded with LoadPlugin.

Suppose you have the plugins mpeg2dec.dll and mpeg2dec3.dll in your autoload directory;
if you want to load a .d2v file with mpeg2dec.dll (which outputs YUY2):

# using mpeg2source from mpeg2dec.dll
mpeg2dec_mpeg2source("F:\From_hell\from_hell.d2v")

or with mpeg2dec3.dll (which outputs YV12):

# using mpeg2source from mpeg2dec3.dll
mpeg2dec3_mpeg2source("F:\From_hell\from_hell.d2v")



Back to AviSynth Syntax.

Personal tools