comparison code-doc/vamp-sdk_2Plugin_8h-source.html @ 35:0976232e353b website

* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Plugin.h Source File</title> 3 <title>VampPluginSDK: Plugin.h Source File</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li><a href="annotated.html"><span>Classes</span></a></li> 13 <li><a href="annotated.html"><span>Classes</span></a></li>
14 <li class="current"><a href="files.html"><span>Files</span></a></li> 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
16 </ul> 22 </ul>
17 </div> 23 </div>
18 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a> 24 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
19 </div> 25 </div>
20 </div> 26 </div>
71 <a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp { 77 <a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp {
72 <a name="l00051"></a>00051 78 <a name="l00051"></a>00051
73 <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...">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> 79 <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...">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>
74 <a name="l00125"></a>00125 { 80 <a name="l00125"></a>00125 {
75 <a name="l00126"></a>00126 <span class="keyword">public</span>: 81 <a name="l00126"></a>00126 <span class="keyword">public</span>:
76 <a name="l00127"></a><a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">00127</a> <span class="keyword">virtual</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>() { } 82 <a name="l00127"></a><a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">00127</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>() { }
77 <a name="l00128"></a>00128 83 <a name="l00128"></a>00128
78 <a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels, 84 <a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels,
79 <a name="l00142"></a>00142 <span class="keywordtype">size_t</span> stepSize, 85 <a name="l00142"></a>00142 <span class="keywordtype">size_t</span> stepSize,
80 <a name="l00143"></a>00143 <span class="keywordtype">size_t</span> blockSize) = 0; 86 <a name="l00143"></a>00143 <span class="keywordtype">size_t</span> blockSize) = 0;
81 <a name="l00144"></a>00144 87 <a name="l00144"></a>00144
82 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0; 88 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
83 <a name="l00151"></a>00151 89 <a name="l00151"></a>00151
84 <a name="l00152"></a><a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">00152</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { TimeDomain, FrequencyDomain }; 90 <a name="l00152"></a><a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">00152</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { TimeDomain, FrequencyDomain };
85 <a name="l00153"></a>00153 91 <a name="l00153"></a>00153
86 <a name="l00164"></a>00164 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0; 92 <a name="l00169"></a>00169 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0;
87 <a name="l00165"></a>00165 93 <a name="l00170"></a>00170
88 <a name="l00174"></a><a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">00174</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getPreferredBlockSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; } 94 <a name="l00179"></a><a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">00179</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; }
89 <a name="l00175"></a>00175 95 <a name="l00180"></a>00180
90 <a name="l00189"></a><a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">00189</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getPreferredStepSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; } 96 <a name="l00194"></a><a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">00194</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; }
91 <a name="l00190"></a>00190
92 <a name="l00194"></a><a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">00194</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getMinChannelCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
93 <a name="l00195"></a>00195 97 <a name="l00195"></a>00195
94 <a name="l00199"></a><a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">00199</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getMaxChannelCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; } 98 <a name="l00199"></a><a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">00199</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; }
95 <a name="l00200"></a>00200 99 <a name="l00200"></a>00200
96 <a name="l00201"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">00201</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> 100 <a name="l00204"></a><a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">00204</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; }
97 <a name="l00202"></a>00202 { 101 <a name="l00205"></a>00205
98 <a name="l00209"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">00209</a> std::string identifier; 102 <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>
99 <a name="l00210"></a>00210 103 <a name="l00207"></a>00207 {
100 <a name="l00215"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">00215</a> std::string name; 104 <a name="l00214"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#2e6f77bcb12d4c95da25348ac85b8696">00214</a> std::string identifier;
101 <a name="l00216"></a>00216 105 <a name="l00215"></a>00215
102 <a name="l00222"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">00222</a> std::string description; 106 <a name="l00220"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0992e05ea70425878365ba85663400a7">00220</a> std::string name;
103 <a name="l00223"></a>00223 107 <a name="l00221"></a>00221
104 <a name="l00227"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">00227</a> std::string unit; 108 <a name="l00227"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#8b44602d8ccea8bb862fd766e74efa1c">00227</a> std::string description;
105 <a name="l00228"></a>00228 109 <a name="l00228"></a>00228
106 <a name="l00234"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d">00234</a> <span class="keywordtype">bool</span> hasFixedBinCount; 110 <a name="l00232"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#52f4b3d8d7070cc9c5ab4aa6ff0c01a0">00232</a> std::string unit;
107 <a name="l00235"></a>00235 111 <a name="l00233"></a>00233
108 <a name="l00242"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc">00242</a> <span class="keywordtype">size_t</span> binCount; 112 <a name="l00239"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0653d3a85fdc226e60fd5e612b399e0c">00239</a> <span class="keywordtype">bool</span> hasFixedBinCount;
109 <a name="l00243"></a>00243 113 <a name="l00240"></a>00240
110 <a name="l00248"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7">00248</a> std::vector&lt;std::string&gt; binNames; 114 <a name="l00247"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#238a4781ebb4151832cbf521feb0fedc">00247</a> <span class="keywordtype">size_t</span> binCount;
111 <a name="l00249"></a>00249 115 <a name="l00248"></a>00248
112 <a name="l00255"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">00255</a> <span class="keywordtype">bool</span> hasKnownExtents; 116 <a name="l00253"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#62b6bdd0d36381da4176b27663072b49">00253</a> std::vector&lt;std::string&gt; binNames;
113 <a name="l00256"></a>00256 117 <a name="l00254"></a>00254
114 <a name="l00261"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">00261</a> <span class="keywordtype">float</span> minValue; 118 <a name="l00260"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#4b8d0d88bee613709e91b48402e28c8e">00260</a> <span class="keywordtype">bool</span> hasKnownExtents;
115 <a name="l00262"></a>00262 119 <a name="l00261"></a>00261
116 <a name="l00267"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">00267</a> <span class="keywordtype">float</span> maxValue; 120 <a name="l00266"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1fc73936c43014393918fe6cce46ac6d">00266</a> <span class="keywordtype">float</span> minValue;
117 <a name="l00268"></a>00268 121 <a name="l00267"></a>00267
118 <a name="l00273"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">00273</a> <span class="keywordtype">bool</span> isQuantized; 122 <a name="l00272"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0df82ce301ad1bc337a272cb730426cf">00272</a> <span class="keywordtype">float</span> maxValue;
119 <a name="l00274"></a>00274 123 <a name="l00273"></a>00273
120 <a name="l00280"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">00280</a> <span class="keywordtype">float</span> quantizeStep; 124 <a name="l00278"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#43673cd31b2b65af427a8e8b8746b6e8">00278</a> <span class="keywordtype">bool</span> isQuantized;
121 <a name="l00281"></a>00281 125 <a name="l00279"></a>00279
122 <a name="l00282"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">00282</a> <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> { 126 <a name="l00285"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#674cd333889514cf8408c18762fede12">00285</a> <span class="keywordtype">float</span> quantizeStep;
123 <a name="l00283"></a>00283
124 <a name="l00285"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca">00285</a> OneSamplePerStep,
125 <a name="l00286"></a>00286 127 <a name="l00286"></a>00286
126 <a name="l00288"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629">00288</a> FixedSampleRate, 128 <a name="l00287"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">00287</a> <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> {
127 <a name="l00289"></a>00289 129 <a name="l00288"></a>00288
128 <a name="l00291"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e">00291</a> VariableSampleRate 130 <a name="l00290"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead">00290</a> OneSamplePerStep,
129 <a name="l00292"></a>00292 }; 131 <a name="l00291"></a>00291
130 <a name="l00293"></a>00293 132 <a name="l00293"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3">00293</a> FixedSampleRate,
131 <a name="l00297"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d">00297</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> sampleType; 133 <a name="l00294"></a>00294
134 <a name="l00296"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547">00296</a> VariableSampleRate
135 <a name="l00297"></a>00297 };
132 <a name="l00298"></a>00298 136 <a name="l00298"></a>00298
133 <a name="l00309"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af">00309</a> <span class="keywordtype">float</span> sampleRate; 137 <a name="l00302"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3cd2e0b7a6da19c32bbb6809a83d9adf">00302</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> sampleType;
134 <a name="l00310"></a>00310 138 <a name="l00303"></a>00303
135 <a name="l00315"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b0d7cc6ab19e53b5bd12ee234f549ea3">00315</a> <span class="keywordtype">bool</span> hasDuration; 139 <a name="l00314"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e49cc87dcb0f09b59feb85d2b78e80ef">00314</a> <span class="keywordtype">float</span> sampleRate;
136 <a name="l00316"></a>00316 140 <a name="l00315"></a>00315
137 <a name="l00317"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1ebf91cc3f60e4cbba818c10591cd344">00317</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>() : <span class="comment">// defaults for mandatory non-class-type members</span> 141 <a name="l00320"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#93cc15894c89a142741c2bd088cdd6af">00320</a> <span class="keywordtype">bool</span> hasDuration;
138 <a name="l00318"></a>00318 hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
139 <a name="l00319"></a>00319 sampleType(OneSamplePerStep), hasDuration(false) { }
140 <a name="l00320"></a>00320 };
141 <a name="l00321"></a>00321 142 <a name="l00321"></a>00321
142 <a name="l00322"></a><a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">00322</a> <span class="keyword">typedef</span> std::vector&lt;OutputDescriptor&gt; OutputList; 143 <a name="l00322"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ba660cc15254061875cbf9ba932aca95">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>
143 <a name="l00323"></a>00323 144 <a name="l00323"></a>00323 hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
144 <a name="l00329"></a>00329 <span class="keyword">virtual</span> OutputList getOutputDescriptors() <span class="keyword">const</span> = 0; 145 <a name="l00324"></a>00324 sampleType(OneSamplePerStep), hasDuration(false) { }
145 <a name="l00330"></a>00330 146 <a name="l00325"></a>00325 };
146 <a name="l00331"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">00331</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> 147 <a name="l00326"></a>00326
147 <a name="l00332"></a>00332 { 148 <a name="l00327"></a><a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">00327</a> <span class="keyword">typedef</span> std::vector&lt;OutputDescriptor&gt; OutputList;
148 <a name="l00339"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b">00339</a> <span class="keywordtype">bool</span> hasTimestamp; 149 <a name="l00328"></a>00328
149 <a name="l00340"></a>00340 150 <a name="l00334"></a>00334 <span class="keyword">virtual</span> OutputList getOutputDescriptors() <span class="keyword">const</span> = 0;
150 <a name="l00347"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7">00347</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp; 151 <a name="l00335"></a>00335
151 <a name="l00348"></a>00348 152 <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>
152 <a name="l00355"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#33686757bd4481c72494122e9bfb9fba">00355</a> <span class="keywordtype">bool</span> hasDuration; 153 <a name="l00337"></a>00337 {
153 <a name="l00356"></a>00356 154 <a name="l00344"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#116bb1b3420a067fc1290b75982fdf62">00344</a> <span class="keywordtype">bool</span> hasTimestamp;
154 <a name="l00362"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#f687c0a7fe041757e922ec296862b115">00362</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> duration; 155 <a name="l00345"></a>00345
155 <a name="l00363"></a>00363 156 <a name="l00352"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#aaf212bd458dc5e6f441bf7606121311">00352</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp;
156 <a name="l00369"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71">00369</a> std::vector&lt;float&gt; values; 157 <a name="l00353"></a>00353
157 <a name="l00370"></a>00370 158 <a name="l00360"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#2a962f4b26d6417ad1b72ae29949332e">00360</a> <span class="keywordtype">bool</span> hasDuration;
158 <a name="l00374"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">00374</a> std::string label; 159 <a name="l00361"></a>00361
160 <a name="l00367"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#f09e2624341f81c8f1f9c2d9137b4230">00367</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> duration;
161 <a name="l00368"></a>00368
162 <a name="l00374"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#106162977cdc92a02146fcb5ed18a34d">00374</a> std::vector&lt;float&gt; values;
159 <a name="l00375"></a>00375 163 <a name="l00375"></a>00375
160 <a name="l00376"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#cd4b4cd0d2c31512f4a5df50f8f7a7b8">00376</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>() : <span class="comment">// defaults for mandatory non-class-type members</span> 164 <a name="l00379"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#14ff2ab7442f508fc3bd3d96c3e85eb5">00379</a> std::string label;
161 <a name="l00377"></a>00377 hasTimestamp(false), hasDuration(false) { } 165 <a name="l00380"></a>00380
162 <a name="l00378"></a>00378 }; 166 <a name="l00381"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#3cd6cae91305ae8bcbd6248954a460f8">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>
163 <a name="l00379"></a>00379 167 <a name="l00382"></a>00382 hasTimestamp(false), hasDuration(false) { }
164 <a name="l00380"></a><a class="code" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">00380</a> <span class="keyword">typedef</span> std::vector&lt;Feature&gt; FeatureList; 168 <a name="l00383"></a>00383 };
165 <a name="l00381"></a>00381 169 <a name="l00384"></a>00384
166 <a name="l00382"></a><a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">00382</a> <span class="keyword">typedef</span> std::map&lt;int, FeatureList&gt; FeatureSet; <span class="comment">// key is output no</span> 170 <a name="l00385"></a><a class="code" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">00385</a> <span class="keyword">typedef</span> std::vector&lt;Feature&gt; FeatureList;
167 <a name="l00383"></a>00383 171 <a name="l00386"></a>00386
168 <a name="l00411"></a>00411 <span class="keyword">virtual</span> FeatureSet process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, 172 <a name="l00387"></a><a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">00387</a> <span class="keyword">typedef</span> std::map&lt;int, FeatureList&gt; FeatureSet; <span class="comment">// key is output no</span>
169 <a name="l00412"></a>00412 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp) = 0; 173 <a name="l00388"></a>00388
170 <a name="l00413"></a>00413 174 <a name="l00416"></a>00416 <span class="keyword">virtual</span> FeatureSet process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
171 <a name="l00418"></a>00418 <span class="keyword">virtual</span> FeatureSet getRemainingFeatures() = 0; 175 <a name="l00417"></a>00417 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp) = 0;
172 <a name="l00419"></a>00419 176 <a name="l00418"></a>00418
173 <a name="l00425"></a><a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">00425</a> <span class="keyword">virtual</span> std::string getType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"Feature Extraction Plugin"</span>; } 177 <a name="l00423"></a>00423 <span class="keyword">virtual</span> FeatureSet getRemainingFeatures() = 0;
174 <a name="l00426"></a>00426 178 <a name="l00424"></a>00424
175 <a name="l00427"></a>00427 <span class="keyword">protected</span>: 179 <a name="l00430"></a><a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">00430</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>; }
176 <a name="l00428"></a><a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">00428</a> <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="keywordtype">float</span> inputSampleRate) : 180 <a name="l00431"></a>00431
177 <a name="l00429"></a>00429 m_inputSampleRate(inputSampleRate) { } 181 <a name="l00432"></a>00432 <span class="keyword">protected</span>:
178 <a name="l00430"></a>00430 182 <a name="l00433"></a><a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">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...">Plugin</a>(<span class="keywordtype">float</span> inputSampleRate) :
179 <a name="l00431"></a><a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">00431</a> <span class="keywordtype">float</span> m_inputSampleRate; 183 <a name="l00434"></a>00434 m_inputSampleRate(inputSampleRate) { }
180 <a name="l00432"></a>00432 };
181 <a name="l00433"></a>00433
182 <a name="l00434"></a>00434 }
183 <a name="l00435"></a>00435 184 <a name="l00435"></a>00435
184 <a name="l00436"></a>00436 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h) 185 <a name="l00436"></a><a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">00436</a> <span class="keywordtype">float</span> m_inputSampleRate;
185 <a name="l00437"></a>00437 186 <a name="l00437"></a>00437 };
186 <a name="l00438"></a>00438 <span class="preprocessor">#endif</span> 187 <a name="l00438"></a>00438
187 <a name="l00439"></a>00439 <span class="preprocessor"></span> 188 <a name="l00439"></a>00439 }
188 <a name="l00440"></a>00440 189 <a name="l00440"></a>00440
189 <a name="l00441"></a>00441 190 <a name="l00441"></a>00441 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h)
191 <a name="l00442"></a>00442
192 <a name="l00443"></a>00443 <span class="preprocessor">#endif</span>
193 <a name="l00444"></a>00444 <span class="preprocessor"></span>
194 <a name="l00445"></a>00445
195 <a name="l00446"></a>00446
190 </pre></div></div> 196 </pre></div></div>
191 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp; 197 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
192 <a href="http://www.doxygen.org/index.html"> 198 <a href="http://www.doxygen.org/index.html">
193 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 199 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
194 </body> 200 </body>
195 </html> 201 </html>