Mercurial > hg > vamp-website
diff code-doc/vamp_8h-source.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | 351c4ebce5f9 |
| children | 0976232e353b |
line wrap: on
line diff
--- a/code-doc/vamp_8h-source.html Mon Nov 24 15:17:08 2008 +0000 +++ b/code-doc/vamp_8h-source.html Tue Dec 09 11:02:57 2008 +0000 @@ -4,7 +4,7 @@ <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.5.5 --> +<!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> @@ -18,7 +18,7 @@ <div class="navpath"><a class="el" href="dir_b086eb10f854304ab96fb3af468374a7.html">vamp</a> </div> </div> -</div> +<div class="contents"> <h1>vamp.h</h1><a href="vamp_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> @@ -62,7 +62,7 @@ <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { <a name="l00042"></a>00042 <span class="preprocessor">#endif</span> <a name="l00043"></a>00043 <span class="preprocessor"></span> -<a name="l00053"></a><a class="code" href="vamp_8h.html#6d6c8c755dbabf161f72712e0e2143c7">00053</a> <span class="preprocessor">#define VAMP_API_VERSION 1</span> +<a name="l00053"></a><a class="code" href="vamp_8h.html#6d6c8c755dbabf161f72712e0e2143c7">00053</a> <span class="preprocessor">#define VAMP_API_VERSION 2</span> <a name="l00054"></a>00054 <span class="preprocessor"></span> <a name="l00071"></a><a class="code" href="struct__VampParameterDescriptor.html">00071</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">_VampParameterDescriptor</a> <a name="l00072"></a>00072 { @@ -128,129 +128,149 @@ <a name="l00158"></a>00158 <a name="l00161"></a><a class="code" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e">00161</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e" title="Sample rate of returned results, if sampleType is vampFixedSampleRate.">sampleRate</a>; <a name="l00162"></a>00162 -<a name="l00163"></a>00163 } <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a>; -<a name="l00164"></a>00164 -<a name="l00165"></a><a class="code" href="struct__VampFeature.html">00165</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeature.html">_VampFeature</a> -<a name="l00166"></a>00166 { -<a name="l00168"></a><a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f">00168</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f" title="1 if the feature has a timestamp (i.e.">hasTimestamp</a>; -<a name="l00169"></a>00169 -<a name="l00171"></a><a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c">00171</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c" title="Seconds component of timestamp.">sec</a>; -<a name="l00172"></a>00172 -<a name="l00174"></a><a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e">00174</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e" title="Nanoseconds component of timestamp.">nsec</a>; -<a name="l00175"></a>00175 -<a name="l00177"></a><a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd">00177</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd" title="Number of values.">valueCount</a>; +<a name="l00170"></a><a class="code" href="struct__VampOutputDescriptor.html#f792a96dbf292ec966b9b68250febd99">00170</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampOutputDescriptor.html#f792a96dbf292ec966b9b68250febd99" title="1 if the returned results for this output are known to have a duration field.">hasDuration</a>; +<a name="l00171"></a>00171 +<a name="l00172"></a>00172 } <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a>; +<a name="l00173"></a>00173 +<a name="l00174"></a><a class="code" href="struct__VampFeature.html">00174</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeature.html">_VampFeature</a> +<a name="l00175"></a>00175 { +<a name="l00177"></a><a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f">00177</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f" title="1 if the feature has a timestamp (i.e.">hasTimestamp</a>; <a name="l00178"></a>00178 -<a name="l00180"></a><a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15">00180</a> <span class="keywordtype">float</span> *<a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15" title="Values for this returned sample.">values</a>; +<a name="l00180"></a><a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c">00180</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c" title="Seconds component of timestamp.">sec</a>; <a name="l00181"></a>00181 -<a name="l00183"></a><a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd">00183</a> <span class="keywordtype">char</span> *<a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd" title="Label for this returned sample.">label</a>; +<a name="l00183"></a><a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e">00183</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e" title="Nanoseconds component of timestamp.">nsec</a>; <a name="l00184"></a>00184 -<a name="l00185"></a>00185 } <a class="code" href="struct__VampFeature.html">VampFeature</a>; -<a name="l00186"></a>00186 -<a name="l00187"></a><a class="code" href="struct__VampFeatureList.html">00187</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeatureList.html">_VampFeatureList</a> -<a name="l00188"></a>00188 { -<a name="l00190"></a><a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1">00190</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1" title="Number of features in this feature list.">featureCount</a>; -<a name="l00191"></a>00191 -<a name="l00193"></a><a class="code" href="struct__VampFeatureList.html#a2d18873fd5e58354460ea77fc48692f">00193</a> <a class="code" href="struct__VampFeature.html">VampFeature</a> *<a class="code" href="struct__VampFeatureList.html#a2d18873fd5e58354460ea77fc48692f" title="Features in this feature list.">features</a>; -<a name="l00194"></a>00194 -<a name="l00195"></a>00195 } <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a>; -<a name="l00196"></a>00196 -<a name="l00197"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">00197</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> -<a name="l00198"></a>00198 { -<a name="l00199"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">00199</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>, -<a name="l00200"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">00200</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a> -<a name="l00201"></a>00201 -<a name="l00202"></a>00202 } <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a>; +<a name="l00186"></a><a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd">00186</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd" title="Number of values.">valueCount</a>; +<a name="l00187"></a>00187 +<a name="l00189"></a><a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15">00189</a> <span class="keywordtype">float</span> *<a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15" title="Values for this returned sample.">values</a>; +<a name="l00190"></a>00190 +<a name="l00192"></a><a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd">00192</a> <span class="keywordtype">char</span> *<a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd" title="Label for this returned sample.">label</a>; +<a name="l00193"></a>00193 +<a name="l00194"></a>00194 } <a class="code" href="struct__VampFeature.html">VampFeature</a>; +<a name="l00195"></a>00195 +<a name="l00196"></a><a class="code" href="struct__VampFeatureV2.html">00196</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeatureV2.html">_VampFeatureV2</a> +<a name="l00197"></a>00197 { +<a name="l00199"></a><a class="code" href="struct__VampFeatureV2.html#44d9c57f1ae197d3fec1a48c650cce81">00199</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureV2.html#44d9c57f1ae197d3fec1a48c650cce81" title="1 if the feature has a duration.">hasDuration</a>; +<a name="l00200"></a>00200 +<a name="l00202"></a><a class="code" href="struct__VampFeatureV2.html#bc95aac3a2efdef6ef0b17e7b6bd3daf">00202</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureV2.html#bc95aac3a2efdef6ef0b17e7b6bd3daf" title="Seconds component of duratiion.">durationSec</a>; <a name="l00203"></a>00203 -<a name="l00204"></a><a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">00204</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>; -<a name="l00205"></a>00205 -<a name="l00206"></a><a class="code" href="struct__VampPluginDescriptor.html">00206</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> -<a name="l00207"></a>00207 { -<a name="l00209"></a><a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">00209</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2" title="API version with which this descriptor is compatible.">vampApiVersion</a>; -<a name="l00210"></a>00210 -<a name="l00212"></a><a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">00212</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219" title="Computer-usable name of the plugin.">identifier</a>; -<a name="l00213"></a>00213 -<a name="l00215"></a><a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">00215</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150" title="Human-readable name of the plugin.">name</a>; +<a name="l00205"></a><a class="code" href="struct__VampFeatureV2.html#f71693d907f69048d602d28edbce679e">00205</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureV2.html#f71693d907f69048d602d28edbce679e" title="Nanoseconds component of duration.">durationNsec</a>; +<a name="l00206"></a>00206 +<a name="l00207"></a>00207 } <a class="code" href="struct__VampFeatureV2.html">VampFeatureV2</a>; +<a name="l00208"></a>00208 +<a name="l00209"></a><a class="code" href="union__VampFeatureUnion.html">00209</a> <span class="keyword">typedef</span> <span class="keyword">union </span><a class="code" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> +<a name="l00210"></a>00210 { +<a name="l00211"></a>00211 <span class="comment">// sizeof(featureV1) >= sizeof(featureV2) for backward compatibility</span> +<a name="l00212"></a><a class="code" href="union__VampFeatureUnion.html#4a32a2ce141ec3cd36b8be54cd9c3369">00212</a> <a class="code" href="struct__VampFeature.html">VampFeature</a> <a class="code" href="union__VampFeatureUnion.html#4a32a2ce141ec3cd36b8be54cd9c3369">v1</a>; +<a name="l00213"></a><a class="code" href="union__VampFeatureUnion.html#87e508e37e02cce11c3c4ddf087a627a">00213</a> <a class="code" href="struct__VampFeatureV2.html">VampFeatureV2</a> <a class="code" href="union__VampFeatureUnion.html#87e508e37e02cce11c3c4ddf087a627a">v2</a>; +<a name="l00214"></a>00214 +<a name="l00215"></a>00215 } <a class="code" href="union__VampFeatureUnion.html">VampFeatureUnion</a>; <a name="l00216"></a>00216 -<a name="l00218"></a><a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">00218</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e" title="Human-readable short text about the plugin.">description</a>; -<a name="l00219"></a>00219 -<a name="l00221"></a><a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">00221</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b" title="Human-readable name of plugin&#39;s author or vendor.">maker</a>; -<a name="l00222"></a>00222 -<a name="l00224"></a><a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">00224</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae" title="Version number of the plugin.">pluginVersion</a>; -<a name="l00225"></a>00225 -<a name="l00227"></a><a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">00227</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521" title="Human-readable summary of copyright or licensing for plugin.">copyright</a>; -<a name="l00228"></a>00228 -<a name="l00230"></a><a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">00230</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab" title="Number of parameter inputs.">parameterCount</a>; -<a name="l00231"></a>00231 -<a name="l00233"></a><a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">00233</a> <span class="keyword">const</span> <a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">VampParameterDescriptor</a> **<a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913" title="Fixed descriptors for parameter inputs.">parameters</a>; -<a name="l00234"></a>00234 -<a name="l00236"></a><a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">00236</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00" title="Number of programs.">programCount</a>; -<a name="l00237"></a>00237 -<a name="l00239"></a><a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">00239</a> <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec" title="Fixed names for programs.">programs</a>; -<a name="l00240"></a>00240 -<a name="l00242"></a><a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">00242</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4" title="Preferred input domain for audio input (time or frequency).">inputDomain</a>; +<a name="l00217"></a><a class="code" href="struct__VampFeatureList.html">00217</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeatureList.html">_VampFeatureList</a> +<a name="l00218"></a>00218 { +<a name="l00220"></a><a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1">00220</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1" title="Number of features in this feature list.">featureCount</a>; +<a name="l00221"></a>00221 +<a name="l00235"></a><a class="code" href="struct__VampFeatureList.html#103c817094643ac5ff4410768f4f92a7">00235</a> <a class="code" href="union__VampFeatureUnion.html">VampFeatureUnion</a> *<a class="code" href="struct__VampFeatureList.html#103c817094643ac5ff4410768f4f92a7" title="Features in this feature list.">features</a>; +<a name="l00236"></a>00236 +<a name="l00237"></a>00237 } <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a>; +<a name="l00238"></a>00238 +<a name="l00239"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">00239</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> +<a name="l00240"></a>00240 { +<a name="l00241"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">00241</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>, +<a name="l00242"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">00242</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a> <a name="l00243"></a>00243 -<a name="l00245"></a>00245 <a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> (*<a class="code" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee" title="Create and return a new instance of this plugin.">instantiate</a>)(<span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, -<a name="l00246"></a>00246 <span class="keywordtype">float</span> inputSampleRate); +<a name="l00244"></a>00244 } <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a>; +<a name="l00245"></a>00245 +<a name="l00246"></a><a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">00246</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>; <a name="l00247"></a>00247 -<a name="l00249"></a>00249 void (*<a class="code" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27" title="Destroy an instance of this plugin.">cleanup</a>)(VampPluginHandle); -<a name="l00250"></a>00250 -<a name="l00252"></a>00252 int (*<a class="code" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22" title="Initialise an instance following parameter configuration.">initialise</a>)(VampPluginHandle, -<a name="l00253"></a>00253 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inputChannels, -<a name="l00254"></a>00254 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stepSize, -<a name="l00255"></a>00255 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize); -<a name="l00256"></a>00256 -<a name="l00258"></a>00258 void (*<a class="code" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336" title="Reset an instance, ready to use again on new input data.">reset</a>)(VampPluginHandle); -<a name="l00259"></a>00259 -<a name="l00261"></a>00261 float (*<a class="code" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395" title="Get a parameter value.">getParameter</a>)(VampPluginHandle, int); -<a name="l00262"></a>00262 -<a name="l00264"></a>00264 void (*<a class="code" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481" title="Set a parameter value.">setParameter</a>)(VampPluginHandle, int, float); -<a name="l00265"></a>00265 -<a name="l00267"></a>00267 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53" title="Get the current program (if programCount &gt; 0).">getCurrentProgram</a>)(VampPluginHandle); -<a name="l00268"></a>00268 -<a name="l00270"></a>00270 void (*<a class="code" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf" title="Set the current program.">selectProgram</a>)(VampPluginHandle, <span class="keywordtype">unsigned</span> int); -<a name="l00271"></a>00271 -<a name="l00273"></a>00273 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb" title="Get the plugin&#39;s preferred processing window increment in samples.">getPreferredStepSize</a>)(VampPluginHandle); -<a name="l00274"></a>00274 -<a name="l00276"></a>00276 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8" title="Get the plugin&#39;s preferred processing window size in samples.">getPreferredBlockSize</a>)(VampPluginHandle); -<a name="l00277"></a>00277 -<a name="l00279"></a>00279 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92" title="Get the minimum number of input channels this plugin can handle.">getMinChannelCount</a>)(VampPluginHandle); -<a name="l00280"></a>00280 -<a name="l00282"></a>00282 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b" title="Get the maximum number of input channels this plugin can handle.">getMaxChannelCount</a>)(VampPluginHandle); -<a name="l00283"></a>00283 -<a name="l00285"></a>00285 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1" title="Get the number of feature outputs (distinct sets of results).">getOutputCount</a>)(VampPluginHandle); -<a name="l00286"></a>00286 -<a name="l00291"></a>00291 <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *(*getOutputDescriptor)(VampPluginHandle, -<a name="l00292"></a>00292 <span class="keywordtype">unsigned</span> int); -<a name="l00293"></a>00293 -<a name="l00295"></a>00295 void (*<a class="code" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79" title="Destroy a descriptor for a feature output.">releaseOutputDescriptor</a>)(<a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *); -<a name="l00296"></a>00296 -<a name="l00302"></a>00302 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*process)(VampPluginHandle, -<a name="l00303"></a>00303 <span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, -<a name="l00304"></a>00304 <span class="keywordtype">int</span> sec, -<a name="l00305"></a>00305 <span class="keywordtype">int</span> nsec); -<a name="l00306"></a>00306 -<a name="l00308"></a>00308 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*getRemainingFeatures)(VampPluginHandle); -<a name="l00309"></a>00309 -<a name="l00311"></a>00311 void (*<a class="code" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63" title="Release a feature set returned from process or getRemainingFeatures.">releaseFeatureSet</a>)(<a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *); -<a name="l00312"></a>00312 -<a name="l00313"></a>00313 } <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>; -<a name="l00314"></a>00314 -<a name="l00315"></a>00315 -<a name="l00334"></a>00334 <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="vamp_8h.html#50cf6f17d0718f02093be6c7f63fcf30" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> -<a name="l00335"></a>00335 (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hostApiVersion, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index); -<a name="l00336"></a>00336 -<a name="l00337"></a>00337 -<a name="l00339"></a>00339 <span class="keyword">typedef</span> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *(*VampGetPluginDescriptorFunction) -<a name="l00340"></a><a class="code" href="vamp_8h.html#551bb7e0d8c970c2202be5f881817478">00340</a> (<span class="keywordtype">unsigned</span> int, <span class="keywordtype">unsigned</span> int); -<a name="l00341"></a>00341 -<a name="l00342"></a>00342 <span class="preprocessor">#ifdef __cplusplus</span> -<a name="l00343"></a>00343 <span class="preprocessor"></span>} -<a name="l00344"></a>00344 <span class="preprocessor">#endif</span> -<a name="l00345"></a>00345 <span class="preprocessor"></span> -<a name="l00346"></a>00346 <span class="preprocessor">#endif</span> +<a name="l00248"></a><a class="code" href="struct__VampPluginDescriptor.html">00248</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> +<a name="l00249"></a>00249 { +<a name="l00251"></a><a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">00251</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2" title="API version with which this descriptor is compatible.">vampApiVersion</a>; +<a name="l00252"></a>00252 +<a name="l00254"></a><a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">00254</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219" title="Computer-usable name of the plugin.">identifier</a>; +<a name="l00255"></a>00255 +<a name="l00257"></a><a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">00257</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150" title="Human-readable name of the plugin.">name</a>; +<a name="l00258"></a>00258 +<a name="l00260"></a><a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">00260</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e" title="Human-readable short text about the plugin.">description</a>; +<a name="l00261"></a>00261 +<a name="l00263"></a><a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">00263</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b" title="Human-readable name of plugin&#39;s author or vendor.">maker</a>; +<a name="l00264"></a>00264 +<a name="l00266"></a><a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">00266</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae" title="Version number of the plugin.">pluginVersion</a>; +<a name="l00267"></a>00267 +<a name="l00269"></a><a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">00269</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521" title="Human-readable summary of copyright or licensing for plugin.">copyright</a>; +<a name="l00270"></a>00270 +<a name="l00272"></a><a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">00272</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab" title="Number of parameter inputs.">parameterCount</a>; +<a name="l00273"></a>00273 +<a name="l00275"></a><a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">00275</a> <span class="keyword">const</span> <a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">VampParameterDescriptor</a> **<a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913" title="Fixed descriptors for parameter inputs.">parameters</a>; +<a name="l00276"></a>00276 +<a name="l00278"></a><a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">00278</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00" title="Number of programs.">programCount</a>; +<a name="l00279"></a>00279 +<a name="l00281"></a><a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">00281</a> <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec" title="Fixed names for programs.">programs</a>; +<a name="l00282"></a>00282 +<a name="l00284"></a><a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">00284</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4" title="Preferred input domain for audio input (time or frequency).">inputDomain</a>; +<a name="l00285"></a>00285 +<a name="l00287"></a>00287 <a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> (*<a class="code" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee" title="Create and return a new instance of this plugin.">instantiate</a>)(<span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, +<a name="l00288"></a>00288 <span class="keywordtype">float</span> inputSampleRate); +<a name="l00289"></a>00289 +<a name="l00291"></a>00291 void (*<a class="code" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27" title="Destroy an instance of this plugin.">cleanup</a>)(VampPluginHandle); +<a name="l00292"></a>00292 +<a name="l00294"></a>00294 int (*<a class="code" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22" title="Initialise an instance following parameter configuration.">initialise</a>)(VampPluginHandle, +<a name="l00295"></a>00295 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inputChannels, +<a name="l00296"></a>00296 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stepSize, +<a name="l00297"></a>00297 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize); +<a name="l00298"></a>00298 +<a name="l00300"></a>00300 void (*<a class="code" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336" title="Reset an instance, ready to use again on new input data.">reset</a>)(VampPluginHandle); +<a name="l00301"></a>00301 +<a name="l00303"></a>00303 float (*<a class="code" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395" title="Get a parameter value.">getParameter</a>)(VampPluginHandle, int); +<a name="l00304"></a>00304 +<a name="l00306"></a>00306 void (*<a class="code" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481" title="Set a parameter value.">setParameter</a>)(VampPluginHandle, int, float); +<a name="l00307"></a>00307 +<a name="l00309"></a>00309 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53" title="Get the current program (if programCount &gt; 0).">getCurrentProgram</a>)(VampPluginHandle); +<a name="l00310"></a>00310 +<a name="l00312"></a>00312 void (*<a class="code" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf" title="Set the current program.">selectProgram</a>)(VampPluginHandle, <span class="keywordtype">unsigned</span> int); +<a name="l00313"></a>00313 +<a name="l00315"></a>00315 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb" title="Get the plugin&#39;s preferred processing window increment in samples.">getPreferredStepSize</a>)(VampPluginHandle); +<a name="l00316"></a>00316 +<a name="l00318"></a>00318 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8" title="Get the plugin&#39;s preferred processing window size in samples.">getPreferredBlockSize</a>)(VampPluginHandle); +<a name="l00319"></a>00319 +<a name="l00321"></a>00321 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92" title="Get the minimum number of input channels this plugin can handle.">getMinChannelCount</a>)(VampPluginHandle); +<a name="l00322"></a>00322 +<a name="l00324"></a>00324 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b" title="Get the maximum number of input channels this plugin can handle.">getMaxChannelCount</a>)(VampPluginHandle); +<a name="l00325"></a>00325 +<a name="l00327"></a>00327 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1" title="Get the number of feature outputs (distinct sets of results).">getOutputCount</a>)(VampPluginHandle); +<a name="l00328"></a>00328 +<a name="l00333"></a>00333 <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *(*getOutputDescriptor)(VampPluginHandle, +<a name="l00334"></a>00334 <span class="keywordtype">unsigned</span> int); +<a name="l00335"></a>00335 +<a name="l00337"></a>00337 void (*<a class="code" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79" title="Destroy a descriptor for a feature output.">releaseOutputDescriptor</a>)(<a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *); +<a name="l00338"></a>00338 +<a name="l00344"></a>00344 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*process)(VampPluginHandle, +<a name="l00345"></a>00345 <span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, +<a name="l00346"></a>00346 <span class="keywordtype">int</span> sec, +<a name="l00347"></a>00347 <span class="keywordtype">int</span> nsec); +<a name="l00348"></a>00348 +<a name="l00350"></a>00350 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*getRemainingFeatures)(VampPluginHandle); +<a name="l00351"></a>00351 +<a name="l00353"></a>00353 void (*<a class="code" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63" title="Release a feature set returned from process or getRemainingFeatures.">releaseFeatureSet</a>)(<a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *); +<a name="l00354"></a>00354 +<a name="l00355"></a>00355 } <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>; +<a name="l00356"></a>00356 +<a name="l00357"></a>00357 +<a name="l00376"></a>00376 <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="vamp_8h.html#50cf6f17d0718f02093be6c7f63fcf30" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> +<a name="l00377"></a>00377 (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hostApiVersion, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index); +<a name="l00378"></a>00378 +<a name="l00379"></a>00379 +<a name="l00381"></a>00381 <span class="keyword">typedef</span> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *(*VampGetPluginDescriptorFunction) +<a name="l00382"></a><a class="code" href="vamp_8h.html#551bb7e0d8c970c2202be5f881817478">00382</a> (<span class="keywordtype">unsigned</span> int, <span class="keywordtype">unsigned</span> int); +<a name="l00383"></a>00383 +<a name="l00384"></a>00384 <span class="preprocessor">#ifdef __cplusplus</span> +<a name="l00385"></a>00385 <span class="preprocessor"></span>} +<a name="l00386"></a>00386 <span class="preprocessor">#endif</span> +<a name="l00387"></a>00387 <span class="preprocessor"></span> +<a name="l00388"></a>00388 <span class="preprocessor">#endif</span> </pre></div></div> -<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>