Mercurial > hg > vamp-website

comparison code-doc/vamp-sdk_2PluginBase_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: PluginBase.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/PluginBase.h</h1><a href="vamp-sdk_2PluginBase_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_BASE_H_</span>
59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_BASE_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
64 <a name="l00043"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#9b7a8e1ac1c91366bec5f2f33c137a2f">00043</a> <span class="preprocessor">#define VAMP_SDK_VERSION "2.0"</span>
65 <a name="l00044"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#b5f7da6acf45065a6c7b7cd38a0bf588">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MAJOR_VERSION 2</span>
66 <a name="l00045"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#d5eef1e2154b42769cd642d2a1d42257">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MINOR_VERSION 0</span>
67 <a name="l00046"></a>00046 <span class="preprocessor"></span>
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>(PluginBase.h)
70 <a name="l00049"></a>00049
71 <a name="l00050"></a>00050 namespace Vamp {
72 <a name="l00051"></a>00051
73 <a name="l00064"></a><a class="code" href="classVamp_1_1PluginBase.html">00064</a> <span class="keyword">class </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="l00065"></a>00065 {
75 <a name="l00066"></a>00066 <span class="keyword">public</span>:
76 <a name="l00067"></a><a class="code" href="classVamp_1_1PluginBase.html#3773b37c658cf22d7f135c575a28f5c5">00067</a> <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>() { }
77 <a name="l00068"></a>00068
78 <a name="l00072"></a><a class="code" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">00072</a> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 2; }
79 <a name="l00073"></a>00073
80 <a name="l00087"></a>00087 <span class="keyword">virtual</span> std::string getIdentifier() <span class="keyword">const</span> = 0;
81 <a name="l00088"></a>00088
82 <a name="l00097"></a>00097 <span class="keyword">virtual</span> std::string getName() <span class="keyword">const</span> = 0;
83 <a name="l00098"></a>00098
84 <a name="l00107"></a>00107 <span class="keyword">virtual</span> std::string getDescription() <span class="keyword">const</span> = 0;
85 <a name="l00108"></a>00108
86 <a name="l00115"></a>00115 <span class="keyword">virtual</span> std::string getMaker() <span class="keyword">const</span> = 0;
87 <a name="l00116"></a>00116
88 <a name="l00122"></a>00122 <span class="keyword">virtual</span> std::string getCopyright() <span class="keyword">const</span> = 0;
89 <a name="l00123"></a>00123
90 <a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0;
91 <a name="l00128"></a>00128
92 <a name="l00129"></a>00129
93 <a name="l00130"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">00130</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>
94 <a name="l00131"></a>00131 {
95 <a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">00137</a> std::string identifier;
96 <a name="l00138"></a>00138
97 <a name="l00142"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084">00142</a> std::string name;
98 <a name="l00143"></a>00143
99 <a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf">00148</a> std::string description;
100 <a name="l00149"></a>00149
101 <a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b">00153</a> std::string unit;
102 <a name="l00154"></a>00154
103 <a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8">00158</a> <span class="keywordtype">float</span> minValue;
104 <a name="l00159"></a>00159
105 <a name="l00163"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4">00163</a> <span class="keywordtype">float</span> maxValue;
106 <a name="l00164"></a>00164
107 <a name="l00171"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc">00171</a> <span class="keywordtype">float</span> defaultValue;
108 <a name="l00172"></a>00172
109 <a name="l00177"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425">00177</a> <span class="keywordtype">bool</span> isQuantized;
110 <a name="l00178"></a>00178
111 <a name="l00184"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7">00184</a> <span class="keywordtype">float</span> quantizeStep;
112 <a name="l00185"></a>00185
113 <a name="l00197"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b">00197</a> std::vector&lt;std::string&gt; valueNames;
114 <a name="l00198"></a>00198
115 <a name="l00199"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#5b793130e9746b2302317b3c9a9c1395">00199</a> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>() : <span class="comment">// the defaults are invalid: you must set them</span>
116 <a name="l00200"></a>00200 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
117 <a name="l00201"></a>00201 };
118 <a name="l00202"></a>00202
119 <a name="l00203"></a><a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">00203</a> <span class="keyword">typedef</span> std::vector&lt;ParameterDescriptor&gt; ParameterList;
120 <a name="l00204"></a>00204
121 <a name="l00208"></a><a class="code" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">00208</a> <span class="keyword">virtual</span> ParameterList getParameterDescriptors()<span class="keyword"> const </span>{
122 <a name="l00209"></a>00209 <span class="keywordflow">return</span> ParameterList();
123 <a name="l00210"></a>00210 }
124 <a name="l00211"></a>00211
125 <a name="l00216"></a><a class="code" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">00216</a> <span class="keyword">virtual</span> <span class="keywordtype">float</span> getParameter(std::string)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0.0; }
126 <a name="l00217"></a>00217
127 <a name="l00222"></a><a class="code" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">00222</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>) { }
128 <a name="l00223"></a>00223
129 <a name="l00224"></a>00224
130 <a name="l00225"></a><a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">00225</a> <span class="keyword">typedef</span> std::vector&lt;std::string&gt; ProgramList;
131 <a name="l00226"></a>00226
132 <a name="l00237"></a><a class="code" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">00237</a> <span class="keyword">virtual</span> ProgramList getPrograms()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ProgramList(); }
133 <a name="l00238"></a>00238
134 <a name="l00242"></a><a class="code" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">00242</a> <span class="keyword">virtual</span> std::string getCurrentProgram()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">""</span>; }
135 <a name="l00243"></a>00243
136 <a name="l00248"></a><a class="code" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">00248</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> selectProgram(std::string) { }
137 <a name="l00249"></a>00249
138 <a name="l00255"></a>00255 <span class="keyword">virtual</span> std::string getType() <span class="keyword">const</span> = 0;
139 <a name="l00256"></a>00256 };
140 <a name="l00257"></a>00257
141 <a name="l00258"></a>00258 }
142 <a name="l00259"></a>00259
143 <a name="l00260"></a>00260 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(PluginBase.h)
144 <a name="l00261"></a>00261
145 <a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
146 </pre></div></div>
147 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
148 <a href="http://www.doxygen.org/index.html">
149 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
150 </body>
151 </html>