Mercurial > hg > vamp-docs

comparison code-docs/PluginWrapper_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: PluginWrapper.h Source File</title> 8 <title>VampPluginSDK: PluginWrapper.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('PluginWrapper_8h.html',''); 58 $(document).ready(function(){initNavTree('PluginWrapper_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">PluginWrapper.h</div> </div> 63 <div class="title">PluginWrapper.h</div> </div>
77 </div><!--header--> 64 </div><!--header-->
78 <div class="contents"> 65 <div class="contents">
79 <a href="PluginWrapper_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="PluginWrapper_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_WRAPPER_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define _VAMP_PLUGIN_WRAPPER_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 &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a>&gt;</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginWrapper.h)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;namespace <a class="code" href="namespaceVamp.html">Vamp</a> {</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;<span class="keyword">namespace </span>HostExt {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginWrapper.html"> 62</a></span>&#160;<span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1Plugin.html">Plugin</a></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> reset();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion() <span class="keyword">const</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; std::string getIdentifier() <span class="keyword">const</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; std::string getName() <span class="keyword">const</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; std::string getDescription() <span class="keyword">const</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; std::string getMaker() <span class="keyword">const</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::string getCopyright() <span class="keyword">const</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> getParameterDescriptors() <span class="keyword">const</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">float</span> getParameter(std::string) <span class="keyword">const</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> getPrograms() <span class="keyword">const</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; std::string getCurrentProgram() <span class="keyword">const</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">void</span> selectProgram(std::string);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">size_t</span> getMinChannelCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">size_t</span> getMaxChannelCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> getOutputDescriptors() <span class="keyword">const</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, <a class="code" href="structVamp_1_1RealTime.html">RealTime</a> timestamp);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures();</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> WrapperType&gt;</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05"> 116</a></span>&#160; WrapperType *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a>() {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; WrapperType *w = <span class="keyword">dynamic_cast&lt;</span>WrapperType *<span class="keyword">&gt;</span>(<span class="keyword">this</span>);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">if</span> (w) <span class="keywordflow">return</span> w;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> *pw = <span class="keyword">dynamic_cast&lt;</span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> *<span class="keyword">&gt;</span>(m_plugin);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">if</span> (pw) <span class="keywordflow">return</span> pw-&gt;<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a>&lt;WrapperType&gt;();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>(<a class="code" href="classVamp_1_1Plugin.html">Plugin</a> *plugin); <span class="comment">// I take ownership of plugin</span></div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2"> 126</a></span>&#160; <a class="code" href="classVamp_1_1Plugin.html">Plugin</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;};</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;}</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;}</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>.h)</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classVamp_1_1Plugin_html_a30f531b8fb69fac41a24e3d2a6a08ed9"><div class="ttname"><a href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a></div><div class="ttdeci">std::vector&lt; OutputDescriptor &gt; OutputList</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00335">vamp-sdk/Plugin.h:335</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="classVamp_1_1Plugin_html_a39cb7649d6dcc20e4cb1640cd55907bc"><div class="ttname"><a href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></div><div class="ttdeci">InputDomain</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00152">vamp-sdk/Plugin.h:152</a></div></div>
82 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 69 <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>
83 <a name="l00005"></a>00005 <span class="comment"></span> 70 <div class="ttc" id="classVamp_1_1Plugin_html_a448fb57dc245d47923ec9eeaf9856c5f"><div class="ttname"><a href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></div><div class="ttdeci">std::map&lt; int, FeatureList &gt; FeatureSet</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00395">vamp-sdk/Plugin.h:395</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="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>
85 <a name="l00007"></a>00007 <span class="comment"></span> 72 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginWrapper_html_ab4e40ecd98b445e1a2aa9e7baa280ea2"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a></div><div class="ttdeci">Plugin * m_plugin</div><div class="ttdef"><b>Definition:</b> <a href="PluginWrapper_8h_source.html#l00126">PluginWrapper.h:126</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_1PluginWrapper_html_a653d0308e8e34881a8749b7631d00f05"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">Vamp::HostExt::PluginWrapper::getWrapper</a></div><div class="ttdeci">WrapperType * getWrapper()</div><div class="ttdoc">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&amp;#39;s plugin...</div><div class="ttdef"><b>Definition:</b> <a href="PluginWrapper_8h_source.html#l00116">PluginWrapper.h:116</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="structVamp_1_1RealTime_html"><div class="ttname"><a href="structVamp_1_1RealTime.html">Vamp::RealTime</a></div><div class="ttdoc">RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2RealTime_8h_source.html#l00066">vamp-sdk/RealTime.h:66</a></div></div>
88 <a name="l00010"></a>00010 <span class="comment"> </span> 75 <div class="ttc" id="classVamp_1_1HostExt_1_1PluginWrapper_html"><div class="ttname"><a href="classVamp_1_1HostExt_1_1PluginWrapper.html">Vamp::HostExt::PluginWrapper</a></div><div class="ttdoc">PluginWrapper is a simple base class for adapter plugins. </div><div class="ttdef"><b>Definition:</b> <a href="PluginWrapper_8h_source.html#l00062">PluginWrapper.h:62</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_1PluginBase_html_a7f66f00437b21e5f694fe02356b12f20"><div class="ttname"><a href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></div><div class="ttdeci">std::vector&lt; std::string &gt; ProgramList</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2PluginBase_8h_source.html#l00225">vamp-sdk/PluginBase.h:225</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="hostguard_8h_html"><div class="ttname"><a href="hostguard_8h.html">hostguard.h</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="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>
92 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> 79 <div class="ttc" id="vamp-hostsdk_2Plugin_8h_html"><div class="ttname"><a href="vamp-hostsdk_2Plugin_8h.html">Plugin.h</a></div></div>
93 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> 80 <div class="ttc" id="classVamp_1_1PluginBase_html_a3b6bb4bbd86affe1ca9deceea1aad4f8"><div class="ttname"><a href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></div><div class="ttdeci">std::vector&lt; ParameterDescriptor &gt; ParameterList</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2PluginBase_8h_source.html#l00203">vamp-sdk/PluginBase.h:203</a></div></div>
94 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> 81 </div><!-- fragment --></div><!-- contents -->
95 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> 82 </div><!-- doc-content -->
96 <a name="l00018"></a>00018 <span class="comment"></span> 83 <!-- start footer part -->
97 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> 84 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
98 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> 85 <ul>
99 <a name="l00021"></a>00021 <span class="comment"></span> 86 <li class="navelem"><a class="el" href="dir_fb90db1f62862cb68177e0e13786fda0.html">vamp-hostsdk</a></li><li class="navelem"><a class="el" href="PluginWrapper_8h.html">PluginWrapper.h</a></li>
100 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span> 87 <li class="footer">Generated by
101 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> 88 <a href="http://www.doxygen.org/index.html">
102 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> 89 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
103 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> 90 </ul>
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_WRAPPER_H_</span>
116 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_WRAPPER_H_</span>
117 <a name="l00039"></a>00039 <span class="preprocessor"></span>
118 <a name="l00040"></a>00040 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
119 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;<a class="code" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a>&gt;</span>
120 <a name="l00042"></a>00042
121 <a name="l00043"></a>00043 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginWrapper.h)
122 <a name="l00044"></a>00044
123 <a name="l00045"></a>00045 namespace Vamp {
124 <a name="l00046"></a>00046
125 <a name="l00047"></a>00047 <span class="keyword">namespace </span>HostExt {
126 <a name="l00048"></a>00048
127 <a name="l00062"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">00062</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> : <span class="keyword">public</span> <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>
128 <a name="l00063"></a>00063 {
129 <a name="l00064"></a>00064 <span class="keyword">public</span>:
130 <a name="l00065"></a>00065 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>();
131 <a name="l00066"></a>00066
132 <a name="l00067"></a>00067 <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
133 <a name="l00068"></a>00068 <span class="keywordtype">void</span> reset();
134 <a name="l00069"></a>00069
135 <a name="l00070"></a>00070 <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
136 <a name="l00071"></a>00071
137 <a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion() <span class="keyword">const</span>;
138 <a name="l00073"></a>00073 std::string getIdentifier() <span class="keyword">const</span>;
139 <a name="l00074"></a>00074 std::string getName() <span class="keyword">const</span>;
140 <a name="l00075"></a>00075 std::string getDescription() <span class="keyword">const</span>;
141 <a name="l00076"></a>00076 std::string getMaker() <span class="keyword">const</span>;
142 <a name="l00077"></a>00077 <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span>;
143 <a name="l00078"></a>00078 std::string getCopyright() <span class="keyword">const</span>;
144 <a name="l00079"></a>00079
145 <a name="l00080"></a>00080 <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> getParameterDescriptors() <span class="keyword">const</span>;
146 <a name="l00081"></a>00081 <span class="keywordtype">float</span> getParameter(std::string) <span class="keyword">const</span>;
147 <a name="l00082"></a>00082 <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
148 <a name="l00083"></a>00083
149 <a name="l00084"></a>00084 <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> getPrograms() <span class="keyword">const</span>;
150 <a name="l00085"></a>00085 std::string getCurrentProgram() <span class="keyword">const</span>;
151 <a name="l00086"></a>00086 <span class="keywordtype">void</span> selectProgram(std::string);
152 <a name="l00087"></a>00087
153 <a name="l00088"></a>00088 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
154 <a name="l00089"></a>00089 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
155 <a name="l00090"></a>00090
156 <a name="l00091"></a>00091 <span class="keywordtype">size_t</span> getMinChannelCount() <span class="keyword">const</span>;
157 <a name="l00092"></a>00092 <span class="keywordtype">size_t</span> getMaxChannelCount() <span class="keyword">const</span>;
158 <a name="l00093"></a>00093
159 <a name="l00094"></a>00094 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> getOutputDescriptors() <span class="keyword">const</span>;
160 <a name="l00095"></a>00095
161 <a name="l00096"></a>00096 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> timestamp);
162 <a name="l00097"></a>00097
163 <a name="l00098"></a>00098 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures();
164 <a name="l00099"></a>00099
165 <a name="l00115"></a>00115 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> WrapperType&gt;
166 <a name="l00116"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">00116</a> WrapperType *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&#39;s plugin...">getWrapper</a>() {
167 <a name="l00117"></a>00117 WrapperType *w = <span class="keyword">dynamic_cast&lt;</span>WrapperType *<span class="keyword">&gt;</span>(<span class="keyword">this</span>);
168 <a name="l00118"></a>00118 <span class="keywordflow">if</span> (w) <span class="keywordflow">return</span> w;
169 <a name="l00119"></a>00119 <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> *pw = <span class="keyword">dynamic_cast&lt;</span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> *<span class="keyword">&gt;</span>(m_plugin);
170 <a name="l00120"></a>00120 <span class="keywordflow">if</span> (pw) <span class="keywordflow">return</span> pw-&gt;<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&#39;s plugin...">getWrapper</a>&lt;WrapperType&gt;();
171 <a name="l00121"></a>00121 <span class="keywordflow">return</span> 0;
172 <a name="l00122"></a>00122 }
173 <a name="l00123"></a>00123
174 <a name="l00124"></a>00124 <span class="keyword">protected</span>:
175 <a name="l00125"></a>00125 <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>(<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> *plugin); <span class="comment">// I take ownership of plugin</span>
176 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">00126</a> <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> *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a>;
177 <a name="l00127"></a>00127 };
178 <a name="l00128"></a>00128
179 <a name="l00129"></a>00129 }
180 <a name="l00130"></a>00130
181 <a name="l00131"></a>00131 }
182 <a name="l00132"></a>00132
183 <a name="l00133"></a>00133 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginWrapper.h)
184 <a name="l00134"></a>00134
185 <a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
186 </pre></div></div><!-- contents -->
187 </div> 91 </div>
188 <div id="nav-path" class="navpath">
189 <ul>
190 <li class="navelem"><a class="el" href="PluginWrapper_8h.html">PluginWrapper.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> 92 </body>
200 </html> 93 </html>