Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:351c4ebce5f9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23 </ul>
24 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html">PluginDeletionNotifyAdapter</a>
26 </div>
27 </div>
28 <div class="contents">
29 <h1>Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><div class="dynheader">
30 Inheritance diagram for Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter:</div>
31 <div class="dynsection">
32 <p><center><img src="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter__inherit__map" alt="Inheritance graph"></center>
33 <map name="Vamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter__inherit__map">
34 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="103,156,303,180"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="153,81,252,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="139,6,267,30"></map>
35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
36
37 <p>
38 <a href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
39
40 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00094">94</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
41 <table border="0" cellpadding="0" cellspacing="0">
42 <tr><td></td></tr>
43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
45 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
46 }</td></tr>
47
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
49 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
50
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
52
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
54 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
57 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
58
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
60
61 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html#80196e30ed72a4f45b4152a3991d7777">PluginDeletionNotifyAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin, <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *loader)</td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html#bb85c0134c354c0854f3868a60d0193f">~PluginDeletionNotifyAdapter</a> ()</td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
67
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a5a1f8290d8e9a315695584dcb3ad137"></a><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
70
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#031aa818fd48fd0f4b5e1bf80c032870">getInputDomain</a> () const </td></tr>
73
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#031aa818fd48fd0f4b5e1bf80c032870"></a><br></td></tr>
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
76
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
79
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
82
83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr>
84 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
85
86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#c334f699c0996055942785410d8a065c"></a><br></td></tr>
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
88
89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
91
92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
94
95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e">getParameterDescriptors</a> () const </td></tr>
97
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#3b075b8f950b344503f0d27ac0fe332e"></a><br></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
100
101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
103
104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">getPrograms</a> () const </td></tr>
106
107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#f3abaf717dc4b00cad5770ed6dfa01e1"></a><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
109
110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
112
113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
115
116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
118
119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
121
122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
124
125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace">getOutputDescriptors</a> () const </td></tr>
127
128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#02c8c01972affeea58b091335e791ace"></a><br></td></tr>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
130
131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#fca78043c2843c1d45019983515e23f7"></a><br></td></tr>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe">getRemainingFeatures</a> ()</td></tr>
133
134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#1dce55a75a32b08fc56a52a300d9fcbe"></a><br></td></tr>
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
136
137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
138 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html#1fb8473ea9ad73b1b6a00b92345d8397">m_loader</a></td></tr>
140
141 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
142
143 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
144
145 </table>
146 <hr><h2>Member Typedef Documentation</h2>
147 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
153 </tr>
154 </table>
155 </div>
156 <div class="memdoc">
157
158 <p>
159
160 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
161
162 </div>
163 </div><p>
164 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
168 <tr>
169 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
170 </tr>
171 </table>
172 </div>
173 <div class="memdoc">
174
175 <p>
176
177 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
178
179 </div>
180 </div><p>
181 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
187 </tr>
188 </table>
189 </div>
190 <div class="memdoc">
191
192 <p>
193
194 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
195
196 </div>
197 </div><p>
198 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
199 <div class="memitem">
200 <div class="memproto">
201 <table class="memname">
202 <tr>
203 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
204 </tr>
205 </table>
206 </div>
207 <div class="memdoc">
208
209 <p>
210
211 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
212
213 </div>
214 </div><p>
215 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
221 </tr>
222 </table>
223 </div>
224 <div class="memdoc">
225
226 <p>
227
228 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
229
230 </div>
231 </div><p>
232 <hr><h2>Member Enumeration Documentation</h2>
233 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
234 <div class="memitem">
235 <div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
239 </tr>
240 </table>
241 </div>
242 <div class="memdoc">
243
244 <p>
245 <dl compact><dt><b>Enumerator: </b></dt><dd>
246 <table border="0" cellspacing="2" cellpadding="0">
247 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
248 </td></tr>
249 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
250 </td></tr>
251 </table>
252 </dl>
253
254 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
255
256 </div>
257 </div><p>
258 <hr><h2>Constructor &amp; Destructor Documentation</h2>
259 <a class="anchor" name="80196e30ed72a4f45b4152a3991d7777"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::PluginDeletionNotifyAdapter" ref="80196e30ed72a4f45b4152a3991d7777" args="(Plugin *plugin, Impl *loader)" -->
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::PluginDeletionNotifyAdapter </td>
265 <td>(</td>
266 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td>
267 <td class="paramname"> <em>plugin</em>, </td>
268 </tr>
269 <tr>
270 <td class="paramkey"></td>
271 <td></td>
272 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *&nbsp;</td>
273 <td class="paramname"> <em>loader</em></td><td>&nbsp;</td>
274 </tr>
275 <tr>
276 <td></td>
277 <td>)</td>
278 <td></td><td></td><td width="100%"></td>
279 </tr>
280 </table>
281 </div>
282 <div class="memdoc">
283
284 <p>
285
286 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00613">613</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
287
288 </div>
289 </div><p>
290 <a class="anchor" name="bb85c0134c354c0854f3868a60d0193f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter" ref="bb85c0134c354c0854f3868a60d0193f" args="()" -->
291 <div class="memitem">
292 <div class="memproto">
293 <table class="memname">
294 <tr>
295 <td class="memname">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter </td>
296 <td>(</td>
297 <td class="paramname"> </td>
298 <td>&nbsp;)&nbsp;</td>
299 <td width="100%"><code> [virtual]</code></td>
300 </tr>
301 </table>
302 </div>
303 <div class="memdoc">
304
305 <p>
306
307 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00620">620</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
308
309 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00099">m_loader</a>, <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00606">Vamp::HostExt::PluginLoader::Impl::pluginDeleted()</a>.</p>
310
311 </div>
312 </div><p>
313 <hr><h2>Member Function Documentation</h2>
314 <a class="anchor" name="a5a1f8290d8e9a315695584dcb3ad137"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::initialise" ref="a5a1f8290d8e9a315695584dcb3ad137" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
315 <div class="memitem">
316 <div class="memproto">
317 <table class="memname">
318 <tr>
319 <td class="memname">bool Vamp::HostExt::PluginWrapper::initialise </td>
320 <td>(</td>
321 <td class="paramtype">size_t&nbsp;</td>
322 <td class="paramname"> <em>inputChannels</em>, </td>
323 </tr>
324 <tr>
325 <td class="paramkey"></td>
326 <td></td>
327 <td class="paramtype">size_t&nbsp;</td>
328 <td class="paramname"> <em>stepSize</em>, </td>
329 </tr>
330 <tr>
331 <td class="paramkey"></td>
332 <td></td>
333 <td class="paramtype">size_t&nbsp;</td>
334 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
335 </tr>
336 <tr>
337 <td></td>
338 <td>)</td>
339 <td></td><td></td><td width="100%"><code> [virtual, inherited]</code></td>
340 </tr>
341 </table>
342 </div>
343 <div class="memdoc">
344
345 <p>
346 Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).
347 <p>
348 The input sample rate should have been already specified at construction time.<p>
349 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
350 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
351
352 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
353
354 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
355
356 <p>References <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin::initialise()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
357
358 </div>
359 </div><p>
360 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
361 <div class="memitem">
362 <div class="memproto">
363 <table class="memname">
364 <tr>
365 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
366 <td>(</td>
367 <td class="paramname"> </td>
368 <td>&nbsp;)&nbsp;</td>
369 <td width="100%"><code> [virtual, inherited]</code></td>
370 </tr>
371 </table>
372 </div>
373 <div class="memdoc">
374
375 <p>
376 Reset the plugin after use, to prepare it for another clean run.
377 <p>
378 Not called for the first initialisation (i.e. initialise must also do a reset).
379 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
380
381 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
382
383 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00068">68</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
384
385 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin::reset()</a>.</p>
386
387 </div>
388 </div><p>
389 <a class="anchor" name="031aa818fd48fd0f4b5e1bf80c032870"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getInputDomain" ref="031aa818fd48fd0f4b5e1bf80c032870" args="() const " -->
390 <div class="memitem">
391 <div class="memproto">
392 <table class="memname">
393 <tr>
394 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Plugin::InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
395 <td>(</td>
396 <td class="paramname"> </td>
397 <td>&nbsp;)&nbsp;</td>
398 <td width="100%"> const<code> [virtual, inherited]</code></td>
399 </tr>
400 </table>
401 </div>
402 <div class="memdoc">
403
404 <p>
405 Get the plugin's required input domain.
406 <p>
407 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
408 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
409
410 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
411
412 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00074">74</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
413
414 <p>References <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
415
416 </div>
417 </div><p>
418 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
419 <div class="memitem">
420 <div class="memproto">
421 <table class="memname">
422 <tr>
423 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
424 <td>(</td>
425 <td class="paramname"> </td>
426 <td>&nbsp;)&nbsp;</td>
427 <td width="100%"> const<code> [virtual, inherited]</code></td>
428 </tr>
429 </table>
430 </div>
431 <div class="memdoc">
432
433 <p>
434 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin.
435 <p>
436
437 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
438
439 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00080">80</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
440
441 <p>References <a class="el" href="PluginBase_8h-source.html#l00067">Vamp::PluginBase::getVampApiVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
442
443 </div>
444 </div><p>
445 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
446 <div class="memitem">
447 <div class="memproto">
448 <table class="memname">
449 <tr>
450 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
451 <td>(</td>
452 <td class="paramname"> </td>
453 <td>&nbsp;)&nbsp;</td>
454 <td width="100%"> const<code> [virtual, inherited]</code></td>
455 </tr>
456 </table>
457 </div>
458 <div class="memdoc">
459
460 <p>
461 Get the computer-usable name of the plugin.
462 <p>
463 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p>
464 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p>
465 Example: "zero_crossings"
466 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
467
468 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00086">86</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
469
470 <p>References <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
471
472 </div>
473 </div><p>
474 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
475 <div class="memitem">
476 <div class="memproto">
477 <table class="memname">
478 <tr>
479 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
480 <td>(</td>
481 <td class="paramname"> </td>
482 <td>&nbsp;)&nbsp;</td>
483 <td width="100%"> const<code> [virtual, inherited]</code></td>
484 </tr>
485 </table>
486 </div>
487 <div class="memdoc">
488
489 <p>
490 Get a human-readable name or title of the plugin.
491 <p>
492 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p>
493 Example: "Zero Crossings"
494 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
495
496 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00092">92</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
497
498 <p>References <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
499
500 </div>
501 </div><p>
502 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
503 <div class="memitem">
504 <div class="memproto">
505 <table class="memname">
506 <tr>
507 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
508 <td>(</td>
509 <td class="paramname"> </td>
510 <td>&nbsp;)&nbsp;</td>
511 <td width="100%"> const<code> [virtual, inherited]</code></td>
512 </tr>
513 </table>
514 </div>
515 <div class="memdoc">
516
517 <p>
518 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".
519 <p>
520 May be empty if the name has said it all already.<p>
521 Example: "Detect and count zero crossing points"
522 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
523
524 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00098">98</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
525
526 <p>References <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
527
528 </div>
529 </div><p>
530 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
531 <div class="memitem">
532 <div class="memproto">
533 <table class="memname">
534 <tr>
535 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
536 <td>(</td>
537 <td class="paramname"> </td>
538 <td>&nbsp;)&nbsp;</td>
539 <td width="100%"> const<code> [virtual, inherited]</code></td>
540 </tr>
541 </table>
542 </div>
543 <div class="memdoc">
544
545 <p>
546 Get the name of the author or vendor of the plugin in human-readable form.
547 <p>
548 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
549 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
550
551 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00104">104</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
552
553 <p>References <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
554
555 </div>
556 </div><p>
557 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
558 <div class="memitem">
559 <div class="memproto">
560 <table class="memname">
561 <tr>
562 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
563 <td>(</td>
564 <td class="paramname"> </td>
565 <td>&nbsp;)&nbsp;</td>
566 <td width="100%"> const<code> [virtual, inherited]</code></td>
567 </tr>
568 </table>
569 </div>
570 <div class="memdoc">
571
572 <p>
573 Get the version number of the plugin.
574 <p>
575
576 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
577
578 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00110">110</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
579
580 <p>References <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
581
582 </div>
583 </div><p>
584 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
585 <div class="memitem">
586 <div class="memproto">
587 <table class="memname">
588 <tr>
589 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
590 <td>(</td>
591 <td class="paramname"> </td>
592 <td>&nbsp;)&nbsp;</td>
593 <td width="100%"> const<code> [virtual, inherited]</code></td>
594 </tr>
595 </table>
596 </div>
597 <div class="memdoc">
598
599 <p>
600 Get the copyright statement or licensing summary for the plugin.
601 <p>
602 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
603 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
604
605 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
606
607 <p>References <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
608
609 </div>
610 </div><p>
611 <a class="anchor" name="3b075b8f950b344503f0d27ac0fe332e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getParameterDescriptors" ref="3b075b8f950b344503f0d27ac0fe332e" args="() const " -->
612 <div class="memitem">
613 <div class="memproto">
614 <table class="memname">
615 <tr>
616 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginBase::ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
617 <td>(</td>
618 <td class="paramname"> </td>
619 <td>&nbsp;)&nbsp;</td>
620 <td width="100%"> const<code> [virtual, inherited]</code></td>
621 </tr>
622 </table>
623 </div>
624 <div class="memdoc">
625
626 <p>
627 Get the controllable parameters of this plugin.
628 <p>
629
630 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
631
632 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00122">122</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
633
634 <p>References <a class="el" href="PluginBase_8h-source.html#l00200">Vamp::PluginBase::getParameterDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
635
636 </div>
637 </div><p>
638 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
639 <div class="memitem">
640 <div class="memproto">
641 <table class="memname">
642 <tr>
643 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
644 <td>(</td>
645 <td class="paramtype">std::string&nbsp;</td>
646 <td class="paramname"> </td>
647 <td>&nbsp;)&nbsp;</td>
648 <td width="100%"> const<code> [virtual, inherited]</code></td>
649 </tr>
650 </table>
651 </div>
652 <div class="memdoc">
653
654 <p>
655 Get the value of a named parameter.
656 <p>
657 The argument is the identifier field from that parameter's descriptor.
658 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
659
660 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
661
662 <p>References <a class="el" href="PluginBase_8h-source.html#l00208">Vamp::PluginBase::getParameter()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
663
664 </div>
665 </div><p>
666 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
667 <div class="memitem">
668 <div class="memproto">
669 <table class="memname">
670 <tr>
671 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
672 <td>(</td>
673 <td class="paramtype">std::string&nbsp;</td>
674 <td class="paramname">, </td>
675 </tr>
676 <tr>
677 <td class="paramkey"></td>
678 <td></td>
679 <td class="paramtype">float&nbsp;</td>
680 <td class="paramname"></td><td>&nbsp;</td>
681 </tr>
682 <tr>
683 <td></td>
684 <td>)</td>
685 <td></td><td></td><td width="100%"><code> [virtual, inherited]</code></td>
686 </tr>
687 </table>
688 </div>
689 <div class="memdoc">
690
691 <p>
692 Set a named parameter.
693 <p>
694 The first argument is the identifier field from that parameter's descriptor.
695 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
696
697 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00134">134</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
698
699 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00214">Vamp::PluginBase::setParameter()</a>.</p>
700
701 </div>
702 </div><p>
703 <a class="anchor" name="f3abaf717dc4b00cad5770ed6dfa01e1"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getPrograms" ref="f3abaf717dc4b00cad5770ed6dfa01e1" args="() const " -->
704 <div class="memitem">
705 <div class="memproto">
706 <table class="memname">
707 <tr>
708 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginBase::ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
709 <td>(</td>
710 <td class="paramname"> </td>
711 <td>&nbsp;)&nbsp;</td>
712 <td width="100%"> const<code> [virtual, inherited]</code></td>
713 </tr>
714 </table>
715 </div>
716 <div class="memdoc">
717
718 <p>
719 Get the program settings available in this plugin.
720 <p>
721 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p>
722 The programs must have unique names.
723 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
724
725 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00140">140</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
726
727 <p>References <a class="el" href="PluginBase_8h-source.html#l00229">Vamp::PluginBase::getPrograms()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
728
729 </div>
730 </div><p>
731 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
732 <div class="memitem">
733 <div class="memproto">
734 <table class="memname">
735 <tr>
736 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
737 <td>(</td>
738 <td class="paramname"> </td>
739 <td>&nbsp;)&nbsp;</td>
740 <td width="100%"> const<code> [virtual, inherited]</code></td>
741 </tr>
742 </table>
743 </div>
744 <div class="memdoc">
745
746 <p>
747 Get the current program.
748 <p>
749
750 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
751
752 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
753
754 <p>References <a class="el" href="PluginBase_8h-source.html#l00234">Vamp::PluginBase::getCurrentProgram()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
755
756 </div>
757 </div><p>
758 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
759 <div class="memitem">
760 <div class="memproto">
761 <table class="memname">
762 <tr>
763 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
764 <td>(</td>
765 <td class="paramtype">std::string&nbsp;</td>
766 <td class="paramname"> </td>
767 <td>&nbsp;)&nbsp;</td>
768 <td width="100%"><code> [virtual, inherited]</code></td>
769 </tr>
770 </table>
771 </div>
772 <div class="memdoc">
773
774 <p>
775 Select a program.
776 <p>
777 (If the given program name is not one of the available programs, do nothing.)
778 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
779
780 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
781
782 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00240">Vamp::PluginBase::selectProgram()</a>.</p>
783
784 </div>
785 </div><p>
786 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " -->
787 <div class="memitem">
788 <div class="memproto">
789 <table class="memname">
790 <tr>
791 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
792 <td>(</td>
793 <td class="paramname"> </td>
794 <td>&nbsp;)&nbsp;</td>
795 <td width="100%"> const<code> [virtual, inherited]</code></td>
796 </tr>
797 </table>
798 </div>
799 <div class="memdoc">
800
801 <p>
802 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin.
803 <p>
804 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
805 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
806 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
807
808 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
809
810 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00158">158</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
811
812 <p>References <a class="el" href="Plugin_8h-source.html#l00186">Vamp::Plugin::getPreferredStepSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
813
814 </div>
815 </div><p>
816 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
817 <div class="memitem">
818 <div class="memproto">
819 <table class="memname">
820 <tr>
821 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
822 <td>(</td>
823 <td class="paramname"> </td>
824 <td>&nbsp;)&nbsp;</td>
825 <td width="100%"> const<code> [virtual, inherited]</code></td>
826 </tr>
827 </table>
828 </div>
829 <div class="memdoc">
830
831 <p>
832 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function).
833 <p>
834 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
835 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
836 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
837
838 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
839
840 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00164">164</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
841
842 <p>References <a class="el" href="Plugin_8h-source.html#l00171">Vamp::Plugin::getPreferredBlockSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
843
844 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize()</a>.</p>
845
846 </div>
847 </div><p>
848 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
849 <div class="memitem">
850 <div class="memproto">
851 <table class="memname">
852 <tr>
853 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
854 <td>(</td>
855 <td class="paramname"> </td>
856 <td>&nbsp;)&nbsp;</td>
857 <td width="100%"> const<code> [virtual, inherited]</code></td>
858 </tr>
859 </table>
860 </div>
861 <div class="memdoc">
862
863 <p>
864 Get the minimum supported number of input channels.
865 <p>
866
867 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
868
869 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00170">170</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
870
871 <p>References <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
872
873 </div>
874 </div><p>
875 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
876 <div class="memitem">
877 <div class="memproto">
878 <table class="memname">
879 <tr>
880 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
881 <td>(</td>
882 <td class="paramname"> </td>
883 <td>&nbsp;)&nbsp;</td>
884 <td width="100%"> const<code> [virtual, inherited]</code></td>
885 </tr>
886 </table>
887 </div>
888 <div class="memdoc">
889
890 <p>
891 Get the maximum supported number of input channels.
892 <p>
893
894 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
895
896 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
897
898 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
899
900 </div>
901 </div><p>
902 <a class="anchor" name="02c8c01972affeea58b091335e791ace"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getOutputDescriptors" ref="02c8c01972affeea58b091335e791ace" args="() const " -->
903 <div class="memitem">
904 <div class="memproto">
905 <table class="memname">
906 <tr>
907 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Plugin::OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
908 <td>(</td>
909 <td class="paramname"> </td>
910 <td>&nbsp;)&nbsp;</td>
911 <td width="100%"> const<code> [virtual, inherited]</code></td>
912 </tr>
913 </table>
914 </div>
915 <div class="memdoc">
916
917 <p>
918 Get the outputs of this plugin.
919 <p>
920 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> call.
921 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
922
923 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
924
925 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00181">181</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
926
927 <p>References <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin::getOutputDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
928
929 </div>
930 </div><p>
931 <a class="anchor" name="fca78043c2843c1d45019983515e23f7"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::process" ref="fca78043c2843c1d45019983515e23f7" args="(const float *const *inputBuffers, RealTime timestamp)" -->
932 <div class="memitem">
933 <div class="memproto">
934 <table class="memname">
935 <tr>
936 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
937 <td>(</td>
938 <td class="paramtype">const float *const *&nbsp;</td>
939 <td class="paramname"> <em>inputBuffers</em>, </td>
940 </tr>
941 <tr>
942 <td class="paramkey"></td>
943 <td></td>
944 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
945 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
946 </tr>
947 <tr>
948 <td></td>
949 <td>)</td>
950 <td></td><td></td><td width="100%"><code> [virtual, inherited]</code></td>
951 </tr>
952 </table>
953 </div>
954 <div class="memdoc">
955
956 <p>
957 Process a single block of input data.
958 <p>
959 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p>
960 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
961 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
962 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
963
964 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#294e663b4d9ec885791faa1b440571ed">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#0867737693c16801d40a6adbde07ec07">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
965
966 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00187">187</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
967
968 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin::process()</a>.</p>
969
970 </div>
971 </div><p>
972 <a class="anchor" name="1dce55a75a32b08fc56a52a300d9fcbe"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getRemainingFeatures" ref="1dce55a75a32b08fc56a52a300d9fcbe" args="()" -->
973 <div class="memitem">
974 <div class="memproto">
975 <table class="memname">
976 <tr>
977 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
978 <td>(</td>
979 <td class="paramname"> </td>
980 <td>&nbsp;)&nbsp;</td>
981 <td width="100%"><code> [virtual, inherited]</code></td>
982 </tr>
983 </table>
984 </div>
985 <div class="memdoc">
986
987 <p>
988 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
989 <p>
990
991 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
992
993 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
994
995 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00193">193</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
996
997 <p>References <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin::getRemainingFeatures()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
998
999 </div>
1000 </div><p>
1001 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
1002 <div class="memitem">
1003 <div class="memproto">
1004 <table class="memname">
1005 <tr>
1006 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1007 <td>(</td>
1008 <td class="paramname"> </td>
1009 <td>&nbsp;)&nbsp;</td>
1010 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
1011 </tr>
1012 </table>
1013 </div>
1014 <div class="memdoc">
1015
1016 <p>
1017 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
1018 <p>
1019 Do not reimplement this function in your subclass.
1020 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1021
1022 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
1023
1024 </div>
1025 </div><p>
1026 <hr><h2>Member Data Documentation</h2>
1027 <a class="anchor" name="1fb8473ea9ad73b1b6a00b92345d8397"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::m_loader" ref="1fb8473ea9ad73b1b6a00b92345d8397" args="" -->
1028 <div class="memitem">
1029 <div class="memproto">
1030 <table class="memname">
1031 <tr>
1032 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html#1fb8473ea9ad73b1b6a00b92345d8397">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::m_loader</a><code> [protected]</code> </td>
1033 </tr>
1034 </table>
1035 </div>
1036 <div class="memdoc">
1037
1038 <p>
1039
1040 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00099">99</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
1041
1042 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00620">~PluginDeletionNotifyAdapter()</a>.</p>
1043
1044 </div>
1045 </div><p>
1046 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
1047 <div class="memitem">
1048 <div class="memproto">
1049 <table class="memname">
1050 <tr>
1051 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code> </td>
1052 </tr>
1053 </table>
1054 </div>
1055 <div class="memdoc">
1056
1057 <p>
1058
1059 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00099">99</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
1060
1061 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00116">Vamp::HostExt::PluginWrapper::getCopyright()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00098">Vamp::HostExt::PluginWrapper::getDescription()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00086">Vamp::HostExt::PluginWrapper::getIdentifier()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00074">Vamp::HostExt::PluginWrapper::getInputDomain()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00104">Vamp::HostExt::PluginWrapper::getMaker()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00092">Vamp::HostExt::PluginWrapper::getName()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00181">Vamp::HostExt::PluginWrapper::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00128">Vamp::HostExt::PluginWrapper::getParameter()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00122">Vamp::HostExt::PluginWrapper::getParameterDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00110">Vamp::HostExt::PluginWrapper::getPluginVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00158">Vamp::HostExt::PluginWrapper::getPreferredStepSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00193">Vamp::HostExt::PluginWrapper::getRemainingFeatures()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00062">Vamp::HostExt::PluginWrapper::initialise()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00187">Vamp::HostExt::PluginWrapper::process()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00068">Vamp::HostExt::PluginWrapper::reset()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00134">Vamp::HostExt::PluginWrapper::setParameter()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00620">~PluginDeletionNotifyAdapter()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00056">Vamp::HostExt::PluginWrapper::~PluginWrapper()</a>.</p>
1062
1063 </div>
1064 </div><p>
1065 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1066 <div class="memitem">
1067 <div class="memproto">
1068 <table class="memname">
1069 <tr>
1070 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
1071 </tr>
1072 </table>
1073 </div>
1074 <div class="memdoc">
1075
1076 <p>
1077
1078 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
1079
1080 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
1081
1082 </div>
1083 </div><p>
1084 <hr>The documentation for this class was generated from the following file:<ul>
1085 <li><a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a></ul>
1086 </div>
1087 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
1088 <a href="http://www.doxygen.org/index.html">
1089 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
1090 </body>
1091 </html>