Mercurial > hg > vamp-website
diff code-doc/PluginLoader_8h-source.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/PluginLoader_8h-source.html Mon Nov 24 15:17:08 2008 +0000 +++ b/code-doc/PluginLoader_8h-source.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> @@ -15,10 +15,10 @@ <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> - <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a> » <a class="el" href="dir_fa454903fff8cd477733ebe28a3468c0.html">hostext</a> + <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a> </div> </div> -</div> +<div class="contents"> <h1>PluginLoader.h</h1><a href="PluginLoader_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> @@ -62,68 +62,73 @@ <a name="l00041"></a>00041 <span class="preprocessor">#include <string></span> <a name="l00042"></a>00042 <span class="preprocessor">#include <map></span> <a name="l00043"></a>00043 -<a name="l00044"></a>00044 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span> -<a name="l00045"></a>00045 -<a name="l00046"></a>00046 <span class="keyword">namespace </span>Vamp { -<a name="l00047"></a>00047 -<a name="l00048"></a>00048 <span class="keyword">class </span>Plugin; -<a name="l00049"></a>00049 -<a name="l00050"></a>00050 <span class="keyword">namespace </span>HostExt { -<a name="l00051"></a>00051 -<a name="l00069"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">00069</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> -<a name="l00070"></a>00070 { -<a name="l00071"></a>00071 <span class="keyword">public</span>: -<a name="l00076"></a>00076 <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#dbb5c8855697a24be890e4f107e26b0e" title="Obtain a pointer to the singleton instance of PluginLoader.">getInstance</a>(); -<a name="l00077"></a>00077 -<a name="l00098"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">00098</a> <span class="keyword">typedef</span> std::string <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the...">PluginKey</a>; -<a name="l00099"></a>00099 -<a name="l00104"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">00104</a> <span class="keyword">typedef</span> std::vector<PluginKey> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a>; -<a name="l00105"></a>00105 -<a name="l00116"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">00116</a> <span class="keyword">typedef</span> std::vector<std::string> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as...">PluginCategoryHierarchy</a>; -<a name="l00117"></a>00117 -<a name="l00122"></a>00122 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a" title="PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().">PluginKeyList</a> <a class="code" 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 name="l00123"></a>00123 -<a name="l00166"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">00166</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in...">AdapterFlags</a> { -<a name="l00167"></a>00167 -<a name="l00168"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">00168</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01, -<a name="l00169"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">00169</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">ADAPT_CHANNEL_COUNT</a> = 0x02, -<a name="l00170"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">00170</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">ADAPT_BUFFER_SIZE</a> = 0x04, -<a name="l00171"></a>00171 -<a name="l00172"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">00172</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">ADAPT_ALL_SAFE</a> = 0x03, -<a name="l00173"></a>00173 -<a name="l00174"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">00174</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">ADAPT_ALL</a> = 0xff -<a name="l00175"></a>00175 }; +<a name="l00044"></a>00044 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span> +<a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span> +<a name="l00046"></a>00046 +<a name="l00047"></a>00047 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginLoader.h) +<a name="l00048"></a>00048 +<a name="l00049"></a>00049 namespace Vamp { +<a name="l00050"></a>00050 +<a name="l00051"></a>00051 <span class="keyword">class </span>Plugin; +<a name="l00052"></a>00052 +<a name="l00053"></a>00053 <span class="keyword">namespace </span>HostExt { +<a name="l00054"></a>00054 +<a name="l00072"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html">00072</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> +<a name="l00073"></a>00073 { +<a name="l00074"></a>00074 <span class="keyword">public</span>: +<a name="l00079"></a>00079 <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> *getInstance(); +<a name="l00080"></a>00080 +<a name="l00101"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">00101</a> <span class="keyword">typedef</span> std::string PluginKey; +<a name="l00102"></a>00102 +<a name="l00107"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">00107</a> <span class="keyword">typedef</span> std::vector<PluginKey> PluginKeyList; +<a name="l00108"></a>00108 +<a name="l00119"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">00119</a> <span class="keyword">typedef</span> std::vector<std::string> PluginCategoryHierarchy; +<a name="l00120"></a>00120 +<a name="l00125"></a>00125 PluginKeyList listPlugins(); +<a name="l00126"></a>00126 +<a name="l00169"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">00169</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in...">AdapterFlags</a> { +<a name="l00170"></a>00170 +<a name="l00171"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">00171</a> ADAPT_INPUT_DOMAIN = 0x01, +<a name="l00172"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">00172</a> ADAPT_CHANNEL_COUNT = 0x02, +<a name="l00173"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">00173</a> ADAPT_BUFFER_SIZE = 0x04, +<a name="l00174"></a>00174 +<a name="l00175"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">00175</a> ADAPT_ALL_SAFE = 0x03, <a name="l00176"></a>00176 -<a name="l00194"></a>00194 <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2" title="Load a Vamp plugin, given its identifying key.">loadPlugin</a>(<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the...">PluginKey</a> key, -<a name="l00195"></a>00195 <span class="keywordtype">float</span> inputSampleRate, -<a name="l00196"></a>00196 <span class="keywordtype">int</span> adapterFlags = 0); -<a name="l00197"></a>00197 -<a name="l00203"></a>00203 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the...">PluginKey</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding...">composePluginKey</a>(std::string libraryName, -<a name="l00204"></a>00204 std::string identifier); -<a name="l00205"></a>00205 -<a name="l00215"></a>00215 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as...">PluginCategoryHierarchy</a> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#d5c594142ff058bd70e66247d45cd86e" title="Return the category hierarchy for a Vamp plugin, given its identifying key.">getPluginCategory</a>(<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the...">PluginKey</a> plugin); -<a name="l00216"></a>00216 -<a name="l00221"></a>00221 std::string <a class="code" 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>(<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d" title="PluginKey is a string type that is used to identify a plugin uniquely within the...">PluginKey</a> plugin); -<a name="l00222"></a>00222 -<a name="l00223"></a>00223 <span class="keyword">protected</span>: -<a name="l00224"></a>00224 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a>(); -<a name="l00225"></a>00225 <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#9e092d864efdc0f16c032bfb25e76dea">~PluginLoader</a>(); -<a name="l00226"></a>00226 -<a name="l00227"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">00227</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a>; -<a name="l00228"></a>00228 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a>; +<a name="l00177"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">00177</a> ADAPT_ALL = 0xff +<a name="l00178"></a>00178 }; +<a name="l00179"></a>00179 +<a name="l00197"></a>00197 <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> *loadPlugin(PluginKey key, +<a name="l00198"></a>00198 <span class="keywordtype">float</span> inputSampleRate, +<a name="l00199"></a>00199 <span class="keywordtype">int</span> adapterFlags = 0); +<a name="l00200"></a>00200 +<a name="l00206"></a>00206 PluginKey composePluginKey(std::string libraryName, +<a name="l00207"></a>00207 std::string identifier); +<a name="l00208"></a>00208 +<a name="l00218"></a>00218 PluginCategoryHierarchy getPluginCategory(PluginKey plugin); +<a name="l00219"></a>00219 +<a name="l00224"></a>00224 std::string getLibraryPathForPlugin(PluginKey plugin); +<a name="l00225"></a>00225 +<a name="l00226"></a>00226 <span class="keyword">protected</span>: +<a name="l00227"></a>00227 <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>(); +<a name="l00228"></a>00228 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>(); <a name="l00229"></a>00229 -<a name="l00230"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">00230</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> *<a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">m_instance</a>; -<a name="l00231"></a>00231 }; +<a name="l00230"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">00230</a> <span class="keyword">class </span>Impl; +<a name="l00231"></a>00231 Impl *m_impl; <a name="l00232"></a>00232 -<a name="l00233"></a>00233 } -<a name="l00234"></a>00234 -<a name="l00235"></a>00235 } -<a name="l00236"></a>00236 -<a name="l00237"></a>00237 <span class="preprocessor">#endif</span> -<a name="l00238"></a>00238 <span class="preprocessor"></span> +<a name="l00233"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html#f89caf5f838a586b117c417260b7a116">00233</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> *m_instance; +<a name="l00234"></a>00234 }; +<a name="l00235"></a>00235 +<a name="l00236"></a>00236 } +<a name="l00237"></a>00237 +<a name="l00238"></a>00238 } +<a name="l00239"></a>00239 +<a name="l00240"></a>00240 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginLoader.h) +<a name="l00241"></a>00241 +<a name="l00242"></a>00242 <span class="preprocessor">#endif</span> +<a name="l00243"></a>00243 <span class="preprocessor"></span> </pre></div></div> -<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 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>