3c430ef1ed66/code-docs/PluginLoader_8h_source.html

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