Mercurial > hg > vamp-docs

annotate code-docs/vamp_8h.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: vamp.h File Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('vamp_8h.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#nested-classes">Classes</a> &#124;
Chris@6 64 <a href="#define-members">Macros</a> &#124;
Chris@1 65 <a href="#typedef-members">Typedefs</a> &#124;
Chris@1 66 <a href="#enum-members">Enumerations</a> &#124;
Chris@1 67 <a href="#func-members">Functions</a> </div>
Chris@1 68 <div class="headertitle">
Chris@1 69 <div class="title">vamp.h File Reference</div> </div>
Chris@3 70 </div><!--header-->
Chris@1 71 <div class="contents">
Chris@6 72 <div class="textblock"><div class="dynheader">
Chris@6 73 This graph shows which files directly or indirectly include this file:</div>
Chris@6 74 <div class="dyncontent">
Chris@6 75 <div class="center"><img src="vamp_8h__dep__incl.png" border="0" usemap="#vamp_8hdep" alt=""/></div>
Chris@6 76 <map name="vamp_8hdep" id="vamp_8hdep">
Chris@6 77 <area shape="rect" id="node2" href="PluginAdapter_8h.html" title="PluginAdapter.h" alt="" coords="5,79,113,104"/>
Chris@6 78 <area shape="rect" id="node3" href="plugins_8cpp.html" title="plugins.cpp" alt="" coords="66,152,151,177"/>
Chris@6 79 <area shape="rect" id="node4" href="host-c_8h.html" title="host&#45;c.h" alt="" coords="189,79,255,104"/>
Chris@6 80 <area shape="rect" id="node5" href="PluginHostAdapter_8h.html" title="PluginHostAdapter.h" alt="" coords="279,79,413,104"/>
Chris@6 81 <area shape="rect" id="node6" href="vamp-hostsdk_8h.html" title="vamp&#45;hostsdk.h" alt="" coords="181,152,292,177"/>
Chris@6 82 <area shape="rect" id="node7" href="vamp-simple-host_8cpp.html" title="vamp&#45;simple&#45;host.cpp" alt="" coords="316,152,461,177"/>
Chris@6 83 </map>
Chris@6 84 </div>
Chris@6 85 </div>
Chris@1 86 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p>
Chris@1 87 <table class="memberdecls">
Chris@6 88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Chris@1 89 Classes</h2></td></tr>
Chris@3 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>
Chris@6 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>
Chris@6 92 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 93 <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>
Chris@6 94 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 95 <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>
Chris@6 96 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 97 <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>
Chris@6 98 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 99 <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>
Chris@6 100 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 101 <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>
Chris@6 102 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 103 <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>
Chris@6 104 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 105 </table><table class="memberdecls">
Chris@6 106 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Chris@6 107 Macros</h2></td></tr>
Chris@3 108 <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>
Chris@6 109 <tr class="memdesc:a6d6c8c755dbabf161f72712e0e2143c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7">More...</a><br /></td></tr>
Chris@6 110 <tr class="separator:a6d6c8c755dbabf161f72712e0e2143c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 111 </table><table class="memberdecls">
Chris@6 112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Chris@1 113 Typedefs</h2></td></tr>
Chris@6 114 <tr class="memitem:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memItemLeft" align="right" valign="top">typedef struct <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>
Chris@6 115 <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">More...</a><br /></td></tr>
Chris@6 116 <tr class="separator:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 117 <tr class="memitem:aa8429dd9c60d65800c58574c2b06bf66"><td class="memItemLeft" align="right" valign="top">typedef struct <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>
Chris@6 118 <tr class="separator:aa8429dd9c60d65800c58574c2b06bf66"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 119 <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>
Chris@6 120 <tr class="separator:a8d04355c13e5ff7a146abcb168cb919f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 121 <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>
Chris@6 122 <tr class="separator:a41cb3518127d0971b1d2c8edfbbe2763"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 123 <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>
Chris@6 124 <tr class="separator:a2517349f1c97e0c59faab6085e092fcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 125 <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>
Chris@6 126 <tr class="separator:a5f257e3f8b5ca1ca4c159d486e219078"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 127 <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>
Chris@6 128 <tr class="separator:ad3be2952b1f4ad7d775940a6db75c79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 129 <tr class="memitem:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memItemLeft" align="right" valign="top">typedef struct <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>
Chris@6 130 <tr class="separator:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 131 <tr class="memitem:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="memItemLeft" align="right" valign="top">typedef 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#afb59eb6e4ea5b47fc300435e98e8aa1b">VampGetPluginDescriptorFunction</a>) (unsigned int, unsigned int)</td></tr>
Chris@6 132 <tr class="memdesc:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#afb59eb6e4ea5b47fc300435e98e8aa1b">More...</a><br /></td></tr>
Chris@6 133 <tr class="separator:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 134 </table><table class="memberdecls">
Chris@6 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Chris@1 136 Enumerations</h2></td></tr>
Chris@3 137 <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>,
Chris@1 138 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>,
Chris@1 139 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a>
Chris@1 140 }</td></tr>
Chris@6 141 <tr class="separator:aa24a8cee023d8b7659d25cbe0584b821"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 142 <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>,
Chris@1 143 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
Chris@1 144 }</td></tr>
Chris@6 145 <tr class="separator:ab107386a5f042feddf6446bea23bb765"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 146 </table><table class="memberdecls">
Chris@6 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Chris@1 148 Functions</h2></td></tr>
Chris@3 149 <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>
Chris@6 150 <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">More...</a><br /></td></tr>
Chris@6 151 <tr class="separator:a50cf6f17d0718f02093be6c7f63fcf30"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 152 </table>
Chris@6 153 <h2 class="groupheader">Macro Definition Documentation</h2>
Chris@6 154 <a id="a6d6c8c755dbabf161f72712e0e2143c7"></a>
Chris@6 155 <h2 class="memtitle"><span class="permalink"><a href="#a6d6c8c755dbabf161f72712e0e2143c7">&#9670;&nbsp;</a></span>VAMP_API_VERSION</h2>
Chris@6 156
Chris@1 157 <div class="memitem">
Chris@1 158 <div class="memproto">
Chris@1 159 <table class="memname">
Chris@1 160 <tr>
Chris@6 161 <td class="memname">#define VAMP_API_VERSION&#160;&#160;&#160;2</td>
Chris@1 162 </tr>
Chris@1 163 </table>
Chris@6 164 </div><div class="memdoc">
Chris@1 165
Chris@1 166 <p>Plugin API version. </p>
Chris@1 167 <p>This is incremented when a change is made that changes the binary layout of the descriptor records. When this happens, there should be a mechanism for retaining compatibility with older hosts and/or plugins.</p>
Chris@1 168 <p>See also the vampApiVersion field in the plugin descriptor, and the hostApiVersion argument to the vampGetPluginDescriptor function. </p>
Chris@1 169
Chris@6 170 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00053">53</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 171
Chris@6 172 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00140">main()</a>.</p>
Chris@1 173
Chris@1 174 </div>
Chris@1 175 </div>
Chris@6 176 <h2 class="groupheader">Typedef Documentation</h2>
Chris@6 177 <a id="ae26a9d54a92f1c083a1b209a25a8e44e"></a>
Chris@6 178 <h2 class="memtitle"><span class="permalink"><a href="#ae26a9d54a92f1c083a1b209a25a8e44e">&#9670;&nbsp;</a></span>VampParameterDescriptor</h2>
Chris@6 179
Chris@1 180 <div class="memitem">
Chris@1 181 <div class="memproto">
Chris@1 182 <table class="memname">
Chris@1 183 <tr>
Chris@1 184 <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>
Chris@1 185 </tr>
Chris@1 186 </table>
Chris@6 187 </div><div class="memdoc">
Chris@1 188
Chris@1 189 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
Chris@1 190 <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>
Chris@1 191 <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>
Chris@1 192
Chris@1 193 </div>
Chris@1 194 </div>
Chris@6 195 <a id="aa8429dd9c60d65800c58574c2b06bf66"></a>
Chris@6 196 <h2 class="memtitle"><span class="permalink"><a href="#aa8429dd9c60d65800c58574c2b06bf66">&#9670;&nbsp;</a></span>VampOutputDescriptor</h2>
Chris@6 197
Chris@1 198 <div class="memitem">
Chris@1 199 <div class="memproto">
Chris@1 200 <table class="memname">
Chris@1 201 <tr>
Chris@1 202 <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>
Chris@1 203 </tr>
Chris@1 204 </table>
Chris@6 205 </div><div class="memdoc">
Chris@1 206
Chris@1 207 </div>
Chris@1 208 </div>
Chris@6 209 <a id="a8d04355c13e5ff7a146abcb168cb919f"></a>
Chris@6 210 <h2 class="memtitle"><span class="permalink"><a href="#a8d04355c13e5ff7a146abcb168cb919f">&#9670;&nbsp;</a></span>VampFeature</h2>
Chris@6 211
Chris@1 212 <div class="memitem">
Chris@1 213 <div class="memproto">
Chris@1 214 <table class="memname">
Chris@1 215 <tr>
Chris@1 216 <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>
Chris@1 217 </tr>
Chris@1 218 </table>
Chris@6 219 </div><div class="memdoc">
Chris@1 220
Chris@1 221 </div>
Chris@1 222 </div>
Chris@6 223 <a id="a41cb3518127d0971b1d2c8edfbbe2763"></a>
Chris@6 224 <h2 class="memtitle"><span class="permalink"><a href="#a41cb3518127d0971b1d2c8edfbbe2763">&#9670;&nbsp;</a></span>VampFeatureV2</h2>
Chris@6 225
Chris@1 226 <div class="memitem">
Chris@1 227 <div class="memproto">
Chris@1 228 <table class="memname">
Chris@1 229 <tr>
Chris@1 230 <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>
Chris@1 231 </tr>
Chris@1 232 </table>
Chris@6 233 </div><div class="memdoc">
Chris@1 234
Chris@1 235 </div>
Chris@1 236 </div>
Chris@6 237 <a id="a2517349f1c97e0c59faab6085e092fcd"></a>
Chris@6 238 <h2 class="memtitle"><span class="permalink"><a href="#a2517349f1c97e0c59faab6085e092fcd">&#9670;&nbsp;</a></span>VampFeatureUnion</h2>
Chris@6 239
Chris@1 240 <div class="memitem">
Chris@1 241 <div class="memproto">
Chris@1 242 <table class="memname">
Chris@1 243 <tr>
Chris@1 244 <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>
Chris@1 245 </tr>
Chris@1 246 </table>
Chris@6 247 </div><div class="memdoc">
Chris@1 248
Chris@1 249 </div>
Chris@1 250 </div>
Chris@6 251 <a id="a5f257e3f8b5ca1ca4c159d486e219078"></a>
Chris@6 252 <h2 class="memtitle"><span class="permalink"><a href="#a5f257e3f8b5ca1ca4c159d486e219078">&#9670;&nbsp;</a></span>VampFeatureList</h2>
Chris@6 253
Chris@1 254 <div class="memitem">
Chris@1 255 <div class="memproto">
Chris@1 256 <table class="memname">
Chris@1 257 <tr>
Chris@1 258 <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>
Chris@1 259 </tr>
Chris@1 260 </table>
Chris@6 261 </div><div class="memdoc">
Chris@1 262
Chris@1 263 </div>
Chris@1 264 </div>
Chris@6 265 <a id="ad3be2952b1f4ad7d775940a6db75c79b"></a>
Chris@6 266 <h2 class="memtitle"><span class="permalink"><a href="#ad3be2952b1f4ad7d775940a6db75c79b">&#9670;&nbsp;</a></span>VampPluginHandle</h2>
Chris@6 267
Chris@1 268 <div class="memitem">
Chris@1 269 <div class="memproto">
Chris@1 270 <table class="memname">
Chris@1 271 <tr>
Chris@1 272 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td>
Chris@1 273 </tr>
Chris@1 274 </table>
Chris@6 275 </div><div class="memdoc">
Chris@1 276
Chris@6 277 <p class="definition">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>
Chris@1 278
Chris@1 279 </div>
Chris@1 280 </div>
Chris@6 281 <a id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a>
Chris@6 282 <h2 class="memtitle"><span class="permalink"><a href="#aa1d6e0792099b9516a89b5fb7ed2ad2b">&#9670;&nbsp;</a></span>VampPluginDescriptor</h2>
Chris@6 283
Chris@1 284 <div class="memitem">
Chris@1 285 <div class="memproto">
Chris@1 286 <table class="memname">
Chris@1 287 <tr>
Chris@1 288 <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>
Chris@1 289 </tr>
Chris@1 290 </table>
Chris@6 291 </div><div class="memdoc">
Chris@1 292
Chris@1 293 </div>
Chris@1 294 </div>
Chris@6 295 <a id="afb59eb6e4ea5b47fc300435e98e8aa1b"></a>
Chris@6 296 <h2 class="memtitle"><span class="permalink"><a href="#afb59eb6e4ea5b47fc300435e98e8aa1b">&#9670;&nbsp;</a></span>VampGetPluginDescriptorFunction</h2>
Chris@6 297
Chris@1 298 <div class="memitem">
Chris@1 299 <div class="memproto">
Chris@1 300 <table class="memname">
Chris@1 301 <tr>
Chris@6 302 <td class="memname">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>*(* VampGetPluginDescriptorFunction) (unsigned int, unsigned int)</td>
Chris@1 303 </tr>
Chris@1 304 </table>
Chris@6 305 </div><div class="memdoc">
Chris@1 306
Chris@1 307 <p>Function pointer type for vampGetPluginDescriptor. </p>
Chris@1 308
Chris@6 309 <p class="definition">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>
Chris@1 310
Chris@1 311 </div>
Chris@1 312 </div>
Chris@6 313 <h2 class="groupheader">Enumeration Type Documentation</h2>
Chris@6 314 <a id="aa24a8cee023d8b7659d25cbe0584b821"></a>
Chris@6 315 <h2 class="memtitle"><span class="permalink"><a href="#aa24a8cee023d8b7659d25cbe0584b821">&#9670;&nbsp;</a></span>VampSampleType</h2>
Chris@6 316
Chris@1 317 <div class="memitem">
Chris@1 318 <div class="memproto">
Chris@1 319 <table class="memname">
Chris@1 320 <tr>
Chris@1 321 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td>
Chris@1 322 </tr>
Chris@1 323 </table>
Chris@6 324 </div><div class="memdoc">
Chris@6 325 <table class="fieldtable">
Chris@6 326 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a>vampOneSamplePerStep&#160;</td><td class="fielddoc"><p>Each process call returns results aligned with call's block start. </p>
Chris@1 327 </td></tr>
Chris@6 328 <tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a>vampFixedSampleRate&#160;</td><td class="fielddoc"><p>Returned results are evenly spaced at samplerate specified below. </p>
Chris@1 329 </td></tr>
Chris@6 330 <tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a>vampVariableSampleRate&#160;</td><td class="fielddoc"><p>Returned results have their own individual timestamps. </p>
Chris@1 331 </td></tr>
Chris@1 332 </table>
Chris@1 333
Chris@6 334 <p class="definition">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>
Chris@1 335
Chris@1 336 </div>
Chris@1 337 </div>
Chris@6 338 <a id="ab107386a5f042feddf6446bea23bb765"></a>
Chris@6 339 <h2 class="memtitle"><span class="permalink"><a href="#ab107386a5f042feddf6446bea23bb765">&#9670;&nbsp;</a></span>VampInputDomain</h2>
Chris@6 340
Chris@1 341 <div class="memitem">
Chris@1 342 <div class="memproto">
Chris@1 343 <table class="memname">
Chris@1 344 <tr>
Chris@1 345 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td>
Chris@1 346 </tr>
Chris@1 347 </table>
Chris@6 348 </div><div class="memdoc">
Chris@6 349 <table class="fieldtable">
Chris@6 350 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a>vampTimeDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 351 <tr><td class="fieldname"><a id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a>vampFrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@1 352 </table>
Chris@1 353
Chris@6 354 <p class="definition">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>
Chris@1 355
Chris@1 356 </div>
Chris@1 357 </div>
Chris@6 358 <h2 class="groupheader">Function Documentation</h2>
Chris@6 359 <a id="a50cf6f17d0718f02093be6c7f63fcf30"></a>
Chris@6 360 <h2 class="memtitle"><span class="permalink"><a href="#a50cf6f17d0718f02093be6c7f63fcf30">&#9670;&nbsp;</a></span>vampGetPluginDescriptor()</h2>
Chris@6 361
Chris@1 362 <div class="memitem">
Chris@1 363 <div class="memproto">
Chris@1 364 <table class="memname">
Chris@1 365 <tr>
Chris@6 366 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
Chris@1 367 <td>(</td>
Chris@1 368 <td class="paramtype">unsigned int&#160;</td>
Chris@1 369 <td class="paramname"><em>hostApiVersion</em>, </td>
Chris@1 370 </tr>
Chris@1 371 <tr>
Chris@1 372 <td class="paramkey"></td>
Chris@1 373 <td></td>
Chris@1 374 <td class="paramtype">unsigned int&#160;</td>
Chris@1 375 <td class="paramname"><em>index</em>&#160;</td>
Chris@1 376 </tr>
Chris@1 377 <tr>
Chris@1 378 <td></td>
Chris@1 379 <td>)</td>
Chris@1 380 <td></td><td></td>
Chris@1 381 </tr>
Chris@1 382 </table>
Chris@6 383 </div><div class="memdoc">
Chris@1 384
Chris@1 385 <p>Get the descriptor for a given plugin index in this library. </p>
Chris@1 386 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
Chris@1 387 <p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
Chris@1 388 <p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>
Chris@1 389
Chris@6 390 <p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 391
Chris@6 392 <p class="reference">References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
Chris@1 393
Chris@1 394 </div>
Chris@1 395 </div>
Chris@3 396 </div><!-- contents -->
Chris@6 397 </div><!-- doc-content -->
Chris@6 398 <!-- start footer part -->
Chris@6 399 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 400 <ul>
Chris@6 401 <li class="navelem"><a class="el" href="dir_9c751ccb9387a8f0ae6ae8f777da02a0.html">vamp</a></li><li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a></li>
Chris@6 402 <li class="footer">Generated by
Chris@6 403 <a href="http://www.doxygen.org/index.html">
Chris@6 404 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 405 </ul>
Chris@1 406 </div>
Chris@1 407 </body>
Chris@1 408 </html>