Mercurial > hg > vamp-website

comparison code-doc/vamp-sdk_2Plugin_8h-source.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
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">
3 <title>VampPluginSDK: Plugin.h Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</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>
14 <li class="current"><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
19 </div>
20 </div>
21 <div class="contents">
22 <h1>vamp-sdk/Plugin.h</h1><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>
23 <a name="l00002"></a>00002
24 <a name="l00003"></a>00003 <span class="comment">/*</span>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
26 <a name="l00005"></a>00005 <span class="comment"></span>
27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
28 <a name="l00007"></a>00007 <span class="comment"></span>
29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
31 <a name="l00010"></a>00010 <span class="comment"> </span>
32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
39 <a name="l00018"></a>00018 <span class="comment"></span>
40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
42 <a name="l00021"></a>00021 <span class="comment"></span>
43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
50 <a name="l00029"></a>00029 <span class="comment"></span>
51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
56 <a name="l00035"></a>00035 <span class="comment">*/</span>
57 <a name="l00036"></a>00036
58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_SDK_PLUGIN_H_</span>
59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_H_</span>
60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
61 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span>
62 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span>
63 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span>
64 <a name="l00043"></a>00043
65 <a name="l00044"></a>00044 <span class="preprocessor">#include "PluginBase.h"</span>
66 <a name="l00045"></a>00045 <span class="preprocessor">#include "RealTime.h"</span>
67 <a name="l00046"></a>00046
68 <a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="plugguard_8h.html">plugguard.h</a>"</span>
69 <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h)
70 <a name="l00049"></a>00049
71 <a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp {
72 <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>
74 <a name="l00125"></a>00125 {
75 <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>() { }
77 <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,
79 <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;
81 <a name="l00144"></a>00144
82 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
83 <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 };
85 <a name="l00153"></a>00153
86 <a name="l00164"></a>00164 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0;
87 <a name="l00165"></a>00165
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; }
89 <a name="l00175"></a>00175
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; }
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
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; }
95 <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>
97 <a name="l00202"></a>00202 {
98 <a name="l00209"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">00209</a> std::string identifier;
99 <a name="l00210"></a>00210
100 <a name="l00215"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">00215</a> std::string name;
101 <a name="l00216"></a>00216
102 <a name="l00222"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">00222</a> std::string description;
103 <a name="l00223"></a>00223
104 <a name="l00227"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">00227</a> std::string unit;
105 <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;
107 <a name="l00235"></a>00235
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;
109 <a name="l00243"></a>00243
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;
111 <a name="l00249"></a>00249
112 <a name="l00255"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">00255</a> <span class="keywordtype">bool</span> hasKnownExtents;
113 <a name="l00256"></a>00256
114 <a name="l00261"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">00261</a> <span class="keywordtype">float</span> minValue;
115 <a name="l00262"></a>00262
116 <a name="l00267"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">00267</a> <span class="keywordtype">float</span> maxValue;
117 <a name="l00268"></a>00268
118 <a name="l00273"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">00273</a> <span class="keywordtype">bool</span> isQuantized;
119 <a name="l00274"></a>00274
120 <a name="l00280"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">00280</a> <span class="keywordtype">float</span> quantizeStep;
121 <a name="l00281"></a>00281
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> {
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
126 <a name="l00288"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629">00288</a> FixedSampleRate,
127 <a name="l00289"></a>00289
128 <a name="l00291"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e">00291</a> VariableSampleRate
129 <a name="l00292"></a>00292 };
130 <a name="l00293"></a>00293
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;
132 <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;
134 <a name="l00310"></a>00310
135 <a name="l00315"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b0d7cc6ab19e53b5bd12ee234f549ea3">00315</a> <span class="keywordtype">bool</span> hasDuration;
136 <a name="l00316"></a>00316
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>
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="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="l00323"></a>00323
144 <a name="l00329"></a>00329 <span class="keyword">virtual</span> OutputList getOutputDescriptors() <span class="keyword">const</span> = 0;
145 <a name="l00330"></a>00330
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="l00332"></a>00332 {
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="l00340"></a>00340
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="l00348"></a>00348
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="l00356"></a>00356
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="l00363"></a>00363
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="l00370"></a>00370
158 <a name="l00374"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">00374</a> std::string label;
159 <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>
161 <a name="l00377"></a>00377 hasTimestamp(false), hasDuration(false) { }
162 <a name="l00378"></a>00378 };
163 <a name="l00379"></a>00379
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;
165 <a name="l00381"></a>00381
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>
167 <a name="l00383"></a>00383
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,
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;
170 <a name="l00413"></a>00413
171 <a name="l00418"></a>00418 <span class="keyword">virtual</span> FeatureSet getRemainingFeatures() = 0;
172 <a name="l00419"></a>00419
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>; }
174 <a name="l00426"></a>00426
175 <a name="l00427"></a>00427 <span class="keyword">protected</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) :
177 <a name="l00429"></a>00429 m_inputSampleRate(inputSampleRate) { }
178 <a name="l00430"></a>00430
179 <a name="l00431"></a><a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">00431</a> <span class="keywordtype">float</span> m_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="l00436"></a>00436 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h)
185 <a name="l00437"></a>00437
186 <a name="l00438"></a>00438 <span class="preprocessor">#endif</span>
187 <a name="l00439"></a>00439 <span class="preprocessor"></span>
188 <a name="l00440"></a>00440
189 <a name="l00441"></a>00441
190 </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;
192 <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>
194 </body>
195 </html>