VampPluginSDK  2.5
PluginLoader.h
Go to the documentation of this file.
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
2 
3 /*
4  Vamp
5 
6  An API for audio analysis and feature extraction plugins.
7 
8  Centre for Digital Music, Queen Mary, University of London.
9  Copyright 2006-2009 Chris Cannam and QMUL.
10 
11  Permission is hereby granted, free of charge, to any person
12  obtaining a copy of this software and associated documentation
13  files (the "Software"), to deal in the Software without
14  restriction, including without limitation the rights to use, copy,
15  modify, merge, publish, distribute, sublicense, and/or sell copies
16  of the Software, and to permit persons to whom the Software is
17  furnished to do so, subject to the following conditions:
18 
19  The above copyright notice and this permission notice shall be
20  included in all copies or substantial portions of the Software.
21 
22  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
26  ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 
30  Except as contained in this notice, the names of the Centre for
31  Digital Music; Queen Mary, University of London; and Chris Cannam
32  shall not be used in advertising or otherwise to promote the sale,
33  use or other dealings in this Software without prior written
34  authorization.
35 */
36 
37 #ifndef _VAMP_PLUGIN_LOADER_H_
38 #define _VAMP_PLUGIN_LOADER_H_
39 
40 #include <vector>
41 #include <string>
42 #include <map>
43 
44 #include "hostguard.h"
45 #include "PluginWrapper.h"
46 
47 _VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h)
48 
49 namespace Vamp {
50 
51 class Plugin;
52 
53 namespace HostExt {
54 
76 {
77 public:
82  static PluginLoader *getInstance();
83 
104  typedef std::string PluginKey;
105 
110  typedef std::vector<PluginKey> PluginKeyList;
111 
122  typedef std::vector<std::string> PluginCategoryHierarchy;
123 
128  PluginKeyList listPlugins();
129 
173 
174  ADAPT_INPUT_DOMAIN = 0x01,
175  ADAPT_CHANNEL_COUNT = 0x02,
176  ADAPT_BUFFER_SIZE = 0x04,
177 
178  ADAPT_ALL_SAFE = 0x03,
179 
180  ADAPT_ALL = 0xff
181  };
182 
200  Plugin *loadPlugin(PluginKey key,
201  float inputSampleRate,
202  int adapterFlags = 0);
203 
209  PluginKey composePluginKey(std::string libraryName,
210  std::string identifier);
211 
221  PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
222 
227  std::string getLibraryPathForPlugin(PluginKey plugin);
228 
229 protected:
230  PluginLoader();
231  virtual ~PluginLoader();
232 
233  class Impl;
234  Impl *m_impl;
235 
237 };
238 
239 }
240 
241 }
242 
243 _VAMP_SDK_HOSTSPACE_END(PluginLoader.h)
244 
245 #endif
246 
std::vector< PluginKey > PluginKeyList
PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().
Definition: PluginLoader.h:110
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition: hostguard.h:56
Definition: FFT.h:43
std::vector< std::string > PluginCategoryHierarchy
PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with ...
Definition: PluginLoader.h:122
static PluginLoader * m_instance
Definition: PluginLoader.h:236
AdapterFlags
AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances Pl...
Definition: PluginLoader.h:172
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition: hostguard.h:59
Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...
Definition: PluginLoader.h:75
std::string PluginKey
PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the curren...
Definition: PluginLoader.h:104