PluginLoader.h
Go to the documentation of this file.
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Vamp
An API for audio analysis and feature extraction plugins.
Centre for Digital Music, Queen Mary, University of London.
Copyright 2006-2009 Chris Cannam and QMUL.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the names of the Centre for
Digital Music; Queen Mary, University of London; and Chris Cannam
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written
authorization.
*/
#ifndef _VAMP_PLUGIN_LOADER_H_
#define _VAMP_PLUGIN_LOADER_H_
#include <vector>
#include <string>
#include <map>
#include "hostguard.h"
#include "PluginWrapper.h"
_VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h)
namespace Vamp {
class Plugin;
namespace HostExt {
class PluginLoader
{
public:
static PluginLoader *getInstance();
typedef std::string PluginKey;
typedef std::vector<PluginKey> PluginKeyList;
typedef std::vector<std::string> PluginCategoryHierarchy;
PluginKeyList listPlugins();
PluginKeyList listPluginsIn(std::vector<std::string> libraryNames);
PluginKeyList listPluginsNotIn(std::vector<std::string> libraryNames);
enum AdapterFlags {
ADAPT_INPUT_DOMAIN = 0x01,
ADAPT_CHANNEL_COUNT = 0x02,
ADAPT_BUFFER_SIZE = 0x04,
ADAPT_ALL_SAFE = 0x03,
ADAPT_ALL = 0xff
};
Plugin *loadPlugin(PluginKey key,
float inputSampleRate,
int adapterFlags = 0);
PluginKey composePluginKey(std::string libraryName,
std::string identifier);
PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
std::string getLibraryPathForPlugin(PluginKey plugin);
protected:
PluginLoader();
virtual ~PluginLoader();
class Impl;
Impl *m_impl;
static PluginLoader *m_instance;
};
}
}
_VAMP_SDK_HOSTSPACE_END(PluginLoader.h)
#endif
PluginWrapper.h
PluginLoader
Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...
Definition PluginLoader.h:76
PluginLoader::PluginLoader
PluginLoader()
Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition vamp-sdk/Plugin.h:125
Vamp::HostExt::PluginLoader::listPluginsIn
PluginKeyList listPluginsIn(std::vector< std::string > libraryNames)
Search for available Vamp plugins in libraries with the given library names, and return a list of the...
Vamp::HostExt::PluginLoader::listPluginsNotIn
PluginKeyList listPluginsNotIn(std::vector< std::string > libraryNames)
Search for available Vamp plugins in libraries other than those with the given library names,...
Vamp::HostExt::PluginLoader::PluginKeyList
std::vector< PluginKey > PluginKeyList
PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().
Definition PluginLoader.h:110
Vamp::HostExt::PluginLoader::loadPlugin
Plugin * loadPlugin(PluginKey key, float inputSampleRate, int adapterFlags=0)
Load a Vamp plugin, given its identifying key.
Vamp::HostExt::PluginLoader::PluginKey
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
Vamp::HostExt::PluginLoader::getLibraryPathForPlugin
std::string getLibraryPathForPlugin(PluginKey plugin)
Return the file path of the dynamic library from which the given plugin will be loaded (if available)...
Vamp::HostExt::PluginLoader::getInstance
static PluginLoader * getInstance()
Obtain a pointer to the singleton instance of PluginLoader.
Vamp::HostExt::PluginLoader::getPluginCategory
PluginCategoryHierarchy getPluginCategory(PluginKey plugin)
Return the category hierarchy for a Vamp plugin, given its identifying key.
Vamp::HostExt::PluginLoader::PluginLoader
PluginLoader()
Vamp::HostExt::PluginLoader::m_impl
Impl * m_impl
Definition PluginLoader.h:268
Vamp::HostExt::PluginLoader::composePluginKey
PluginKey composePluginKey(std::string libraryName, std::string identifier)
Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form...
Vamp::HostExt::PluginLoader::PluginCategoryHierarchy
std::vector< std::string > PluginCategoryHierarchy
PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with ...
Definition PluginLoader.h:122
Vamp::HostExt::PluginLoader::~PluginLoader
virtual ~PluginLoader()
Vamp::HostExt::PluginLoader::m_instance
static PluginLoader * m_instance
Definition PluginLoader.h:270
Vamp::HostExt::PluginLoader::AdapterFlags
AdapterFlags
AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances Pl...
Definition PluginLoader.h:200
Vamp::HostExt::PluginLoader::ADAPT_ALL
@ ADAPT_ALL
Definition PluginLoader.h:208
Vamp::HostExt::PluginLoader::ADAPT_CHANNEL_COUNT
@ ADAPT_CHANNEL_COUNT
Definition PluginLoader.h:203
Vamp::HostExt::PluginLoader::ADAPT_BUFFER_SIZE
@ ADAPT_BUFFER_SIZE
Definition PluginLoader.h:204
Vamp::HostExt::PluginLoader::ADAPT_INPUT_DOMAIN
@ ADAPT_INPUT_DOMAIN
Definition PluginLoader.h:202
Vamp::HostExt::PluginLoader::ADAPT_ALL_SAFE
@ ADAPT_ALL_SAFE
Definition PluginLoader.h:206
Vamp::HostExt::PluginLoader::listPlugins
PluginKeyList listPlugins()
Search for all available Vamp plugins, and return a list of them in the order in which they were foun...
Vamp::Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition vamp-sdk/Plugin.h:125
hostguard.h
_VAMP_SDK_HOSTSPACE_END
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition hostguard.h:59
_VAMP_SDK_HOSTSPACE_BEGIN
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition hostguard.h:56
Vamp
Definition FFT.h:43