Mercurial > hg > vamp-docs

comparison code-docs/vamp_8h.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
5 <title>VampPluginSDK: vamp.h File Reference</title> 6 <title>VampPluginSDK: vamp.h File Reference</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li> 49 <li><a href="annotated.html"><span>Classes</span></a></li>
77 <a href="#typedef-members">Typedefs</a> &#124; 78 <a href="#typedef-members">Typedefs</a> &#124;
78 <a href="#enum-members">Enumerations</a> &#124; 79 <a href="#enum-members">Enumerations</a> &#124;
79 <a href="#func-members">Functions</a> </div> 80 <a href="#func-members">Functions</a> </div>
80 <div class="headertitle"> 81 <div class="headertitle">
81 <div class="title">vamp.h File Reference</div> </div> 82 <div class="title">vamp.h File Reference</div> </div>
82 </div> 83 </div><!--header-->
83 <div class="contents"> 84 <div class="contents">
84 85
85 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p> 86 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p>
86 <table class="memberdecls"> 87 <table class="memberdecls">
87 <tr><td colspan="2"><h2><a name="nested-classes"></a> 88 <tr><td colspan="2"><h2><a name="nested-classes"></a>
88 Classes</h2></td></tr> 89 Classes</h2></td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td></tr> 90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td></tr>
90 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="struct__VampParameterDescriptor.html#details">More...</a><br/></td></tr> 91 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="struct__VampParameterDescriptor.html#details">More...</a><br/></td></tr>
91 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td></tr> 92 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td></tr>
92 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td></tr> 93 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td></tr> 94 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td></tr>
94 <tr><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td></tr> 95 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td></tr> 96 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td></tr> 97 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td></tr>
97 <tr><td colspan="2"><h2><a name="define-members"></a> 98 <tr><td colspan="2"><h2><a name="define-members"></a>
98 Defines</h2></td></tr> 99 Defines</h2></td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td></tr> 100 <tr class="memitem:a6d6c8c755dbabf161f72712e0e2143c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td></tr>
100 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7"></a><br/></td></tr> 101 <tr class="memdesc:a6d6c8c755dbabf161f72712e0e2143c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7"></a><br/></td></tr>
101 <tr><td colspan="2"><h2><a name="typedef-members"></a> 102 <tr><td colspan="2"><h2><a name="typedef-members"></a>
102 Typedefs</h2></td></tr> 103 Typedefs</h2></td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 104 <tr class="memitem:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
104 <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td></tr> 105 <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td></tr>
105 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="#ae26a9d54a92f1c083a1b209a25a8e44e"></a><br/></td></tr> 106 <tr class="memdesc:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="#ae26a9d54a92f1c083a1b209a25a8e44e"></a><br/></td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 107 <tr class="memitem:aa8429dd9c60d65800c58574c2b06bf66"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
107 <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td></tr> 108 <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td></tr>
108 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td></tr> 109 <tr class="memitem:a8d04355c13e5ff7a146abcb168cb919f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td></tr> 110 <tr class="memitem:a41cb3518127d0971b1d2c8edfbbe2763"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td></tr>
110 <tr><td class="memItemLeft" align="right" valign="top">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td></tr> 111 <tr class="memitem:a2517349f1c97e0c59faab6085e092fcd"><td class="memItemLeft" align="right" valign="top">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td></tr>
111 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td></tr> 112 <tr class="memitem:a5f257e3f8b5ca1ca4c159d486e219078"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td></tr>
112 <tr><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td></tr> 113 <tr class="memitem:ad3be2952b1f4ad7d775940a6db75c79b"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td></tr>
113 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 114 <tr class="memitem:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
114 <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td></tr> 115 <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td></tr>
115 <tr><td class="memItemLeft" align="right" valign="top">typedef const <br class="typebreak"/> 116 <tr class="memitem:a551bb7e0d8c970c2202be5f881817478"><td class="memItemLeft" align="right" valign="top">typedef const <br class="typebreak"/>
116 <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a> )(unsigned int, unsigned int)</td></tr> 117 <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a> )(unsigned int, unsigned int)</td></tr>
117 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#a551bb7e0d8c970c2202be5f881817478"></a><br/></td></tr> 118 <tr class="memdesc:a551bb7e0d8c970c2202be5f881817478"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#a551bb7e0d8c970c2202be5f881817478"></a><br/></td></tr>
118 <tr><td colspan="2"><h2><a name="enum-members"></a> 119 <tr><td colspan="2"><h2><a name="enum-members"></a>
119 Enumerations</h2></td></tr> 120 Enumerations</h2></td></tr>
120 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> { <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113">vampOneSamplePerStep</a>, 121 <tr class="memitem:aa24a8cee023d8b7659d25cbe0584b821"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> { <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113">vampOneSamplePerStep</a>,
121 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>, 122 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>,
122 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a> 123 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a>
123 }</td></tr> 124 }</td></tr>
124 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> { <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>, 125 <tr class="memitem:ab107386a5f042feddf6446bea23bb765"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> { <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>,
125 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a> 126 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
126 }</td></tr> 127 }</td></tr>
127 <tr><td colspan="2"><h2><a name="func-members"></a> 128 <tr><td colspan="2"><h2><a name="func-members"></a>
128 Functions</h2></td></tr> 129 Functions</h2></td></tr>
129 <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a50cf6f17d0718f02093be6c7f63fcf30">vampGetPluginDescriptor</a> (unsigned int hostApiVersion, unsigned int index)</td></tr> 130 <tr class="memitem:a50cf6f17d0718f02093be6c7f63fcf30"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a50cf6f17d0718f02093be6c7f63fcf30">vampGetPluginDescriptor</a> (unsigned int hostApiVersion, unsigned int index)</td></tr>
130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#a50cf6f17d0718f02093be6c7f63fcf30"></a><br/></td></tr> 131 <tr class="memdesc:a50cf6f17d0718f02093be6c7f63fcf30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#a50cf6f17d0718f02093be6c7f63fcf30"></a><br/></td></tr>
131 </table> 132 </table>
132 <hr/><h2>Define Documentation</h2> 133 <hr/><h2>Define Documentation</h2>
133 <a class="anchor" id="a6d6c8c755dbabf161f72712e0e2143c7"></a><!-- doxytag: member="vamp.h::VAMP_API_VERSION" ref="a6d6c8c755dbabf161f72712e0e2143c7" args="" --> 134 <a class="anchor" id="a6d6c8c755dbabf161f72712e0e2143c7"></a>
134 <div class="memitem"> 135 <div class="memitem">
135 <div class="memproto"> 136 <div class="memproto">
136 <table class="memname"> 137 <table class="memname">
137 <tr> 138 <tr>
138 <td class="memname">#define VAMP_API_VERSION&#160;&#160;&#160;2</td> 139 <td class="memname">#define <a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td>
139 </tr> 140 </tr>
140 </table> 141 </table>
141 </div> 142 </div>
142 <div class="memdoc"> 143 <div class="memdoc">
143 144
150 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00137">main()</a>.</p> 151 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00137">main()</a>.</p>
151 152
152 </div> 153 </div>
153 </div> 154 </div>
154 <hr/><h2>Typedef Documentation</h2> 155 <hr/><h2>Typedef Documentation</h2>
155 <a class="anchor" id="ae26a9d54a92f1c083a1b209a25a8e44e"></a><!-- doxytag: member="vamp.h::VampParameterDescriptor" ref="ae26a9d54a92f1c083a1b209a25a8e44e" args="" --> 156 <a class="anchor" id="ae26a9d54a92f1c083a1b209a25a8e44e"></a>
156 <div class="memitem"> 157 <div class="memitem">
157 <div class="memproto"> 158 <div class="memproto">
158 <table class="memname"> 159 <table class="memname">
159 <tr> 160 <tr>
160 <td class="memname">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td> 161 <td class="memname">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td>
167 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p> 168 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p>
168 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p> 169 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p>
169 170
170 </div> 171 </div>
171 </div> 172 </div>
172 <a class="anchor" id="aa8429dd9c60d65800c58574c2b06bf66"></a><!-- doxytag: member="vamp.h::VampOutputDescriptor" ref="aa8429dd9c60d65800c58574c2b06bf66" args="" --> 173 <a class="anchor" id="aa8429dd9c60d65800c58574c2b06bf66"></a>
173 <div class="memitem"> 174 <div class="memitem">
174 <div class="memproto"> 175 <div class="memproto">
175 <table class="memname"> 176 <table class="memname">
176 <tr> 177 <tr>
177 <td class="memname">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a> <a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td> 178 <td class="memname">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a> <a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td>
180 </div> 181 </div>
181 <div class="memdoc"> 182 <div class="memdoc">
182 183
183 </div> 184 </div>
184 </div> 185 </div>
185 <a class="anchor" id="a8d04355c13e5ff7a146abcb168cb919f"></a><!-- doxytag: member="vamp.h::VampFeature" ref="a8d04355c13e5ff7a146abcb168cb919f" args="" --> 186 <a class="anchor" id="a8d04355c13e5ff7a146abcb168cb919f"></a>
186 <div class="memitem"> 187 <div class="memitem">
187 <div class="memproto"> 188 <div class="memproto">
188 <table class="memname"> 189 <table class="memname">
189 <tr> 190 <tr>
190 <td class="memname">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a> <a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td> 191 <td class="memname">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a> <a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td>
193 </div> 194 </div>
194 <div class="memdoc"> 195 <div class="memdoc">
195 196
196 </div> 197 </div>
197 </div> 198 </div>
198 <a class="anchor" id="a41cb3518127d0971b1d2c8edfbbe2763"></a><!-- doxytag: member="vamp.h::VampFeatureV2" ref="a41cb3518127d0971b1d2c8edfbbe2763" args="" --> 199 <a class="anchor" id="a41cb3518127d0971b1d2c8edfbbe2763"></a>
199 <div class="memitem"> 200 <div class="memitem">
200 <div class="memproto"> 201 <div class="memproto">
201 <table class="memname"> 202 <table class="memname">
202 <tr> 203 <tr>
203 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a> <a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td> 204 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a> <a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td>
206 </div> 207 </div>
207 <div class="memdoc"> 208 <div class="memdoc">
208 209
209 </div> 210 </div>
210 </div> 211 </div>
211 <a class="anchor" id="a2517349f1c97e0c59faab6085e092fcd"></a><!-- doxytag: member="vamp.h::VampFeatureUnion" ref="a2517349f1c97e0c59faab6085e092fcd" args="" --> 212 <a class="anchor" id="a2517349f1c97e0c59faab6085e092fcd"></a>
212 <div class="memitem"> 213 <div class="memitem">
213 <div class="memproto"> 214 <div class="memproto">
214 <table class="memname"> 215 <table class="memname">
215 <tr> 216 <tr>
216 <td class="memname">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> <a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td> 217 <td class="memname">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> <a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td>
219 </div> 220 </div>
220 <div class="memdoc"> 221 <div class="memdoc">
221 222
222 </div> 223 </div>
223 </div> 224 </div>
224 <a class="anchor" id="a5f257e3f8b5ca1ca4c159d486e219078"></a><!-- doxytag: member="vamp.h::VampFeatureList" ref="a5f257e3f8b5ca1ca4c159d486e219078" args="" --> 225 <a class="anchor" id="a5f257e3f8b5ca1ca4c159d486e219078"></a>
225 <div class="memitem"> 226 <div class="memitem">
226 <div class="memproto"> 227 <div class="memproto">
227 <table class="memname"> 228 <table class="memname">
228 <tr> 229 <tr>
229 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> <a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td> 230 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> <a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td>
232 </div> 233 </div>
233 <div class="memdoc"> 234 <div class="memdoc">
234 235
235 </div> 236 </div>
236 </div> 237 </div>
237 <a class="anchor" id="ad3be2952b1f4ad7d775940a6db75c79b"></a><!-- doxytag: member="vamp.h::VampPluginHandle" ref="ad3be2952b1f4ad7d775940a6db75c79b" args="" --> 238 <a class="anchor" id="ad3be2952b1f4ad7d775940a6db75c79b"></a>
238 <div class="memitem"> 239 <div class="memitem">
239 <div class="memproto"> 240 <div class="memproto">
240 <table class="memname"> 241 <table class="memname">
241 <tr> 242 <tr>
242 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td> 243 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td>
247 248
248 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00246">246</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 249 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00246">246</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
249 250
250 </div> 251 </div>
251 </div> 252 </div>
252 <a class="anchor" id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a><!-- doxytag: member="vamp.h::VampPluginDescriptor" ref="aa1d6e0792099b9516a89b5fb7ed2ad2b" args="" --> 253 <a class="anchor" id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a>
253 <div class="memitem"> 254 <div class="memitem">
254 <div class="memproto"> 255 <div class="memproto">
255 <table class="memname"> 256 <table class="memname">
256 <tr> 257 <tr>
257 <td class="memname">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td> 258 <td class="memname">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td>
260 </div> 261 </div>
261 <div class="memdoc"> 262 <div class="memdoc">
262 263
263 </div> 264 </div>
264 </div> 265 </div>
265 <a class="anchor" id="a551bb7e0d8c970c2202be5f881817478"></a><!-- doxytag: member="vamp.h::VampGetPluginDescriptorFunction" ref="a551bb7e0d8c970c2202be5f881817478" args=")(unsigned int, unsigned int)" --> 266 <a class="anchor" id="a551bb7e0d8c970c2202be5f881817478"></a>
266 <div class="memitem"> 267 <div class="memitem">
267 <div class="memproto"> 268 <div class="memproto">
268 <table class="memname"> 269 <table class="memname">
269 <tr> 270 <tr>
270 <td class="memname">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>*(* <a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a>)(unsigned int, unsigned int)</td> 271 <td class="memname">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>*(* <a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a>)(unsigned int, unsigned int)</td>
278 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00382">382</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 279 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00382">382</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
279 280
280 </div> 281 </div>
281 </div> 282 </div>
282 <hr/><h2>Enumeration Type Documentation</h2> 283 <hr/><h2>Enumeration Type Documentation</h2>
283 <a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821"></a><!-- doxytag: member="vamp.h::VampSampleType" ref="aa24a8cee023d8b7659d25cbe0584b821" args="" --> 284 <a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821"></a>
284 <div class="memitem"> 285 <div class="memitem">
285 <div class="memproto"> 286 <div class="memproto">
286 <table class="memname"> 287 <table class="memname">
287 <tr> 288 <tr>
288 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td> 289 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td>
289 </tr> 290 </tr>
290 </table> 291 </table>
291 </div> 292 </div>
292 <div class="memdoc"> 293 <div class="memdoc">
293 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 294 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
294 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a><!-- doxytag: member="vampOneSamplePerStep" ref="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113" args="" -->vampOneSamplePerStep</em>&nbsp;</td><td> 295 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a>vampOneSamplePerStep</em>&nbsp;</td><td>
295 <p>Each process call returns results aligned with call's block start. </p> 296 <p>Each process call returns results aligned with call's block start. </p>
296 </td></tr> 297 </td></tr>
297 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a><!-- doxytag: member="vampFixedSampleRate" ref="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8" args="" -->vampFixedSampleRate</em>&nbsp;</td><td> 298 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a>vampFixedSampleRate</em>&nbsp;</td><td>
298 <p>Returned results are evenly spaced at samplerate specified below. </p> 299 <p>Returned results are evenly spaced at samplerate specified below. </p>
299 </td></tr> 300 </td></tr>
300 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a><!-- doxytag: member="vampVariableSampleRate" ref="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8" args="" -->vampVariableSampleRate</em>&nbsp;</td><td> 301 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a>vampVariableSampleRate</em>&nbsp;</td><td>
301 <p>Returned results have their own individual timestamps. </p> 302 <p>Returned results have their own individual timestamps. </p>
302 </td></tr> 303 </td></tr>
303 </table> 304 </table>
304 </dd> 305 </dd>
305 </dl> 306 </dl>
306 307
307 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00105">105</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 308 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00105">105</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
308 309
309 </div> 310 </div>
310 </div> 311 </div>
311 <a class="anchor" id="ab107386a5f042feddf6446bea23bb765"></a><!-- doxytag: member="vamp.h::VampInputDomain" ref="ab107386a5f042feddf6446bea23bb765" args="" --> 312 <a class="anchor" id="ab107386a5f042feddf6446bea23bb765"></a>
312 <div class="memitem"> 313 <div class="memitem">
313 <div class="memproto"> 314 <div class="memproto">
314 <table class="memname"> 315 <table class="memname">
315 <tr> 316 <tr>
316 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td> 317 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td>
317 </tr> 318 </tr>
318 </table> 319 </table>
319 </div> 320 </div>
320 <div class="memdoc"> 321 <div class="memdoc">
321 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 322 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
322 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a><!-- doxytag: member="vampTimeDomain" ref="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1" args="" -->vampTimeDomain</em>&nbsp;</td><td> 323 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a>vampTimeDomain</em>&nbsp;</td><td>
323 </td></tr> 324 </td></tr>
324 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a><!-- doxytag: member="vampFrequencyDomain" ref="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d" args="" -->vampFrequencyDomain</em>&nbsp;</td><td> 325 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a>vampFrequencyDomain</em>&nbsp;</td><td>
325 </td></tr> 326 </td></tr>
326 </table> 327 </table>
327 </dd> 328 </dd>
328 </dl> 329 </dl>
329 330
330 <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> 331 <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>
331 332
332 </div> 333 </div>
333 </div> 334 </div>
334 <hr/><h2>Function Documentation</h2> 335 <hr/><h2>Function Documentation</h2>
335 <a class="anchor" id="a50cf6f17d0718f02093be6c7f63fcf30"></a><!-- doxytag: member="vamp.h::vampGetPluginDescriptor" ref="a50cf6f17d0718f02093be6c7f63fcf30" args="(unsigned int hostApiVersion, unsigned int index)" --> 336 <a class="anchor" id="a50cf6f17d0718f02093be6c7f63fcf30"></a>
336 <div class="memitem"> 337 <div class="memitem">
337 <div class="memproto"> 338 <div class="memproto">
338 <table class="memname"> 339 <table class="memname">
339 <tr> 340 <tr>
340 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td> 341 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> </td>
341 <td>(</td> 342 <td>(</td>
342 <td class="paramtype">unsigned int&#160;</td> 343 <td class="paramtype">unsigned int&#160;</td>
343 <td class="paramname"><em>hostApiVersion</em>, </td> 344 <td class="paramname"><em>hostApiVersion</em>, </td>
344 </tr> 345 </tr>
345 <tr> 346 <tr>
366 367
367 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p> 368 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
368 369
369 </div> 370 </div>
370 </div> 371 </div>
371 </div> 372 </div><!-- contents -->
372 </div> 373 </div>
373 <div id="nav-path" class="navpath"> 374 <div id="nav-path" class="navpath">
374 <ul> 375 <ul>
375 <li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a> </li> 376 <li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a> </li>
376 377
377 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by 378 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
378 <a href="http://www.doxygen.org/index.html"> 379 <a href="http://www.doxygen.org/index.html">
379 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 380 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
380 </ul> 381 </ul>
381 </div> 382 </div>
382 383
383 384
384 </body> 385 </body>