Mercurial > hg > vamp-docs

comparison code-docs/PluginLoader_8h_source.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: PluginLoader.h Source File</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li>
49 <li class="current"><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="files.html"><span>File&#160;List</span></a></li>
56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
57 </ul>
58 </div>
59 </div>
60 <div id="side-nav" class="ui-resizable side-nav-resizable">
61 <div id="nav-tree">
62 <div id="nav-tree-contents">
63 </div>
64 </div>
65 <div id="splitbar" style="-moz-user-select:none;"
66 class="ui-resizable-handle">
67 </div>
68 </div>
69 <script type="text/javascript">
70 initNavTree('PluginLoader_8h.html','');
71 </script>
72 <div id="doc-content">
73 <div class="header">
74 <div class="headertitle">
75 <div class="title">PluginLoader.h</div> </div>
76 </div>
77 <div class="contents">
78 <a href="PluginLoader_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>
79 <a name="l00002"></a>00002
80 <a name="l00003"></a>00003 <span class="comment">/*</span>
81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
82 <a name="l00005"></a>00005 <span class="comment"></span>
83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
84 <a name="l00007"></a>00007 <span class="comment"></span>
85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
86 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
87 <a name="l00010"></a>00010 <span class="comment"> </span>
88 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
89 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
90 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
91 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
92 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
93 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
94 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
95 <a name="l00018"></a>00018 <span class="comment"></span>
96 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
97 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
98 <a name="l00021"></a>00021 <span class="comment"></span>
99 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
100 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
101 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
102 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
103 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
104 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
105 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
106 <a name="l00029"></a>00029 <span class="comment"></span>
107 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
108 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
109 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
110 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
111 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
112 <a name="l00035"></a>00035 <span class="comment">*/</span>
113 <a name="l00036"></a>00036
114 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_LOADER_H_</span>
115 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_LOADER_H_</span>
116 <a name="l00039"></a>00039 <span class="preprocessor"></span>
117 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;vector&gt;</span>
118 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;string&gt;</span>
119 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;map&gt;</span>
120 <a name="l00043"></a>00043
121 <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
122 <a name="l00045"></a>00045 <span class="preprocessor">#include &quot;<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>&quot;</span>
123 <a name="l00046"></a>00046
124 <a name="l00047"></a>00047 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginLoader.h)
125 <a name="l00048"></a>00048
126 <a name="l00049"></a>00049 namespace Vamp {
127 <a name="l00050"></a>00050
128 <a name="l00051"></a>00051 <span class="keyword">class </span>Plugin;
129 <a name="l00052"></a>00052
130 <a name="l00053"></a>00053 <span class="keyword">namespace </span>HostExt {
131 <a name="l00054"></a>00054
132 <a name="l00072"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">00072</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>
133 <a name="l00073"></a>00073 {
134 <a name="l00074"></a>00074 <span class="keyword">public</span>:
135 <a name="l00079"></a>00079 <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a> *getInstance();
136 <a name="l00080"></a>00080
137 <a name="l00101"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">00101</a> <span class="keyword">typedef</span> std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the scope of &quot;the curren...">PluginKey</a>;
138 <a name="l00102"></a>00102
139 <a name="l00107"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">00107</a> <span class="keyword">typedef</span> std::vector&lt;PluginKey&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a>;
140 <a name="l00108"></a>00108
141 <a name="l00119"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">00119</a> <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with ...">PluginCategoryHierarchy</a>;
142 <a name="l00120"></a>00120
143 <a name="l00125"></a>00125 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a> listPlugins();
144 <a name="l00126"></a>00126
145 <a name="l00169"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">00169</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in which circumstances Pl...">AdapterFlags</a> {
146 <a name="l00170"></a>00170
147 <a name="l00171"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09">00171</a> ADAPT_INPUT_DOMAIN = 0x01,
148 <a name="l00172"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139">00172</a> ADAPT_CHANNEL_COUNT = 0x02,
149 <a name="l00173"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1">00173</a> ADAPT_BUFFER_SIZE = 0x04,
150 <a name="l00174"></a>00174
151 <a name="l00175"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08">00175</a> ADAPT_ALL_SAFE = 0x03,
152 <a name="l00176"></a>00176
153 <a name="l00177"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0">00177</a> ADAPT_ALL = 0xff
154 <a name="l00178"></a>00178 };
155 <a name="l00179"></a>00179
156 <a name="l00197"></a>00197 <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> *loadPlugin(PluginKey key,
157 <a name="l00198"></a>00198 <span class="keywordtype">float</span> inputSampleRate,
158 <a name="l00199"></a>00199 <span class="keywordtype">int</span> adapterFlags = 0);
159 <a name="l00200"></a>00200
160 <a name="l00206"></a>00206 PluginKey composePluginKey(std::string libraryName,
161 <a name="l00207"></a>00207 std::string identifier);
162 <a name="l00208"></a>00208
163 <a name="l00218"></a>00218 PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
164 <a name="l00219"></a>00219
165 <a name="l00224"></a>00224 std::string getLibraryPathForPlugin(PluginKey plugin);
166 <a name="l00225"></a>00225
167 <a name="l00226"></a>00226 <span class="keyword">protected</span>:
168 <a name="l00227"></a>00227 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>();
169 <a name="l00228"></a>00228 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a>();
170 <a name="l00229"></a>00229
171 <a name="l00230"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">00230</a> <span class="keyword">class </span>Impl;
172 <a name="l00231"></a>00231 Impl *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">m_impl</a>;
173 <a name="l00232"></a>00232
174 <a name="l00233"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">00233</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">PluginLoader</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">m_instance</a>;
175 <a name="l00234"></a>00234 };
176 <a name="l00235"></a>00235
177 <a name="l00236"></a>00236 }
178 <a name="l00237"></a>00237
179 <a name="l00238"></a>00238 }
180 <a name="l00239"></a>00239
181 <a name="l00240"></a>00240 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginLoader.h)
182 <a name="l00241"></a>00241
183 <a name="l00242"></a>00242 <span class="preprocessor">#endif</span>
184 <a name="l00243"></a>00243 <span class="preprocessor"></span>
185 </pre></div></div>
186 </div>
187 <div id="nav-path" class="navpath">
188 <ul>
189 <li class="navelem"><a class="el" href="PluginLoader_8h.html">PluginLoader.h</a> </li>
190
191 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
192 <a href="http://www.doxygen.org/index.html">
193 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
194 </ul>
195 </div>
196
197
198 </body>
199 </html>