Mercurial > hg > vamp-website
view code-doc/PluginLoader_8h-source.html @ 76:e3e11437ecea website
Add forum code
author | Chris Cannam |
---|---|
date | Sun, 07 Jul 2013 11:25:48 +0200 |
parents | 0976232e353b |
children |
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: PluginLoader.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.8 --> <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="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a> </div> </div> <div class="contents"> <h1>PluginLoader.h</h1><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> <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-2009 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_LOADER_H_</span> <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_LOADER_H_</span> <a name="l00039"></a>00039 <span class="preprocessor"></span> <a name="l00040"></a>00040 <span class="preprocessor">#include <vector></span> <a name="l00041"></a>00041 <span class="preprocessor">#include <string></span> <a name="l00042"></a>00042 <span class="preprocessor">#include <map></span> <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span> <a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span> <a name="l00046"></a>00046 <a name="l00047"></a>00047 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginLoader.h) <a name="l00048"></a>00048 <a name="l00049"></a>00049 namespace Vamp { <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="keyword">class </span>Plugin; <a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="keyword">namespace </span>HostExt { <a name="l00054"></a>00054 <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...">PluginLoader</a> <a name="l00073"></a>00073 { <a name="l00074"></a>00074 <span class="keyword">public</span>: <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...">PluginLoader</a> *getInstance(); <a name="l00080"></a>00080 <a name="l00101"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">00101</a> <span class="keyword">typedef</span> std::string PluginKey; <a name="l00102"></a>00102 <a name="l00107"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">00107</a> <span class="keyword">typedef</span> std::vector<PluginKey> PluginKeyList; <a name="l00108"></a>00108 <a name="l00119"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">00119</a> <span class="keyword">typedef</span> std::vector<std::string> PluginCategoryHierarchy; <a name="l00120"></a>00120 <a name="l00125"></a>00125 PluginKeyList listPlugins(); <a name="l00126"></a>00126 <a name="l00169"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">00169</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in...">AdapterFlags</a> { <a name="l00170"></a>00170 <a name="l00171"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">00171</a> ADAPT_INPUT_DOMAIN = 0x01, <a name="l00172"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">00172</a> ADAPT_CHANNEL_COUNT = 0x02, <a name="l00173"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">00173</a> ADAPT_BUFFER_SIZE = 0x04, <a name="l00174"></a>00174 <a name="l00175"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">00175</a> ADAPT_ALL_SAFE = 0x03, <a name="l00176"></a>00176 <a name="l00177"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">00177</a> ADAPT_ALL = 0xff <a name="l00178"></a>00178 }; <a name="l00179"></a>00179 <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...">Plugin</a> *loadPlugin(PluginKey key, <a name="l00198"></a>00198 <span class="keywordtype">float</span> inputSampleRate, <a name="l00199"></a>00199 <span class="keywordtype">int</span> adapterFlags = 0); <a name="l00200"></a>00200 <a name="l00206"></a>00206 PluginKey composePluginKey(std::string libraryName, <a name="l00207"></a>00207 std::string identifier); <a name="l00208"></a>00208 <a name="l00218"></a>00218 PluginCategoryHierarchy getPluginCategory(PluginKey plugin); <a name="l00219"></a>00219 <a name="l00224"></a>00224 std::string getLibraryPathForPlugin(PluginKey plugin); <a name="l00225"></a>00225 <a name="l00226"></a>00226 <span class="keyword">protected</span>: <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...">PluginLoader</a>(); <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...">PluginLoader</a>(); <a name="l00229"></a>00229 <a name="l00230"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">00230</a> <span class="keyword">class </span>Impl; <a name="l00231"></a>00231 Impl *m_impl; <a name="l00232"></a>00232 <a name="l00233"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#f89caf5f838a586b117c417260b7a116">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...">PluginLoader</a> *m_instance; <a name="l00234"></a>00234 }; <a name="l00235"></a>00235 <a name="l00236"></a>00236 } <a name="l00237"></a>00237 <a name="l00238"></a>00238 } <a name="l00239"></a>00239 <a name="l00240"></a>00240 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginLoader.h) <a name="l00241"></a>00241 <a name="l00242"></a>00242 <span class="preprocessor">#endif</span> <a name="l00243"></a>00243 <span class="preprocessor"></span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> </body> </html>