Mercurial > hg > vamp-website

comparison code-doc/struct__VampPluginDescriptor.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 cc0be37dc9d3
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: _VampPluginDescriptor Struct 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>
26 <div class="contents">
27 <h1>_VampPluginDescriptor Struct Reference</h1><!-- doxytag: class="_VampPluginDescriptor" --><code>#include &lt;<a class="el" href="vamp_8h-source.html">vamp.h</a>&gt;</code>
28 <p>
29
30 <p>
31 <a href="struct__VampPluginDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
32
33 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00206">206</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
34 <table border="0" cellpadding="0" cellspacing="0">
35 <tr><td></td></tr>
36 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr>
38
39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">API version with which this descriptor is compatible. <a href="#b6c87760e87ddaa9ac3491bccaaa28c2"></a><br></td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">identifier</a></td></tr>
41
42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer-usable name of the plugin. <a href="#4915ec8276749cb505c01d25a6d02219"></a><br></td></tr>
43 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">name</a></td></tr>
44
45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable name of the plugin. <a href="#9dd5a0190e4d453ff36b5acb7000b150"></a><br></td></tr>
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">description</a></td></tr>
47
48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable short text about the plugin. <a href="#9ff8050f92f1a04a68bb34a9d368295e"></a><br></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">maker</a></td></tr>
50
51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable name of plugin's author or vendor. <a href="#4dca3d57331802964716edfa80580c9b"></a><br></td></tr>
52 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">pluginVersion</a></td></tr>
53
54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Version number of the plugin. <a href="#04427c420d9252c7796c0bf5101345ae"></a><br></td></tr>
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">copyright</a></td></tr>
56
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable summary of copyright or licensing for plugin. <a href="#e704bba384af0de056a26da1b13ee521"></a><br></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">parameterCount</a></td></tr>
59
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of parameter inputs. <a href="#e6271dc3ea0cea959c84a64185492cab"></a><br></td></tr>
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampParameterDescriptor.html">VampParameterDescriptor</a> **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">parameters</a></td></tr>
62
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fixed descriptors for parameter inputs. <a href="#64d614862604c31d6b84c49005f51913"></a><br></td></tr>
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">programCount</a></td></tr>
65
66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of programs. <a href="#1962666aa173e7a9a2c30dc82e4b2e00"></a><br></td></tr>
67 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">programs</a></td></tr>
68
69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fixed names for programs. <a href="#d488470c582d8472d86455889d71c5ec"></a><br></td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">inputDomain</a></td></tr>
71
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preferred input domain for audio input (time or frequency). <a href="#ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><br></td></tr>
73 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee">instantiate</a> )(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td></tr>
74
75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create and return a new instance of this plugin. <a href="#19c4ce36fdeb88eeedb539efc544b8ee"></a><br></td></tr>
76 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27">cleanup</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
77
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy an instance of this plugin. <a href="#0e4522c33e59c3c518b9262f2477bc27"></a><br></td></tr>
79 <tr><td class="memItemLeft" nowrap align="right" valign="top">int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22">initialise</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td></tr>
80
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise an instance following parameter configuration. <a href="#d0978f17a5e568079470a1978a9aad22"></a><br></td></tr>
82 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336">reset</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
83
84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset an instance, ready to use again on new input data. <a href="#12267f6b506aeda3792ff7c982b02336"></a><br></td></tr>
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">float(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395">getParameter</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td></tr>
86
87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a parameter value. <a href="#07174981875b55ee2ec7521a7f4fc395"></a><br></td></tr>
88 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481">setParameter</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td></tr>
89
90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a parameter value. <a href="#ad3cfc7a3b432df40bd9db13eee6a481"></a><br></td></tr>
91 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53">getCurrentProgram</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
92
93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program (if programCount &gt; 0). <a href="#861a77525a95d424cb846820b018af53"></a><br></td></tr>
94 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf">selectProgram</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
95
96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the current program. <a href="#d9af40cb165ca187e49250964af5f5cf"></a><br></td></tr>
97 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb">getPreferredStepSize</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
98
99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's preferred processing window increment in samples. <a href="#2beddf2ce156c05dd24477ac663adcbb"></a><br></td></tr>
100 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8">getPreferredBlockSize</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
101
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's preferred processing window size in samples. <a href="#c626e42554ab1532c8d8b5132a0faee8"></a><br></td></tr>
103 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92">getMinChannelCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
104
105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum number of input channels this plugin can handle. <a href="#f175ca17716db5a7545b61b01caabd92"></a><br></td></tr>
106 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b">getMaxChannelCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
107
108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum number of input channels this plugin can handle. <a href="#d1600203418d9646332f5b917284261b"></a><br></td></tr>
109 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1">getOutputCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
110
111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of feature outputs (distinct sets of results). <a href="#a8fc88da704e24b2b5f674821dd380c1"></a><br></td></tr>
112 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#92c58b8ff99ad0c23a42333aa55c144d">getOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
113
114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a descriptor for a given feature output. <a href="#92c58b8ff99ad0c23a42333aa55c144d"></a><br></td></tr>
115 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79">releaseOutputDescriptor</a> )(<a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *)</td></tr>
116
117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a descriptor for a feature output. <a href="#8cc38edc921616e67e551aa03397ec79"></a><br></td></tr>
118 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#c5a0a75b6e68b22fed536765d1f2f254">process</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td></tr>
119
120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process an input block and return a set of features. <a href="#c5a0a75b6e68b22fed536765d1f2f254"></a><br></td></tr>
121 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d22c666188aadab83c354a0edb18fcf0">getRemainingFeatures</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
122
123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return any remaining features at the end of processing. <a href="#d22c666188aadab83c354a0edb18fcf0"></a><br></td></tr>
124 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">releaseFeatureSet</a> )(<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *)</td></tr>
125
126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release a feature set returned from process or getRemainingFeatures. <a href="#c4bafe8ad2734d21a433d745b18e7d63"></a><br></td></tr>
127 </table>
128 <hr><h2>Member Data Documentation</h2>
129 <a class="anchor" name="b6c87760e87ddaa9ac3491bccaaa28c2"></a><!-- doxytag: member="_VampPluginDescriptor::vampApiVersion" ref="b6c87760e87ddaa9ac3491bccaaa28c2" args="" -->
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">_VampPluginDescriptor::vampApiVersion</a> </td>
135 </tr>
136 </table>
137 </div>
138 <div class="memdoc">
139
140 <p>
141 API version with which this descriptor is compatible.
142 <p>
143
144 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00209">209</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
145
146 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00145">Vamp::PluginHostAdapter::getVampApiVersion()</a>.</p>
147
148 </div>
149 </div><p>
150 <a class="anchor" name="4915ec8276749cb505c01d25a6d02219"></a><!-- doxytag: member="_VampPluginDescriptor::identifier" ref="4915ec8276749cb505c01d25a6d02219" args="" -->
151 <div class="memitem">
152 <div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">_VampPluginDescriptor::identifier</a> </td>
156 </tr>
157 </table>
158 </div>
159 <div class="memdoc">
160
161 <p>
162 Computer-usable name of the plugin.
163 <p>
164 Must not change. [a-zA-Z0-9_]
165 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00212">212</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
166
167 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00226">Vamp::HostExt::PluginLoader::Impl::enumeratePlugins()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00151">Vamp::PluginHostAdapter::getIdentifier()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00355">Vamp::HostExt::PluginLoader::Impl::loadPlugin()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
168
169 </div>
170 </div><p>
171 <a class="anchor" name="9dd5a0190e4d453ff36b5acb7000b150"></a><!-- doxytag: member="_VampPluginDescriptor::name" ref="9dd5a0190e4d453ff36b5acb7000b150" args="" -->
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">_VampPluginDescriptor::name</a> </td>
177 </tr>
178 </table>
179 </div>
180 <div class="memdoc">
181
182 <p>
183 Human-readable name of the plugin.
184 <p>
185 May be translatable.
186 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00215">215</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
187
188 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00157">Vamp::PluginHostAdapter::getName()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
189
190 </div>
191 </div><p>
192 <a class="anchor" name="9ff8050f92f1a04a68bb34a9d368295e"></a><!-- doxytag: member="_VampPluginDescriptor::description" ref="9ff8050f92f1a04a68bb34a9d368295e" args="" -->
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
196 <tr>
197 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">_VampPluginDescriptor::description</a> </td>
198 </tr>
199 </table>
200 </div>
201 <div class="memdoc">
202
203 <p>
204 Human-readable short text about the plugin.
205 <p>
206 May be translatable.
207 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00218">218</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
208
209 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00163">Vamp::PluginHostAdapter::getDescription()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
210
211 </div>
212 </div><p>
213 <a class="anchor" name="4dca3d57331802964716edfa80580c9b"></a><!-- doxytag: member="_VampPluginDescriptor::maker" ref="4dca3d57331802964716edfa80580c9b" args="" -->
214 <div class="memitem">
215 <div class="memproto">
216 <table class="memname">
217 <tr>
218 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">_VampPluginDescriptor::maker</a> </td>
219 </tr>
220 </table>
221 </div>
222 <div class="memdoc">
223
224 <p>
225 Human-readable name of plugin's author or vendor.
226 <p>
227
228 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00221">221</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
229
230 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00169">Vamp::PluginHostAdapter::getMaker()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
231
232 </div>
233 </div><p>
234 <a class="anchor" name="04427c420d9252c7796c0bf5101345ae"></a><!-- doxytag: member="_VampPluginDescriptor::pluginVersion" ref="04427c420d9252c7796c0bf5101345ae" args="" -->
235 <div class="memitem">
236 <div class="memproto">
237 <table class="memname">
238 <tr>
239 <td class="memname">int <a class="el" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">_VampPluginDescriptor::pluginVersion</a> </td>
240 </tr>
241 </table>
242 </div>
243 <div class="memdoc">
244
245 <p>
246 Version number of the plugin.
247 <p>
248
249 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00224">224</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
250
251 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00175">Vamp::PluginHostAdapter::getPluginVersion()</a>.</p>
252
253 </div>
254 </div><p>
255 <a class="anchor" name="e704bba384af0de056a26da1b13ee521"></a><!-- doxytag: member="_VampPluginDescriptor::copyright" ref="e704bba384af0de056a26da1b13ee521" args="" -->
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
259 <tr>
260 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">_VampPluginDescriptor::copyright</a> </td>
261 </tr>
262 </table>
263 </div>
264 <div class="memdoc">
265
266 <p>
267 Human-readable summary of copyright or licensing for plugin.
268 <p>
269
270 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00227">227</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
271
272 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00181">Vamp::PluginHostAdapter::getCopyright()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
273
274 </div>
275 </div><p>
276 <a class="anchor" name="e6271dc3ea0cea959c84a64185492cab"></a><!-- doxytag: member="_VampPluginDescriptor::parameterCount" ref="e6271dc3ea0cea959c84a64185492cab" args="" -->
277 <div class="memitem">
278 <div class="memproto">
279 <table class="memname">
280 <tr>
281 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">_VampPluginDescriptor::parameterCount</a> </td>
282 </tr>
283 </table>
284 </div>
285 <div class="memdoc">
286
287 <p>
288 Number of parameter inputs.
289 <p>
290
291 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00230">230</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
292
293 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
294
295 </div>
296 </div><p>
297 <a class="anchor" name="64d614862604c31d6b84c49005f51913"></a><!-- doxytag: member="_VampPluginDescriptor::parameters" ref="64d614862604c31d6b84c49005f51913" args="" -->
298 <div class="memitem">
299 <div class="memproto">
300 <table class="memname">
301 <tr>
302 <td class="memname">const <a class="el" href="struct__VampParameterDescriptor.html">VampParameterDescriptor</a>** <a class="el" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">_VampPluginDescriptor::parameters</a> </td>
303 </tr>
304 </table>
305 </div>
306 <div class="memdoc">
307
308 <p>
309 Fixed descriptors for parameter inputs.
310 <p>
311
312 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00233">233</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
313
314 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
315
316 </div>
317 </div><p>
318 <a class="anchor" name="1962666aa173e7a9a2c30dc82e4b2e00"></a><!-- doxytag: member="_VampPluginDescriptor::programCount" ref="1962666aa173e7a9a2c30dc82e4b2e00" args="" -->
319 <div class="memitem">
320 <div class="memproto">
321 <table class="memname">
322 <tr>
323 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">_VampPluginDescriptor::programCount</a> </td>
324 </tr>
325 </table>
326 </div>
327 <div class="memdoc">
328
329 <p>
330 Number of programs.
331 <p>
332
333 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00236">236</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
334
335 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">Vamp::PluginHostAdapter::getPrograms()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
336
337 </div>
338 </div><p>
339 <a class="anchor" name="d488470c582d8472d86455889d71c5ec"></a><!-- doxytag: member="_VampPluginDescriptor::programs" ref="d488470c582d8472d86455889d71c5ec" args="" -->
340 <div class="memitem">
341 <div class="memproto">
342 <table class="memname">
343 <tr>
344 <td class="memname">const char** <a class="el" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">_VampPluginDescriptor::programs</a> </td>
345 </tr>
346 </table>
347 </div>
348 <div class="memdoc">
349
350 <p>
351 Fixed names for programs.
352 <p>
353
354 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00239">239</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
355
356 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">Vamp::PluginHostAdapter::getCurrentProgram()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">Vamp::PluginHostAdapter::getPrograms()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
357
358 </div>
359 </div><p>
360 <a class="anchor" name="ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><!-- doxytag: member="_VampPluginDescriptor::inputDomain" ref="ffc4d1796da7ced2c0cbb2cc2c4a22f4" args="" -->
361 <div class="memitem">
362 <div class="memproto">
363 <table class="memname">
364 <tr>
365 <td class="memname"><a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="el" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">_VampPluginDescriptor::inputDomain</a> </td>
366 </tr>
367 </table>
368 </div>
369 <div class="memdoc">
370
371 <p>
372 Preferred input domain for audio input (time or frequency).
373 <p>
374
375 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00242">242</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
376
377 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00135">Vamp::PluginHostAdapter::getInputDomain()</a>.</p>
378
379 </div>
380 </div><p>
381 <a class="anchor" name="19c4ce36fdeb88eeedb539efc544b8ee"></a><!-- doxytag: member="_VampPluginDescriptor::instantiate" ref="19c4ce36fdeb88eeedb539efc544b8ee" args=")(const struct _VampPluginDescriptor *, float inputSampleRate)" -->
382 <div class="memitem">
383 <div class="memproto">
384 <table class="memname">
385 <tr>
386 <td class="memname"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* <a class="el" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee">_VampPluginDescriptor::instantiate</a>)(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate) </td>
387 </tr>
388 </table>
389 </div>
390 <div class="memdoc">
391
392 <p>
393 Create and return a new instance of this plugin.
394 <p>
395
396 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00043">Vamp::PluginHostAdapter::PluginHostAdapter()</a>.</p>
397
398 </div>
399 </div><p>
400 <a class="anchor" name="0e4522c33e59c3c518b9262f2477bc27"></a><!-- doxytag: member="_VampPluginDescriptor::cleanup" ref="0e4522c33e59c3c518b9262f2477bc27" args=")(VampPluginHandle)" -->
401 <div class="memitem">
402 <div class="memproto">
403 <table class="memname">
404 <tr>
405 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27">_VampPluginDescriptor::cleanup</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
406 </tr>
407 </table>
408 </div>
409 <div class="memdoc">
410
411 <p>
412 Destroy an instance of this plugin.
413 <p>
414
415 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00055">Vamp::PluginHostAdapter::~PluginHostAdapter()</a>.</p>
416
417 </div>
418 </div><p>
419 <a class="anchor" name="d0978f17a5e568079470a1978a9aad22"></a><!-- doxytag: member="_VampPluginDescriptor::initialise" ref="d0978f17a5e568079470a1978a9aad22" args=")(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)" -->
420 <div class="memitem">
421 <div class="memproto">
422 <table class="memname">
423 <tr>
424 <td class="memname">int(* <a class="el" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22">_VampPluginDescriptor::initialise</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize) </td>
425 </tr>
426 </table>
427 </div>
428 <div class="memdoc">
429
430 <p>
431 Initialise an instance following parameter configuration.
432 <p>
433
434 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00118">Vamp::PluginHostAdapter::initialise()</a>.</p>
435
436 </div>
437 </div><p>
438 <a class="anchor" name="12267f6b506aeda3792ff7c982b02336"></a><!-- doxytag: member="_VampPluginDescriptor::reset" ref="12267f6b506aeda3792ff7c982b02336" args=")(VampPluginHandle)" -->
439 <div class="memitem">
440 <div class="memproto">
441 <table class="memname">
442 <tr>
443 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336">_VampPluginDescriptor::reset</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
444 </tr>
445 </table>
446 </div>
447 <div class="memdoc">
448
449 <p>
450 Reset an instance, ready to use again on new input data.
451 <p>
452
453 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00128">Vamp::PluginHostAdapter::reset()</a>.</p>
454
455 </div>
456 </div><p>
457 <a class="anchor" name="07174981875b55ee2ec7521a7f4fc395"></a><!-- doxytag: member="_VampPluginDescriptor::getParameter" ref="07174981875b55ee2ec7521a7f4fc395" args=")(VampPluginHandle, int)" -->
458 <div class="memitem">
459 <div class="memproto">
460 <table class="memname">
461 <tr>
462 <td class="memname">float(* <a class="el" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395">_VampPluginDescriptor::getParameter</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int) </td>
463 </tr>
464 </table>
465 </div>
466 <div class="memdoc">
467
468 <p>
469 Get a parameter value.
470 <p>
471
472 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>.</p>
473
474 </div>
475 </div><p>
476 <a class="anchor" name="ad3cfc7a3b432df40bd9db13eee6a481"></a><!-- doxytag: member="_VampPluginDescriptor::setParameter" ref="ad3cfc7a3b432df40bd9db13eee6a481" args=")(VampPluginHandle, int, float)" -->
477 <div class="memitem">
478 <div class="memproto">
479 <table class="memname">
480 <tr>
481 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481">_VampPluginDescriptor::setParameter</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float) </td>
482 </tr>
483 </table>
484 </div>
485 <div class="memdoc">
486
487 <p>
488 Set a parameter value.
489 <p>
490 May only be called before initialise.
491 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>.</p>
492
493 </div>
494 </div><p>
495 <a class="anchor" name="861a77525a95d424cb846820b018af53"></a><!-- doxytag: member="_VampPluginDescriptor::getCurrentProgram" ref="861a77525a95d424cb846820b018af53" args=")(VampPluginHandle)" -->
496 <div class="memitem">
497 <div class="memproto">
498 <table class="memname">
499 <tr>
500 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53">_VampPluginDescriptor::getCurrentProgram</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
501 </tr>
502 </table>
503 </div>
504 <div class="memdoc">
505
506 <p>
507 Get the current program (if programCount &gt; 0).
508 <p>
509
510 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">Vamp::PluginHostAdapter::getCurrentProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>.</p>
511
512 </div>
513 </div><p>
514 <a class="anchor" name="d9af40cb165ca187e49250964af5f5cf"></a><!-- doxytag: member="_VampPluginDescriptor::selectProgram" ref="d9af40cb165ca187e49250964af5f5cf" args=")(VampPluginHandle, unsigned int)" -->
515 <div class="memitem">
516 <div class="memproto">
517 <table class="memname">
518 <tr>
519 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf">_VampPluginDescriptor::selectProgram</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int) </td>
520 </tr>
521 </table>
522 </div>
523 <div class="memdoc">
524
525 <p>
526 Set the current program.
527 <p>
528 May only be called before initialise.
529 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>.</p>
530
531 </div>
532 </div><p>
533 <a class="anchor" name="2beddf2ce156c05dd24477ac663adcbb"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredStepSize" ref="2beddf2ce156c05dd24477ac663adcbb" args=")(VampPluginHandle)" -->
534 <div class="memitem">
535 <div class="memproto">
536 <table class="memname">
537 <tr>
538 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb">_VampPluginDescriptor::getPreferredStepSize</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
539 </tr>
540 </table>
541 </div>
542 <div class="memdoc">
543
544 <p>
545 Get the plugin's preferred processing window increment in samples.
546 <p>
547
548 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00275">Vamp::PluginHostAdapter::getPreferredStepSize()</a>.</p>
549
550 </div>
551 </div><p>
552 <a class="anchor" name="c626e42554ab1532c8d8b5132a0faee8"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredBlockSize" ref="c626e42554ab1532c8d8b5132a0faee8" args=")(VampPluginHandle)" -->
553 <div class="memitem">
554 <div class="memproto">
555 <table class="memname">
556 <tr>
557 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8">_VampPluginDescriptor::getPreferredBlockSize</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
558 </tr>
559 </table>
560 </div>
561 <div class="memdoc">
562
563 <p>
564 Get the plugin's preferred processing window size in samples.
565 <p>
566
567 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00282">Vamp::PluginHostAdapter::getPreferredBlockSize()</a>.</p>
568
569 </div>
570 </div><p>
571 <a class="anchor" name="f175ca17716db5a7545b61b01caabd92"></a><!-- doxytag: member="_VampPluginDescriptor::getMinChannelCount" ref="f175ca17716db5a7545b61b01caabd92" args=")(VampPluginHandle)" -->
572 <div class="memitem">
573 <div class="memproto">
574 <table class="memname">
575 <tr>
576 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92">_VampPluginDescriptor::getMinChannelCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
577 </tr>
578 </table>
579 </div>
580 <div class="memdoc">
581
582 <p>
583 Get the minimum number of input channels this plugin can handle.
584 <p>
585
586 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00289">Vamp::PluginHostAdapter::getMinChannelCount()</a>.</p>
587
588 </div>
589 </div><p>
590 <a class="anchor" name="d1600203418d9646332f5b917284261b"></a><!-- doxytag: member="_VampPluginDescriptor::getMaxChannelCount" ref="d1600203418d9646332f5b917284261b" args=")(VampPluginHandle)" -->
591 <div class="memitem">
592 <div class="memproto">
593 <table class="memname">
594 <tr>
595 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b">_VampPluginDescriptor::getMaxChannelCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
596 </tr>
597 </table>
598 </div>
599 <div class="memdoc">
600
601 <p>
602 Get the maximum number of input channels this plugin can handle.
603 <p>
604
605 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00296">Vamp::PluginHostAdapter::getMaxChannelCount()</a>.</p>
606
607 </div>
608 </div><p>
609 <a class="anchor" name="a8fc88da704e24b2b5f674821dd380c1"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputCount" ref="a8fc88da704e24b2b5f674821dd380c1" args=")(VampPluginHandle)" -->
610 <div class="memitem">
611 <div class="memproto">
612 <table class="memname">
613 <tr>
614 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
615 </tr>
616 </table>
617 </div>
618 <div class="memdoc">
619
620 <p>
621 Get the number of feature outputs (distinct sets of results).
622 <p>
623
624 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
625
626 </div>
627 </div><p>
628 <a class="anchor" name="92c58b8ff99ad0c23a42333aa55c144d"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputDescriptor" ref="92c58b8ff99ad0c23a42333aa55c144d" args=")(VampPluginHandle, unsigned int)" -->
629 <div class="memitem">
630 <div class="memproto">
631 <table class="memname">
632 <tr>
633 <td class="memname"><a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#92c58b8ff99ad0c23a42333aa55c144d">_VampPluginDescriptor::getOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int) </td>
634 </tr>
635 </table>
636 </div>
637 <div class="memdoc">
638
639 <p>
640 Get a descriptor for a given feature output.
641 <p>
642 Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use.
643 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
644
645 </div>
646 </div><p>
647 <a class="anchor" name="8cc38edc921616e67e551aa03397ec79"></a><!-- doxytag: member="_VampPluginDescriptor::releaseOutputDescriptor" ref="8cc38edc921616e67e551aa03397ec79" args=")(VampOutputDescriptor *)" -->
648 <div class="memitem">
649 <div class="memproto">
650 <table class="memname">
651 <tr>
652 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79">_VampPluginDescriptor::releaseOutputDescriptor</a>)(<a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *) </td>
653 </tr>
654 </table>
655 </div>
656 <div class="memdoc">
657
658 <p>
659 Destroy a descriptor for a feature output.
660 <p>
661
662 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
663
664 </div>
665 </div><p>
666 <a class="anchor" name="c5a0a75b6e68b22fed536765d1f2f254"></a><!-- doxytag: member="_VampPluginDescriptor::process" ref="c5a0a75b6e68b22fed536765d1f2f254" args=")(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec)" -->
667 <div class="memitem">
668 <div class="memproto">
669 <table class="memname">
670 <tr>
671 <td class="memname"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#c5a0a75b6e68b22fed536765d1f2f254">_VampPluginDescriptor::process</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec) </td>
672 </tr>
673 </table>
674 </div>
675 <div class="memdoc">
676
677 <p>
678 Process an input block and return a set of features.
679 <p>
680 Returned pointer is valid only until next call to process, getRemainingFeatures, or cleanup for this handle, or releaseFeatureSet for this feature set. Host must call releaseFeatureSet after use.
681 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">Vamp::PluginHostAdapter::process()</a>.</p>
682
683 </div>
684 </div><p>
685 <a class="anchor" name="d22c666188aadab83c354a0edb18fcf0"></a><!-- doxytag: member="_VampPluginDescriptor::getRemainingFeatures" ref="d22c666188aadab83c354a0edb18fcf0" args=")(VampPluginHandle)" -->
686 <div class="memitem">
687 <div class="memproto">
688 <table class="memname">
689 <tr>
690 <td class="memname"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#d22c666188aadab83c354a0edb18fcf0">_VampPluginDescriptor::getRemainingFeatures</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
691 </tr>
692 </table>
693 </div>
694 <div class="memdoc">
695
696 <p>
697 Return any remaining features at the end of processing.
698 <p>
699
700 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">Vamp::PluginHostAdapter::getRemainingFeatures()</a>.</p>
701
702 </div>
703 </div><p>
704 <a class="anchor" name="c4bafe8ad2734d21a433d745b18e7d63"></a><!-- doxytag: member="_VampPluginDescriptor::releaseFeatureSet" ref="c4bafe8ad2734d21a433d745b18e7d63" args=")(VampFeatureList *)" -->
705 <div class="memitem">
706 <div class="memproto">
707 <table class="memname">
708 <tr>
709 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>)(<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *) </td>
710 </tr>
711 </table>
712 </div>
713 <div class="memdoc">
714
715 <p>
716 Release a feature set returned from process or getRemainingFeatures.
717 <p>
718
719 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">Vamp::PluginHostAdapter::getRemainingFeatures()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">Vamp::PluginHostAdapter::process()</a>.</p>
720
721 </div>
722 </div><p>
723 <hr>The documentation for this struct was generated from the following file:<ul>
724 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul>
725 </div>
726 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp;
727 <a href="http://www.doxygen.org/index.html">
728 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
729 </body>
730 </html>