Mercurial > hg > vamp-website

comparison code-doc/PluginBufferingAdapter_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: PluginBufferingAdapter.h Source File</title> 3 <title>VampPluginSDK: PluginBufferingAdapter.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>PluginBufferingAdapter.h</h1><a href="PluginBufferingAdapter_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>PluginBufferingAdapter.h</h1><a href="PluginBufferingAdapter_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>
27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> 27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
28 <a name="l00007"></a>00007 <span class="comment"></span> 28 <a name="l00007"></a>00007 <span class="comment"></span>
29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> 29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2007 Chris Cannam and QMUL.</span> 30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2007 Chris Cannam and QMUL.</span>
31 <a name="l00010"></a>00010 <span class="comment"> This file by Mark Levy, Copyright 2007 QMUL.</span> 31 <a name="l00010"></a>00010 <span class="comment"> This file by Mark Levy and Chris Cannam, Copyright 2007-2008 QMUL.</span>
32 <a name="l00011"></a>00011 <span class="comment"> </span> 32 <a name="l00011"></a>00011 <span class="comment"> </span>
33 <a name="l00012"></a>00012 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> 33 <a name="l00012"></a>00012 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
34 <a name="l00013"></a>00013 <span class="comment"> obtaining a copy of this software and associated documentation</span> 34 <a name="l00013"></a>00013 <span class="comment"> obtaining a copy of this software and associated documentation</span>
35 <a name="l00014"></a>00014 <span class="comment"> files (the "Software"), to deal in the Software without</span> 35 <a name="l00014"></a>00014 <span class="comment"> files (the "Software"), to deal in the Software without</span>
36 <a name="l00015"></a>00015 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> 36 <a name="l00015"></a>00015 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
57 <a name="l00036"></a>00036 <span class="comment">*/</span> 57 <a name="l00036"></a>00036 <span class="comment">*/</span>
58 <a name="l00037"></a>00037 58 <a name="l00037"></a>00037
59 <a name="l00038"></a>00038 <span class="preprocessor">#ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span> 59 <a name="l00038"></a>00038 <span class="preprocessor">#ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span>
60 <a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span> 60 <a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span>
61 <a name="l00040"></a>00040 <span class="preprocessor"></span> 61 <a name="l00040"></a>00040 <span class="preprocessor"></span>
62 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span> 62 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span>
63 <a name="l00042"></a>00042 63 <a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span>
64 <a name="l00043"></a>00043 <span class="keyword">namespace </span>Vamp { 64 <a name="l00043"></a>00043
65 <a name="l00044"></a>00044 65 <a name="l00044"></a>00044 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginBufferingAdapter.h)
66 <a name="l00045"></a>00045 <span class="keyword">namespace </span>HostExt { 66 <a name="l00045"></a>00045
67 <a name="l00046"></a>00046 67 <a name="l00046"></a>00046 namespace Vamp {
68 <a name="l00072"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">00072</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</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> 68 <a name="l00047"></a>00047
69 <a name="l00073"></a>00073 { 69 <a name="l00048"></a><a class="code" href="namespaceVamp_1_1HostExt.html">00048</a> <span class="keyword">namespace </span>HostExt {
70 <a name="l00074"></a>00074 <span class="keyword">public</span>: 70 <a name="l00049"></a>00049
71 <a name="l00075"></a>00075 <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</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> 71 <a name="l00075"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">00075</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</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>
72 <a name="l00076"></a>00076 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#539423b54a4ede511476125f4a97d977">~PluginBufferingAdapter</a>(); 72 <a name="l00076"></a>00076 {
73 <a name="l00077"></a>00077 73 <a name="l00077"></a>00077 <span class="keyword">public</span>:
74 <a name="l00078"></a>00078 <span class="keywordtype">bool</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" 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); 74 <a name="l00083"></a>00083 <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</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);
75 <a name="l00079"></a>00079 75 <a name="l00084"></a>00084 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a>();
76 <a name="l00080"></a>00080 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>() <span class="keyword">const</span>;
77 <a name="l00081"></a>00081
78 <a name="l00082"></a>00082 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
79 <a name="l00083"></a>00083
80 <a name="l00084"></a>00084 <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
81 <a name="l00085"></a>00085 76 <a name="l00085"></a>00085
82 <a name="l00086"></a>00086 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" 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); 77 <a name="l00095"></a>00095 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
83 <a name="l00087"></a>00087
84 <a name="l00088"></a>00088 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
85 <a name="l00089"></a>00089
86 <a name="l00090"></a>00090 <span class="keyword">protected</span>:
87 <a name="l00091"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">00091</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a>;
88 <a name="l00092"></a>00092 <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">m_impl</a>;
89 <a name="l00093"></a>00093 };
90 <a name="l00094"></a>00094
91 <a name="l00095"></a>00095 }
92 <a name="l00096"></a>00096 78 <a name="l00096"></a>00096
93 <a name="l00097"></a>00097 } 79 <a name="l00107"></a>00107 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
94 <a name="l00098"></a>00098 80 <a name="l00108"></a>00108
95 <a name="l00099"></a>00099 <span class="preprocessor">#endif</span> 81 <a name="l00118"></a>00118 <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);
82 <a name="l00119"></a>00119
83 <a name="l00131"></a>00131 <span class="keywordtype">size_t</span> getPluginPreferredStepSize() <span class="keyword">const</span>;
84 <a name="l00132"></a>00132
85 <a name="l00139"></a>00139 <span class="keywordtype">size_t</span> getPluginPreferredBlockSize() <span class="keyword">const</span>;
86 <a name="l00140"></a>00140
87 <a name="l00148"></a>00148 <span class="keywordtype">void</span> setPluginStepSize(<span class="keywordtype">size_t</span> stepSize);
88 <a name="l00149"></a>00149
89 <a name="l00157"></a>00157 <span class="keywordtype">void</span> setPluginBlockSize(<span class="keywordtype">size_t</span> blockSize);
90 <a name="l00158"></a>00158
91 <a name="l00170"></a>00170 <span class="keywordtype">void</span> getActualStepAndBlockSizes(<span class="keywordtype">size_t</span> &amp;stepSize, <span class="keywordtype">size_t</span> &amp;blockSize);
92 <a name="l00171"></a>00171
93 <a name="l00172"></a>00172 <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
94 <a name="l00173"></a>00173 <span class="keywordtype">void</span> selectProgram(std::string);
95 <a name="l00174"></a>00174
96 <a name="l00175"></a>00175 OutputList getOutputDescriptors() <span class="keyword">const</span>;
97 <a name="l00176"></a>00176
98 <a name="l00177"></a>00177 <span class="keywordtype">void</span> reset();
99 <a name="l00178"></a>00178
100 <a name="l00179"></a>00179 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);
101 <a name="l00180"></a>00180
102 <a name="l00181"></a>00181 FeatureSet getRemainingFeatures();
103 <a name="l00182"></a>00182
104 <a name="l00183"></a>00183 <span class="keyword">protected</span>:
105 <a name="l00184"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">00184</a> <span class="keyword">class </span>Impl;
106 <a name="l00185"></a>00185 Impl *m_impl;
107 <a name="l00186"></a>00186 };
108 <a name="l00187"></a>00187
109 <a name="l00188"></a>00188 }
110 <a name="l00189"></a>00189
111 <a name="l00190"></a>00190 }
112 <a name="l00191"></a>00191
113 <a name="l00192"></a>00192 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginBufferingAdapter.h)
114 <a name="l00193"></a>00193
115 <a name="l00194"></a>00194 <span class="preprocessor">#endif</span>
96 </pre></div></div> 116 </pre></div></div>
97 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:06 2008 for VampPluginSDK by&nbsp; 117 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
98 <a href="http://www.doxygen.org/index.html"> 118 <a href="http://www.doxygen.org/index.html">
99 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
100 </body> 120 </body>
101 </html> 121 </html>