Mercurial > hg > vamp-website
diff code-doc/classVamp_1_1HostExt_1_1PluginLoader.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | 351c4ebce5f9 |
| children | 0976232e353b |
line wrap: on
line diff
--- a/code-doc/classVamp_1_1HostExt_1_1PluginLoader.html Mon Nov 24 15:17:08 2008 +0000 +++ b/code-doc/classVamp_1_1HostExt_1_1PluginLoader.html Tue Dec 09 11:02:57 2008 +0000 @@ -4,7 +4,7 @@ <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.5.5 --> +<!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> @@ -26,18 +26,18 @@ </div> </div> <div class="contents"> -<h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><code>#include <<a class="el" href="PluginLoader_8h-source.html">vamp-sdk/hostext/PluginLoader.h</a>></code> +<h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><code>#include <<a class="el" href="PluginLoader_8h-source.html">vamp-hostsdk/PluginLoader.h</a>></code> <p> <p> <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> -<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. +<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. <p> -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> -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> -<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> +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> +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> +<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> -<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> +<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> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> @@ -57,43 +57,40 @@ <tr><td class="mdescLeft"> </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> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a></td></tr> -<tr><td class="mdescLeft"> </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> +<tr><td class="mdescLeft"> </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> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with a single plugin. <a href="#d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b">listPlugins</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff51b52bb68aa2934ccf26ad1d284f28">listPlugins</a> ()</td></tr> -<tr><td class="mdescLeft"> </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> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </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> +<tr><td class="mdescLeft"> </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> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </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> -<tr><td class="mdescLeft"> </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> +<tr><td class="mdescLeft"> </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> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> </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> -<tr><td class="mdescLeft"> </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> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> </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> +<tr><td class="mdescLeft"> </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> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> </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> -<tr><td class="mdescLeft"> </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> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </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> +<tr><td class="mdescLeft"> </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> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </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> -<tr><td class="mdescLeft"> </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> +<tr><td class="mdescLeft"> </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> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#dbb5c8855697a24be890e4f107e26b0e">getInstance</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#1d77fa1d58ee4fee2985b5af02380326">getInstance</a> ()</td></tr> -<tr><td class="mdescLeft"> </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> +<tr><td class="mdescLeft"> </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> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a> ()</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#9e092d864efdc0f16c032bfb25e76dea">~PluginLoader</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d74ab52bc6aa2514b3a6b3f679fc492c">~PluginLoader</a> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr> <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">m_instance</a> = 0</td></tr> - -<tr><td colspan="2"><br><h2>Classes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#f89caf5f838a586b117c417260b7a116">m_instance</a></td></tr> </table> <hr><h2>Member Typedef Documentation</h2> @@ -111,10 +108,10 @@ <p> PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". <p> -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> +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> 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> -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. -<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> +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. +<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> </div> </div><p> @@ -130,10 +127,10 @@ <div class="memdoc"> <p> -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>. +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>. <p> -<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> +<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> </div> </div><p> @@ -152,9 +149,9 @@ PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with a single plugin. <p> 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> -<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> +<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> -<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> +<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> </div> </div><p> @@ -194,7 +191,7 @@ </table> </dl> -<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> +<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> </div> </div><p> @@ -208,7 +205,7 @@ <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [protected]</code></td> + <td><code> [protected]</code></td> </tr> </table> </div> @@ -216,24 +213,18 @@ <p> -<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> - -<p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p> - -<p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p> - </div> </div><p> -<a class="anchor" name="9e092d864efdc0f16c032bfb25e76dea"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="9e092d864efdc0f16c032bfb25e76dea" args="()" --> +<a class="anchor" name="d74ab52bc6aa2514b3a6b3f679fc492c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="d74ab52bc6aa2514b3a6b3f679fc492c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">Vamp::HostExt::PluginLoader::~PluginLoader </td> + <td class="memname">virtual Vamp::HostExt::PluginLoader::~PluginLoader </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [protected, virtual]</code></td> + <td><code> [protected, virtual]</code></td> </tr> </table> </div> @@ -241,23 +232,19 @@ <p> -<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> - -<p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p> - </div> </div><p> <hr><h2>Member Function Documentation</h2> -<a class="anchor" name="dbb5c8855697a24be890e4f107e26b0e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="dbb5c8855697a24be890e4f107e26b0e" args="()" --> +<a class="anchor" name="1d77fa1d58ee4fee2985b5af02380326"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="1d77fa1d58ee4fee2985b5af02380326" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * Vamp::HostExt::PluginLoader::getInstance </td> + <td class="memname">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::getInstance </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [static]</code></td> + <td><code> [static]</code></td> </tr> </table> </div> @@ -267,45 +254,37 @@ 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>. <p> Use this to obtain your loader object. -<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> - -<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> - </div> </div><p> -<a class="anchor" name="ec450c2928b1ae5318d45972722dd16b"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ec450c2928b1ae5318d45972722dd16b" args="()" --> +<a class="anchor" name="ff51b52bb68aa2934ccf26ad1d284f28"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ff51b52bb68aa2934ccf26ad1d284f28" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">vector< <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginLoader::PluginKey</a> > Vamp::HostExt::PluginLoader::listPlugins </td> + <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPlugins </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -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. +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. <p> -<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> - -<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> - -<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> +<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> </div> </div><p> -<a class="anchor" name="2154970381343edef629482bdafea7e2"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="2154970381343edef629482bdafea7e2" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" --> +<a class="anchor" name="964689eb9688cd7e58e8c82ebb0d305f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="964689eb9688cd7e58e8c82ebb0d305f" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * Vamp::HostExt::PluginLoader::loadPlugin </td> + <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginLoader::loadPlugin </td> <td>(</td> <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> </td> <td class="paramname"> <em>key</em>, </td> @@ -325,14 +304,14 @@ <tr> <td></td> <td>)</td> - <td></td><td></td><td width="100%"></td> + <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> -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. +Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <p> If the plugin could not be loaded, returns 0.<p> The returned plugin should be deleted (using the standard C++ delete keyword) after use.<p> @@ -343,11 +322,7 @@ </dl> <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'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> -<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> - -<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> - -<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> +<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> </div> </div><p> @@ -370,61 +345,57 @@ <tr> <td></td> <td>)</td> - <td></td><td></td><td width="100%"></td> + <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> -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>. +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>. <p> -<p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p> +<p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> </div> </div><p> -<a class="anchor" name="d5c594142ff058bd70e66247d45cd86e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="d5c594142ff058bd70e66247d45cd86e" args="(PluginKey plugin)" --> +<a class="anchor" name="52746ea66339ad981b868a031a3b382d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="52746ea66339ad981b868a031a3b382d" args="(PluginKey plugin)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginLoader::PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td> + <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td> <td>(</td> <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> </td> <td class="paramname"> <em>plugin</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -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. +Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <p> If the plugin has no category information, return an empty hierarchy.<p> <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->specific category names, as...">PluginCategoryHierarchy</a> </dd></dl> -<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> - -<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> - -<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> +<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> </div> </div><p> -<a class="anchor" name="592d6b4c6edaa369407e833f56e4a4de"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="592d6b4c6edaa369407e833f56e4a4de" args="(PluginKey plugin)" --> +<a class="anchor" name="4bbcb7873e617bbc9f79eade1f90f7ad"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="4bbcb7873e617bbc9f79eade1f90f7ad" args="(PluginKey plugin)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td> + <td class="memname">std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td> <td>(</td> <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> </td> <td class="paramname"> <em>plugin</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -434,11 +405,7 @@ Return the file path of the dynamic library from which the given plugin will be loaded (if available). <p> -<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> - -<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> - -<p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>.</p> +<p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p> </div> </div><p> @@ -448,26 +415,7 @@ <div class="memproto"> <table class="memname"> <tr> - <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> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> - -<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> - -<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> - -</div> -</div><p> -<a class="anchor" name="aa4eae58ddbadf6537a95dbb6e957187"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="aa4eae58ddbadf6537a95dbb6e957187" args="" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <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> + <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> </tr> </table> </div> @@ -477,15 +425,30 @@ <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> -<p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p> +</div> +</div><p> +<a class="anchor" name="f89caf5f838a586b117c417260b7a116"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="f89caf5f838a586b117c417260b7a116" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<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> </div> </div><p> -<hr>The documentation for this class was generated from the following files:<ul> -<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> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a></ul> </div> -<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>