Mercurial > hg > vamp-website

annotate code-doc/vamp-sdk_2Plugin_8h_source.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@50 5 <title>VampPluginSDK: Plugin.h Source File</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@50 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@50 48 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@50 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@50 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@50 51 </ul>
cannam@50 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
cannam@50 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
cannam@50 57 </ul>
cannam@50 58 </div>
cannam@50 59 </div>
cannam@50 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 61 <div id="nav-tree">
cannam@50 62 <div id="nav-tree-contents">
cannam@50 63 </div>
cannam@50 64 </div>
cannam@50 65 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 66 class="ui-resizable-handle">
cannam@50 67 </div>
cannam@50 68 </div>
cannam@50 69 <script type="text/javascript">
cannam@50 70 initNavTree('vamp-sdk_2Plugin_8h.html','');
cannam@50 71 </script>
cannam@50 72 <div id="doc-content">
cannam@50 73 <div class="header">
cannam@50 74 <div class="headertitle">
cannam@50 75 <div class="title">vamp-sdk/Plugin.h</div> </div>
cannam@50 76 </div>
cannam@50 77 <div class="contents">
cannam@50 78 <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>
cannam@50 79 <a name="l00002"></a>00002
cannam@50 80 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@50 81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@50 82 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@50 83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@50 84 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@50 85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@50 86 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@50 87 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@50 88 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@50 89 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@50 90 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
cannam@50 91 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@50 92 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@50 93 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@50 94 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@50 95 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@50 96 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@50 97 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@50 98 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@50 99 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
cannam@50 100 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@50 101 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@50 102 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@50 103 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@50 104 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@50 105 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@50 106 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@50 107 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@50 108 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@50 109 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@50 110 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@50 111 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@50 112 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@50 113 <a name="l00036"></a>00036
cannam@50 114 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_SDK_PLUGIN_H_</span>
cannam@50 115 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_H_</span>
cannam@50 116 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@50 117 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span>
cannam@50 118 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span>
cannam@50 119 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span>
cannam@50 120 <a name="l00043"></a>00043
cannam@50 121 <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;PluginBase.h&quot;</span>
cannam@50 122 <a name="l00045"></a>00045 <span class="preprocessor">#include &quot;RealTime.h&quot;</span>
cannam@50 123 <a name="l00046"></a>00046
cannam@50 124 <a name="l00047"></a>00047 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span>
cannam@50 125 <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h)
cannam@50 126 <a name="l00049"></a>00049
cannam@50 127 <a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp {
cannam@50 128 <a name="l00051"></a>00051
cannam@50 129 <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>
cannam@50 130 <a name="l00125"></a>00125 {
cannam@50 131 <a name="l00126"></a>00126 <span class="keyword">public</span>:
cannam@50 132 <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>() { }
cannam@50 133 <a name="l00128"></a>00128
cannam@50 134 <a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels,
cannam@50 135 <a name="l00142"></a>00142 <span class="keywordtype">size_t</span> stepSize,
cannam@50 136 <a name="l00143"></a>00143 <span class="keywordtype">size_t</span> blockSize) = 0;
cannam@50 137 <a name="l00144"></a>00144
cannam@50 138 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
cannam@50 139 <a name="l00151"></a>00151
cannam@50 140 <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 };
cannam@50 141 <a name="l00153"></a>00153
cannam@50 142 <a name="l00169"></a>00169 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0;
cannam@50 143 <a name="l00170"></a>00170
cannam@50 144 <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; }
cannam@50 145 <a name="l00180"></a>00180
cannam@50 146 <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; }
cannam@50 147 <a name="l00195"></a>00195
cannam@50 148 <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; }
cannam@50 149 <a name="l00200"></a>00200
cannam@50 150 <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; }
cannam@50 151 <a name="l00205"></a>00205
cannam@50 152 <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>
cannam@50 153 <a name="l00207"></a>00207 {
cannam@50 154 <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>;
cannam@50 155 <a name="l00215"></a>00215
cannam@50 156 <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>;
cannam@50 157 <a name="l00221"></a>00221
cannam@50 158 <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>;
cannam@50 159 <a name="l00228"></a>00228
cannam@50 160 <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>;
cannam@50 161 <a name="l00233"></a>00233
cannam@50 162 <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>;
cannam@50 163 <a name="l00240"></a>00240
cannam@50 164 <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>;
cannam@50 165 <a name="l00248"></a>00248
cannam@50 166 <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>;
cannam@50 167 <a name="l00254"></a>00254
cannam@50 168 <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>;
cannam@50 169 <a name="l00261"></a>00261
cannam@50 170 <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>;
cannam@50 171 <a name="l00267"></a>00267
cannam@50 172 <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>;
cannam@50 173 <a name="l00273"></a>00273
cannam@50 174 <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>;
cannam@50 175 <a name="l00279"></a>00279
cannam@50 176 <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>;
cannam@50 177 <a name="l00286"></a>00286
cannam@50 178 <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> {
cannam@50 179 <a name="l00288"></a>00288
cannam@50 180 <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>,
cannam@50 181 <a name="l00291"></a>00291
cannam@50 182 <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>,
cannam@50 183 <a name="l00294"></a>00294
cannam@50 184 <a name="l00296"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">00296</a> VariableSampleRate
cannam@50 185 <a name="l00297"></a>00297 };
cannam@50 186 <a name="l00298"></a>00298
cannam@50 187 <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>;
cannam@50 188 <a name="l00303"></a>00303
cannam@50 189 <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>;
cannam@50 190 <a name="l00315"></a>00315
cannam@50 191 <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>;
cannam@50 192 <a name="l00321"></a>00321
cannam@50 193 <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>
cannam@50 194 <a name="l00323"></a>00323 hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
cannam@50 195 <a name="l00324"></a>00324 sampleType(OneSamplePerStep), hasDuration(false) { }
cannam@50 196 <a name="l00325"></a>00325 };
cannam@50 197 <a name="l00326"></a>00326
cannam@50 198 <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>;
cannam@50 199 <a name="l00328"></a>00328
cannam@50 200 <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;
cannam@50 201 <a name="l00335"></a>00335
cannam@50 202 <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>
cannam@50 203 <a name="l00337"></a>00337 {
cannam@50 204 <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>;
cannam@50 205 <a name="l00345"></a>00345
cannam@50 206 <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>;
cannam@50 207 <a name="l00353"></a>00353
cannam@50 208 <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>;
cannam@50 209 <a name="l00361"></a>00361
cannam@50 210 <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>;
cannam@50 211 <a name="l00368"></a>00368
cannam@50 212 <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>;
cannam@50 213 <a name="l00375"></a>00375
cannam@50 214 <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>;
cannam@50 215 <a name="l00380"></a>00380
cannam@50 216 <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>
cannam@50 217 <a name="l00382"></a>00382 hasTimestamp(false), hasDuration(false) { }
cannam@50 218 <a name="l00383"></a>00383 };
cannam@50 219 <a name="l00384"></a>00384
cannam@50 220 <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>;
cannam@50 221 <a name="l00386"></a>00386
cannam@50 222 <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>
cannam@50 223 <a name="l00388"></a>00388
cannam@50 224 <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,
cannam@50 225 <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;
cannam@50 226 <a name="l00418"></a>00418
cannam@50 227 <a name="l00423"></a>00423 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures() = 0;
cannam@50 228 <a name="l00424"></a>00424
cannam@50 229 <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>; }
cannam@50 230 <a name="l00431"></a>00431
cannam@50 231 <a name="l00432"></a>00432 <span class="keyword">protected</span>:
cannam@50 232 <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) :
cannam@50 233 <a name="l00434"></a>00434 m_inputSampleRate(inputSampleRate) { }
cannam@50 234 <a name="l00435"></a>00435
cannam@50 235 <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>;
cannam@50 236 <a name="l00437"></a>00437 };
cannam@50 237 <a name="l00438"></a>00438
cannam@50 238 <a name="l00439"></a>00439 }
cannam@50 239 <a name="l00440"></a>00440
cannam@50 240 <a name="l00441"></a>00441 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h)
cannam@50 241 <a name="l00442"></a>00442
cannam@50 242 <a name="l00443"></a>00443 <span class="preprocessor">#endif</span>
cannam@50 243 <a name="l00444"></a>00444 <span class="preprocessor"></span>
cannam@50 244 <a name="l00445"></a>00445
cannam@50 245 <a name="l00446"></a>00446
cannam@50 246 </pre></div></div>
cannam@50 247 </div>
cannam@50 248 <div id="nav-path" class="navpath">
cannam@50 249 <ul>
cannam@50 250 <li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a> </li>
cannam@50 251
cannam@50 252 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
cannam@50 253 <a href="http://www.doxygen.org/index.html">
cannam@50 254 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 255 </ul>
cannam@50 256 </div>
cannam@50 257
cannam@50 258
cannam@50 259 </body>
cannam@50 260 </html>