Mercurial > hg > vamp-docs

annotate code-docs/PluginWrapper_8h_source.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: PluginWrapper.h Source File</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li class="current"><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="files.html"><span>File&#160;List</span></a></li>
Chris@1 57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('PluginWrapper_8h.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="headertitle">
Chris@1 76 <div class="title">PluginWrapper.h</div> </div>
Chris@3 77 </div><!--header-->
Chris@1 78 <div class="contents">
Chris@1 79 <a href="PluginWrapper_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>
Chris@1 80 <a name="l00002"></a>00002
Chris@1 81 <a name="l00003"></a>00003 <span class="comment">/*</span>
Chris@1 82 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
Chris@1 83 <a name="l00005"></a>00005 <span class="comment"></span>
Chris@1 84 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
Chris@1 85 <a name="l00007"></a>00007 <span class="comment"></span>
Chris@1 86 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
Chris@1 87 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
Chris@1 88 <a name="l00010"></a>00010 <span class="comment"> </span>
Chris@1 89 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
Chris@1 90 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
Chris@1 91 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
Chris@1 92 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
Chris@1 93 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
Chris@1 94 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
Chris@1 95 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
Chris@1 96 <a name="l00018"></a>00018 <span class="comment"></span>
Chris@1 97 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
Chris@1 98 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
Chris@1 99 <a name="l00021"></a>00021 <span class="comment"></span>
Chris@1 100 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
Chris@1 101 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
Chris@1 102 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
Chris@1 103 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
Chris@1 104 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
Chris@1 105 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
Chris@1 106 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
Chris@1 107 <a name="l00029"></a>00029 <span class="comment"></span>
Chris@1 108 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
Chris@1 109 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
Chris@1 110 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
Chris@1 111 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
Chris@1 112 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
Chris@1 113 <a name="l00035"></a>00035 <span class="comment">*/</span>
Chris@1 114 <a name="l00036"></a>00036
Chris@1 115 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_WRAPPER_H_</span>
Chris@1 116 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_WRAPPER_H_</span>
Chris@1 117 <a name="l00039"></a>00039 <span class="preprocessor"></span>
Chris@1 118 <a name="l00040"></a>00040 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
Chris@1 119 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;<a class="code" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a>&gt;</span>
Chris@1 120 <a name="l00042"></a>00042
Chris@1 121 <a name="l00043"></a>00043 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginWrapper.h)
Chris@1 122 <a name="l00044"></a>00044
Chris@1 123 <a name="l00045"></a>00045 namespace Vamp {
Chris@1 124 <a name="l00046"></a>00046
Chris@1 125 <a name="l00047"></a>00047 <span class="keyword">namespace </span>HostExt {
Chris@1 126 <a name="l00048"></a>00048
Chris@1 127 <a name="l00062"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">00062</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a>
Chris@1 128 <a name="l00063"></a>00063 {
Chris@1 129 <a name="l00064"></a>00064 <span class="keyword">public</span>:
Chris@1 130 <a name="l00065"></a>00065 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>();
Chris@1 131 <a name="l00066"></a>00066
Chris@1 132 <a name="l00067"></a>00067 <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
Chris@1 133 <a name="l00068"></a>00068 <span class="keywordtype">void</span> reset();
Chris@1 134 <a name="l00069"></a>00069
Chris@1 135 <a name="l00070"></a>00070 <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
Chris@1 136 <a name="l00071"></a>00071
Chris@1 137 <a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion() <span class="keyword">const</span>;
Chris@1 138 <a name="l00073"></a>00073 std::string getIdentifier() <span class="keyword">const</span>;
Chris@1 139 <a name="l00074"></a>00074 std::string getName() <span class="keyword">const</span>;
Chris@1 140 <a name="l00075"></a>00075 std::string getDescription() <span class="keyword">const</span>;
Chris@1 141 <a name="l00076"></a>00076 std::string getMaker() <span class="keyword">const</span>;
Chris@1 142 <a name="l00077"></a>00077 <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span>;
Chris@1 143 <a name="l00078"></a>00078 std::string getCopyright() <span class="keyword">const</span>;
Chris@1 144 <a name="l00079"></a>00079
Chris@1 145 <a name="l00080"></a>00080 <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> getParameterDescriptors() <span class="keyword">const</span>;
Chris@1 146 <a name="l00081"></a>00081 <span class="keywordtype">float</span> getParameter(std::string) <span class="keyword">const</span>;
Chris@1 147 <a name="l00082"></a>00082 <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
Chris@1 148 <a name="l00083"></a>00083
Chris@1 149 <a name="l00084"></a>00084 <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> getPrograms() <span class="keyword">const</span>;
Chris@1 150 <a name="l00085"></a>00085 std::string getCurrentProgram() <span class="keyword">const</span>;
Chris@1 151 <a name="l00086"></a>00086 <span class="keywordtype">void</span> selectProgram(std::string);
Chris@1 152 <a name="l00087"></a>00087
Chris@1 153 <a name="l00088"></a>00088 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
Chris@1 154 <a name="l00089"></a>00089 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
Chris@1 155 <a name="l00090"></a>00090
Chris@1 156 <a name="l00091"></a>00091 <span class="keywordtype">size_t</span> getMinChannelCount() <span class="keyword">const</span>;
Chris@1 157 <a name="l00092"></a>00092 <span class="keywordtype">size_t</span> getMaxChannelCount() <span class="keyword">const</span>;
Chris@1 158 <a name="l00093"></a>00093
Chris@1 159 <a name="l00094"></a>00094 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> getOutputDescriptors() <span class="keyword">const</span>;
Chris@1 160 <a name="l00095"></a>00095
Chris@1 161 <a name="l00096"></a>00096 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> timestamp);
Chris@1 162 <a name="l00097"></a>00097
Chris@1 163 <a name="l00098"></a>00098 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures();
Chris@1 164 <a name="l00099"></a>00099
Chris@1 165 <a name="l00115"></a>00115 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> WrapperType&gt;
Chris@1 166 <a name="l00116"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">00116</a> WrapperType *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&#39;s plugin...">getWrapper</a>() {
Chris@1 167 <a name="l00117"></a>00117 WrapperType *w = <span class="keyword">dynamic_cast&lt;</span>WrapperType *<span class="keyword">&gt;</span>(<span class="keyword">this</span>);
Chris@1 168 <a name="l00118"></a>00118 <span class="keywordflow">if</span> (w) <span class="keywordflow">return</span> w;
Chris@1 169 <a name="l00119"></a>00119 <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> *pw = <span class="keyword">dynamic_cast&lt;</span><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> *<span class="keyword">&gt;</span>(m_plugin);
Chris@1 170 <a name="l00120"></a>00120 <span class="keywordflow">if</span> (pw) <span class="keywordflow">return</span> pw-&gt;<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&#39;s plugin...">getWrapper</a>&lt;WrapperType&gt;();
Chris@1 171 <a name="l00121"></a>00121 <span class="keywordflow">return</span> 0;
Chris@1 172 <a name="l00122"></a>00122 }
Chris@1 173 <a name="l00123"></a>00123
Chris@1 174 <a name="l00124"></a>00124 <span class="keyword">protected</span>:
Chris@1 175 <a name="l00125"></a>00125 <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>(<a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> *plugin); <span class="comment">// I take ownership of plugin</span>
Chris@1 176 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">00126</a> <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a>;
Chris@1 177 <a name="l00127"></a>00127 };
Chris@1 178 <a name="l00128"></a>00128
Chris@1 179 <a name="l00129"></a>00129 }
Chris@1 180 <a name="l00130"></a>00130
Chris@1 181 <a name="l00131"></a>00131 }
Chris@1 182 <a name="l00132"></a>00132
Chris@1 183 <a name="l00133"></a>00133 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginWrapper.h)
Chris@1 184 <a name="l00134"></a>00134
Chris@1 185 <a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
Chris@3 186 </pre></div></div><!-- contents -->
Chris@1 187 </div>
Chris@1 188 <div id="nav-path" class="navpath">
Chris@1 189 <ul>
Chris@1 190 <li class="navelem"><a class="el" href="PluginWrapper_8h.html">PluginWrapper.h</a> </li>
Chris@1 191
Chris@3 192 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
Chris@1 193 <a href="http://www.doxygen.org/index.html">
Chris@3 194 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 195 </ul>
Chris@1 196 </div>
Chris@1 197
Chris@1 198
Chris@1 199 </body>
Chris@1 200 </html>