Mercurial > hg > vamp-website

comparison code-doc/PluginInputDomainAdapter_8h-source.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.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.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
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>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
16 </ul> 22 </ul>
17 </div> 23 </div>
18 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a> 24 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
19 </div> 25 </div>
20 </div> 26 </div>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
26 <a name="l00005"></a>00005 <span class="comment"></span> 32 <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> 33 <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> 34 <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> 35 <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> 36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
31 <a name="l00010"></a>00010 <span class="comment"> </span> 37 <a name="l00010"></a>00010 <span class="comment"> </span>
32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> 38 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> 39 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> 40 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> 41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
72 <a name="l00084"></a>00084 <span class="keyword">public</span>: 78 <a name="l00084"></a>00084 <span class="keyword">public</span>:
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); 79 <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="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>(); 80 <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="l00092"></a>00092 81 <a name="l00092"></a>00092
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); 82 <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="l00094"></a>00094 83 <a name="l00094"></a>00094 <span class="keywordtype">void</span> reset();
78 <a name="l00095"></a>00095 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>; 84 <a name="l00095"></a>00095
79 <a name="l00096"></a>00096 85 <a name="l00096"></a>00096 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> getInputDomain() <span class="keyword">const</span>;
80 <a name="l00097"></a>00097 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>; 86 <a name="l00097"></a>00097
81 <a name="l00098"></a>00098 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>; 87 <a name="l00098"></a>00098 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
82 <a name="l00099"></a>00099 88 <a name="l00099"></a>00099 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
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); 89 <a name="l00100"></a>00100
84 <a name="l00101"></a>00101 90 <a name="l00101"></a>00101 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);
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>; 91 <a name="l00102"></a>00102
86 <a name="l00124"></a>00124 92 <a name="l00137"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">00137</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577" title="ProcessTimestampMethod determines how the PluginInputDomainAdapter handles timestamps...">ProcessTimestampMethod</a> {
87 <a name="l00125"></a>00125 <span class="keyword">protected</span>: 93 <a name="l00138"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd">00138</a> ShiftTimestamp,
88 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">00126</a> <span class="keyword">class </span>Impl; 94 <a name="l00139"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152">00139</a> ShiftData,
89 <a name="l00127"></a>00127 Impl *m_impl; 95 <a name="l00140"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297">00140</a> NoShift
90 <a name="l00128"></a>00128 }; 96 <a name="l00141"></a>00141 };
91 <a name="l00129"></a>00129 97 <a name="l00142"></a>00142
92 <a name="l00130"></a>00130 } 98 <a name="l00151"></a>00151 <span class="keywordtype">void</span> setProcessTimestampMethod(ProcessTimestampMethod);
93 <a name="l00131"></a>00131 99 <a name="l00152"></a>00152
94 <a name="l00132"></a>00132 } 100 <a name="l00158"></a>00158 ProcessTimestampMethod getProcessTimestampMethod() <span class="keyword">const</span>;
95 <a name="l00133"></a>00133 101 <a name="l00159"></a>00159
96 <a name="l00134"></a>00134 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginInputDomainAdapter.h) 102 <a name="l00185"></a>00185 <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>;
97 <a name="l00135"></a>00135 103 <a name="l00186"></a>00186
98 <a name="l00136"></a>00136 <span class="preprocessor">#endif</span> 104 <a name="l00187"></a>00187 <span class="keyword">protected</span>:
105 <a name="l00188"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">00188</a> <span class="keyword">class </span>Impl;
106 <a name="l00189"></a>00189 Impl *m_impl;
107 <a name="l00190"></a>00190 };
108 <a name="l00191"></a>00191
109 <a name="l00192"></a>00192 }
110 <a name="l00193"></a>00193
111 <a name="l00194"></a>00194 }
112 <a name="l00195"></a>00195
113 <a name="l00196"></a>00196 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginInputDomainAdapter.h)
114 <a name="l00197"></a>00197
115 <a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
99 </pre></div></div> 116 </pre></div></div>
100 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp; 117 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
101 <a href="http://www.doxygen.org/index.html"> 118 <a href="http://www.doxygen.org/index.html">
102 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
103 </body> 120 </body>
104 </html> 121 </html>