Mercurial > hg > vamp-docs

diff code-docs/vamp-sdk_2Plugin_8h_source.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/code-docs/vamp-sdk_2Plugin_8h_source.html	Tue Oct 04 14:56:07 2011 +0100
@@ -0,0 +1,260 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>VampPluginSDK: Plugin.h Source File</title>
+
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+</script>
+
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div! -->
+
+
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  
+  
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">VampPluginSDK
+   &#160;<span id="projectnumber">2.1</span>
+   </div>
+   
+  </td>
+  
+  
+  
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<!-- Generated by Doxygen 1.7.5.1 -->
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="dirs.html"><span>Directories</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+  initNavTree('vamp-sdk_2Plugin_8h.html','');
+</script>
+<div id="doc-content">
+<div class="header">
+  <div class="headertitle">
+<div class="title">vamp-sdk/Plugin.h</div>  </div>
+</div>
+<div class="contents">
+<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>
+<a name="l00002"></a>00002 
+<a name="l00003"></a>00003 <span class="comment">/*</span>
+<a name="l00004"></a>00004 <span class="comment">    Vamp</span>
+<a name="l00005"></a>00005 <span class="comment"></span>
+<a name="l00006"></a>00006 <span class="comment">    An API for audio analysis and feature extraction plugins.</span>
+<a name="l00007"></a>00007 <span class="comment"></span>
+<a name="l00008"></a>00008 <span class="comment">    Centre for Digital Music, Queen Mary, University of London.</span>
+<a name="l00009"></a>00009 <span class="comment">    Copyright 2006 Chris Cannam.</span>
+<a name="l00010"></a>00010 <span class="comment">  </span>
+<a name="l00011"></a>00011 <span class="comment">    Permission is hereby granted, free of charge, to any person</span>
+<a name="l00012"></a>00012 <span class="comment">    obtaining a copy of this software and associated documentation</span>
+<a name="l00013"></a>00013 <span class="comment">    files (the &quot;Software&quot;), to deal in the Software without</span>
+<a name="l00014"></a>00014 <span class="comment">    restriction, including without limitation the rights to use, copy,</span>
+<a name="l00015"></a>00015 <span class="comment">    modify, merge, publish, distribute, sublicense, and/or sell copies</span>
+<a name="l00016"></a>00016 <span class="comment">    of the Software, and to permit persons to whom the Software is</span>
+<a name="l00017"></a>00017 <span class="comment">    furnished to do so, subject to the following conditions:</span>
+<a name="l00018"></a>00018 <span class="comment"></span>
+<a name="l00019"></a>00019 <span class="comment">    The above copyright notice and this permission notice shall be</span>
+<a name="l00020"></a>00020 <span class="comment">    included in all copies or substantial portions of the Software.</span>
+<a name="l00021"></a>00021 <span class="comment"></span>
+<a name="l00022"></a>00022 <span class="comment">    THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
+<a name="l00023"></a>00023 <span class="comment">    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
+<a name="l00024"></a>00024 <span class="comment">    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
+<a name="l00025"></a>00025 <span class="comment">    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
+<a name="l00026"></a>00026 <span class="comment">    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
+<a name="l00027"></a>00027 <span class="comment">    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
+<a name="l00028"></a>00028 <span class="comment">    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
+<a name="l00029"></a>00029 <span class="comment"></span>
+<a name="l00030"></a>00030 <span class="comment">    Except as contained in this notice, the names of the Centre for</span>
+<a name="l00031"></a>00031 <span class="comment">    Digital Music; Queen Mary, University of London; and Chris Cannam</span>
+<a name="l00032"></a>00032 <span class="comment">    shall not be used in advertising or otherwise to promote the sale,</span>
+<a name="l00033"></a>00033 <span class="comment">    use or other dealings in this Software without prior written</span>
+<a name="l00034"></a>00034 <span class="comment">    authorization.</span>
+<a name="l00035"></a>00035 <span class="comment">*/</span>
+<a name="l00036"></a>00036 
+<a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_SDK_PLUGIN_H_</span>
+<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_H_</span>
+<a name="l00039"></a>00039 <span class="preprocessor"></span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span>
+<a name="l00043"></a>00043 
+<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;PluginBase.h&quot;</span>
+<a name="l00045"></a>00045 <span class="preprocessor">#include &quot;RealTime.h&quot;</span>
+<a name="l00046"></a>00046 
+<a name="l00047"></a>00047 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span>
+<a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h)
+<a name="l00049"></a>00049 
+<a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp {
+<a name="l00051"></a>00051 
+<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>
+<a name="l00125"></a>00125 {
+<a name="l00126"></a>00126 <span class="keyword">public</span>:
+<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>() { }
+<a name="l00128"></a>00128 
+<a name="l00141"></a>00141     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels,
+<a name="l00142"></a>00142                             <span class="keywordtype">size_t</span> stepSize,
+<a name="l00143"></a>00143                             <span class="keywordtype">size_t</span> blockSize) = 0;
+<a name="l00144"></a>00144 
+<a name="l00150"></a>00150     <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
+<a name="l00151"></a>00151 
+<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 };
+<a name="l00153"></a>00153     
+<a name="l00169"></a>00169     <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0;
+<a name="l00170"></a>00170 
+<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; }
+<a name="l00180"></a>00180 
+<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; }
+<a name="l00195"></a>00195 
+<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; }
+<a name="l00200"></a>00200 
+<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; }
+<a name="l00205"></a>00205 
+<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>
+<a name="l00207"></a>00207     {
+<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>;
+<a name="l00215"></a>00215 
+<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>;
+<a name="l00221"></a>00221 
+<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>;
+<a name="l00228"></a>00228 
+<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>;
+<a name="l00233"></a>00233 
+<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>;
+<a name="l00240"></a>00240 
+<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>;
+<a name="l00248"></a>00248 
+<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>;
+<a name="l00254"></a>00254 
+<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>;
+<a name="l00261"></a>00261 
+<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>;
+<a name="l00267"></a>00267 
+<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>;
+<a name="l00273"></a>00273 
+<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>;
+<a name="l00279"></a>00279 
+<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>;
+<a name="l00286"></a>00286 
+<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> {
+<a name="l00288"></a>00288 
+<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>,
+<a name="l00291"></a>00291 
+<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>,
+<a name="l00294"></a>00294 
+<a name="l00296"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">00296</a>             VariableSampleRate
+<a name="l00297"></a>00297         };
+<a name="l00298"></a>00298 
+<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>;
+<a name="l00303"></a>00303 
+<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>;
+<a name="l00315"></a>00315 
+<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>;
+<a name="l00321"></a>00321 
+<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>
+<a name="l00323"></a>00323             hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
+<a name="l00324"></a>00324             sampleType(OneSamplePerStep), hasDuration(false) { }
+<a name="l00325"></a>00325     };
+<a name="l00326"></a>00326 
+<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>;
+<a name="l00328"></a>00328 
+<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;
+<a name="l00335"></a>00335 
+<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>
+<a name="l00337"></a>00337     {
+<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>;
+<a name="l00345"></a>00345 
+<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>;
+<a name="l00353"></a>00353 
+<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>;
+<a name="l00361"></a>00361 
+<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>;
+<a name="l00368"></a>00368         
+<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>;
+<a name="l00375"></a>00375 
+<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>;
+<a name="l00380"></a>00380 
+<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>
+<a name="l00382"></a>00382             hasTimestamp(false), hasDuration(false) { }
+<a name="l00383"></a>00383     };
+<a name="l00384"></a>00384 
+<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>;
+<a name="l00386"></a>00386 
+<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>
+<a name="l00388"></a>00388 
+<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,
+<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;
+<a name="l00418"></a>00418 
+<a name="l00423"></a>00423     <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures() = 0;
+<a name="l00424"></a>00424 
+<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>; }
+<a name="l00431"></a>00431 
+<a name="l00432"></a>00432 <span class="keyword">protected</span>:
+<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) :
+<a name="l00434"></a>00434         m_inputSampleRate(inputSampleRate) { }
+<a name="l00435"></a>00435 
+<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>;
+<a name="l00437"></a>00437 };
+<a name="l00438"></a>00438 
+<a name="l00439"></a>00439 }
+<a name="l00440"></a>00440 
+<a name="l00441"></a>00441 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h)
+<a name="l00442"></a>00442 
+<a name="l00443"></a>00443 <span class="preprocessor">#endif</span>
+<a name="l00444"></a>00444 <span class="preprocessor"></span>
+<a name="l00445"></a>00445 
+<a name="l00446"></a>00446 
+</pre></div></div>
+</div>
+  <div id="nav-path" class="navpath">
+    <ul>
+      <li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a>      </li>
+
+    <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
+   </ul>
+ </div>
+
+
+</body>
+</html>