|
cannam@21
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
cannam@21
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
cannam@21
|
3 <title>VampPluginSDK: PluginBase.h Source File</title>
|
|
cannam@35
|
4 <link href="tabs.css" rel="stylesheet" type="text/css">
|
|
cannam@21
|
5 <link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
cannam@21
|
6 </head><body>
|
|
cannam@35
|
7 <!-- Generated by Doxygen 1.5.8 -->
|
|
cannam@21
|
8 <div class="navigation" id="top">
|
|
cannam@21
|
9 <div class="tabs">
|
|
cannam@21
|
10 <ul>
|
|
cannam@21
|
11 <li><a href="main.html"><span>Main Page</span></a></li>
|
|
cannam@21
|
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@21
|
13 <li><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@21
|
14 <li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
cannam@21
|
15 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
cannam@21
|
16 </ul>
|
|
cannam@21
|
17 </div>
|
|
cannam@35
|
18 <div class="tabs">
|
|
cannam@35
|
19 <ul>
|
|
cannam@35
|
20 <li><a href="files.html"><span>File List</span></a></li>
|
|
cannam@35
|
21 <li><a href="globals.html"><span>File Members</span></a></li>
|
|
cannam@35
|
22 </ul>
|
|
cannam@35
|
23 </div>
|
|
cannam@21
|
24 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
|
|
cannam@21
|
25 </div>
|
|
cannam@21
|
26 </div>
|
|
cannam@21
|
27 <div class="contents">
|
|
cannam@21
|
28 <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>
|
|
cannam@21
|
29 <a name="l00002"></a>00002
|
|
cannam@21
|
30 <a name="l00003"></a>00003 <span class="comment">/*</span>
|
|
cannam@21
|
31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
|
|
cannam@21
|
32 <a name="l00005"></a>00005 <span class="comment"></span>
|
|
cannam@21
|
33 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
|
|
cannam@21
|
34 <a name="l00007"></a>00007 <span class="comment"></span>
|
|
cannam@21
|
35 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
|
|
cannam@21
|
36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
|
|
cannam@21
|
37 <a name="l00010"></a>00010 <span class="comment"> </span>
|
|
cannam@21
|
38 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
|
|
cannam@21
|
39 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
|
|
cannam@21
|
40 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
|
|
cannam@21
|
41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
|
|
cannam@21
|
42 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
|
|
cannam@21
|
43 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
|
|
cannam@21
|
44 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
|
|
cannam@21
|
45 <a name="l00018"></a>00018 <span class="comment"></span>
|
|
cannam@21
|
46 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
|
|
cannam@21
|
47 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
|
|
cannam@21
|
48 <a name="l00021"></a>00021 <span class="comment"></span>
|
|
cannam@21
|
49 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
|
|
cannam@21
|
50 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
|
|
cannam@21
|
51 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
|
|
cannam@21
|
52 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
|
|
cannam@21
|
53 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
|
|
cannam@21
|
54 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
|
|
cannam@21
|
55 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
|
|
cannam@21
|
56 <a name="l00029"></a>00029 <span class="comment"></span>
|
|
cannam@21
|
57 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
|
|
cannam@21
|
58 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
|
|
cannam@21
|
59 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
|
|
cannam@21
|
60 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
|
|
cannam@21
|
61 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
|
|
cannam@21
|
62 <a name="l00035"></a>00035 <span class="comment">*/</span>
|
|
cannam@21
|
63 <a name="l00036"></a>00036
|
|
cannam@21
|
64 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_SDK_PLUGIN_BASE_H_</span>
|
|
cannam@21
|
65 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_BASE_H_</span>
|
|
cannam@21
|
66 <a name="l00039"></a>00039 <span class="preprocessor"></span>
|
|
cannam@21
|
67 <a name="l00040"></a>00040 <span class="preprocessor">#include <string></span>
|
|
cannam@21
|
68 <a name="l00041"></a>00041 <span class="preprocessor">#include <vector></span>
|
|
cannam@21
|
69 <a name="l00042"></a>00042
|
|
cannam@21
|
70 <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>
|
|
cannam@21
|
71 <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>
|
|
cannam@21
|
72 <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>
|
|
cannam@21
|
73 <a name="l00046"></a>00046 <span class="preprocessor"></span>
|
|
cannam@21
|
74 <a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="plugguard_8h.html">plugguard.h</a>"</span>
|
|
cannam@21
|
75 <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(PluginBase.h)
|
|
cannam@21
|
76 <a name="l00049"></a>00049
|
|
cannam@21
|
77 <a name="l00050"></a>00050 namespace Vamp {
|
|
cannam@21
|
78 <a name="l00051"></a>00051
|
|
cannam@21
|
79 <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>
|
|
cannam@21
|
80 <a name="l00065"></a>00065 {
|
|
cannam@21
|
81 <a name="l00066"></a>00066 <span class="keyword">public</span>:
|
|
cannam@35
|
82 <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#3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>() { }
|
|
cannam@21
|
83 <a name="l00068"></a>00068
|
|
cannam@35
|
84 <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> <a class="code" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 2; }
|
|
cannam@21
|
85 <a name="l00073"></a>00073
|
|
cannam@21
|
86 <a name="l00087"></a>00087 <span class="keyword">virtual</span> std::string getIdentifier() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
87 <a name="l00088"></a>00088
|
|
cannam@21
|
88 <a name="l00097"></a>00097 <span class="keyword">virtual</span> std::string getName() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
89 <a name="l00098"></a>00098
|
|
cannam@21
|
90 <a name="l00107"></a>00107 <span class="keyword">virtual</span> std::string getDescription() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
91 <a name="l00108"></a>00108
|
|
cannam@21
|
92 <a name="l00115"></a>00115 <span class="keyword">virtual</span> std::string getMaker() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
93 <a name="l00116"></a>00116
|
|
cannam@21
|
94 <a name="l00122"></a>00122 <span class="keyword">virtual</span> std::string getCopyright() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
95 <a name="l00123"></a>00123
|
|
cannam@21
|
96 <a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
97 <a name="l00128"></a>00128
|
|
cannam@21
|
98 <a name="l00129"></a>00129
|
|
cannam@21
|
99 <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>
|
|
cannam@21
|
100 <a name="l00131"></a>00131 {
|
|
cannam@35
|
101 <a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b34ea7114875647281ac031021e45d06">00137</a> std::string identifier;
|
|
cannam@21
|
102 <a name="l00138"></a>00138
|
|
cannam@35
|
103 <a name="l00142"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#2c1000e78a6414dab6c5af5201053741">00142</a> std::string name;
|
|
cannam@21
|
104 <a name="l00143"></a>00143
|
|
cannam@35
|
105 <a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0cbc8fe35b0d15fd8e19de2ade33d147">00148</a> std::string description;
|
|
cannam@21
|
106 <a name="l00149"></a>00149
|
|
cannam@35
|
107 <a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#e0d6c74d915b99bacb55a0622e0ecb1c">00153</a> std::string unit;
|
|
cannam@21
|
108 <a name="l00154"></a>00154
|
|
cannam@35
|
109 <a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#18221c4bb5c57332fe6a1393c5ec3b6d">00158</a> <span class="keywordtype">float</span> minValue;
|
|
cannam@21
|
110 <a name="l00159"></a>00159
|
|
cannam@35
|
111 <a name="l00163"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#52e0c1f0acfc7ff8622ca1ccc97ad69d">00163</a> <span class="keywordtype">float</span> maxValue;
|
|
cannam@21
|
112 <a name="l00164"></a>00164
|
|
cannam@35
|
113 <a name="l00171"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#4b36674815777f54846bb7033205bbea">00171</a> <span class="keywordtype">float</span> defaultValue;
|
|
cannam@21
|
114 <a name="l00172"></a>00172
|
|
cannam@35
|
115 <a name="l00177"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#6e76a119dafbdd26351521ec486550ea">00177</a> <span class="keywordtype">bool</span> isQuantized;
|
|
cannam@21
|
116 <a name="l00178"></a>00178
|
|
cannam@35
|
117 <a name="l00184"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0b84d9928f1ecce8663335f6a80ad2b1">00184</a> <span class="keywordtype">float</span> quantizeStep;
|
|
cannam@21
|
118 <a name="l00185"></a>00185
|
|
cannam@35
|
119 <a name="l00197"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0a4ab495e32d7746f2c55a5a59af1adc">00197</a> std::vector<std::string> valueNames;
|
|
cannam@21
|
120 <a name="l00198"></a>00198
|
|
cannam@35
|
121 <a name="l00199"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7759ab75c33d0f4d8bc85c755bfb10f3">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>
|
|
cannam@21
|
122 <a name="l00200"></a>00200 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
|
|
cannam@21
|
123 <a name="l00201"></a>00201 };
|
|
cannam@21
|
124 <a name="l00202"></a>00202
|
|
cannam@21
|
125 <a name="l00203"></a><a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">00203</a> <span class="keyword">typedef</span> std::vector<ParameterDescriptor> ParameterList;
|
|
cannam@21
|
126 <a name="l00204"></a>00204
|
|
cannam@35
|
127 <a name="l00208"></a><a class="code" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">00208</a> <span class="keyword">virtual</span> ParameterList <a class="code" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>()<span class="keyword"> const </span>{
|
|
cannam@21
|
128 <a name="l00209"></a>00209 <span class="keywordflow">return</span> ParameterList();
|
|
cannam@21
|
129 <a name="l00210"></a>00210 }
|
|
cannam@21
|
130 <a name="l00211"></a>00211
|
|
cannam@35
|
131 <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> <a class="code" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7" title="Get the value of a named parameter.">getParameter</a>(std::string)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0.0; }
|
|
cannam@21
|
132 <a name="l00217"></a>00217
|
|
cannam@35
|
133 <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> <a class="code" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>) { }
|
|
cannam@21
|
134 <a name="l00223"></a>00223
|
|
cannam@21
|
135 <a name="l00224"></a>00224
|
|
cannam@21
|
136 <a name="l00225"></a><a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">00225</a> <span class="keyword">typedef</span> std::vector<std::string> ProgramList;
|
|
cannam@21
|
137 <a name="l00226"></a>00226
|
|
cannam@35
|
138 <a name="l00237"></a><a class="code" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">00237</a> <span class="keyword">virtual</span> ProgramList <a class="code" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af" title="Get the program settings available in this plugin.">getPrograms</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ProgramList(); }
|
|
cannam@21
|
139 <a name="l00238"></a>00238
|
|
cannam@35
|
140 <a name="l00242"></a><a class="code" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">00242</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3" title="Get the current program.">getCurrentProgram</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">""</span>; }
|
|
cannam@21
|
141 <a name="l00243"></a>00243
|
|
cannam@35
|
142 <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> <a class="code" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353" title="Select a program.">selectProgram</a>(std::string) { }
|
|
cannam@21
|
143 <a name="l00249"></a>00249
|
|
cannam@21
|
144 <a name="l00255"></a>00255 <span class="keyword">virtual</span> std::string getType() <span class="keyword">const</span> = 0;
|
|
cannam@21
|
145 <a name="l00256"></a>00256 };
|
|
cannam@21
|
146 <a name="l00257"></a>00257
|
|
cannam@21
|
147 <a name="l00258"></a>00258 }
|
|
cannam@21
|
148 <a name="l00259"></a>00259
|
|
cannam@21
|
149 <a name="l00260"></a>00260 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(PluginBase.h)
|
|
cannam@21
|
150 <a name="l00261"></a>00261
|
|
cannam@21
|
151 <a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
|
|
cannam@21
|
152 </pre></div></div>
|
|
cannam@35
|
153 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by
|
|
cannam@21
|
154 <a href="http://www.doxygen.org/index.html">
|
|
cannam@35
|
155 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
|
|
cannam@21
|
156 </body>
|
|
cannam@21
|
157 </html>
|
