Mercurial > hg > vamp-docs
view code-docs/host-c_8h_source.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 |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: host-c.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('host-c_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">host-c.h</div> </div> </div><!--header--> <div class="contents"> <a href="host-c_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Vamp</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> An API for audio analysis and feature extraction plugins.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Copyright 2006-2015 Chris Cannam and QMUL.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> Permission is hereby granted, free of charge, to any person</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> obtaining a copy of this software and associated documentation</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> files (the "Software"), to deal in the Software without</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> restriction, including without limitation the rights to use, copy,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> The above copyright notice and this permission notice shall be</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> included in all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> Except as contained in this notice, the names of the Centre for</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> use or other dealings in this Software without prior written</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> authorization.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/*</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> This file defines a low-level API for enumerating and loading</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> plugin libraries using C calling conventions. It could be used in</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> C programs, or in languages with C-compatible foreign-function</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> interfaces. Note that this works by calling to the C++ Vamp host</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> SDK, so any program using this interface must still link against</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> the rest of the Vamp plugin library and the C++ standard library.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> This is not the simplest or easiest interface for hosting Vamp</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> plugins -- if you have the capability to use the C++ API, please</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> do that instead. (Most programs should not even include this</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> header.)</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> The C and C++ interfaces provide different abstraction levels:</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> In the C++ interface, the class PluginLoader provides a list of</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> keys corresponding to the installed plugins (where a key combines</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> the plugin's library name and plugin identifier into a single</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> string) plus a method to load a single plugin based on its key</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> (obtaining an instance of class Plugin). With the C++ interface</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> you go straight from the key to a live instance of the plugin. The</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> PluginLoader also provides various facilities to adapt the plugin</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> based on your requirements (e.g. to do time- to frequency-domain</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> conversion for you if the plugin requires it).</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> This low-level C interface, on the other hand, deals only in</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> plugin libraries and static descriptors, not in plugin</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> instances. You can enumerate the installed libraries, getting just</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> the base .soname of each library. Then you can retrieve each of</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> the raw C plugin descriptors from a library, and use the</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> descriptor (whose interface is defined in vamp/vamp.h) to</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> instantiate the plugin.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> So this header corresponds to the first part of the PluginLoader</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> class interface: finding and loading plugin libraries and</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> retrieving plugin descriptors from them. But it does not do any of</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> the rest, i.e. instantiating and adapting the plugins themselves.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> Although this makes the API appear very simple, it means the</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> resulting plugins are relatively hard to use compared to those</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> obtained by the PluginLoader API. There is no way to get to the</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> full C++ abstraction using this API.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> This API is not thread-safe; use it from a single application</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> thread, or guard access to it with a mutex.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> This header was introduced in version 2.6 of the Vamp plugin SDK.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">*/</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#ifndef VAMPHOST_C_H_INCLUDED</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#define VAMPHOST_C_H_INCLUDED</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#include <<a class="code" href="vamp_8h.html">vamp/vamp.h</a>></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748"> 94</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>vhLibrary_t *<a class="code" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43">vhGetLibraryCount</a>();</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="host-c_8h.html#afdaa93128f4c785fc4c022bc8ecd840a">vhGetLibraryName</a>(<span class="keywordtype">int</span> library);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="host-c_8h.html#ac1e2a1b3c3f1c3019bee99140b4a1551">vhGetLibraryIndex</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">extern</span> vhLibrary <a class="code" href="host-c_8h.html#ae93710ce0c0d9d99ca798fffa7517929">vhLoadLibrary</a>(<span class="keywordtype">int</span> library);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="host-c_8h.html#af23b8bddcbf13f9d15f87a15d698de0b">vhGetPluginCount</a>(vhLibrary library);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="host-c_8h.html#a7d85254dce15986f87829d1c6e7b8d00">vhGetPluginDescriptor</a>(vhLibrary library,</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">int</span> plugin);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="host-c_8h.html#a4ec9d6f7408267d7567d9b2435807840">vhUnloadLibrary</a>(vhLibrary);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> }</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="host-c_8h_html_a7d85254dce15986f87829d1c6e7b8d00"><div class="ttname"><a href="host-c_8h.html#a7d85254dce15986f87829d1c6e7b8d00">vhGetPluginDescriptor</a></div><div class="ttdeci">const VampPluginDescriptor * vhGetPluginDescriptor(vhLibrary library, int plugin)</div><div class="ttdoc">Return a Vamp plugin descriptor for a plugin in a given library. </div></div> <div class="ttc" id="host-c_8h_html_ae93710ce0c0d9d99ca798fffa7517929"><div class="ttname"><a href="host-c_8h.html#ae93710ce0c0d9d99ca798fffa7517929">vhLoadLibrary</a></div><div class="ttdeci">vhLibrary vhLoadLibrary(int library)</div><div class="ttdoc">Load the library with the given index. </div></div> <div class="ttc" id="host-c_8h_html_a0d6585882923f575e76bd0a6835e9748"><div class="ttname"><a href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a></div><div class="ttdeci">struct vhLibrary_t * vhLibrary</div><div class="ttdef"><b>Definition:</b> <a href="host-c_8h_source.html#l00094">host-c.h:94</a></div></div> <div class="ttc" id="host-c_8h_html_a4ec9d6f7408267d7567d9b2435807840"><div class="ttname"><a href="host-c_8h.html#a4ec9d6f7408267d7567d9b2435807840">vhUnloadLibrary</a></div><div class="ttdeci">void vhUnloadLibrary(vhLibrary)</div><div class="ttdoc">Unload a plugin library. </div></div> <div class="ttc" id="host-c_8h_html_af23b8bddcbf13f9d15f87a15d698de0b"><div class="ttname"><a href="host-c_8h.html#af23b8bddcbf13f9d15f87a15d698de0b">vhGetPluginCount</a></div><div class="ttdeci">int vhGetPluginCount(vhLibrary library)</div><div class="ttdoc">Return the number of Vamp plugins in the given library. </div></div> <div class="ttc" id="struct__VampPluginDescriptor_html"><div class="ttname"><a href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp_8h_source.html#l00248">vamp.h:248</a></div></div> <div class="ttc" id="vamp_8h_html"><div class="ttname"><a href="vamp_8h.html">vamp.h</a></div></div> <div class="ttc" id="host-c_8h_html_afdaa93128f4c785fc4c022bc8ecd840a"><div class="ttname"><a href="host-c_8h.html#afdaa93128f4c785fc4c022bc8ecd840a">vhGetLibraryName</a></div><div class="ttdeci">const char * vhGetLibraryName(int library)</div><div class="ttdoc">Return the library name (base soname) of the library with the given index, in the range 0...</div></div> <div class="ttc" id="host-c_8h_html_a63420c2f047538e88f88f76cf8f22a43"><div class="ttname"><a href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43">vhGetLibraryCount</a></div><div class="ttdeci">int vhGetLibraryCount()</div><div class="ttdoc">Return the number of Vamp plugin libraries discovered in the installation path. </div></div> <div class="ttc" id="host-c_8h_html_ac1e2a1b3c3f1c3019bee99140b4a1551"><div class="ttname"><a href="host-c_8h.html#ac1e2a1b3c3f1c3019bee99140b4a1551">vhGetLibraryIndex</a></div><div class="ttdeci">int vhGetLibraryIndex(const char *name)</div><div class="ttdoc">Return the library index for the given library name, or -1 if the name is not known. </div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <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> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>