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

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@6 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@6 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@6 3 <head>
Chris@6 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@6 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@6 8 <title>VampPluginSDK: host-c.h File Reference</title>
Chris@6 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@6 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@6 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@6 15 <script type="text/javascript" src="navtree.js"></script>
Chris@6 16 <script type="text/javascript">
Chris@6 17 $(document).ready(initResizable);
Chris@6 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@6 20 </head>
Chris@6 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@6 23 <div id="titlearea">
Chris@6 24 <table cellspacing="0" cellpadding="0">
Chris@6 25 <tbody>
Chris@6 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@6 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@6 30 </div>
Chris@6 31 </td>
Chris@6 32 </tr>
Chris@6 33 </tbody>
Chris@6 34 </table>
Chris@6 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@6 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@6 48 <div id="nav-tree">
Chris@6 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@6 51 </div>
Chris@6 52 </div>
Chris@6 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@6 54 class="ui-resizable-handle">
Chris@6 55 </div>
Chris@6 56 </div>
Chris@6 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('host-c_8h.html','');});
Chris@6 59 </script>
Chris@6 60 <div id="doc-content">
Chris@6 61 <div class="header">
Chris@6 62 <div class="summary">
Chris@6 63 <a href="#typedef-members">Typedefs</a> &#124;
Chris@6 64 <a href="#func-members">Functions</a> </div>
Chris@6 65 <div class="headertitle">
Chris@6 66 <div class="title">host-c.h File Reference</div> </div>
Chris@6 67 </div><!--header-->
Chris@6 68 <div class="contents">
Chris@6 69 <div class="textblock"><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp/vamp.h</a>&gt;</code><br />
Chris@6 70 </div><div class="textblock"><div class="dynheader">
Chris@6 71 Include dependency graph for host-c.h:</div>
Chris@6 72 <div class="dyncontent">
Chris@6 73 <div class="center"><img src="host-c_8h__incl.png" border="0" usemap="#host-c_8h" alt=""/></div>
Chris@6 74 <map name="host-c_8h" id="host-c_8h">
Chris@6 75 <area shape="rect" id="node2" href="vamp_8h.html" title="vamp/vamp.h" alt="" coords="5,79,104,104"/>
Chris@6 76 </map>
Chris@6 77 </div>
Chris@6 78 </div>
Chris@6 79 <p><a href="host-c_8h_source.html">Go to the source code of this file.</a></p>
Chris@6 80 <table class="memberdecls">
Chris@6 81 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Chris@6 82 Typedefs</h2></td></tr>
Chris@6 83 <tr class="memitem:a0d6585882923f575e76bd0a6835e9748"><td class="memItemLeft" align="right" valign="top">typedef struct vhLibrary_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a></td></tr>
Chris@6 84 <tr class="separator:a0d6585882923f575e76bd0a6835e9748"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 85 </table><table class="memberdecls">
Chris@6 86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Chris@6 87 Functions</h2></td></tr>
Chris@6 88 <tr class="memitem:a63420c2f047538e88f88f76cf8f22a43"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43">vhGetLibraryCount</a> ()</td></tr>
Chris@6 89 <tr class="memdesc:a63420c2f047538e88f88f76cf8f22a43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries discovered in the installation path. <a href="#a63420c2f047538e88f88f76cf8f22a43">More...</a><br /></td></tr>
Chris@6 90 <tr class="separator:a63420c2f047538e88f88f76cf8f22a43"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 91 <tr class="memitem:afdaa93128f4c785fc4c022bc8ecd840a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#afdaa93128f4c785fc4c022bc8ecd840a">vhGetLibraryName</a> (int library)</td></tr>
Chris@6 92 <tr class="memdesc:afdaa93128f4c785fc4c022bc8ecd840a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the library name (base soname) of the library with the given index, in the range 0..(<a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43" title="Return the number of Vamp plugin libraries discovered in the installation path. ">vhGetLibraryCount()</a>-1). <a href="#afdaa93128f4c785fc4c022bc8ecd840a">More...</a><br /></td></tr>
Chris@6 93 <tr class="separator:afdaa93128f4c785fc4c022bc8ecd840a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 94 <tr class="memitem:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#ac1e2a1b3c3f1c3019bee99140b4a1551">vhGetLibraryIndex</a> (const char *name)</td></tr>
Chris@6 95 <tr class="memdesc:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the library index for the given library name, or -1 if the name is not known. <a href="#ac1e2a1b3c3f1c3019bee99140b4a1551">More...</a><br /></td></tr>
Chris@6 96 <tr class="separator:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 97 <tr class="memitem:ae93710ce0c0d9d99ca798fffa7517929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#ae93710ce0c0d9d99ca798fffa7517929">vhLoadLibrary</a> (int library)</td></tr>
Chris@6 98 <tr class="memdesc:ae93710ce0c0d9d99ca798fffa7517929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load the library with the given index. <a href="#ae93710ce0c0d9d99ca798fffa7517929">More...</a><br /></td></tr>
Chris@6 99 <tr class="separator:ae93710ce0c0d9d99ca798fffa7517929"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 100 <tr class="memitem:af23b8bddcbf13f9d15f87a15d698de0b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#af23b8bddcbf13f9d15f87a15d698de0b">vhGetPluginCount</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> library)</td></tr>
Chris@6 101 <tr class="memdesc:af23b8bddcbf13f9d15f87a15d698de0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugins in the given library. <a href="#af23b8bddcbf13f9d15f87a15d698de0b">More...</a><br /></td></tr>
Chris@6 102 <tr class="separator:af23b8bddcbf13f9d15f87a15d698de0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 103 <tr class="memitem:a7d85254dce15986f87829d1c6e7b8d00"><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="host-c_8h.html#a7d85254dce15986f87829d1c6e7b8d00">vhGetPluginDescriptor</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> library, int plugin)</td></tr>
Chris@6 104 <tr class="memdesc:a7d85254dce15986f87829d1c6e7b8d00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <a class="el" href="namespaceVamp.html">Vamp</a> plugin descriptor for a plugin in a given library. <a href="#a7d85254dce15986f87829d1c6e7b8d00">More...</a><br /></td></tr>
Chris@6 105 <tr class="separator:a7d85254dce15986f87829d1c6e7b8d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 106 <tr class="memitem:a4ec9d6f7408267d7567d9b2435807840"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a4ec9d6f7408267d7567d9b2435807840">vhUnloadLibrary</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>)</td></tr>
Chris@6 107 <tr class="memdesc:a4ec9d6f7408267d7567d9b2435807840"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unload a plugin library. <a href="#a4ec9d6f7408267d7567d9b2435807840">More...</a><br /></td></tr>
Chris@6 108 <tr class="separator:a4ec9d6f7408267d7567d9b2435807840"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 109 </table>
Chris@6 110 <h2 class="groupheader">Typedef Documentation</h2>
Chris@6 111 <a id="a0d6585882923f575e76bd0a6835e9748"></a>
Chris@6 112 <h2 class="memtitle"><span class="permalink"><a href="#a0d6585882923f575e76bd0a6835e9748">&#9670;&nbsp;</a></span>vhLibrary</h2>
Chris@6 113
Chris@6 114 <div class="memitem">
Chris@6 115 <div class="memproto">
Chris@6 116 <table class="memname">
Chris@6 117 <tr>
Chris@6 118 <td class="memname">typedef struct vhLibrary_t* <a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a></td>
Chris@6 119 </tr>
Chris@6 120 </table>
Chris@6 121 </div><div class="memdoc">
Chris@6 122
Chris@6 123 <p class="definition">Definition at line <a class="el" href="host-c_8h_source.html#l00094">94</a> of file <a class="el" href="host-c_8h_source.html">host-c.h</a>.</p>
Chris@6 124
Chris@6 125 </div>
Chris@6 126 </div>
Chris@6 127 <h2 class="groupheader">Function Documentation</h2>
Chris@6 128 <a id="a63420c2f047538e88f88f76cf8f22a43"></a>
Chris@6 129 <h2 class="memtitle"><span class="permalink"><a href="#a63420c2f047538e88f88f76cf8f22a43">&#9670;&nbsp;</a></span>vhGetLibraryCount()</h2>
Chris@6 130
Chris@6 131 <div class="memitem">
Chris@6 132 <div class="memproto">
Chris@6 133 <table class="memname">
Chris@6 134 <tr>
Chris@6 135 <td class="memname">int vhGetLibraryCount </td>
Chris@6 136 <td>(</td>
Chris@6 137 <td class="paramname"></td><td>)</td>
Chris@6 138 <td></td>
Chris@6 139 </tr>
Chris@6 140 </table>
Chris@6 141 </div><div class="memdoc">
Chris@6 142
Chris@6 143 <p>Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries discovered in the installation path. </p>
Chris@6 144 <p>This number will remain fixed after the first call &ndash; plugins are only discovered once, the first time this function is called. </p>
Chris@6 145
Chris@6 146 </div>
Chris@6 147 </div>
Chris@6 148 <a id="afdaa93128f4c785fc4c022bc8ecd840a"></a>
Chris@6 149 <h2 class="memtitle"><span class="permalink"><a href="#afdaa93128f4c785fc4c022bc8ecd840a">&#9670;&nbsp;</a></span>vhGetLibraryName()</h2>
Chris@6 150
Chris@6 151 <div class="memitem">
Chris@6 152 <div class="memproto">
Chris@6 153 <table class="memname">
Chris@6 154 <tr>
Chris@6 155 <td class="memname">const char* vhGetLibraryName </td>
Chris@6 156 <td>(</td>
Chris@6 157 <td class="paramtype">int&#160;</td>
Chris@6 158 <td class="paramname"><em>library</em></td><td>)</td>
Chris@6 159 <td></td>
Chris@6 160 </tr>
Chris@6 161 </table>
Chris@6 162 </div><div class="memdoc">
Chris@6 163
Chris@6 164 <p>Return the library name (base soname) of the library with the given index, in the range 0..(<a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43" title="Return the number of Vamp plugin libraries discovered in the installation path. ">vhGetLibraryCount()</a>-1). </p>
Chris@6 165
Chris@6 166 </div>
Chris@6 167 </div>
Chris@6 168 <a id="ac1e2a1b3c3f1c3019bee99140b4a1551"></a>
Chris@6 169 <h2 class="memtitle"><span class="permalink"><a href="#ac1e2a1b3c3f1c3019bee99140b4a1551">&#9670;&nbsp;</a></span>vhGetLibraryIndex()</h2>
Chris@6 170
Chris@6 171 <div class="memitem">
Chris@6 172 <div class="memproto">
Chris@6 173 <table class="memname">
Chris@6 174 <tr>
Chris@6 175 <td class="memname">int vhGetLibraryIndex </td>
Chris@6 176 <td>(</td>
Chris@6 177 <td class="paramtype">const char *&#160;</td>
Chris@6 178 <td class="paramname"><em>name</em></td><td>)</td>
Chris@6 179 <td></td>
Chris@6 180 </tr>
Chris@6 181 </table>
Chris@6 182 </div><div class="memdoc">
Chris@6 183
Chris@6 184 <p>Return the library index for the given library name, or -1 if the name is not known. </p>
Chris@6 185
Chris@6 186 </div>
Chris@6 187 </div>
Chris@6 188 <a id="ae93710ce0c0d9d99ca798fffa7517929"></a>
Chris@6 189 <h2 class="memtitle"><span class="permalink"><a href="#ae93710ce0c0d9d99ca798fffa7517929">&#9670;&nbsp;</a></span>vhLoadLibrary()</h2>
Chris@6 190
Chris@6 191 <div class="memitem">
Chris@6 192 <div class="memproto">
Chris@6 193 <table class="memname">
Chris@6 194 <tr>
Chris@6 195 <td class="memname"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> vhLoadLibrary </td>
Chris@6 196 <td>(</td>
Chris@6 197 <td class="paramtype">int&#160;</td>
Chris@6 198 <td class="paramname"><em>library</em></td><td>)</td>
Chris@6 199 <td></td>
Chris@6 200 </tr>
Chris@6 201 </table>
Chris@6 202 </div><div class="memdoc">
Chris@6 203
Chris@6 204 <p>Load the library with the given index. </p>
Chris@6 205 <p>If the library cannot be loaded for any reason, the return value is 0; otherwise it is an opaque pointer suitable for passing to other functions in this API. </p>
Chris@6 206
Chris@6 207 </div>
Chris@6 208 </div>
Chris@6 209 <a id="af23b8bddcbf13f9d15f87a15d698de0b"></a>
Chris@6 210 <h2 class="memtitle"><span class="permalink"><a href="#af23b8bddcbf13f9d15f87a15d698de0b">&#9670;&nbsp;</a></span>vhGetPluginCount()</h2>
Chris@6 211
Chris@6 212 <div class="memitem">
Chris@6 213 <div class="memproto">
Chris@6 214 <table class="memname">
Chris@6 215 <tr>
Chris@6 216 <td class="memname">int vhGetPluginCount </td>
Chris@6 217 <td>(</td>
Chris@6 218 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
Chris@6 219 <td class="paramname"><em>library</em></td><td>)</td>
Chris@6 220 <td></td>
Chris@6 221 </tr>
Chris@6 222 </table>
Chris@6 223 </div><div class="memdoc">
Chris@6 224
Chris@6 225 <p>Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugins in the given library. </p>
Chris@6 226
Chris@6 227 </div>
Chris@6 228 </div>
Chris@6 229 <a id="a7d85254dce15986f87829d1c6e7b8d00"></a>
Chris@6 230 <h2 class="memtitle"><span class="permalink"><a href="#a7d85254dce15986f87829d1c6e7b8d00">&#9670;&nbsp;</a></span>vhGetPluginDescriptor()</h2>
Chris@6 231
Chris@6 232 <div class="memitem">
Chris@6 233 <div class="memproto">
Chris@6 234 <table class="memname">
Chris@6 235 <tr>
Chris@6 236 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vhGetPluginDescriptor </td>
Chris@6 237 <td>(</td>
Chris@6 238 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
Chris@6 239 <td class="paramname"><em>library</em>, </td>
Chris@6 240 </tr>
Chris@6 241 <tr>
Chris@6 242 <td class="paramkey"></td>
Chris@6 243 <td></td>
Chris@6 244 <td class="paramtype">int&#160;</td>
Chris@6 245 <td class="paramname"><em>plugin</em>&#160;</td>
Chris@6 246 </tr>
Chris@6 247 <tr>
Chris@6 248 <td></td>
Chris@6 249 <td>)</td>
Chris@6 250 <td></td><td></td>
Chris@6 251 </tr>
Chris@6 252 </table>
Chris@6 253 </div><div class="memdoc">
Chris@6 254
Chris@6 255 <p>Return a <a class="el" href="namespaceVamp.html">Vamp</a> plugin descriptor for a plugin in a given library. </p>
Chris@6 256 <p>This simply calls the vampGetPluginDescriptor function in that library with the given plugin index and returns the result. See <a class="el" href="vamp_8h.html">vamp/vamp.h</a> for details about the plugin descriptor. </p>
Chris@6 257
Chris@6 258 </div>
Chris@6 259 </div>
Chris@6 260 <a id="a4ec9d6f7408267d7567d9b2435807840"></a>
Chris@6 261 <h2 class="memtitle"><span class="permalink"><a href="#a4ec9d6f7408267d7567d9b2435807840">&#9670;&nbsp;</a></span>vhUnloadLibrary()</h2>
Chris@6 262
Chris@6 263 <div class="memitem">
Chris@6 264 <div class="memproto">
Chris@6 265 <table class="memname">
Chris@6 266 <tr>
Chris@6 267 <td class="memname">void vhUnloadLibrary </td>
Chris@6 268 <td>(</td>
Chris@6 269 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
Chris@6 270 <td class="paramname"></td><td>)</td>
Chris@6 271 <td></td>
Chris@6 272 </tr>
Chris@6 273 </table>
Chris@6 274 </div><div class="memdoc">
Chris@6 275
Chris@6 276 <p>Unload a plugin library. </p>
Chris@6 277 <p>Do not do this while any of its plugins are still in use. </p>
Chris@6 278
Chris@6 279 </div>
Chris@6 280 </div>
Chris@6 281 </div><!-- contents -->
Chris@6 282 </div><!-- doc-content -->
Chris@6 283 <!-- start footer part -->
Chris@6 284 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 285 <ul>
Chris@6 286 <li class="navelem"><a class="el" href="dir_fb90db1f62862cb68177e0e13786fda0.html">vamp-hostsdk</a></li><li class="navelem"><a class="el" href="host-c_8h.html">host-c.h</a></li>
Chris@6 287 <li class="footer">Generated by
Chris@6 288 <a href="http://www.doxygen.org/index.html">
Chris@6 289 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 290 </ul>
Chris@6 291 </div>
Chris@6 292 </body>
Chris@6 293 </html>