Mercurial > hg > vamp-website
view code-doc/PluginInputDomainAdapter_8h-source.html @ 0:351c4ebce5f9 website
* Move website from vamp-website/trunk to plain website
| author | cannam |
|---|---|
| date | Mon, 22 Sep 2008 13:01:46 +0000 |
| parents | |
| children | cc0be37dc9d3 |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: PluginInputDomainAdapter.h Source File</title> <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 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <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> » <a class="el" href="dir_fa454903fff8cd477733ebe28a3468c0.html">hostext</a> </div> </div> </div> <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> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> <a name="l00004"></a>00004 <span class="comment"> Vamp</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> <a name="l00007"></a>00007 <span class="comment"></span> <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2007 Chris Cannam and QMUL.</span> <a name="l00010"></a>00010 <span class="comment"> </span> <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> <a name="l00018"></a>00018 <span class="comment"></span> <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> <a name="l00021"></a>00021 <span class="comment"></span> <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> <a name="l00029"></a>00029 <span class="comment"></span> <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> <a name="l00034"></a>00034 <span class="comment"> authorization.</span> <a name="l00035"></a>00035 <span class="comment">*/</span> <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span> <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_</span> <a name="l00039"></a>00039 <span class="preprocessor"></span> <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.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="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> <a name="l00080"></a>00080 { <a name="l00081"></a>00081 <span class="keyword">public</span>: <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> <a name="l00083"></a>00083 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ec457c952155adf516dd8e3dc7739321">~PluginInputDomainAdapter</a>(); <a name="l00084"></a>00084 <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); <a name="l00086"></a>00086 <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&#39;s required input domain.">getInputDomain</a>() <span class="keyword">const</span>; <a name="l00088"></a>00088 <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>; <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>; <a name="l00091"></a>00091 <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); <a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="keyword">protected</span>: <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>; <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>; <a name="l00097"></a>00097 }; <a name="l00098"></a>00098 <a name="l00099"></a>00099 } <a name="l00100"></a>00100 <a name="l00101"></a>00101 } <a name="l00102"></a>00102 <a name="l00103"></a>00103 <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 <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> </body> </html>