Mercurial > hg > vamp-docs

comparison code-docs/vamp-sdk_2Plugin_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: Plugin.h Source File</title> 8 <title>VampPluginSDK: Plugin.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('vamp-sdk_2Plugin_8h.html',''); 58 $(document).ready(function(){initNavTree('vamp-sdk_2Plugin_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">vamp-sdk/Plugin.h</div> </div> 63 <div class="title">vamp-sdk/Plugin.h</div> </div>
77 </div><!--header--> 64 </div><!--header-->
78 <div class="contents"> 65 <div class="contents">
79 <a href="vamp-sdk_2Plugin_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="vamp-sdk_2Plugin_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 Chris Cannam.</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_SDK_PLUGIN_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define _VAMP_SDK_PLUGIN_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;string&gt;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &lt;vector&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="vamp-sdk_2PluginBase_8h.html">PluginBase.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="vamp-sdk_2RealTime_8h.html">RealTime.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;<span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;namespace <a class="code" href="namespaceVamp.html">Vamp</a> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html"> 124</a></span>&#160;<span class="keyword">class </span><a class="code" href="classVamp_1_1Plugin.html">Plugin</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1PluginBase.html">PluginBase</a></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;{</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b"> 127</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>() { }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels,</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">size_t</span> stepSize,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordtype">size_t</span> blockSize) = 0;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"> 152</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, FrequencyDomain };</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div><div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d"> 179</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">getPreferredBlockSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;</div><div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2"> 194</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">getPreferredStepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div><div class="line"><a name="l00199"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30"> 199</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">getMinChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div><div class="line"><a name="l00204"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd"> 204</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">getMaxChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }</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="structVamp_1_1Plugin_1_1OutputDescriptor.html"> 206</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; {</div><div class="line"><a name="l00214"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b"> 214</a></span>&#160; std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">identifier</a>;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;</div><div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87"> 220</a></span>&#160; std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">name</a>;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1"> 227</a></span>&#160; std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">description</a>;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;</div><div class="line"><a name="l00232"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4"> 232</a></span>&#160; std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">unit</a>;</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;</div><div class="line"><a name="l00239"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d"> 239</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">hasFixedBinCount</a>;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;</div><div class="line"><a name="l00247"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc"> 247</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">binCount</a>;</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;</div><div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7"> 253</a></span>&#160; std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">binNames</a>;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;</div><div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31"> 260</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">hasKnownExtents</a>;</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;</div><div class="line"><a name="l00266"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4"> 266</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">minValue</a>;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;</div><div class="line"><a name="l00272"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f"> 272</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">maxValue</a>;</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;</div><div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4"> 278</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">isQuantized</a>;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;</div><div class="line"><a name="l00285"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b"> 285</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">quantizeStep</a>;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;</div><div class="line"><a name="l00287"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c"> 287</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> {</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;</div><div class="line"><a name="l00290"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca"> 290</a></span>&#160; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca">OneSamplePerStep</a>,</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;</div><div class="line"><a name="l00293"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629"> 293</a></span>&#160; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>,</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;</div><div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e"> 296</a></span>&#160; VariableSampleRate</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; };</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;</div><div class="line"><a name="l00302"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d"> 302</a></span>&#160; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a>;</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;</div><div class="line"><a name="l00314"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af"> 314</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">sampleRate</a>;</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;</div><div class="line"><a name="l00320"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3"> 320</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">hasDuration</a>;</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;</div><div class="line"><a name="l00322"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344"> 322</a></span>&#160; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">OutputDescriptor</a>() : <span class="comment">// defaults for mandatory non-class-type members</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; hasFixedBinCount(false),</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; binCount(0),</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; hasKnownExtents(false),</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; minValue(0),</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; maxValue(0),</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; isQuantized(false),</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; quantizeStep(0),</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; sampleType(OneSamplePerStep), </div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; sampleRate(0), </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; hasDuration(false) { }</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; };</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;</div><div class="line"><a name="l00335"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9"> 335</a></span>&#160; <span class="keyword">typedef</span> std::vector&lt;OutputDescriptor&gt; <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>;</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <span class="keyword">virtual</span> OutputList getOutputDescriptors() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;</div><div class="line"><a name="l00344"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html"> 344</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; {</div><div class="line"><a name="l00352"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b"> 352</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">hasTimestamp</a>;</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;</div><div class="line"><a name="l00360"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7"> 360</a></span>&#160; <a class="code" href="structVamp_1_1RealTime.html">RealTime</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">timestamp</a>;</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;</div><div class="line"><a name="l00368"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba"> 368</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">hasDuration</a>;</div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;</div><div class="line"><a name="l00375"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115"> 375</a></span>&#160; <a class="code" href="structVamp_1_1RealTime.html">RealTime</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">duration</a>;</div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; </div><div class="line"><a name="l00382"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71"> 382</a></span>&#160; std::vector&lt;float&gt; <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">values</a>;</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;</div><div class="line"><a name="l00387"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036"> 387</a></span>&#160; std::string <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">label</a>;</div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;</div><div class="line"><a name="l00389"></a><span class="lineno"><a class="line" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8"> 389</a></span>&#160; <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a>() : <span class="comment">// defaults for mandatory non-class-type members</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; hasTimestamp(false), hasDuration(false) { }</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; };</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;</div><div class="line"><a name="l00393"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1"> 393</a></span>&#160; <span class="keyword">typedef</span> std::vector&lt;Feature&gt; <a class="code" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>;</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;</div><div class="line"><a name="l00395"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f"> 395</a></span>&#160; <span class="keyword">typedef</span> std::map&lt;int, FeatureList&gt; <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>; <span class="comment">// key is output no</span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;</div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; <span class="keyword">virtual</span> FeatureSet process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,</div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; <a class="code" href="structVamp_1_1RealTime.html">RealTime</a> timestamp) = 0;</div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;</div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; <span class="keyword">virtual</span> FeatureSet getRemainingFeatures() = 0;</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;</div><div class="line"><a name="l00438"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5"> 438</a></span>&#160; <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">getType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;Feature Extraction Plugin&quot;</span>; }</div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160;</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00441"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9"> 441</a></span>&#160; <a class="code" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>(<span class="keywordtype">float</span> inputSampleRate) :</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; m_inputSampleRate(inputSampleRate) { }</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;</div><div class="line"><a name="l00444"></a><span class="lineno"><a class="line" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23"> 444</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;};</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;</div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;}</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160;</div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;<a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(<a class="code" href="classVamp_1_1Plugin.html">Plugin</a>.h)</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160;</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160;</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160;</div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160;</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="structVamp_1_1Plugin_1_1OutputDescriptor_html_ab0d7cc6ab19e53b5bd12ee234f549ea3"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">Vamp::Plugin::OutputDescriptor::hasDuration</a></div><div class="ttdeci">bool hasDuration</div><div class="ttdoc">True if the returned results for this output are known to have a duration field. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00320">vamp-sdk/Plugin.h:320</a></div></div>
81 <a name="l00003"></a>00003 <span class="comment">/*</span> 68 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_a8eb1fb35f73b247ed13de9527c18f036"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">Vamp::Plugin::Feature::label</a></div><div class="ttdeci">std::string label</div><div class="ttdoc">Label for the sample of this feature. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00387">vamp-sdk/Plugin.h:387</a></div></div>
82 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 69 <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>
83 <a name="l00005"></a>00005 <span class="comment"></span> 70 <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>
84 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> 71 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::OutputDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00206">vamp-sdk/Plugin.h:206</a></div></div>
85 <a name="l00007"></a>00007 <span class="comment"></span> 72 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_add0cbbdfa9c91764037c39365b1d42af"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">Vamp::Plugin::OutputDescriptor::sampleRate</a></div><div class="ttdeci">float sampleRate</div><div class="ttdoc">Sample rate of the output results, as samples per second. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00314">vamp-sdk/Plugin.h:314</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="structVamp_1_1Plugin_1_1OutputDescriptor_html_af0e577e1a256ff6eed6ea42133fec77d"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a></div><div class="ttdeci">bool hasFixedBinCount</div><div class="ttdoc">True if the output has the same number of values per sample for every output sample. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00239">vamp-sdk/Plugin.h:239</a></div></div>
87 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span> 74 <div class="ttc" id="vamp-sdk_2PluginBase_8h_html"><div class="ttname"><a href="vamp-sdk_2PluginBase_8h.html">PluginBase.h</a></div></div>
88 <a name="l00010"></a>00010 <span class="comment"> </span> 75 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_a60b9f3057386820dbcaec0eb1189ce71"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a></div><div class="ttdeci">std::vector&lt; float &gt; values</div><div class="ttdoc">Results for a single sample of this feature. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00382">vamp-sdk/Plugin.h:382</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="structVamp_1_1Plugin_1_1OutputDescriptor_html_abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">Vamp::Plugin::OutputDescriptor::FixedSampleRate</a></div><div class="ttdoc">Results are evenly spaced in time (sampleRate specified below) </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00293">vamp-sdk/Plugin.h:293</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_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>
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="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>
92 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> 79 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a3bed37153067b625b95acb40b60dbf0b"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">Vamp::Plugin::OutputDescriptor::quantizeStep</a></div><div class="ttdeci">float quantizeStep</div><div class="ttdoc">Quantization resolution of the output values (e.g. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00285">vamp-sdk/Plugin.h:285</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="structVamp_1_1Plugin_1_1Feature_html_acaa605f36839c07e76f4882f5e22d8d7"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">Vamp::Plugin::Feature::timestamp</a></div><div class="ttdeci">RealTime timestamp</div><div class="ttdoc">Timestamp of the output feature. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00360">vamp-sdk/Plugin.h:360</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 class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_af9b4fe8f78e7126ead820ba5dc55efd1"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">Vamp::Plugin::OutputDescriptor::description</a></div><div class="ttdeci">std::string description</div><div class="ttdoc">A human-readable short text describing the output. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00227">vamp-sdk/Plugin.h:227</a></div></div>
95 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> 82 <div class="ttc" id="classVamp_1_1Plugin_html_a1b78c4f46c72ef345ed27f0b9bf20ac9"><div class="ttname"><a href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Vamp::Plugin::Plugin</a></div><div class="ttdeci">Plugin(float inputSampleRate)</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00441">vamp-sdk/Plugin.h:441</a></div></div>
96 <a name="l00018"></a>00018 <span class="comment"></span> 83 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_ae2c893ddb1860589517ab7eaa989a18b"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">Vamp::Plugin::OutputDescriptor::identifier</a></div><div class="ttdeci">std::string identifier</div><div class="ttdoc">The name of the output, in computer-usable form. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00214">vamp-sdk/Plugin.h:214</a></div></div>
97 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> 84 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_ac9f5924c0be7571bba8e7ae7e7a921f4"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">Vamp::Plugin::OutputDescriptor::minValue</a></div><div class="ttdeci">float minValue</div><div class="ttdoc">Minimum value of the results in the output. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00266">vamp-sdk/Plugin.h:266</a></div></div>
98 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> 85 <div class="ttc" id="classVamp_1_1Plugin_html_a42d3096f9c1f58b1876024cd8d9ab80b"><div class="ttname"><a href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">Vamp::Plugin::~Plugin</a></div><div class="ttdeci">virtual ~Plugin()</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00127">vamp-sdk/Plugin.h:127</a></div></div>
99 <a name="l00021"></a>00021 <span class="comment"></span> 86 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a31d9b79e2d8241344f551a22fcb5c8c7"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">Vamp::Plugin::OutputDescriptor::binNames</a></div><div class="ttdeci">std::vector&lt; std::string &gt; binNames</div><div class="ttdoc">The (human-readable) names of each of the bins, if appropriate. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00253">vamp-sdk/Plugin.h:253</a></div></div>
100 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span> 87 <div class="ttc" id="classVamp_1_1Plugin_html_ae3b9c32b12796ece152388babad7cc7d"><div class="ttname"><a href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin::getPreferredBlockSize</a></div><div class="ttdeci">virtual size_t getPreferredBlockSize() const</div><div class="ttdoc">Get the preferred block size (window size – the number of sample frames passed in each block to the ...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00179">vamp-sdk/Plugin.h:179</a></div></div>
101 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> 88 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Feature</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00344">vamp-sdk/Plugin.h:344</a></div></div>
102 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> 89 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_acd4b4cd0d2c31512f4a5df50f8f7a7b8"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Vamp::Plugin::Feature::Feature</a></div><div class="ttdeci">Feature()</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00389">vamp-sdk/Plugin.h:389</a></div></div>
103 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> 90 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a907b4e8fbb48a46ac5a05f880d72719f"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">Vamp::Plugin::OutputDescriptor::maxValue</a></div><div class="ttdeci">float maxValue</div><div class="ttdoc">Maximum value of the results in the output. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00272">vamp-sdk/Plugin.h:272</a></div></div>
104 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> 91 <div class="ttc" id="classVamp_1_1Plugin_html_a530123068767a8728c568ffccfe3e4e5"><div class="ttname"><a href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">Vamp::Plugin::getType</a></div><div class="ttdeci">virtual std::string getType() const</div><div class="ttdoc">Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00438">vamp-sdk/Plugin.h:438</a></div></div>
105 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> 92 <div class="ttc" id="classVamp_1_1Plugin_html_a59b9dd82a4f4eb946cd0474cc81abc23"><div class="ttname"><a href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a></div><div class="ttdeci">float m_inputSampleRate</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00444">vamp-sdk/Plugin.h:444</a></div></div>
106 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> 93 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_af687c0a7fe041757e922ec296862b115"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">Vamp::Plugin::Feature::duration</a></div><div class="ttdeci">RealTime duration</div><div class="ttdoc">Duration of the output feature. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00375">vamp-sdk/Plugin.h:375</a></div></div>
107 <a name="l00029"></a>00029 <span class="comment"></span> 94 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_aa057a8833fa037f06ac9f7b85b85d5e4"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">Vamp::Plugin::OutputDescriptor::unit</a></div><div class="ttdeci">std::string unit</div><div class="ttdoc">The unit of the output, in human-readable form. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00232">vamp-sdk/Plugin.h:232</a></div></div>
108 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> 95 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a1ebf91cc3f60e4cbba818c10591cd344"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">Vamp::Plugin::OutputDescriptor::OutputDescriptor</a></div><div class="ttdeci">OutputDescriptor()</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00322">vamp-sdk/Plugin.h:322</a></div></div>
109 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> 96 <div class="ttc" id="classVamp_1_1Plugin_html_ab74f7634c6ac6e3da115667808a79c30"><div class="ttname"><a href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">Vamp::Plugin::getMinChannelCount</a></div><div class="ttdeci">virtual size_t getMinChannelCount() const</div><div class="ttdoc">Get the minimum supported number of input channels. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00199">vamp-sdk/Plugin.h:199</a></div></div>
110 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> 97 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_ab824b2b34ee50f897a30901c620e8d87"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">Vamp::Plugin::OutputDescriptor::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">The human-readable name of the output. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00220">vamp-sdk/Plugin.h:220</a></div></div>
111 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> 98 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_abffa9ed50cd756df70fd51f0355f448c"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a></div><div class="ttdeci">SampleType</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00287">vamp-sdk/Plugin.h:287</a></div></div>
112 <a name="l00034"></a>00034 <span class="comment"> authorization.</span> 99 <div class="ttc" id="classVamp_1_1Plugin_html_a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"><div class="ttname"><a href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">Vamp::Plugin::TimeDomain</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00152">vamp-sdk/Plugin.h:152</a></div></div>
113 <a name="l00035"></a>00035 <span class="comment">*/</span> 100 <div class="ttc" id="classVamp_1_1Plugin_html_a0bff9464bc8c117470136c396b2405dd"><div class="ttname"><a href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">Vamp::Plugin::getMaxChannelCount</a></div><div class="ttdeci">virtual size_t getMaxChannelCount() const</div><div class="ttdoc">Get the maximum supported number of input channels. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00204">vamp-sdk/Plugin.h:204</a></div></div>
114 <a name="l00036"></a>00036 101 <div class="ttc" id="classVamp_1_1Plugin_html_a33eaf9a265bc3a055e156452112456c2"><div class="ttname"><a href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin::getPreferredStepSize</a></div><div class="ttdeci">virtual size_t getPreferredStepSize() const</div><div class="ttdoc">Get the preferred step size (window increment – the distance in sample frames between the start fram...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00194">vamp-sdk/Plugin.h:194</a></div></div>
115 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_SDK_PLUGIN_H_</span> 102 <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>
116 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_H_</span> 103 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_a98907091d0b6a589720ae35ae588a82b"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a></div><div class="ttdeci">bool hasTimestamp</div><div class="ttdoc">True if an output feature has its own timestamp. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00352">vamp-sdk/Plugin.h:352</a></div></div>
117 <a name="l00039"></a>00039 <span class="preprocessor"></span> 104 <div class="ttc" id="plugguard_8h_html_a1a2724ea453971288d3218e4eab3072c"><div class="ttname"><a href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a></div><div class="ttdeci">#define _VAMP_SDK_PLUGSPACE_BEGIN(h)</div><div class="ttdef"><b>Definition:</b> <a href="plugguard_8h_source.html#l00079">plugguard.h:79</a></div></div>
118 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span> 105 <div class="ttc" id="vamp-sdk_2RealTime_8h_html"><div class="ttname"><a href="vamp-sdk_2RealTime_8h.html">RealTime.h</a></div></div>
119 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span> 106 <div class="ttc" id="classVamp_1_1Plugin_html_a0730bc72c87fa02eb8d2854b233f7be1"><div class="ttname"><a href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a></div><div class="ttdeci">std::vector&lt; Feature &gt; FeatureList</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00393">vamp-sdk/Plugin.h:393</a></div></div>
120 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span> 107 <div class="ttc" id="plugguard_8h_html_ac879bb1077ecc6132ea3581ef9033753"><div class="ttname"><a href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a></div><div class="ttdeci">#define _VAMP_SDK_PLUGSPACE_END(h)</div><div class="ttdef"><b>Definition:</b> <a href="plugguard_8h_source.html#l00080">plugguard.h:80</a></div></div>
121 <a name="l00043"></a>00043 108 <div class="ttc" id="structVamp_1_1Plugin_1_1Feature_html_a33686757bd4481c72494122e9bfb9fba"><div class="ttname"><a href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a></div><div class="ttdeci">bool hasDuration</div><div class="ttdoc">True if an output feature has a specified duration. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00368">vamp-sdk/Plugin.h:368</a></div></div>
122 <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;PluginBase.h&quot;</span> 109 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a></div><div class="ttdoc">Results from each process() align with that call&amp;#39;s block start. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00290">vamp-sdk/Plugin.h:290</a></div></div>
123 <a name="l00045"></a>00045 <span class="preprocessor">#include &quot;RealTime.h&quot;</span> 110 <div class="ttc" id="classVamp_1_1PluginBase_html"><div class="ttname"><a href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></div><div class="ttdoc">A base class for plugins with optional configurable parameters, programs, etc. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2PluginBase_8h_source.html#l00060">vamp-sdk/PluginBase.h:60</a></div></div>
124 <a name="l00046"></a>00046 111 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_afdd006959a995e40ef7d565a3a4df6dc"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">Vamp::Plugin::OutputDescriptor::binCount</a></div><div class="ttdeci">size_t binCount</div><div class="ttdoc">The number of values per result of the output. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00247">vamp-sdk/Plugin.h:247</a></div></div>
125 <a name="l00047"></a>00047 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span> 112 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a1b4858928d23bfd7d5bc557c82a83fb4"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">Vamp::Plugin::OutputDescriptor::isQuantized</a></div><div class="ttdeci">bool isQuantized</div><div class="ttdoc">True if the output values are quantized to a particular resolution. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00278">vamp-sdk/Plugin.h:278</a></div></div>
126 <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h) 113 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_a0d1194980d44e31b25ef3b4b070d6b5d"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">Vamp::Plugin::OutputDescriptor::sampleType</a></div><div class="ttdeci">SampleType sampleType</div><div class="ttdoc">Positioning in time of the output results. </div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00302">vamp-sdk/Plugin.h:302</a></div></div>
127 <a name="l00049"></a>00049 114 <div class="ttc" id="plugguard_8h_html"><div class="ttname"><a href="plugguard_8h.html">plugguard.h</a></div></div>
128 <a name="l00050"></a>00050 namespace Vamp { 115 <div class="ttc" id="structVamp_1_1Plugin_1_1OutputDescriptor_html_ae9ccb65f99f477096b65dd031f4c5e31"><div class="ttname"><a href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a></div><div class="ttdeci">bool hasKnownExtents</div><div class="ttdoc">True if the results in each output bin fall within a fixed numeric range (minimum and maximum values)...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00260">vamp-sdk/Plugin.h:260</a></div></div>
129 <a name="l00051"></a>00051 116 </div><!-- fragment --></div><!-- contents -->
130 <a name="l00124"></a><a class="code" href="classVamp_1_1Plugin.html">00124</a> <span class="keyword">class </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> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a> 117 </div><!-- doc-content -->
131 <a name="l00125"></a>00125 { 118 <!-- start footer part -->
132 <a name="l00126"></a>00126 <span class="keyword">public</span>: 119 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
133 <a name="l00127"></a><a class="code" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">00127</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>() { } 120 <ul>
134 <a name="l00128"></a>00128 121 <li class="navelem"><a class="el" href="dir_8661d6ced9d80e9e8c7982a58cd73404.html">vamp-sdk</a></li><li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a></li>
135 <a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels, 122 <li class="footer">Generated by
136 <a name="l00142"></a>00142 <span class="keywordtype">size_t</span> stepSize, 123 <a href="http://www.doxygen.org/index.html">
137 <a name="l00143"></a>00143 <span class="keywordtype">size_t</span> blockSize) = 0; 124 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
138 <a name="l00144"></a>00144 125 </ul>
139 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
140 <a name="l00151"></a>00151
141 <a name="l00152"></a><a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">00152</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, FrequencyDomain };
142 <a name="l00153"></a>00153
143 <a name="l00169"></a>00169 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0;
144 <a name="l00170"></a>00170
145 <a name="l00179"></a><a class="code" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">00179</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac" title="Get the preferred block size (window size -- the number of sample frames passed in each block to the ...">getPreferredBlockSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
146 <a name="l00180"></a>00180
147 <a name="l00194"></a><a class="code" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">00194</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567" title="Get the preferred step size (window increment -- the distance in sample frames between the start fram...">getPreferredStepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
148 <a name="l00195"></a>00195
149 <a name="l00199"></a><a class="code" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">00199</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
150 <a name="l00200"></a>00200
151 <a name="l00204"></a><a class="code" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">00204</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
152 <a name="l00205"></a>00205
153 <a name="l00206"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">00206</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>
154 <a name="l00207"></a>00207 {
155 <a name="l00214"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">00214</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a>;
156 <a name="l00215"></a>00215
157 <a name="l00220"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">00220</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a>;
158 <a name="l00221"></a>00221
159 <a name="l00227"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">00227</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a>;
160 <a name="l00228"></a>00228
161 <a name="l00232"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">00232</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a>;
162 <a name="l00233"></a>00233
163 <a name="l00239"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">00239</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample.">hasFixedBinCount</a>;
164 <a name="l00240"></a>00240
165 <a name="l00247"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">00247</a> <span class="keywordtype">size_t</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a>;
166 <a name="l00248"></a>00248
167 <a name="l00253"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">00253</a> std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7" title="The (human-readable) names of each of the bins, if appropriate.">binNames</a>;
168 <a name="l00254"></a>00254
169 <a name="l00260"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">00260</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum and maximum values)...">hasKnownExtents</a>;
170 <a name="l00261"></a>00261
171 <a name="l00266"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">00266</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4" title="Minimum value of the results in the output.">minValue</a>;
172 <a name="l00267"></a>00267
173 <a name="l00272"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">00272</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f" title="Maximum value of the results in the output.">maxValue</a>;
174 <a name="l00273"></a>00273
175 <a name="l00278"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">00278</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a>;
176 <a name="l00279"></a>00279
177 <a name="l00285"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">00285</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b" title="Quantization resolution of the output values (e.g.">quantizeStep</a>;
178 <a name="l00286"></a>00286
179 <a name="l00287"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">00287</a> <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> {
180 <a name="l00288"></a>00288
181 <a name="l00290"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca">00290</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call&#39;s block start.">OneSamplePerStep</a>,
182 <a name="l00291"></a>00291
183 <a name="l00293"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">00293</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629" title="Results are evenly spaced in time (sampleRate specified below)">FixedSampleRate</a>,
184 <a name="l00294"></a>00294
185 <a name="l00296"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">00296</a> VariableSampleRate
186 <a name="l00297"></a>00297 };
187 <a name="l00298"></a>00298
188 <a name="l00302"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">00302</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a>;
189 <a name="l00303"></a>00303
190 <a name="l00314"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">00314</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af" title="Sample rate of the output results, as samples per second.">sampleRate</a>;
191 <a name="l00315"></a>00315
192 <a name="l00320"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">00320</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3" title="True if the returned results for this output are known to have a duration field.">hasDuration</a>;
193 <a name="l00321"></a>00321
194 <a name="l00322"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">00322</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>() : <span class="comment">// defaults for mandatory non-class-type members</span>
195 <a name="l00323"></a>00323 hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
196 <a name="l00324"></a>00324 sampleType(OneSamplePerStep), hasDuration(false) { }
197 <a name="l00325"></a>00325 };
198 <a name="l00326"></a>00326
199 <a name="l00327"></a><a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">00327</a> <span class="keyword">typedef</span> std::vector&lt;OutputDescriptor&gt; <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>;
200 <a name="l00328"></a>00328
201 <a name="l00334"></a>00334 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> getOutputDescriptors() <span class="keyword">const</span> = 0;
202 <a name="l00335"></a>00335
203 <a name="l00336"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">00336</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>
204 <a name="l00337"></a>00337 {
205 <a name="l00344"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">00344</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a>;
206 <a name="l00345"></a>00345
207 <a name="l00352"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">00352</a> <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> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7" title="Timestamp of the output feature.">timestamp</a>;
208 <a name="l00353"></a>00353
209 <a name="l00360"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">00360</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba" title="True if an output feature has a specified duration.">hasDuration</a>;
210 <a name="l00361"></a>00361
211 <a name="l00367"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">00367</a> <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> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115" title="Duration of the output feature.">duration</a>;
212 <a name="l00368"></a>00368
213 <a name="l00374"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">00374</a> std::vector&lt;float&gt; <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>;
214 <a name="l00375"></a>00375
215 <a name="l00379"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">00379</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036" title="Label for the sample of this feature.">label</a>;
216 <a name="l00380"></a>00380
217 <a name="l00381"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">00381</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>() : <span class="comment">// defaults for mandatory non-class-type members</span>
218 <a name="l00382"></a>00382 hasTimestamp(false), hasDuration(false) { }
219 <a name="l00383"></a>00383 };
220 <a name="l00384"></a>00384
221 <a name="l00385"></a><a class="code" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">00385</a> <span class="keyword">typedef</span> std::vector&lt;Feature&gt; <a class="code" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>;
222 <a name="l00386"></a>00386
223 <a name="l00387"></a><a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">00387</a> <span class="keyword">typedef</span> std::map&lt;int, FeatureList&gt; <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>; <span class="comment">// key is output no</span>
224 <a name="l00388"></a>00388
225 <a name="l00416"></a>00416 <span class="keyword">virtual</span> <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,
226 <a name="l00417"></a>00417 <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) = 0;
227 <a name="l00418"></a>00418
228 <a name="l00423"></a>00423 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures() = 0;
229 <a name="l00424"></a>00424
230 <a name="l00430"></a><a class="code" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">00430</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91" title="Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase...">getType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;Feature Extraction Plugin&quot;</span>; }
231 <a name="l00431"></a>00431
232 <a name="l00432"></a>00432 <span class="keyword">protected</span>:
233 <a name="l00433"></a><a class="code" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">00433</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>(<span class="keywordtype">float</span> inputSampleRate) :
234 <a name="l00434"></a>00434 m_inputSampleRate(inputSampleRate) { }
235 <a name="l00435"></a>00435
236 <a name="l00436"></a><a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">00436</a> <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;
237 <a name="l00437"></a>00437 };
238 <a name="l00438"></a>00438
239 <a name="l00439"></a>00439 }
240 <a name="l00440"></a>00440
241 <a name="l00441"></a>00441 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h)
242 <a name="l00442"></a>00442
243 <a name="l00443"></a>00443 <span class="preprocessor">#endif</span>
244 <a name="l00444"></a>00444 <span class="preprocessor"></span>
245 <a name="l00445"></a>00445
246 <a name="l00446"></a>00446
247 </pre></div></div><!-- contents -->
248 </div> 126 </div>
249 <div id="nav-path" class="navpath">
250 <ul>
251 <li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a> </li>
252
253 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
254 <a href="http://www.doxygen.org/index.html">
255 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
256 </ul>
257 </div>
258
259
260 </body> 127 </body>
261 </html> 128 </html>