Mercurial > hg > vamp-website

annotate code-doc/PluginAdapter_8h-source.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: PluginAdapter.h Source File</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
cannam@0 19 </div>
cannam@0 20 </div>
cannam@0 21 </div>
cannam@0 22 <h1>PluginAdapter.h</h1><a href="PluginAdapter_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>
cannam@0 23 <a name="l00002"></a>00002
cannam@0 24 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@0 25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@0 26 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@0 27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@0 28 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@0 29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@0 30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@0 31 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@0 32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@0 33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@0 34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@0 35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@0 36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@0 37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@0 38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@0 39 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@0 40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@0 41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@0 42 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@0 43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@0 44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@0 45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@0 46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@0 47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@0 48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@0 49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@0 50 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@0 51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@0 52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@0 53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@0 54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@0 55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@0 56 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@0 57 <a name="l00036"></a>00036
cannam@0 58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_ADAPTER_H_</span>
cannam@0 59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_ADAPTER_H_</span>
cannam@0 60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@0 61 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;<a class="code" href="vamp_8h.html">vamp/vamp.h</a>&gt;</span>
cannam@0 62 <a name="l00041"></a>00041
cannam@0 63 <a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="Plugin_8h.html">Plugin.h</a>"</span>
cannam@0 64 <a name="l00043"></a>00043
cannam@0 65 <a name="l00044"></a>00044 <span class="preprocessor">#include &lt;map&gt;</span>
cannam@0 66 <a name="l00045"></a>00045
cannam@0 67 <a name="l00046"></a>00046 <span class="keyword">namespace </span>Vamp {
cannam@0 68 <a name="l00047"></a>00047
cannam@0 69 <a name="l00063"></a><a class="code" href="classVamp_1_1PluginAdapterBase.html">00063</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>
cannam@0 70 <a name="l00064"></a>00064 {
cannam@0 71 <a name="l00065"></a>00065 <span class="keyword">public</span>:
cannam@0 72 <a name="l00066"></a>00066 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginAdapterBase.html#e39492abdca4b588a582962fdeab819d">~PluginAdapterBase</a>();
cannam@0 73 <a name="l00067"></a>00067
cannam@0 74 <a name="l00072"></a>00072 <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="classVamp_1_1PluginAdapterBase.html#7ff5c9374a8dc43f977c3707d1da45b5" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@0 75 <a name="l00073"></a>00073
cannam@0 76 <a name="l00074"></a>00074 <span class="keyword">protected</span>:
cannam@0 77 <a name="l00075"></a>00075 <a class="code" href="classVamp_1_1PluginAdapterBase.html#5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a>();
cannam@0 78 <a name="l00076"></a>00076
cannam@0 79 <a name="l00077"></a>00077 <span class="keyword">virtual</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 class="code" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a>(<span class="keywordtype">float</span> inputSampleRate) = 0;
cannam@0 80 <a name="l00078"></a>00078
cannam@0 81 <a name="l00079"></a><a class="code" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">00079</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a>;
cannam@0 82 <a name="l00080"></a>00080 <a class="code" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a> *<a class="code" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a>;
cannam@0 83 <a name="l00081"></a>00081 };
cannam@0 84 <a name="l00082"></a>00082
cannam@0 85 <a name="l00092"></a>00092 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> P&gt;
cannam@0 86 <a name="l00093"></a><a class="code" href="classVamp_1_1PluginAdapter.html">00093</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>
cannam@0 87 <a name="l00094"></a>00094 {
cannam@0 88 <a name="l00095"></a>00095 <span class="keyword">public</span>:
cannam@0 89 <a name="l00096"></a><a class="code" href="classVamp_1_1PluginAdapter.html#16312efd629b7063d7b6d67889a2c15a">00096</a> <a class="code" href="classVamp_1_1PluginAdapter.html#16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a>() : <a class="code" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>() { }
cannam@0 90 <a name="l00097"></a><a class="code" href="classVamp_1_1PluginAdapter.html#9612c9df7d4844959a36921d43d4bd50">00097</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginAdapter.html#9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a>() { }
cannam@0 91 <a name="l00098"></a>00098
cannam@0 92 <a name="l00099"></a>00099 <span class="keyword">protected</span>:
cannam@0 93 <a name="l00100"></a><a class="code" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">00100</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_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">createPlugin</a>(<span class="keywordtype">float</span> inputSampleRate) {
cannam@0 94 <a name="l00101"></a>00101 P *p = <span class="keyword">new</span> P(inputSampleRate);
cannam@0 95 <a name="l00102"></a>00102 <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="keyword">dynamic_cast&lt;</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> *<span class="keyword">&gt;</span>(p);
cannam@0 96 <a name="l00103"></a>00103 <span class="keywordflow">if</span> (!plugin) {
cannam@0 97 <a name="l00104"></a>00104 std::cerr &lt;&lt; <span class="stringliteral">"ERROR: PluginAdapter::createPlugin: "</span>
cannam@0 98 <a name="l00105"></a>00105 &lt;&lt; <span class="stringliteral">"Template type is not a plugin!"</span>
cannam@0 99 <a name="l00106"></a>00106 &lt;&lt; std::endl;
cannam@0 100 <a name="l00107"></a>00107 <span class="keyword">delete</span> p;
cannam@0 101 <a name="l00108"></a>00108 <span class="keywordflow">return</span> 0;
cannam@0 102 <a name="l00109"></a>00109 }
cannam@0 103 <a name="l00110"></a>00110 <span class="keywordflow">return</span> plugin;
cannam@0 104 <a name="l00111"></a>00111 }
cannam@0 105 <a name="l00112"></a>00112 };
cannam@0 106 <a name="l00113"></a>00113
cannam@0 107 <a name="l00114"></a>00114 }
cannam@0 108 <a name="l00115"></a>00115
cannam@0 109 <a name="l00116"></a>00116 <span class="preprocessor">#endif</span>
cannam@0 110 <a name="l00117"></a>00117 <span class="preprocessor"></span>
cannam@0 111 </pre></div></div>
cannam@0 112 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:06 2008 for VampPluginSDK by&nbsp;
cannam@0 113 <a href="http://www.doxygen.org/index.html">
cannam@0 114 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 115 </body>
cannam@0 116 </html>