Mercurial > hg > vamp-website

annotate code-doc/PluginWrapper_8h-source.html @ 39:01f34bbd799b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Add VamPy page
author cannam
date Mon, 12 Oct 2009 16:16:52 +0000
parents 0976232e353b
children
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: PluginWrapper.h Source File</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@35 18 <div class="tabs">
cannam@35 19 <ul>
cannam@35 20 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
cannam@35 21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
cannam@35 22 </ul>
cannam@35 23 </div>
cannam@21 24 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
cannam@0 25 </div>
cannam@0 26 </div>
cannam@21 27 <div class="contents">
cannam@0 28 <h1>PluginWrapper.h</h1><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>
cannam@0 29 <a name="l00002"></a>00002
cannam@0 30 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@0 31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@0 32 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@0 33 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@0 34 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@0 35 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@35 36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
cannam@0 37 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@0 38 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@0 39 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@0 40 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@0 41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@0 42 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@0 43 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@0 44 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@0 45 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@0 46 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@0 47 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@0 48 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@0 49 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@0 50 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@0 51 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@0 52 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@0 53 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@0 54 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@0 55 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@0 56 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@0 57 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@0 58 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@0 59 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@0 60 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@0 61 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@0 62 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@0 63 <a name="l00036"></a>00036
cannam@0 64 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_WRAPPER_H_</span>
cannam@0 65 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_WRAPPER_H_</span>
cannam@0 66 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@21 67 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span>
cannam@21 68 <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>
cannam@21 69 <a name="l00042"></a>00042
cannam@21 70 <a name="l00043"></a>00043 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginWrapper.h)
cannam@21 71 <a name="l00044"></a>00044
cannam@21 72 <a name="l00045"></a>00045 namespace Vamp {
cannam@21 73 <a name="l00046"></a>00046
cannam@21 74 <a name="l00047"></a>00047 <span class="keyword">namespace </span>HostExt {
cannam@21 75 <a name="l00048"></a>00048
cannam@21 76 <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...">Plugin</a>
cannam@21 77 <a name="l00063"></a>00063 {
cannam@21 78 <a name="l00064"></a>00064 <span class="keyword">public</span>:
cannam@21 79 <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>();
cannam@21 80 <a name="l00066"></a>00066
cannam@21 81 <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);
cannam@21 82 <a name="l00068"></a>00068 <span class="keywordtype">void</span> reset();
cannam@21 83 <a name="l00069"></a>00069
cannam@21 84 <a name="l00070"></a>00070 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
cannam@21 85 <a name="l00071"></a>00071
cannam@21 86 <a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion() <span class="keyword">const</span>;
cannam@21 87 <a name="l00073"></a>00073 std::string getIdentifier() <span class="keyword">const</span>;
cannam@21 88 <a name="l00074"></a>00074 std::string getName() <span class="keyword">const</span>;
cannam@21 89 <a name="l00075"></a>00075 std::string getDescription() <span class="keyword">const</span>;
cannam@21 90 <a name="l00076"></a>00076 std::string getMaker() <span class="keyword">const</span>;
cannam@21 91 <a name="l00077"></a>00077 <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span>;
cannam@21 92 <a name="l00078"></a>00078 std::string getCopyright() <span class="keyword">const</span>;
cannam@21 93 <a name="l00079"></a>00079
cannam@21 94 <a name="l00080"></a>00080 ParameterList getParameterDescriptors() <span class="keyword">const</span>;
cannam@21 95 <a name="l00081"></a>00081 <span class="keywordtype">float</span> getParameter(std::string) <span class="keyword">const</span>;
cannam@21 96 <a name="l00082"></a>00082 <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
cannam@21 97 <a name="l00083"></a>00083
cannam@21 98 <a name="l00084"></a>00084 ProgramList getPrograms() <span class="keyword">const</span>;
cannam@21 99 <a name="l00085"></a>00085 std::string getCurrentProgram() <span class="keyword">const</span>;
cannam@21 100 <a name="l00086"></a>00086 <span class="keywordtype">void</span> selectProgram(std::string);
cannam@0 101 <a name="l00087"></a>00087
cannam@21 102 <a name="l00088"></a>00088 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
cannam@21 103 <a name="l00089"></a>00089 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
cannam@0 104 <a name="l00090"></a>00090
cannam@21 105 <a name="l00091"></a>00091 <span class="keywordtype">size_t</span> getMinChannelCount() <span class="keyword">const</span>;
cannam@21 106 <a name="l00092"></a>00092 <span class="keywordtype">size_t</span> getMaxChannelCount() <span class="keyword">const</span>;
cannam@21 107 <a name="l00093"></a>00093
cannam@21 108 <a name="l00094"></a>00094 OutputList getOutputDescriptors() <span class="keyword">const</span>;
cannam@21 109 <a name="l00095"></a>00095
cannam@21 110 <a name="l00096"></a>00096 FeatureSet 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...">RealTime</a> timestamp);
cannam@21 111 <a name="l00097"></a>00097
cannam@21 112 <a name="l00098"></a>00098 FeatureSet getRemainingFeatures();
cannam@21 113 <a name="l00099"></a>00099
cannam@21 114 <a name="l00115"></a>00115 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> WrapperType&gt;
cannam@35 115 <a name="l00116"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">00116</a> WrapperType *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&amp;#39;s...">getWrapper</a>() {
cannam@21 116 <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>);
cannam@21 117 <a name="l00118"></a>00118 <span class="keywordflow">if</span> (w) <span class="keywordflow">return</span> w;
cannam@21 118 <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);
cannam@21 119 <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#e9d79bed7237d55a73018a6b982a55b3" title="Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper&amp;#39;s...">getWrapper</a>&lt;WrapperType&gt;();
cannam@21 120 <a name="l00121"></a>00121 <span class="keywordflow">return</span> 0;
cannam@21 121 <a name="l00122"></a>00122 }
cannam@21 122 <a name="l00123"></a>00123
cannam@21 123 <a name="l00124"></a>00124 <span class="keyword">protected</span>:
cannam@21 124 <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...">Plugin</a> *plugin); <span class="comment">// I take ownership of plugin</span>
cannam@21 125 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">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...">Plugin</a> *m_plugin;
cannam@21 126 <a name="l00127"></a>00127 };
cannam@21 127 <a name="l00128"></a>00128
cannam@21 128 <a name="l00129"></a>00129 }
cannam@21 129 <a name="l00130"></a>00130
cannam@21 130 <a name="l00131"></a>00131 }
cannam@21 131 <a name="l00132"></a>00132
cannam@21 132 <a name="l00133"></a>00133 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginWrapper.h)
cannam@21 133 <a name="l00134"></a>00134
cannam@21 134 <a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
cannam@0 135 </pre></div></div>
cannam@35 136 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@0 137 <a href="http://www.doxygen.org/index.html">
cannam@35 138 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 139 </body>
cannam@0 140 </html>