Mercurial > hg > vamp-website

annotate code-doc/PluginLoader_8h_source.html @ 128:817c3988afc7 website tip

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