Mercurial > hg > vamp-website

comparison code-doc/PluginHostAdapter_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
comparison
equal deleted inserted replaced
-1:000000000000 0:351c4ebce5f9
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">
3 <title>VampPluginSDK: PluginHostAdapter.h Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</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>
14 <li class="current"><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
19 </div>
20 </div>
21 </div>
22 <h1>PluginHostAdapter.h</h1><a href="PluginHostAdapter_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
24 <a name="l00003"></a>00003 <span class="comment">/*</span>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</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>
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>
30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
31 <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>
33 <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>
35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
39 <a name="l00018"></a>00018 <span class="comment"></span>
40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
42 <a name="l00021"></a>00021 <span class="comment"></span>
43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
50 <a name="l00029"></a>00029 <span class="comment"></span>
51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
56 <a name="l00035"></a>00035 <span class="comment">*/</span>
57 <a name="l00036"></a>00036
58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_HOST_ADAPTER_H_</span>
59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_HOST_ADAPTER_H_</span>
60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
61 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;<a class="code" href="vamp_8h.html">vamp/vamp.h</a>&gt;</span>
62 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;<a class="code" href="Plugin_8h.html">vamp-sdk/Plugin.h</a>&gt;</span>
63 <a name="l00042"></a>00042
64 <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;vector&gt;</span>
65 <a name="l00044"></a>00044
66 <a name="l00045"></a>00045 <span class="keyword">namespace </span>Vamp {
67 <a name="l00046"></a>00046
68 <a name="l00064"></a><a class="code" href="classVamp_1_1PluginHostAdapter.html">00064</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> : <span class="keyword">public</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>
69 <a name="l00065"></a>00065 {
70 <a name="l00066"></a>00066 <span class="keyword">public</span>:
71 <a name="l00067"></a>00067 <a class="code" href="classVamp_1_1PluginHostAdapter.html#6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a>(<span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *descriptor,
72 <a name="l00068"></a>00068 <span class="keywordtype">float</span> inputSampleRate);
73 <a name="l00069"></a>00069 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#b0f354cb332852ab1892488f6b8e8c0e">~PluginHostAdapter</a>();
74 <a name="l00070"></a>00070
75 <a name="l00071"></a>00071 <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1PluginHostAdapter.html#08d7ed3a11bf4a3c30fa0f9b41a0fed6">getPluginPath</a>();
76 <a name="l00072"></a>00072
77 <a name="l00073"></a>00073 <span class="keywordtype">bool</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" 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);
78 <a name="l00074"></a>00074 <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#5d54c5bbd76bc27b7a243827148afeaa" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
79 <a name="l00075"></a>00075
80 <a name="l00076"></a>00076 <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#9c5239a4da67f1a426cd059e1a2856eb" title="Get the plugin&amp;#39;s required input domain.">getInputDomain</a>() <span class="keyword">const</span>;
81 <a name="l00077"></a>00077
82 <a name="l00078"></a>00078 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>() <span class="keyword">const</span>;
83 <a name="l00079"></a>00079 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#b27423a656f878d97d2ad2eba4e76c7a" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>;
84 <a name="l00080"></a>00080 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#45f1d0377e233eeddd1b7cefb48be62a" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>;
85 <a name="l00081"></a>00081 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#5eaafcef030e81b90a3e77cf16cf8ae1" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span>;
86 <a name="l00082"></a>00082 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#f572be0b175f5661559006a380a0f3db" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>;
87 <a name="l00083"></a>00083 <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#6fbd94781867ca46a20368c2a3593c77" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>;
88 <a name="l00084"></a>00084 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#c73c9d6baad04369beee695e99584815" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>;
89 <a name="l00085"></a>00085
90 <a name="l00086"></a>00086 <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#bfa93b20d9b5651a32042a9bb7c8df13" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>() <span class="keyword">const</span>;
91 <a name="l00087"></a>00087 <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb" title="Get the value of a named parameter.">getParameter</a>(std::string) <span class="keyword">const</span>;
92 <a name="l00088"></a>00088 <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>);
93 <a name="l00089"></a>00089
94 <a name="l00090"></a>00090 <a class="code" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#7ac5681dcfe08b7b8a796bffc0aff3e3" title="Get the program settings available in this plugin.">getPrograms</a>() <span class="keyword">const</span>;
95 <a name="l00091"></a>00091 std::string <a class="code" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867" title="Get the current program.">getCurrentProgram</a>() <span class="keyword">const</span>;
96 <a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683" title="Select a program.">selectProgram</a>(std::string);
97 <a name="l00093"></a>00093
98 <a name="l00094"></a>00094 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>() <span class="keyword">const</span>;
99 <a name="l00095"></a>00095 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>() <span class="keyword">const</span>;
100 <a name="l00096"></a>00096
101 <a name="l00097"></a>00097 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() <span class="keyword">const</span>;
102 <a name="l00098"></a>00098 <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>() <span class="keyword">const</span>;
103 <a name="l00099"></a>00099
104 <a name="l00100"></a>00100 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#e02670cca9d25cdc4100cbe7a12e3e68" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
105 <a name="l00101"></a>00101
106 <a name="l00102"></a>00102 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" 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);
107 <a name="l00103"></a>00103
108 <a name="l00104"></a>00104 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#d3f5f16a89a821da2ec1186fd2062e83" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
109 <a name="l00105"></a>00105
110 <a name="l00106"></a>00106 <span class="keyword">protected</span>:
111 <a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginHostAdapter.html#ee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a>(<a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *, <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;);
112 <a name="l00108"></a>00108
113 <a name="l00109"></a><a class="code" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">00109</a> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a>;
114 <a name="l00110"></a><a class="code" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">00110</a> <a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> <a class="code" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">m_handle</a>;
115 <a name="l00111"></a>00111 };
116 <a name="l00112"></a>00112
117 <a name="l00113"></a>00113 }
118 <a name="l00114"></a>00114
119 <a name="l00115"></a>00115 <span class="preprocessor">#endif</span>
120 <a name="l00116"></a>00116 <span class="preprocessor"></span>
121 <a name="l00117"></a>00117
122 </pre></div></div>
123 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:06 2008 for VampPluginSDK by&nbsp;
124 <a href="http://www.doxygen.org/index.html">
125 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
126 </body>
127 </html>