Mercurial > hg > vamp-website

diff code-doc/PluginWrapper_8h-source.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
line wrap: on
line diff
--- a/code-doc/PluginWrapper_8h-source.html	Mon Nov 24 15:17:08 2008 +0000
+++ b/code-doc/PluginWrapper_8h-source.html	Tue Dec 09 11:02:57 2008 +0000
@@ -4,7 +4,7 @@
 <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 -->
+<!-- Generated by Doxygen 1.5.6 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
@@ -15,10 +15,10 @@
       <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>&nbsp;&raquo&nbsp;<a class="el" href="dir_fa454903fff8cd477733ebe28a3468c0.html">hostext</a>
+  <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
   </div>
 </div>
-</div>
+<div class="contents">
 <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>
 <a name="l00002"></a>00002 
 <a name="l00003"></a>00003 <span class="comment">/*</span>
@@ -58,63 +58,77 @@
 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_WRAPPER_H_</span>
 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_WRAPPER_H_</span>
 <a name="l00039"></a>00039 <span class="preprocessor"></span>
-<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span>
-<a name="l00041"></a>00041 
-<a name="l00042"></a>00042 <span class="keyword">namespace </span>Vamp {
-<a name="l00043"></a>00043 
-<a name="l00044"></a>00044 <span class="keyword">namespace </span>HostExt {
-<a name="l00045"></a>00045 
-<a name="l00059"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html">00059</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>
-<a name="l00060"></a>00060 {
-<a name="l00061"></a>00061 <span class="keyword">public</span>:
-<a name="l00062"></a>00062     <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7449a364d524de75352a4719fec2e1f5">~PluginWrapper</a>();
-<a name="l00063"></a>00063     
-<a name="l00064"></a>00064     <span class="keywordtype">bool</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
-<a name="l00065"></a>00065     <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
-<a name="l00066"></a>00066 
-<a name="l00067"></a>00067     <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#031aa818fd48fd0f4b5e1bf80c032870" title="Get the plugin&amp;#39;s required input domain.">getInputDomain</a>() <span class="keyword">const</span>;
-<a name="l00068"></a>00068 
-<a name="l00069"></a>00069     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>() <span class="keyword">const</span>;
-<a name="l00070"></a>00070     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>;
-<a name="l00071"></a>00071     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>;
-<a name="l00072"></a>00072     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span>;
-<a name="l00073"></a>00073     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>;
-<a name="l00074"></a>00074     <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>;
-<a name="l00075"></a>00075     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>;
-<a name="l00076"></a>00076 
-<a name="l00077"></a>00077     <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>() <span class="keyword">const</span>;
-<a name="l00078"></a>00078     <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c" title="Get the value of a named parameter.">getParameter</a>(std::string) <span class="keyword">const</span>;
-<a name="l00079"></a>00079     <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>);
-<a name="l00080"></a>00080 
-<a name="l00081"></a>00081     <a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1" title="Get the program settings available in this plugin.">getPrograms</a>() <span class="keyword">const</span>;
-<a name="l00082"></a>00082     std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651" title="Get the current program.">getCurrentProgram</a>() <span class="keyword">const</span>;
-<a name="l00083"></a>00083     <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf" title="Select a program.">selectProgram</a>(std::string);
-<a name="l00084"></a>00084 
-<a name="l00085"></a>00085     <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>() <span class="keyword">const</span>;
-<a name="l00086"></a>00086     <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>() <span class="keyword">const</span>;
+<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span>
+<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>
+<a name="l00042"></a>00042 
+<a name="l00043"></a>00043 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginWrapper.h)
+<a name="l00044"></a>00044 
+<a name="l00045"></a>00045 namespace Vamp {
+<a name="l00046"></a>00046 
+<a name="l00047"></a>00047 <span class="keyword">namespace </span>HostExt {
+<a name="l00048"></a>00048 
+<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>
+<a name="l00063"></a>00063 {
+<a name="l00064"></a>00064 <span class="keyword">public</span>:
+<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>();
+<a name="l00066"></a>00066     
+<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);
+<a name="l00068"></a>00068     <span class="keywordtype">void</span> reset();
+<a name="l00069"></a>00069 
+<a name="l00070"></a>00070     <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
+<a name="l00071"></a>00071 
+<a name="l00072"></a>00072     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVampApiVersion() <span class="keyword">const</span>;
+<a name="l00073"></a>00073     std::string getIdentifier() <span class="keyword">const</span>;
+<a name="l00074"></a>00074     std::string getName() <span class="keyword">const</span>;
+<a name="l00075"></a>00075     std::string getDescription() <span class="keyword">const</span>;
+<a name="l00076"></a>00076     std::string getMaker() <span class="keyword">const</span>;
+<a name="l00077"></a>00077     <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span>;
+<a name="l00078"></a>00078     std::string getCopyright() <span class="keyword">const</span>;
+<a name="l00079"></a>00079 
+<a name="l00080"></a>00080     ParameterList getParameterDescriptors() <span class="keyword">const</span>;
+<a name="l00081"></a>00081     <span class="keywordtype">float</span> getParameter(std::string) <span class="keyword">const</span>;
+<a name="l00082"></a>00082     <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
+<a name="l00083"></a>00083 
+<a name="l00084"></a>00084     ProgramList getPrograms() <span class="keyword">const</span>;
+<a name="l00085"></a>00085     std::string getCurrentProgram() <span class="keyword">const</span>;
+<a name="l00086"></a>00086     <span class="keywordtype">void</span> selectProgram(std::string);
 <a name="l00087"></a>00087 
-<a name="l00088"></a>00088     <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() <span class="keyword">const</span>;
-<a name="l00089"></a>00089     <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>() <span class="keyword">const</span>;
+<a name="l00088"></a>00088     <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
+<a name="l00089"></a>00089     <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
 <a name="l00090"></a>00090 
-<a name="l00091"></a>00091     <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
-<a name="l00092"></a>00092 
-<a name="l00093"></a>00093     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process</a>(<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);
-<a name="l00094"></a>00094 
-<a name="l00095"></a>00095     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
-<a name="l00096"></a>00096 
-<a name="l00097"></a>00097 <span class="keyword">protected</span>:
-<a name="l00098"></a>00098     <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#35cc2d42f8322f5022e89859a79c97be">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>
-<a name="l00099"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">00099</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> *<a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a>;
-<a name="l00100"></a>00100 };
-<a name="l00101"></a>00101 
-<a name="l00102"></a>00102 }
-<a name="l00103"></a>00103 
-<a name="l00104"></a>00104 }
-<a name="l00105"></a>00105 
-<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
+<a name="l00091"></a>00091     <span class="keywordtype">size_t</span> getMinChannelCount() <span class="keyword">const</span>;
+<a name="l00092"></a>00092     <span class="keywordtype">size_t</span> getMaxChannelCount() <span class="keyword">const</span>;
+<a name="l00093"></a>00093 
+<a name="l00094"></a>00094     OutputList getOutputDescriptors() <span class="keyword">const</span>;
+<a name="l00095"></a>00095 
+<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);
+<a name="l00097"></a>00097 
+<a name="l00098"></a>00098     FeatureSet getRemainingFeatures();
+<a name="l00099"></a>00099 
+<a name="l00115"></a>00115     <span class="keyword">template</span> &lt;<span class="keyword">typename</span> WrapperType&gt;
+<a name="l00116"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">00116</a>     WrapperType *getWrapper() {
+<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>);
+<a name="l00118"></a>00118         <span class="keywordflow">if</span> (w) <span class="keywordflow">return</span> w;
+<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);
+<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;();
+<a name="l00121"></a>00121         <span class="keywordflow">return</span> 0;
+<a name="l00122"></a>00122     }
+<a name="l00123"></a>00123 
+<a name="l00124"></a>00124 <span class="keyword">protected</span>:
+<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>
+<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;
+<a name="l00127"></a>00127 };
+<a name="l00128"></a>00128 
+<a name="l00129"></a>00129 }
+<a name="l00130"></a>00130 
+<a name="l00131"></a>00131 }
+<a name="l00132"></a>00132 
+<a name="l00133"></a>00133 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginWrapper.h)
+<a name="l00134"></a>00134 
+<a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 </body>
 </html>