Mercurial > hg > vamp-website

view code-doc/vamp-sdk_2PluginBase_8h_source.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>VampPluginSDK: PluginBase.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('vamp-sdk_2PluginBase_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vamp-sdk/PluginBase.h</div>  </div>
</div>
<div class="contents">
<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>
<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 &quot;Software&quot;), 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 &quot;AS IS&quot;, 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_SDK_PLUGIN_BASE_H_</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_BASE_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00042"></a>00042 
<a name="l00043"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f">00043</a> <span class="preprocessor">#define VAMP_SDK_VERSION &quot;3.5&quot;</span>
<a name="l00044"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MAJOR_VERSION 2</span>
<a name="l00045"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#ad5eef1e2154b42769cd642d2a1d42257">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MINOR_VERSION 2</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span>
<a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(PluginBase.h)
<a name="l00049"></a>00049 
<a name="l00050"></a>00050 namespace Vamp {
<a name="l00051"></a>00051 
<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> 
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a><a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">00067</a>     <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>() { }
<a name="l00068"></a>00068 
<a name="l00072"></a><a class="code" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">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#a8fd2c48291c64b790f0efb8948508dcf" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 2; }
<a name="l00073"></a>00073 
<a name="l00087"></a>00087     <span class="keyword">virtual</span> std::string getIdentifier() <span class="keyword">const</span> = 0;
<a name="l00088"></a>00088 
<a name="l00097"></a>00097     <span class="keyword">virtual</span> std::string getName() <span class="keyword">const</span> = 0;
<a name="l00098"></a>00098 
<a name="l00107"></a>00107     <span class="keyword">virtual</span> std::string getDescription() <span class="keyword">const</span> = 0;
<a name="l00108"></a>00108     
<a name="l00115"></a>00115     <span class="keyword">virtual</span> std::string getMaker() <span class="keyword">const</span> = 0;
<a name="l00116"></a>00116 
<a name="l00122"></a>00122     <span class="keyword">virtual</span> std::string getCopyright() <span class="keyword">const</span> = 0;
<a name="l00123"></a>00123 
<a name="l00127"></a>00127     <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0;
<a name="l00128"></a>00128 
<a name="l00129"></a>00129 
<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>
<a name="l00131"></a>00131     {
<a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">00137</a>         std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a>;
<a name="l00138"></a>00138 
<a name="l00142"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">00142</a>         std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a>;
<a name="l00143"></a>00143 
<a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">00148</a>         std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a>;
<a name="l00149"></a>00149 
<a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">00153</a>         std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a>;
<a name="l00154"></a>00154 
<a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">00158</a>         <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a>;
<a name="l00159"></a>00159 
<a name="l00163"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">00163</a>         <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a>;
<a name="l00164"></a>00164 
<a name="l00171"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">00171</a>         <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a>;
<a name="l00172"></a>00172         
<a name="l00177"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">00177</a>         <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a>;
<a name="l00178"></a>00178 
<a name="l00184"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">00184</a>         <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7" title="Quantization resolution of the parameter values (e.g.">quantizeStep</a>;
<a name="l00185"></a>00185 
<a name="l00197"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">00197</a>         std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b" title="Names for the quantized values.">valueNames</a>;
<a name="l00198"></a>00198 
<a name="l00199"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">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>
<a name="l00200"></a>00200             minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
<a name="l00201"></a>00201     };
<a name="l00202"></a>00202 
<a name="l00203"></a><a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">00203</a>     <span class="keyword">typedef</span> std::vector&lt;ParameterDescriptor&gt; <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>;
<a name="l00204"></a>00204 
<a name="l00208"></a><a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">00208</a>     <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>()<span class="keyword"> const </span>{
<a name="l00209"></a>00209         <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>();
<a name="l00210"></a>00210     }
<a name="l00211"></a>00211 
<a name="l00216"></a><a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">00216</a>     <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7" 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="l00217"></a>00217 
<a name="l00222"></a><a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">00222</a>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>) { } 
<a name="l00223"></a>00223 
<a name="l00224"></a>00224     
<a name="l00225"></a><a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">00225</a>     <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>;
<a name="l00226"></a>00226 
<a name="l00237"></a><a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">00237</a>     <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af" 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#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>(); }
<a name="l00238"></a>00238 
<a name="l00242"></a><a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">00242</a>     <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3" title="Get the current program.">getCurrentProgram</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }
<a name="l00243"></a>00243 
<a name="l00248"></a><a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">00248</a>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353" title="Select a program.">selectProgram</a>(std::string) { }
<a name="l00249"></a>00249 
<a name="l00255"></a>00255     <span class="keyword">virtual</span> std::string getType() <span class="keyword">const</span> = 0;
<a name="l00256"></a>00256 };
<a name="l00257"></a>00257 
<a name="l00258"></a>00258 }
<a name="l00259"></a>00259 
<a name="l00260"></a>00260 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(PluginBase.h)
<a name="l00261"></a>00261 
<a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="vamp-sdk_2PluginBase_8h.html">PluginBase.h</a>      </li>

    <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>