Mercurial > hg > vamp-website
view code-doc/PluginBase_8h-source.html @ 0:351c4ebce5f9 website
* Move website from vamp-website/trunk to plain website
| author | cannam |
|---|---|
| date | Mon, 22 Sep 2008 13:01:46 +0000 |
| parents | |
| children |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: PluginBase.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.5 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a> </div> </div> </div> <h1>PluginBase.h</h1><a href="PluginBase_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> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> <a name="l00004"></a>00004 <span class="comment"> Vamp</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> <a name="l00007"></a>00007 <span class="comment"></span> <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span> <a name="l00010"></a>00010 <span class="comment"> </span> <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> <a name="l00018"></a>00018 <span class="comment"></span> <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> <a name="l00021"></a>00021 <span class="comment"></span> <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> <a name="l00029"></a>00029 <span class="comment"></span> <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> <a name="l00034"></a>00034 <span class="comment"> authorization.</span> <a name="l00035"></a>00035 <span class="comment">*/</span> <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_BASE_H_</span> <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_BASE_H_</span> <a name="l00039"></a>00039 <span class="preprocessor"></span> <a name="l00040"></a>00040 <span class="preprocessor">#include <string></span> <a name="l00041"></a>00041 <span class="preprocessor">#include <vector></span> <a name="l00042"></a>00042 <a name="l00043"></a><a class="code" href="PluginBase_8h.html#9b7a8e1ac1c91366bec5f2f33c137a2f">00043</a> <span class="preprocessor">#define VAMP_SDK_VERSION "1.2"</span> <a name="l00044"></a>00044 <span class="preprocessor"></span> <a name="l00045"></a>00045 <span class="keyword">namespace </span>Vamp { <a name="l00046"></a>00046 <a name="l00059"></a><a class="code" href="classVamp_1_1PluginBase.html">00059</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> <a name="l00060"></a>00060 { <a name="l00061"></a>00061 <span class="keyword">public</span>: <a name="l00062"></a><a class="code" href="classVamp_1_1PluginBase.html#3773b37c658cf22d7f135c575a28f5c5">00062</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>() { } <a name="l00063"></a>00063 <a name="l00067"></a><a class="code" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">00067</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> 1; } <a name="l00068"></a>00068 <a name="l00082"></a>00082 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span> = 0; <a name="l00083"></a>00083 <a name="l00092"></a>00092 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span> = 0; <a name="l00093"></a>00093 <a name="l00102"></a>00102 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span> = 0; <a name="l00103"></a>00103 <a name="l00110"></a>00110 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span> = 0; <a name="l00111"></a>00111 <a name="l00117"></a>00117 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span> = 0; <a name="l00118"></a>00118 <a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span> = 0; <a name="l00123"></a>00123 <a name="l00124"></a>00124 <a name="l00125"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">00125</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> <a name="l00126"></a>00126 { <a name="l00132"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">00132</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a>; <a name="l00133"></a>00133 <a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084">00137</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a>; <a name="l00138"></a>00138 <a name="l00143"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf">00143</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a>; <a name="l00144"></a>00144 <a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b">00148</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a>; <a name="l00149"></a>00149 <a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8">00153</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a>; <a name="l00154"></a>00154 <a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4">00158</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a>; <a name="l00159"></a>00159 <a name="l00166"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc">00166</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a>; <a name="l00167"></a>00167 <a name="l00172"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425">00172</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a>; <a name="l00173"></a>00173 <a name="l00179"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7">00179</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7" title="Quantization resolution of the parameter values (e.g.">quantizeStep</a>; <a name="l00180"></a>00180 <a name="l00192"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b">00192</a> std::vector<std::string> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b" title="Names for the quantized values.">valueNames</a>; <a name="l00193"></a>00193 }; <a name="l00194"></a>00194 <a name="l00195"></a><a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">00195</a> <span class="keyword">typedef</span> std::vector<ParameterDescriptor> <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>; <a name="l00196"></a>00196 <a name="l00200"></a><a class="code" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">00200</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>()<span class="keyword"> const </span>{ <a name="l00201"></a>00201 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>(); <a name="l00202"></a>00202 } <a name="l00203"></a>00203 <a name="l00208"></a><a class="code" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">00208</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; } <a name="l00209"></a>00209 <a name="l00214"></a><a class="code" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">00214</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>) { } <a name="l00215"></a>00215 <a name="l00216"></a>00216 <a name="l00217"></a><a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">00217</a> <span class="keyword">typedef</span> std::vector<std::string> <a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>; <a name="l00218"></a>00218 <a name="l00229"></a><a class="code" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">00229</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <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> <a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>(); } <a name="l00230"></a>00230 <a name="l00234"></a><a class="code" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">00234</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>; } <a name="l00235"></a>00235 <a name="l00240"></a><a class="code" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">00240</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) { } <a name="l00241"></a>00241 <a name="l00247"></a>00247 <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff" title="Get the type of plugin.">getType</a>() <span class="keyword">const</span> = 0; <a name="l00248"></a>00248 }; <a name="l00249"></a>00249 <a name="l00250"></a>00250 } <a name="l00251"></a>00251 <a name="l00252"></a>00252 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:06 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> </body> </html>