Mercurial > hg > vamp-website

annotate code-doc/Plugin_8h-source.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Plugin.h Source File</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
cannam@0 19 </div>
cannam@0 20 </div>
cannam@0 21 </div>
cannam@0 22 <h1>Plugin.h</h1><a href="Plugin_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@0 23 <a name="l00002"></a>00002
cannam@0 24 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@0 25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@0 26 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@0 27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@0 28 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@0 29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@0 30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@0 31 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@0 32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@0 33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@0 34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@0 35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@0 36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@0 37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@0 38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@0 39 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@0 40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@0 41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@0 42 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@0 43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@0 44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@0 45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@0 46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@0 47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@0 48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@0 49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@0 50 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@0 51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@0 52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@0 53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@0 54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@0 55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@0 56 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@0 57 <a name="l00036"></a>00036
cannam@0 58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_H_</span>
cannam@0 59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_H_</span>
cannam@0 60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@0 61 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="PluginBase_8h.html">PluginBase.h</a>"</span>
cannam@0 62 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="RealTime_8h.html">RealTime.h</a>"</span>
cannam@0 63 <a name="l00042"></a>00042
cannam@0 64 <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;string&gt;</span>
cannam@0 65 <a name="l00044"></a>00044 <span class="preprocessor">#include &lt;vector&gt;</span>
cannam@0 66 <a name="l00045"></a>00045 <span class="preprocessor">#include &lt;map&gt;</span>
cannam@0 67 <a name="l00046"></a>00046
cannam@0 68 <a name="l00047"></a><a class="code" href="namespaceVamp.html">00047</a> <span class="keyword">namespace </span>Vamp {
cannam@0 69 <a name="l00048"></a>00048
cannam@0 70 <a name="l00121"></a><a class="code" href="classVamp_1_1Plugin.html">00121</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...">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@0 71 <a name="l00122"></a>00122 {
cannam@0 72 <a name="l00123"></a>00123 <span class="keyword">public</span>:
cannam@0 73 <a name="l00124"></a><a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">00124</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>() { }
cannam@0 74 <a name="l00125"></a>00125
cannam@0 75 <a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise</a>(<span class="keywordtype">size_t</span> inputChannels,
cannam@0 76 <a name="l00139"></a>00139 <span class="keywordtype">size_t</span> stepSize,
cannam@0 77 <a name="l00140"></a>00140 <span class="keywordtype">size_t</span> blockSize) = 0;
cannam@0 78 <a name="l00141"></a>00141
cannam@0 79 <a name="l00147"></a>00147 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>() = 0;
cannam@0 80 <a name="l00148"></a>00148
cannam@0 81 <a name="l00149"></a><a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">00149</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> };
cannam@0 82 <a name="l00150"></a>00150
cannam@0 83 <a name="l00161"></a>00161 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6" title="Get the plugin&amp;#39;s required input domain.">getInputDomain</a>() <span class="keyword">const</span> = 0;
cannam@0 84 <a name="l00162"></a>00162
cannam@0 85 <a name="l00171"></a><a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">00171</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
cannam@0 86 <a name="l00172"></a>00172
cannam@0 87 <a name="l00186"></a><a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">00186</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
cannam@0 88 <a name="l00187"></a>00187
cannam@0 89 <a name="l00191"></a><a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">00191</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
cannam@0 90 <a name="l00192"></a>00192
cannam@0 91 <a name="l00196"></a><a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">00196</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
cannam@0 92 <a name="l00197"></a>00197
cannam@0 93 <a name="l00198"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">00198</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>
cannam@0 94 <a name="l00199"></a>00199 {
cannam@0 95 <a name="l00206"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">00206</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a>;
cannam@0 96 <a name="l00207"></a>00207
cannam@0 97 <a name="l00212"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">00212</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a>;
cannam@0 98 <a name="l00213"></a>00213
cannam@0 99 <a name="l00219"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">00219</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a>;
cannam@0 100 <a name="l00220"></a>00220
cannam@0 101 <a name="l00224"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">00224</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a>;
cannam@0 102 <a name="l00225"></a>00225
cannam@0 103 <a name="l00231"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d">00231</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample...">hasFixedBinCount</a>;
cannam@0 104 <a name="l00232"></a>00232
cannam@0 105 <a name="l00239"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc">00239</a> <span class="keywordtype">size_t</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a>;
cannam@0 106 <a name="l00240"></a>00240
cannam@0 107 <a name="l00245"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7">00245</a> std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7" title="The (human-readable) names of each of the bins, if appropriate.">binNames</a>;
cannam@0 108 <a name="l00246"></a>00246
cannam@0 109 <a name="l00252"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">00252</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum...">hasKnownExtents</a>;
cannam@0 110 <a name="l00253"></a>00253
cannam@0 111 <a name="l00258"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">00258</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4" title="Minimum value of the results in the output.">minValue</a>;
cannam@0 112 <a name="l00259"></a>00259
cannam@0 113 <a name="l00264"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">00264</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f" title="Maximum value of the results in the output.">maxValue</a>;
cannam@0 114 <a name="l00265"></a>00265
cannam@0 115 <a name="l00270"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">00270</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a>;
cannam@0 116 <a name="l00271"></a>00271
cannam@0 117 <a name="l00277"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">00277</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b" title="Quantization resolution of the output values (e.g.">quantizeStep</a>;
cannam@0 118 <a name="l00278"></a>00278
cannam@0 119 <a name="l00279"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">00279</a> <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> {
cannam@0 120 <a name="l00280"></a>00280
cannam@0 121 <a name="l00282"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca">00282</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call&amp;#39;s block start.">OneSamplePerStep</a>,
cannam@0 122 <a name="l00283"></a>00283
cannam@0 123 <a name="l00285"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629">00285</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629" title="Results are evenly spaced in time (sampleRate specified below).">FixedSampleRate</a>,
cannam@0 124 <a name="l00286"></a>00286
cannam@0 125 <a name="l00288"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e">00288</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e" title="Results are unevenly spaced and have individual timestamps.">VariableSampleRate</a>
cannam@0 126 <a name="l00289"></a>00289 };
cannam@0 127 <a name="l00290"></a>00290
cannam@0 128 <a name="l00294"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d">00294</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a>;
cannam@0 129 <a name="l00295"></a>00295
cannam@0 130 <a name="l00306"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af">00306</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af" title="Sample rate of the output results, as samples per second.">sampleRate</a>;
cannam@0 131 <a name="l00307"></a>00307 };
cannam@0 132 <a name="l00308"></a>00308
cannam@0 133 <a name="l00309"></a><a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">00309</a> <span class="keyword">typedef</span> std::vector&lt;OutputDescriptor&gt; <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>;
cannam@0 134 <a name="l00310"></a>00310
cannam@0 135 <a name="l00316"></a>00316 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span> = 0;
cannam@0 136 <a name="l00317"></a>00317
cannam@0 137 <a name="l00318"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">00318</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>
cannam@0 138 <a name="l00319"></a>00319 {
cannam@0 139 <a name="l00325"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b">00325</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a>;
cannam@0 140 <a name="l00326"></a>00326
cannam@0 141 <a name="l00332"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7">00332</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7" title="Timestamp of the output feature.">timestamp</a>;
cannam@0 142 <a name="l00333"></a>00333
cannam@0 143 <a name="l00339"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71">00339</a> std::vector&lt;float&gt; <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>;
cannam@0 144 <a name="l00340"></a>00340
cannam@0 145 <a name="l00344"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">00344</a> std::string <a class="code" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036" title="Label for the sample of this feature.">label</a>;
cannam@0 146 <a name="l00345"></a>00345 };
cannam@0 147 <a name="l00346"></a>00346
cannam@0 148 <a name="l00347"></a><a class="code" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">00347</a> <span class="keyword">typedef</span> std::vector&lt;Feature&gt; <a class="code" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>;
cannam@0 149 <a name="l00348"></a><a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">00348</a> <span class="keyword">typedef</span> std::map&lt;int, FeatureList&gt; <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>; <span class="comment">// key is output no</span>
cannam@0 150 <a name="l00349"></a>00349
cannam@0 151 <a name="l00377"></a>00377 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
cannam@0 152 <a name="l00378"></a>00378 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp) = 0;
cannam@0 153 <a name="l00379"></a>00379
cannam@0 154 <a name="l00384"></a>00384 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>() = 0;
cannam@0 155 <a name="l00385"></a>00385
cannam@0 156 <a name="l00391"></a><a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">00391</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91" title="Used to distinguish between Vamp::Plugin and other potential sibling subclasses of...">getType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"Feature Extraction Plugin"</span>; }
cannam@0 157 <a name="l00392"></a>00392
cannam@0 158 <a name="l00393"></a>00393 <span class="keyword">protected</span>:
cannam@0 159 <a name="l00394"></a><a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">00394</a> <a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>(<span class="keywordtype">float</span> inputSampleRate) :
cannam@0 160 <a name="l00395"></a>00395 <a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>(inputSampleRate) { }
cannam@0 161 <a name="l00396"></a>00396
cannam@0 162 <a name="l00397"></a><a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">00397</a> <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;
cannam@0 163 <a name="l00398"></a>00398 };
cannam@0 164 <a name="l00399"></a>00399
cannam@0 165 <a name="l00400"></a>00400 }
cannam@0 166 <a name="l00401"></a>00401
cannam@0 167 <a name="l00402"></a>00402 <span class="preprocessor">#endif</span>
cannam@0 168 <a name="l00403"></a>00403 <span class="preprocessor"></span>
cannam@0 169 <a name="l00404"></a>00404
cannam@0 170 <a name="l00405"></a>00405
cannam@0 171 </pre></div></div>
cannam@0 172 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:06 2008 for VampPluginSDK by&nbsp;
cannam@0 173 <a href="http://www.doxygen.org/index.html">
cannam@0 174 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 175 </body>
cannam@0 176 </html>