Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginLoader.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title> 3 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
29 <h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><code>#include &lt;<a class="el" href="PluginLoader_8h-source.html">vamp-sdk/hostext/PluginLoader.h</a>&gt;</code> 29 <h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><code>#include &lt;<a class="el" href="PluginLoader_8h-source.html">vamp-hostsdk/PluginLoader.h</a>&gt;</code>
30 <p> 30 <p>
31 31
32 <p> 32 <p>
33 <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 33 <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
34 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> SDK documentation. 34 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation.
35 <p> 35 <p>
36 This class is intended to greatly simplify the task of becoming a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin host for any C++ application.<p> 36 This class is intended to greatly simplify the task of becoming a <a class="el" href="namespaceVamp.html">Vamp</a> plugin host for any C++ application.<p>
37 Hosts are not required by the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> specification to use the same plugin search path and naming conventions as implemented by this class, and are certainly not required to use this actual class. But we do strongly recommend it.<p> 37 Hosts are not required by the <a class="el" href="namespaceVamp.html">Vamp</a> specification to use the same plugin search path and naming conventions as implemented by this class, and are certainly not required to use this actual class. But we do strongly recommend it.<p>
38 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin SDK. </dd></dl> 38 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
39 39
40 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00069">69</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 40 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00072">72</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
41 <table border="0" cellpadding="0" cellspacing="0"> 41 <table border="0" cellpadding="0" cellspacing="0">
42 <tr><td></td></tr> 42 <tr><td></td></tr>
43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> 43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">AdapterFlags</a> { <br> 44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">AdapterFlags</a> { <br>
45 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01, 45 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01,
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a></td></tr> 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a></td></tr>
56 56
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". <a href="#473645bbb3ac5c1a0da2f0f482947c4d"></a><br></td></tr> 57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". <a href="#473645bbb3ac5c1a0da2f0f482947c4d"></a><br></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a></td></tr> 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a></td></tr>
59 59
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>. <a href="#0d48b76e4f995110f53e0feeb23f733a"></a><br></td></tr> 60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff51b52bb68aa2934ccf26ad1d284f28" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>. <a href="#0d48b76e4f995110f53e0feeb23f733a"></a><br></td></tr>
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a></td></tr> 61 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a></td></tr>
62 62
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. <a href="#d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><br></td></tr> 63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. <a href="#d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><br></td></tr>
64 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 64 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b">listPlugins</a> ()</td></tr> 65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff51b52bb68aa2934ccf26ad1d284f28">listPlugins</a> ()</td></tr>
66 66
67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Search for all available <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins, and return a list of them in the order in which they were found. <a href="#ec450c2928b1ae5318d45972722dd16b"></a><br></td></tr> 67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Search for all available <a class="el" href="namespaceVamp.html">Vamp</a> plugins, and return a list of them in the order in which they were found. <a href="#ff51b52bb68aa2934ccf26ad1d284f28"></a><br></td></tr>
68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2">loadPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> key, float inputSampleRate, int adapterFlags=0)</td></tr> 68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f">loadPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> key, float inputSampleRate, int adapterFlags=0)</td></tr>
69 69
70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. <a href="#2154970381343edef629482bdafea7e2"></a><br></td></tr> 70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <a href="#964689eb9688cd7e58e8c82ebb0d305f"></a><br></td></tr>
71 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207">composePluginKey</a> (std::string libraryName, std::string identifier)</td></tr> 71 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207">composePluginKey</a> (std::string libraryName, std::string identifier)</td></tr>
72 72
73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Given a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. <a href="#cc6865d27825c100d7b6f9ed6ecf5207"></a><br></td></tr> 73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Given a <a class="el" href="namespaceVamp.html">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. <a href="#cc6865d27825c100d7b6f9ed6ecf5207"></a><br></td></tr>
74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d5c594142ff058bd70e66247d45cd86e">getPluginCategory</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr> 74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#52746ea66339ad981b868a031a3b382d">getPluginCategory</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
75 75
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the category hierarchy for a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. <a href="#d5c594142ff058bd70e66247d45cd86e"></a><br></td></tr> 76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <a href="#52746ea66339ad981b868a031a3b382d"></a><br></td></tr>
77 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#592d6b4c6edaa369407e833f56e4a4de">getLibraryPathForPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr> 77 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#4bbcb7873e617bbc9f79eade1f90f7ad">getLibraryPathForPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
78 78
79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file path of the dynamic library from which the given plugin will be loaded (if available). <a href="#592d6b4c6edaa369407e833f56e4a4de"></a><br></td></tr> 79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file path of the dynamic library from which the given plugin will be loaded (if available). <a href="#4bbcb7873e617bbc9f79eade1f90f7ad"></a><br></td></tr>
80 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 80 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#dbb5c8855697a24be890e4f107e26b0e">getInstance</a> ()</td></tr> 81 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#1d77fa1d58ee4fee2985b5af02380326">getInstance</a> ()</td></tr>
82 82
83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>. <a href="#dbb5c8855697a24be890e4f107e26b0e"></a><br></td></tr> 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>. <a href="#1d77fa1d58ee4fee2985b5af02380326"></a><br></td></tr>
84 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 84 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a> ()</td></tr> 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a> ()</td></tr>
86 86
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#9e092d864efdc0f16c032bfb25e76dea">~PluginLoader</a> ()</td></tr> 87 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d74ab52bc6aa2514b3a6b3f679fc492c">~PluginLoader</a> ()</td></tr>
88 88
89 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 89 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr> 90 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr>
91 91
92 <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr> 92 <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">m_instance</a> = 0</td></tr> 93 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#f89caf5f838a586b117c417260b7a116">m_instance</a></td></tr>
94
95 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a></td></tr>
97 94
98 </table> 95 </table>
99 <hr><h2>Member Typedef Documentation</h2> 96 <hr><h2>Member Typedef Documentation</h2>
100 <a class="anchor" name="473645bbb3ac5c1a0da2f0f482947c4d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKey" ref="473645bbb3ac5c1a0da2f0f482947c4d" args="" --> 97 <a class="anchor" name="473645bbb3ac5c1a0da2f0f482947c4d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKey" ref="473645bbb3ac5c1a0da2f0f482947c4d" args="" -->
101 <div class="memitem"> 98 <div class="memitem">
109 <div class="memdoc"> 106 <div class="memdoc">
110 107
111 <p> 108 <p>
112 PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". 109 PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system".
113 <p> 110 <p>
114 It consists of the lower-cased base name of the plugin library, a colon separator, and the identifier string for the plugin. It is only meaningful in the context of a given plugin path (the one returned by <a class="el" href="classVamp_1_1PluginHostAdapter.html#08d7ed3a11bf4a3c30fa0f9b41a0fed6">PluginHostAdapter::getPluginPath()</a>).<p> 111 It consists of the lower-cased base name of the plugin library, a colon separator, and the identifier string for the plugin. It is only meaningful in the context of a given plugin path (the one returned by <a class="el" href="classVamp_1_1PluginHostAdapter.html#09cbfb7903d28f10d6d556c6cb81c5f6">PluginHostAdapter::getPluginPath()</a>).<p>
115 Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding...">composePluginKey()</a> to construct a plugin key from a known plugin library name and identifier.<p> 112 Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding...">composePluginKey()</a> to construct a plugin key from a known plugin library name and identifier.<p>
116 Note: the fact that the library component of the key is lower-cased implies that library names are matched case-insensitively by the <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> class, regardless of the case sensitivity of the underlying filesystem. (<a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> identifiers _are_ case sensitive, however.) Also, it is not possible to portably extract a working library name from a plugin key, as the result may fail on case-sensitive filesystems. Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#592d6b4c6edaa369407e833f56e4a4de" title="Return the file path of the dynamic library from which the given plugin will be loaded...">getLibraryPathForPlugin()</a> instead. 113 Note: the fact that the library component of the key is lower-cased implies that library names are matched case-insensitively by the <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> class, regardless of the case sensitivity of the underlying filesystem. (<a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> identifiers _are_ case sensitive, however.) Also, it is not possible to portably extract a working library name from a plugin key, as the result may fail on case-sensitive filesystems. Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#4bbcb7873e617bbc9f79eade1f90f7ad" title="Return the file path of the dynamic library from which the given plugin will be loaded...">getLibraryPathForPlugin()</a> instead.
117 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00098">98</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 114 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00101">101</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
118 115
119 </div> 116 </div>
120 </div><p> 117 </div><p>
121 <a class="anchor" name="0d48b76e4f995110f53e0feeb23f733a"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKeyList" ref="0d48b76e4f995110f53e0feeb23f733a" args="" --> 118 <a class="anchor" name="0d48b76e4f995110f53e0feeb23f733a"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKeyList" ref="0d48b76e4f995110f53e0feeb23f733a" args="" -->
122 <div class="memitem"> 119 <div class="memitem">
128 </table> 125 </table>
129 </div> 126 </div>
130 <div class="memdoc"> 127 <div class="memdoc">
131 128
132 <p> 129 <p>
133 PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>. 130 PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff51b52bb68aa2934ccf26ad1d284f28" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>.
134 <p> 131 <p>
135 132
136 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00104">104</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 133 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00107">107</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
137 134
138 </div> 135 </div>
139 </div><p> 136 </div><p>
140 <a class="anchor" name="d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginCategoryHierarchy" ref="d6a39aa0c79d8d9209eb0b8dfe9d1364" args="" --> 137 <a class="anchor" name="d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginCategoryHierarchy" ref="d6a39aa0c79d8d9209eb0b8dfe9d1364" args="" -->
141 <div class="memitem"> 138 <div class="memitem">
150 147
151 <p> 148 <p>
152 PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. 149 PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin.
153 <p> 150 <p>
154 This sequence describes the location of a plugin within a category forest, containing the human-readable names of the plugin's category tree root, followed by each of the nodes down to the leaf containing the plugin.<p> 151 This sequence describes the location of a plugin within a category forest, containing the human-readable names of the plugin's category tree root, followed by each of the nodes down to the leaf containing the plugin.<p>
155 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d5c594142ff058bd70e66247d45cd86e" title="Return the category hierarchy for a Vamp plugin, given its identifying key.">getPluginCategory()</a> </dd></dl> 152 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#52746ea66339ad981b868a031a3b382d" title="Return the category hierarchy for a Vamp plugin, given its identifying key.">getPluginCategory()</a> </dd></dl>
156 153
157 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00116">116</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 154 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00119">119</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
158 155
159 </div> 156 </div>
160 </div><p> 157 </div><p>
161 <hr><h2>Member Enumeration Documentation</h2> 158 <hr><h2>Member Enumeration Documentation</h2>
162 <a class="anchor" name="ff3ee11692ce25e0dfb904324cbe3494"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::AdapterFlags" ref="ff3ee11692ce25e0dfb904324cbe3494" args="" --> 159 <a class="anchor" name="ff3ee11692ce25e0dfb904324cbe3494"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::AdapterFlags" ref="ff3ee11692ce25e0dfb904324cbe3494" args="" -->
192 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0"></a><!-- doxytag: member="ADAPT_ALL" ref="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0" args="" -->ADAPT_ALL</em>&nbsp;</td><td> 189 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0"></a><!-- doxytag: member="ADAPT_ALL" ref="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0" args="" -->ADAPT_ALL</em>&nbsp;</td><td>
193 </td></tr> 190 </td></tr>
194 </table> 191 </table>
195 </dl> 192 </dl>
196 193
197 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00166">166</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 194 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00169">169</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
198 195
199 </div> 196 </div>
200 </div><p> 197 </div><p>
201 <hr><h2>Constructor &amp; Destructor Documentation</h2> 198 <hr><h2>Constructor &amp; Destructor Documentation</h2>
202 <a class="anchor" name="5ab9e0281244bef7976c6c0ce1a55c24"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginLoader" ref="5ab9e0281244bef7976c6c0ce1a55c24" args="()" --> 199 <a class="anchor" name="5ab9e0281244bef7976c6c0ce1a55c24"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginLoader" ref="5ab9e0281244bef7976c6c0ce1a55c24" args="()" -->
206 <tr> 203 <tr>
207 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td> 204 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td>
208 <td>(</td> 205 <td>(</td>
209 <td class="paramname"> </td> 206 <td class="paramname"> </td>
210 <td>&nbsp;)&nbsp;</td> 207 <td>&nbsp;)&nbsp;</td>
211 <td width="100%"><code> [protected]</code></td> 208 <td><code> [protected]</code></td>
212 </tr> 209 </tr>
213 </table> 210 </table>
214 </div> 211 </div>
215 <div class="memdoc"> 212 <div class="memdoc">
216 213
217 <p> 214 <p>
218 215
219 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00141">141</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 216 </div>
220 217 </div><p>
221 <p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p> 218 <a class="anchor" name="d74ab52bc6aa2514b3a6b3f679fc492c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="d74ab52bc6aa2514b3a6b3f679fc492c" args="()" -->
222 219 <div class="memitem">
223 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p> 220 <div class="memproto">
224 221 <table class="memname">
225 </div> 222 <tr>
226 </div><p> 223 <td class="memname">virtual Vamp::HostExt::PluginLoader::~PluginLoader </td>
227 <a class="anchor" name="9e092d864efdc0f16c032bfb25e76dea"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="9e092d864efdc0f16c032bfb25e76dea" args="()" -->
228 <div class="memitem">
229 <div class="memproto">
230 <table class="memname">
231 <tr>
232 <td class="memname">Vamp::HostExt::PluginLoader::~PluginLoader </td>
233 <td>(</td> 224 <td>(</td>
234 <td class="paramname"> </td> 225 <td class="paramname"> </td>
235 <td>&nbsp;)&nbsp;</td> 226 <td>&nbsp;)&nbsp;</td>
236 <td width="100%"><code> [protected, virtual]</code></td> 227 <td><code> [protected, virtual]</code></td>
237 </tr> 228 </tr>
238 </table> 229 </table>
239 </div> 230 </div>
240 <div class="memdoc"> 231 <div class="memdoc">
241 232
242 <p> 233 <p>
243
244 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
245
246 <p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
247 234
248 </div> 235 </div>
249 </div><p> 236 </div><p>
250 <hr><h2>Member Function Documentation</h2> 237 <hr><h2>Member Function Documentation</h2>
251 <a class="anchor" name="dbb5c8855697a24be890e4f107e26b0e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="dbb5c8855697a24be890e4f107e26b0e" args="()" --> 238 <a class="anchor" name="1d77fa1d58ee4fee2985b5af02380326"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="1d77fa1d58ee4fee2985b5af02380326" args="()" -->
252 <div class="memitem"> 239 <div class="memitem">
253 <div class="memproto"> 240 <div class="memproto">
254 <table class="memname"> 241 <table class="memname">
255 <tr> 242 <tr>
256 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * Vamp::HostExt::PluginLoader::getInstance </td> 243 <td class="memname">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::getInstance </td>
257 <td>(</td> 244 <td>(</td>
258 <td class="paramname"> </td> 245 <td class="paramname"> </td>
259 <td>&nbsp;)&nbsp;</td> 246 <td>&nbsp;)&nbsp;</td>
260 <td width="100%"><code> [static]</code></td> 247 <td><code> [static]</code></td>
261 </tr> 248 </tr>
262 </table> 249 </table>
263 </div> 250 </div>
264 <div class="memdoc"> 251 <div class="memdoc">
265 252
266 <p> 253 <p>
267 Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>. 254 Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>.
268 <p> 255 <p>
269 Use this to obtain your loader object. 256 Use this to obtain your loader object.
270 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 257 </div>
271 258 </div><p>
272 <p>References <a class="el" href="PluginLoader_8h-source.html#l00230">m_instance</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00141">PluginLoader()</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00206">Vamp::HostExt::PluginLoader::Impl::setInstanceToClean()</a>.</p> 259 <a class="anchor" name="ff51b52bb68aa2934ccf26ad1d284f28"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ff51b52bb68aa2934ccf26ad1d284f28" args="()" -->
273 260 <div class="memitem">
274 </div> 261 <div class="memproto">
275 </div><p> 262 <table class="memname">
276 <a class="anchor" name="ec450c2928b1ae5318d45972722dd16b"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ec450c2928b1ae5318d45972722dd16b" args="()" --> 263 <tr>
277 <div class="memitem"> 264 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPlugins </td>
278 <div class="memproto">
279 <table class="memname">
280 <tr>
281 <td class="memname">vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginLoader::PluginKey</a> &gt; Vamp::HostExt::PluginLoader::listPlugins </td>
282 <td>(</td> 265 <td>(</td>
283 <td class="paramname"> </td> 266 <td class="paramname"> </td>
284 <td>&nbsp;)&nbsp;</td> 267 <td>&nbsp;)&nbsp;</td>
285 <td width="100%"></td> 268 <td></td>
286 </tr> 269 </tr>
287 </table> 270 </table>
288 </div> 271 </div>
289 <div class="memdoc"> 272 <div class="memdoc">
290 273
291 <p> 274 <p>
292 Search for all available <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins, and return a list of them in the order in which they were found. 275 Search for all available <a class="el" href="namespaceVamp.html">Vamp</a> plugins, and return a list of them in the order in which they were found.
293 <p> 276 <p>
294 277
295 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00165">165</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 278 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p>
296 279
297 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00212">Vamp::HostExt::PluginLoader::Impl::listPlugins()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p> 280 </div>
298 281 </div><p>
299 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>.</p> 282 <a class="anchor" name="964689eb9688cd7e58e8c82ebb0d305f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="964689eb9688cd7e58e8c82ebb0d305f" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" -->
300 283 <div class="memitem">
301 </div> 284 <div class="memproto">
302 </div><p> 285 <table class="memname">
303 <a class="anchor" name="2154970381343edef629482bdafea7e2"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="2154970381343edef629482bdafea7e2" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" --> 286 <tr>
304 <div class="memitem"> 287 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginLoader::loadPlugin </td>
305 <div class="memproto">
306 <table class="memname">
307 <tr>
308 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * Vamp::HostExt::PluginLoader::loadPlugin </td>
309 <td>(</td> 288 <td>(</td>
310 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td> 289 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
311 <td class="paramname"> <em>key</em>, </td> 290 <td class="paramname"> <em>key</em>, </td>
312 </tr> 291 </tr>
313 <tr> 292 <tr>
323 <td class="paramname"> <em>adapterFlags</em> = <code>0</code></td><td>&nbsp;</td> 302 <td class="paramname"> <em>adapterFlags</em> = <code>0</code></td><td>&nbsp;</td>
324 </tr> 303 </tr>
325 <tr> 304 <tr>
326 <td></td> 305 <td></td>
327 <td>)</td> 306 <td>)</td>
328 <td></td><td></td><td width="100%"></td> 307 <td></td><td></td><td></td>
329 </tr> 308 </tr>
330 </table> 309 </table>
331 </div> 310 </div>
332 <div class="memdoc"> 311 <div class="memdoc">
333 312
334 <p> 313 <p>
335 Load a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. 314 Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key.
336 <p> 315 <p>
337 If the plugin could not be loaded, returns 0.<p> 316 If the plugin could not be loaded, returns 0.<p>
338 The returned plugin should be deleted (using the standard C++ delete keyword) after use.<p> 317 The returned plugin should be deleted (using the standard C++ delete keyword) after use.<p>
339 <dl compact><dt><b>Parameters:</b></dt><dd> 318 <dl compact><dt><b>Parameters:</b></dt><dd>
340 <table border="0" cellspacing="2" cellpadding="0"> 319 <table border="0" cellspacing="2" cellpadding="0">
341 <tr><td valign="top"></td><td valign="top"><em>adapterFlags</em>&nbsp;</td><td>a bitwise OR of the values in the AdapterFlags enumeration, indicating under which circumstances an adapter should be used to wrap the original plugin. If adapterFlags is 0, no optional adapters will be used. Otherwise, the returned plugin may be of an adapter class type which will behave identically to the original plugin, apart from any particular features implemented by the adapter itself.</td></tr> 320 <tr><td valign="top"></td><td valign="top"><em>adapterFlags</em>&nbsp;</td><td>a bitwise OR of the values in the AdapterFlags enumeration, indicating under which circumstances an adapter should be used to wrap the original plugin. If adapterFlags is 0, no optional adapters will be used. Otherwise, the returned plugin may be of an adapter class type which will behave identically to the original plugin, apart from any particular features implemented by the adapter itself.</td></tr>
342 </table> 321 </table>
343 </dl> 322 </dl>
344 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" 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 class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> </dd></dl> 323 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" 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 class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> </dd></dl>
345 324
346 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00171">171</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 325 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
347
348 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00355">Vamp::HostExt::PluginLoader::Impl::loadPlugin()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
349
350 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
351 326
352 </div> 327 </div>
353 </div><p> 328 </div><p>
354 <a class="anchor" name="cc6865d27825c100d7b6f9ed6ecf5207"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::composePluginKey" ref="cc6865d27825c100d7b6f9ed6ecf5207" args="(std::string libraryName, std::string identifier)" --> 329 <a class="anchor" name="cc6865d27825c100d7b6f9ed6ecf5207"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::composePluginKey" ref="cc6865d27825c100d7b6f9ed6ecf5207" args="(std::string libraryName, std::string identifier)" -->
355 <div class="memitem"> 330 <div class="memitem">
368 <td class="paramname"> <em>identifier</em></td><td>&nbsp;</td> 343 <td class="paramname"> <em>identifier</em></td><td>&nbsp;</td>
369 </tr> 344 </tr>
370 <tr> 345 <tr>
371 <td></td> 346 <td></td>
372 <td>)</td> 347 <td>)</td>
373 <td></td><td></td><td width="100%"></td> 348 <td></td><td></td><td></td>
374 </tr> 349 </tr>
375 </table> 350 </table>
376 </div> 351 </div>
377 <div class="memdoc"> 352 <div class="memdoc">
378 353
379 <p> 354 <p>
380 Given a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. 355 Given a <a class="el" href="namespaceVamp.html">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>.
381 <p> 356 <p>
382 357
383 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p> 358 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
384 359
385 </div> 360 </div>
386 </div><p> 361 </div><p>
387 <a class="anchor" name="d5c594142ff058bd70e66247d45cd86e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="d5c594142ff058bd70e66247d45cd86e" args="(PluginKey plugin)" --> 362 <a class="anchor" name="52746ea66339ad981b868a031a3b382d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="52746ea66339ad981b868a031a3b382d" args="(PluginKey plugin)" -->
388 <div class="memitem"> 363 <div class="memitem">
389 <div class="memproto"> 364 <div class="memproto">
390 <table class="memname"> 365 <table class="memname">
391 <tr> 366 <tr>
392 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginLoader::PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td> 367 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td>
393 <td>(</td> 368 <td>(</td>
394 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td> 369 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
395 <td class="paramname"> <em>plugin</em> </td> 370 <td class="paramname"> <em>plugin</em> </td>
396 <td>&nbsp;)&nbsp;</td> 371 <td>&nbsp;)&nbsp;</td>
397 <td width="100%"></td> 372 <td></td>
398 </tr> 373 </tr>
399 </table> 374 </table>
400 </div> 375 </div>
401 <div class="memdoc"> 376 <div class="memdoc">
402 377
403 <p> 378 <p>
404 Return the category hierarchy for a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. 379 Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key.
405 <p> 380 <p>
406 If the plugin has no category information, return an empty hierarchy.<p> 381 If the plugin has no category information, return an empty hierarchy.<p>
407 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as...">PluginCategoryHierarchy</a> </dd></dl> 382 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as...">PluginCategoryHierarchy</a> </dd></dl>
408 383
409 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00185">185</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 384 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p>
410 385
411 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00332">Vamp::HostExt::PluginLoader::Impl::getPluginCategory()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p> 386 </div>
412 387 </div><p>
413 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>.</p> 388 <a class="anchor" name="4bbcb7873e617bbc9f79eade1f90f7ad"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="4bbcb7873e617bbc9f79eade1f90f7ad" args="(PluginKey plugin)" -->
414 389 <div class="memitem">
415 </div> 390 <div class="memproto">
416 </div><p> 391 <table class="memname">
417 <a class="anchor" name="592d6b4c6edaa369407e833f56e4a4de"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="592d6b4c6edaa369407e833f56e4a4de" args="(PluginKey plugin)" --> 392 <tr>
418 <div class="memitem"> 393 <td class="memname">std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td>
419 <div class="memproto">
420 <table class="memname">
421 <tr>
422 <td class="memname">string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td>
423 <td>(</td> 394 <td>(</td>
424 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td> 395 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
425 <td class="paramname"> <em>plugin</em> </td> 396 <td class="paramname"> <em>plugin</em> </td>
426 <td>&nbsp;)&nbsp;</td> 397 <td>&nbsp;)&nbsp;</td>
427 <td width="100%"></td> 398 <td></td>
428 </tr> 399 </tr>
429 </table> 400 </table>
430 </div> 401 </div>
431 <div class="memdoc"> 402 <div class="memdoc">
432 403
433 <p> 404 <p>
434 Return the file path of the dynamic library from which the given plugin will be loaded (if available). 405 Return the file path of the dynamic library from which the given plugin will be loaded (if available).
435 <p> 406 <p>
436 407
437 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00191">191</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p> 408 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
438
439 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00342">Vamp::HostExt::PluginLoader::Impl::getLibraryPathForPlugin()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
440
441 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>.</p>
442 409
443 </div> 410 </div>
444 </div><p> 411 </div><p>
445 <hr><h2>Member Data Documentation</h2> 412 <hr><h2>Member Data Documentation</h2>
446 <a class="anchor" name="c12254d823f6d63cb8ce82a07bdcb072"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_impl" ref="c12254d823f6d63cb8ce82a07bdcb072" args="" --> 413 <a class="anchor" name="c12254d823f6d63cb8ce82a07bdcb072"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_impl" ref="c12254d823f6d63cb8ce82a07bdcb072" args="" -->
447 <div class="memitem"> 414 <div class="memitem">
448 <div class="memproto"> 415 <div class="memproto">
449 <table class="memname"> 416 <table class="memname">
450 <tr> 417 <tr>
451 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a><code> [protected]</code> </td> 418 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a><code> [protected]</code> </td>
452 </tr>
453 </table>
454 </div>
455 <div class="memdoc">
456
457 <p>
458
459 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00227">227</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
460
461 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00191">getLibraryPathForPlugin()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00185">getPluginCategory()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00165">listPlugins()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00171">loadPlugin()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00141">PluginLoader()</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00146">~PluginLoader()</a>.</p>
462
463 </div>
464 </div><p>
465 <a class="anchor" name="aa4eae58ddbadf6537a95dbb6e957187"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="aa4eae58ddbadf6537a95dbb6e957187" args="" -->
466 <div class="memitem">
467 <div class="memproto">
468 <table class="memname">
469 <tr>
470 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">Vamp::HostExt::PluginLoader::m_instance</a> = 0<code> [static, protected]</code> </td>
471 </tr> 419 </tr>
472 </table> 420 </table>
473 </div> 421 </div>
474 <div class="memdoc"> 422 <div class="memdoc">
475 423
476 <p> 424 <p>
477 425
478 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00230">230</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 426 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00230">230</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
479 427
480 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p> 428 </div>
481 429 </div><p>
482 </div> 430 <a class="anchor" name="f89caf5f838a586b117c417260b7a116"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="f89caf5f838a586b117c417260b7a116" args="" -->
483 </div><p> 431 <div class="memitem">
484 <hr>The documentation for this class was generated from the following files:<ul> 432 <div class="memproto">
485 <li><a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a><li><a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a></ul> 433 <table class="memname">
486 </div> 434 <tr>
487 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp; 435 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#f89caf5f838a586b117c417260b7a116">Vamp::HostExt::PluginLoader::m_instance</a><code> [static, protected]</code> </td>
436 </tr>
437 </table>
438 </div>
439 <div class="memdoc">
440
441 <p>
442
443 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00233">233</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
444
445 </div>
446 </div><p>
447 <hr>The documentation for this class was generated from the following file:<ul>
448 <li><a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a></ul>
449 </div>
450 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp;
488 <a href="http://www.doxygen.org/index.html"> 451 <a href="http://www.doxygen.org/index.html">
489 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 452 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
490 </body> 453 </body>
491 </html> 454 </html>