Mercurial > hg > vamp-docs

comparison code-docs/PluginLoader_8h_source.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
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 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: PluginLoader.h Source File</title> 8 <title>VampPluginSDK: PluginLoader.h Source File</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34
35 </td> 31 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li class="current"><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="files.html"><span>File&#160;List</span></a></li>
57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree"> 48 <div id="nav-tree">
63 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
64 </div> 51 </div>
65 </div> 52 </div>
66 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
68 </div> 55 </div>
69 </div> 56 </div>
70 <script type="text/javascript"> 57 <script type="text/javascript">
71 initNavTree('PluginLoader_8h.html',''); 58 $(document).ready(function(){initNavTree('PluginLoader_8h_source.html','');});
72 </script> 59 </script>
73 <div id="doc-content"> 60 <div id="doc-content">
74 <div class="header"> 61 <div class="header">
75 <div class="headertitle"> 62 <div class="headertitle">
76 <div class="title">PluginLoader.h</div> </div> 63 <div class="title">PluginLoader.h</div> </div>
77 </div><!--header--> 64 </div><!--header-->
78 <div class="contents"> 65 <div class="contents">
79 <a href="PluginLoader_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span> 66 <a href="PluginLoader_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>&#160;<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>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Vamp</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;<span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<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>&#160;<span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<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>&#160;<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>&#160;<span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<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>&#160;<span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"> authorization.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#ifndef _VAMP_PLUGIN_LOADER_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define _VAMP_PLUGIN_LOADER_H_</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>&quot;</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginLoader.h)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;namespace <a class="code" href="namespaceVamp.html">Vamp</a> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">class </span>Plugin;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">namespace </span>HostExt {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html"> 75</a></span>&#160;<span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;{</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *getInstance();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d"> 104</a></span>&#160; <span class="keyword">typedef</span> std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a"> 110</a></span>&#160; <span class="keyword">typedef</span> std::vector&lt;PluginKey&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364"> 122</a></span>&#160; <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; PluginKeyList listPlugins();</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; PluginKeyList listPluginsIn(std::vector&lt;std::string&gt; libraryNames);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; PluginKeyList listPluginsNotIn(std::vector&lt;std::string&gt; libraryNames);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div><div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494"> 200</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">AdapterFlags</a> {</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;</div><div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09"> 202</a></span>&#160; ADAPT_INPUT_DOMAIN = 0x01,</div><div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139"> 203</a></span>&#160; ADAPT_CHANNEL_COUNT = 0x02,</div><div class="line"><a name="l00204"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1"> 204</a></span>&#160; ADAPT_BUFFER_SIZE = 0x04,</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div><div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08"> 206</a></span>&#160; ADAPT_ALL_SAFE = 0x03,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;</div><div class="line"><a name="l00208"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0"> 208</a></span>&#160; ADAPT_ALL = 0xff</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; };</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <a class="code" href="classVamp_1_1Plugin.html">Plugin</a> *loadPlugin(PluginKey key,</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keywordtype">float</span> inputSampleRate,</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keywordtype">int</span> adapterFlags = 0);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; PluginKey composePluginKey(std::string libraryName,</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; std::string identifier);</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; PluginCategoryHierarchy getPluginCategory(PluginKey plugin);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; std::string getLibraryPathForPlugin(PluginKey plugin);</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>();</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>();</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;</div><div class="line"><a name="l00261"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072"> 261</a></span>&#160; <span class="keyword">class </span>Impl;</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; Impl *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">m_impl</a>;</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;</div><div class="line"><a name="l00264"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116"> 264</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">m_instance</a>;</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;};</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;}</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;}</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;<a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>.h)</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;</div><div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_a0d48b76e4f995110f53e0feeb23f733a"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">Vamp::HostExt::PluginLoader::PluginKeyList</a></div><div class="ttdeci">std::vector&lt; PluginKey &gt; PluginKeyList</div><div class="ttdoc">PluginKeyList is a sequence of plugin keys, such as returned by listPlugins(). </div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00110">PluginLoader.h:110</a></div></div>
80 <a name="l00002"></a>00002 67 <div class="ttc" id="classVamp_1_1Plugin_html"><div class="ttname"><a href="classVamp_1_1Plugin.html">Vamp::Plugin</a></div><div class="ttdoc">Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00124">vamp-sdk/Plugin.h:124</a></div></div>
81 <a name="l00003"></a>00003 <span class="comment">/*</span> 68 <div class="ttc" id="hostguard_8h_html_aef42eae5f1b0b897d8dac58cd54afbcd"><div class="ttname"><a href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a></div><div class="ttdeci">#define _VAMP_SDK_HOSTSPACE_BEGIN(h)</div><div class="ttdef"><b>Definition:</b> <a href="hostguard_8h_source.html#l00056">hostguard.h:56</a></div></div>
82 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 69 <div class="ttc" id="namespaceVamp_html"><div class="ttname"><a href="namespaceVamp.html">Vamp</a></div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00043">FFT.h:43</a></div></div>
83 <a name="l00005"></a>00005 <span class="comment"></span> 70 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_ad6a39aa0c79d8d9209eb0b8dfe9d1364"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">Vamp::HostExt::PluginLoader::PluginCategoryHierarchy</a></div><div class="ttdeci">std::vector&lt; std::string &gt; PluginCategoryHierarchy</div><div class="ttdoc">PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with ...</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00122">PluginLoader.h:122</a></div></div>
84 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> 71 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_af89caf5f838a586b117c417260b7a116"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">Vamp::HostExt::PluginLoader::m_instance</a></div><div class="ttdeci">static PluginLoader * m_instance</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00264">PluginLoader.h:264</a></div></div>
85 <a name="l00007"></a>00007 <span class="comment"></span> 72 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_ac12254d823f6d63cb8ce82a07bdcb072"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a></div><div class="ttdeci">Impl * m_impl</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00261">PluginLoader.h:261</a></div></div>
86 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> 73 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_aff3ee11692ce25e0dfb904324cbe3494"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">Vamp::HostExt::PluginLoader::AdapterFlags</a></div><div class="ttdeci">AdapterFlags</div><div class="ttdoc">AdapterFlags contains a set of values that may be OR&amp;#39;d together to indicate in which circumstances Pl...</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00200">PluginLoader.h:200</a></div></div>
87 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span> 74 <div class="ttc" id="hostguard_8h_html"><div class="ttname"><a href="hostguard_8h.html">hostguard.h</a></div></div>
88 <a name="l00010"></a>00010 <span class="comment"> </span> 75 <div class="ttc" id="hostguard_8h_html_a0e6efdc2909bdb0cfab70e087d91b171"><div class="ttname"><a href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a></div><div class="ttdeci">#define _VAMP_SDK_HOSTSPACE_END(h)</div><div class="ttdef"><b>Definition:</b> <a href="hostguard_8h_source.html#l00059">hostguard.h:59</a></div></div>
89 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> 76 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html">Vamp::HostExt::PluginLoader</a></div><div class="ttdoc">Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00075">PluginLoader.h:75</a></div></div>
90 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> 77 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginLoader_html_a473645bbb3ac5c1a0da2f0f482947c4d"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">Vamp::HostExt::PluginLoader::PluginKey</a></div><div class="ttdeci">std::string PluginKey</div><div class="ttdoc">PluginKey is a string type that is used to identify a plugin uniquely within the scope of &quot;the curren...</div><div class="ttdef"><b>Definition:</b> <a href="PluginLoader_8h_source.html#l00104">PluginLoader.h:104</a></div></div>
91 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span> 78 <div class="ttc" id="PluginWrapper_8h_html"><div class="ttname"><a href="PluginWrapper_8h.html">PluginWrapper.h</a></div></div>
92 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> 79 </div><!-- fragment --></div><!-- contents -->
93 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> 80 </div><!-- doc-content -->
94 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> 81 <!-- start footer part -->
95 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> 82 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
96 <a name="l00018"></a>00018 <span class="comment"></span> 83 <ul>
97 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> 84 <li class="navelem"><a class="el" href="dir_fb90db1f62862cb68177e0e13786fda0.html">vamp-hostsdk</a></li><li class="navelem"><a class="el" href="PluginLoader_8h.html">PluginLoader.h</a></li>
98 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> 85 <li class="footer">Generated by
99 <a name="l00021"></a>00021 <span class="comment"></span> 86 <a href="http://www.doxygen.org/index.html">
100 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span> 87 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
101 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> 88 </ul>
102 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
103 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
104 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
105 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
106 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
107 <a name="l00029"></a>00029 <span class="comment"></span>
108 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
109 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
110 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
111 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
112 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
113 <a name="l00035"></a>00035 <span class="comment">*/</span>
114 <a name="l00036"></a>00036
115 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_LOADER_H_</span>
116 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_LOADER_H_</span>
117 <a name="l00039"></a>00039 <span class="preprocessor"></span>
118 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;vector&gt;</span>
119 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;string&gt;</span>
120 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span>
121 <a name="l00043"></a>00043
122 <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
123 <a name="l00045"></a>00045 <span class="preprocessor">#include &quot;<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>&quot;</span>
124 <a name="l00046"></a>00046
125 <a name="l00047"></a>00047 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginLoader.h)
126 <a name="l00048"></a>00048
127 <a name="l00049"></a>00049 namespace Vamp {
128 <a name="l00050"></a>00050
129 <a name="l00051"></a>00051 <span class="keyword">class </span>Plugin;
130 <a name="l00052"></a>00052
131 <a name="l00053"></a>00053 <span class="keyword">namespace </span>HostExt {
132 <a name="l00054"></a>00054
133 <a name="l00072"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">00072</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>
134 <a name="l00073"></a>00073 {
135 <a name="l00074"></a>00074 <span class="keyword">public</span>:
136 <a name="l00079"></a>00079 <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a> *getInstance();
137 <a name="l00080"></a>00080
138 <a name="l00101"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">00101</a> <span class="keyword">typedef</span> std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the scope of &quot;the curren...">PluginKey</a>;
139 <a name="l00102"></a>00102
140 <a name="l00107"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">00107</a> <span class="keyword">typedef</span> std::vector&lt;PluginKey&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a>;
141 <a name="l00108"></a>00108
142 <a name="l00119"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">00119</a> <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with ...">PluginCategoryHierarchy</a>;
143 <a name="l00120"></a>00120
144 <a name="l00125"></a>00125 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a> listPlugins();
145 <a name="l00126"></a>00126
146 <a name="l00169"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">00169</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in which circumstances Pl...">AdapterFlags</a> {
147 <a name="l00170"></a>00170
148 <a name="l00171"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09">00171</a> ADAPT_INPUT_DOMAIN = 0x01,
149 <a name="l00172"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139">00172</a> ADAPT_CHANNEL_COUNT = 0x02,
150 <a name="l00173"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1">00173</a> ADAPT_BUFFER_SIZE = 0x04,
151 <a name="l00174"></a>00174
152 <a name="l00175"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08">00175</a> ADAPT_ALL_SAFE = 0x03,
153 <a name="l00176"></a>00176
154 <a name="l00177"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0">00177</a> ADAPT_ALL = 0xff
155 <a name="l00178"></a>00178 };
156 <a name="l00179"></a>00179
157 <a name="l00197"></a>00197 <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> *loadPlugin(PluginKey key,
158 <a name="l00198"></a>00198 <span class="keywordtype">float</span> inputSampleRate,
159 <a name="l00199"></a>00199 <span class="keywordtype">int</span> adapterFlags = 0);
160 <a name="l00200"></a>00200
161 <a name="l00206"></a>00206 PluginKey composePluginKey(std::string libraryName,
162 <a name="l00207"></a>00207 std::string identifier);
163 <a name="l00208"></a>00208
164 <a name="l00218"></a>00218 PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
165 <a name="l00219"></a>00219
166 <a name="l00224"></a>00224 std::string getLibraryPathForPlugin(PluginKey plugin);
167 <a name="l00225"></a>00225
168 <a name="l00226"></a>00226 <span class="keyword">protected</span>:
169 <a name="l00227"></a>00227 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>();
170 <a name="l00228"></a>00228 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>();
171 <a name="l00229"></a>00229
172 <a name="l00230"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">00230</a> <span class="keyword">class </span>Impl;
173 <a name="l00231"></a>00231 Impl *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">m_impl</a>;
174 <a name="l00232"></a>00232
175 <a name="l00233"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">00233</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">m_instance</a>;
176 <a name="l00234"></a>00234 };
177 <a name="l00235"></a>00235
178 <a name="l00236"></a>00236 }
179 <a name="l00237"></a>00237
180 <a name="l00238"></a>00238 }
181 <a name="l00239"></a>00239
182 <a name="l00240"></a>00240 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginLoader.h)
183 <a name="l00241"></a>00241
184 <a name="l00242"></a>00242 <span class="preprocessor">#endif</span>
185 <a name="l00243"></a>00243 <span class="preprocessor"></span>
186 </pre></div></div><!-- contents -->
187 </div> 89 </div>
188 <div id="nav-path" class="navpath">
189 <ul>
190 <li class="navelem"><a class="el" href="PluginLoader_8h.html">PluginLoader.h</a> </li>
191
192 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
193 <a href="http://www.doxygen.org/index.html">
194 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
195 </ul>
196 </div>
197
198
199 </body> 90 </body>
200 </html> 91 </html>