VampPluginSDK: PluginLoader.h Source File

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@0: 00009     Copyright 2006-2007 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@0: 00044 #include "PluginWrapper.h"
cannam@0: 00045 
cannam@0: 00046 namespace Vamp {
cannam@0: 00047 
cannam@0: 00048 class Plugin;
cannam@0: 00049 
cannam@0: 00050 namespace HostExt {
cannam@0: 00051 
cannam@0: 00069 class PluginLoader
cannam@0: 00070 {
cannam@0: 00071 public:
cannam@0: 00076     static PluginLoader *getInstance();
cannam@0: 00077 
cannam@0: 00098     typedef std::string PluginKey;
cannam@0: 00099 
cannam@0: 00104     typedef std::vector<PluginKey> PluginKeyList;
cannam@0: 00105 
cannam@0: 00116     typedef std::vector<std::string> PluginCategoryHierarchy;
cannam@0: 00117 
cannam@0: 00122     PluginKeyList listPlugins();
cannam@0: 00123 
cannam@0: 00166     enum AdapterFlags {
cannam@0: 00167 
cannam@0: 00168         ADAPT_INPUT_DOMAIN  = 0x01,
cannam@0: 00169         ADAPT_CHANNEL_COUNT = 0x02,
cannam@0: 00170         ADAPT_BUFFER_SIZE   = 0x04,
cannam@0: 00171 
cannam@0: 00172         ADAPT_ALL_SAFE      = 0x03,
cannam@0: 00173 
cannam@0: 00174         ADAPT_ALL           = 0xff
cannam@0: 00175     };
cannam@0: 00176 
cannam@0: 00194     Plugin *loadPlugin(PluginKey key,
cannam@0: 00195                        float inputSampleRate,
cannam@0: 00196                        int adapterFlags = 0);
cannam@0: 00197 
cannam@0: 00203     PluginKey composePluginKey(std::string libraryName,
cannam@0: 00204                                std::string identifier);
cannam@0: 00205 
cannam@0: 00215     PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
cannam@0: 00216 
cannam@0: 00221     std::string getLibraryPathForPlugin(PluginKey plugin);
cannam@0: 00222 
cannam@0: 00223 protected:
cannam@0: 00224     PluginLoader();
cannam@0: 00225     virtual ~PluginLoader();
cannam@0: 00226 
cannam@0: 00227     class Impl;
cannam@0: 00228     Impl *m_impl;
cannam@0: 00229 
cannam@0: 00230     static PluginLoader *m_instance;
cannam@0: 00231 };
cannam@0: 00232 
cannam@0: 00233 }
cannam@0: 00234 
cannam@0: 00235 }
cannam@0: 00236 
cannam@0: 00237 #endif
cannam@0: 00238 
cannam@0: