Mercurial > hg > vamp-website

comparison code-doc/PluginInputDomainAdapter_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
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: PluginInputDomainAdapter.h Source File</title> 3 <title>VampPluginSDK: PluginInputDomainAdapter.h Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li><a href="annotated.html"><span>Classes</span></a></li> 13 <li><a href="annotated.html"><span>Classes</span></a></li>
14 <li class="current"><a href="files.html"><span>Files</span></a></li> 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul> 16 </ul>
17 </div> 17 </div>
18 <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> 18 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
19 </div> 19 </div>
20 </div> 20 </div>
21 </div> 21 <div class="contents">
22 <h1>PluginInputDomainAdapter.h</h1><a href="PluginInputDomainAdapter_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> 22 <h1>PluginInputDomainAdapter.h</h1><a href="PluginInputDomainAdapter_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>
23 <a name="l00002"></a>00002 23 <a name="l00002"></a>00002
24 <a name="l00003"></a>00003 <span class="comment">/*</span> 24 <a name="l00003"></a>00003 <span class="comment">/*</span>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
26 <a name="l00005"></a>00005 <span class="comment"></span> 26 <a name="l00005"></a>00005 <span class="comment"></span>
56 <a name="l00035"></a>00035 <span class="comment">*/</span> 56 <a name="l00035"></a>00035 <span class="comment">*/</span>
57 <a name="l00036"></a>00036 57 <a name="l00036"></a>00036
58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span> 58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span>
59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span> 59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span>
60 <a name="l00039"></a>00039 <span class="preprocessor"></span> 60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
61 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span> 61 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span>
62 <a name="l00041"></a>00041 62 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span>
63 <a name="l00042"></a>00042 <span class="keyword">namespace </span>Vamp { 63 <a name="l00042"></a>00042
64 <a name="l00043"></a>00043 64 <a name="l00043"></a>00043 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginInputDomainAdapter.h)
65 <a name="l00044"></a>00044 <span class="keyword">namespace </span>HostExt { 65 <a name="l00044"></a>00044
66 <a name="l00045"></a>00045 66 <a name="l00045"></a>00045 namespace Vamp {
67 <a name="l00079"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">00079</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> 67 <a name="l00046"></a>00046
68 <a name="l00080"></a>00080 { 68 <a name="l00047"></a>00047 <span class="keyword">namespace </span>HostExt {
69 <a name="l00081"></a>00081 <span class="keyword">public</span>: 69 <a name="l00048"></a>00048
70 <a name="l00082"></a>00082 <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#878e7275acdb77efc7a802944305039d">PluginInputDomainAdapter</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> 70 <a name="l00082"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">00082</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>
71 <a name="l00083"></a>00083 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ec457c952155adf516dd8e3dc7739321">~PluginInputDomainAdapter</a>(); 71 <a name="l00083"></a>00083 {
72 <a name="l00084"></a>00084 72 <a name="l00084"></a>00084 <span class="keyword">public</span>:
73 <a name="l00085"></a>00085 <span class="keywordtype">bool</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" 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); 73 <a name="l00090"></a>00090 <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</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);
74 <a name="l00086"></a>00086 74 <a name="l00091"></a>00091 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>();
75 <a name="l00087"></a>00087 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976" title="Get the plugin&amp;#39;s required input domain.">getInputDomain</a>() <span class="keyword">const</span>; 75 <a name="l00092"></a>00092
76 <a name="l00088"></a>00088 76 <a name="l00093"></a>00093 <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);
77 <a name="l00089"></a>00089 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>() <span class="keyword">const</span>; 77 <a name="l00094"></a>00094
78 <a name="l00090"></a>00090 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>() <span class="keyword">const</span>; 78 <a name="l00095"></a>00095 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
79 <a name="l00091"></a>00091 79 <a name="l00096"></a>00096
80 <a name="l00092"></a>00092 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#0867737693c16801d40a6adbde07ec07" 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); 80 <a name="l00097"></a>00097 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
81 <a name="l00093"></a>00093 81 <a name="l00098"></a>00098 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
82 <a name="l00094"></a>00094 <span class="keyword">protected</span>: 82 <a name="l00099"></a>00099
83 <a name="l00095"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">00095</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter_1_1Impl.html">Impl</a>; 83 <a name="l00100"></a>00100 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);
84 <a name="l00096"></a>00096 <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter_1_1Impl.html">Impl</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">m_impl</a>; 84 <a name="l00101"></a>00101
85 <a name="l00097"></a>00097 }; 85 <a name="l00123"></a>00123 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> getTimestampAdjustment() <span class="keyword">const</span>;
86 <a name="l00098"></a>00098 86 <a name="l00124"></a>00124
87 <a name="l00099"></a>00099 } 87 <a name="l00125"></a>00125 <span class="keyword">protected</span>:
88 <a name="l00100"></a>00100 88 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">00126</a> <span class="keyword">class </span>Impl;
89 <a name="l00101"></a>00101 } 89 <a name="l00127"></a>00127 Impl *m_impl;
90 <a name="l00102"></a>00102 90 <a name="l00128"></a>00128 };
91 <a name="l00103"></a>00103 <span class="preprocessor">#endif</span> 91 <a name="l00129"></a>00129
92 <a name="l00130"></a>00130 }
93 <a name="l00131"></a>00131
94 <a name="l00132"></a>00132 }
95 <a name="l00133"></a>00133
96 <a name="l00134"></a>00134 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginInputDomainAdapter.h)
97 <a name="l00135"></a>00135
98 <a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
92 </pre></div></div> 99 </pre></div></div>
93 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp; 100 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
94 <a href="http://www.doxygen.org/index.html"> 101 <a href="http://www.doxygen.org/index.html">
95 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 102 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
96 </body> 103 </body>
97 </html> 104 </html>