cannam@0:
PluginLoader.h

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