VampPluginSDK  2.1
PluginLoader.h
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
00002 
00003 /*
00004     Vamp
00005 
00006     An API for audio analysis and feature extraction plugins.
00007 
00008     Centre for Digital Music, Queen Mary, University of London.
00009     Copyright 2006-2009 Chris Cannam and QMUL.
00010   
00011     Permission is hereby granted, free of charge, to any person
00012     obtaining a copy of this software and associated documentation
00013     files (the "Software"), to deal in the Software without
00014     restriction, including without limitation the rights to use, copy,
00015     modify, merge, publish, distribute, sublicense, and/or sell copies
00016     of the Software, and to permit persons to whom the Software is
00017     furnished to do so, subject to the following conditions:
00018 
00019     The above copyright notice and this permission notice shall be
00020     included in all copies or substantial portions of the Software.
00021 
00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00029 
00030     Except as contained in this notice, the names of the Centre for
00031     Digital Music; Queen Mary, University of London; and Chris Cannam
00032     shall not be used in advertising or otherwise to promote the sale,
00033     use or other dealings in this Software without prior written
00034     authorization.
00035 */
00036 
00037 #ifndef _VAMP_PLUGIN_LOADER_H_
00038 #define _VAMP_PLUGIN_LOADER_H_
00039 
00040 #include <vector>
00041 #include <string>
00042 #include <map>
00043 
00044 #include "hostguard.h"
00045 #include "PluginWrapper.h"
00046 
00047 _VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h)
00048 
00049 namespace Vamp {
00050 
00051 class Plugin;
00052 
00053 namespace HostExt {
00054 
00072 class PluginLoader
00073 {
00074 public:
00079     static PluginLoader *getInstance();
00080 
00101     typedef std::string PluginKey;
00102 
00107     typedef std::vector<PluginKey> PluginKeyList;
00108 
00119     typedef std::vector<std::string> PluginCategoryHierarchy;
00120 
00125     PluginKeyList listPlugins();
00126 
00169     enum AdapterFlags {
00170 
00171         ADAPT_INPUT_DOMAIN  = 0x01,
00172         ADAPT_CHANNEL_COUNT = 0x02,
00173         ADAPT_BUFFER_SIZE   = 0x04,
00174 
00175         ADAPT_ALL_SAFE      = 0x03,
00176 
00177         ADAPT_ALL           = 0xff
00178     };
00179 
00197     Plugin *loadPlugin(PluginKey key,
00198                        float inputSampleRate,
00199                        int adapterFlags = 0);
00200 
00206     PluginKey composePluginKey(std::string libraryName,
00207                                std::string identifier);
00208 
00218     PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
00219 
00224     std::string getLibraryPathForPlugin(PluginKey plugin);
00225 
00226 protected:
00227     PluginLoader();
00228     virtual ~PluginLoader();
00229 
00230     class Impl;
00231     Impl *m_impl;
00232 
00233     static PluginLoader *m_instance;
00234 };
00235 
00236 }
00237 
00238 }
00239 
00240 _VAMP_SDK_HOSTSPACE_END(PluginLoader.h)
00241 
00242 #endif
00243