Mercurial > hg > vamp-website

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* 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: PluginBase.h Source File</title> 3 <title>VampPluginSDK: PluginBase.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>00050 namespace Vamp { 77 <a name="l00050"></a>00050 namespace Vamp {
72 <a name="l00051"></a>00051 78 <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> 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>
74 <a name="l00065"></a>00065 { 80 <a name="l00065"></a>00065 {
75 <a name="l00066"></a>00066 <span class="keyword">public</span>: 81 <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>() { } 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>() { }
77 <a name="l00068"></a>00068 83 <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; } 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; }
79 <a name="l00073"></a>00073 85 <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; 86 <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 87 <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; 88 <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 89 <a name="l00098"></a>00098
90 <a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0; 96 <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 97 <a name="l00128"></a>00128
92 <a name="l00129"></a>00129 98 <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> 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>
94 <a name="l00131"></a>00131 { 100 <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; 101 <a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b34ea7114875647281ac031021e45d06">00137</a> std::string identifier;
96 <a name="l00138"></a>00138 102 <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; 103 <a name="l00142"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#2c1000e78a6414dab6c5af5201053741">00142</a> std::string name;
98 <a name="l00143"></a>00143 104 <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; 105 <a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0cbc8fe35b0d15fd8e19de2ade33d147">00148</a> std::string description;
100 <a name="l00149"></a>00149 106 <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; 107 <a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#e0d6c74d915b99bacb55a0622e0ecb1c">00153</a> std::string unit;
102 <a name="l00154"></a>00154 108 <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; 109 <a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#18221c4bb5c57332fe6a1393c5ec3b6d">00158</a> <span class="keywordtype">float</span> minValue;
104 <a name="l00159"></a>00159 110 <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; 111 <a name="l00163"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#52e0c1f0acfc7ff8622ca1ccc97ad69d">00163</a> <span class="keywordtype">float</span> maxValue;
106 <a name="l00164"></a>00164 112 <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; 113 <a name="l00171"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#4b36674815777f54846bb7033205bbea">00171</a> <span class="keywordtype">float</span> defaultValue;
108 <a name="l00172"></a>00172 114 <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; 115 <a name="l00177"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#6e76a119dafbdd26351521ec486550ea">00177</a> <span class="keywordtype">bool</span> isQuantized;
110 <a name="l00178"></a>00178 116 <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; 117 <a name="l00184"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0b84d9928f1ecce8663335f6a80ad2b1">00184</a> <span class="keywordtype">float</span> quantizeStep;
112 <a name="l00185"></a>00185 118 <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; 119 <a name="l00197"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0a4ab495e32d7746f2c55a5a59af1adc">00197</a> std::vector&lt;std::string&gt; valueNames;
114 <a name="l00198"></a>00198 120 <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> 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>
116 <a name="l00200"></a>00200 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { } 122 <a name="l00200"></a>00200 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
117 <a name="l00201"></a>00201 }; 123 <a name="l00201"></a>00201 };
118 <a name="l00202"></a>00202 124 <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; 125 <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 126 <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>{ 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>{
122 <a name="l00209"></a>00209 <span class="keywordflow">return</span> ParameterList(); 128 <a name="l00209"></a>00209 <span class="keywordflow">return</span> ParameterList();
123 <a name="l00210"></a>00210 } 129 <a name="l00210"></a>00210 }
124 <a name="l00211"></a>00211 130 <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; } 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; }
126 <a name="l00217"></a>00217 132 <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>) { } 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>) { }
128 <a name="l00223"></a>00223 134 <a name="l00223"></a>00223
129 <a name="l00224"></a>00224 135 <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; 136 <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 137 <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(); } 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(); }
133 <a name="l00238"></a>00238 139 <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>; } 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>; }
135 <a name="l00243"></a>00243 141 <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) { } 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) { }
137 <a name="l00249"></a>00249 143 <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; 144 <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 }; 145 <a name="l00256"></a>00256 };
140 <a name="l00257"></a>00257 146 <a name="l00257"></a>00257
141 <a name="l00258"></a>00258 } 147 <a name="l00258"></a>00258 }
142 <a name="l00259"></a>00259 148 <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) 149 <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 150 <a name="l00261"></a>00261
145 <a name="l00262"></a>00262 <span class="preprocessor">#endif</span> 151 <a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
146 </pre></div></div> 152 </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; 153 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
148 <a href="http://www.doxygen.org/index.html"> 154 <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> 155 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
150 </body> 156 </body>
151 </html> 157 </html>