Mercurial > hg > vamp-plugin-sdk
view vamp-hostsdk/LoadRequest.h @ 423:8c45dee08a95 vampipe
Add PluginConfiguration, PluginStaticData, and LoadRequest structures, and use them in PluginLoader
author | Chris Cannam |
---|---|
date | Thu, 12 May 2016 12:22:02 +0100 |
parents | |
children | 6b2567f365b0 |
line wrap: on
line source
/* -*- 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-2016 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_LOAD_REQUEST_H #define VAMP_LOAD_REQUEST_H #include "PluginStaticData.h" #include "PluginConfiguration.h" #include "hostguard.h" #include <map> #include <string> _VAMP_SDK_HOSTSPACE_BEGIN(LoadRequest.h) namespace Vamp { class Plugin; namespace HostExt { /** * \class LoadRequest LoadRequest.h <vamp-hostsdk/LoadRequest.h> * * Vamp::HostExt::LoadRequest is a structure containing the * information necessary to load a plugin. When a request is made to * load a plugin using a LoadRequest, the response is typically * returned in a LoadResponse structure. * * \see LoadResponse * * \note This class was introduced in version 2.7 of the Vamp plugin * SDK, along with the PluginLoader method that accepts this structure * rather than accepting its elements individually. */ struct LoadRequest { LoadRequest() : // invalid request by default inputSampleRate(0.f), adapterFlags(0) { } std::string pluginKey; //!!! separate out key from PluginLoader?? float inputSampleRate; int adapterFlags; //!!! from PluginLoader::AdapterFlags, but how best to handle? }; /** * \class LoadResponse LoadResponse.h <vamp-hostsdk/LoadResponse.h> * * Vamp::HostExt::LoadResponse is a structure containing the * information returned by PluginLoader when asked to load a plugin * using a LoadRequest. * * If the plugin could not be loaded, the plugin field will be 0. * * The caller takes ownership of the plugin contained here, which * should be deleted (using the standard C++ delete keyword) after * use. * * \see LoadRequest * * \note This class was introduced in version 2.7 of the Vamp plugin * SDK, along with the PluginLoader method that returns this structure. */ struct LoadResponse { LoadResponse() : // invalid (failed) response by default plugin(0) { } Plugin *plugin; PluginStaticData staticData; PluginConfiguration defaultConfiguration; }; } } _VAMP_SDK_HOSTSPACE_END(LoadRequest.h) #endif