# HG changeset patch # User Chris Cannam # Date 1463563988 -3600 # Node ID 9c25e2289faabdffd9c1608260ae46c8f47e7958 # Parent 4912b698f3f748371d9ca583b7cdfa440e6aa216 Rename LoadRequest.h -> RequestResponse.h diff -r 4912b698f3f7 -r 9c25e2289faa Makefile.in --- a/Makefile.in Tue May 17 13:52:51 2016 +0100 +++ b/Makefile.in Wed May 18 10:33:08 2016 +0100 @@ -155,7 +155,7 @@ $(HOSTSDKDIR)/RealTime.h \ $(HOSTSDKDIR)/PluginConfiguration.h \ $(HOSTSDKDIR)/PluginStaticData.h \ - $(HOSTSDKDIR)/LoadRequest.h \ + $(HOSTSDKDIR)/RequestResponse.h \ $(HOSTSDKDIR)/hostguard.h \ $(HOSTSDKDIR)/host-c.h \ $(HOSTSDKDIR)/vamp-hostsdk.h diff -r 4912b698f3f7 -r 9c25e2289faa build/Makefile.mingw32 --- a/build/Makefile.mingw32 Tue May 17 13:52:51 2016 +0100 +++ b/build/Makefile.mingw32 Wed May 18 10:33:08 2016 +0100 @@ -134,7 +134,7 @@ $(HOSTSDKDIR)/PluginWrapper.h \ $(HOSTSDKDIR)/PluginConfiguration.h \ $(HOSTSDKDIR)/PluginStaticData.h \ - $(HOSTSDKDIR)/LoadRequest.h \ + $(HOSTSDKDIR)/RequestResponse.h \ $(HOSTSDKDIR)/hostguard.h \ $(HOSTSDKDIR)/host-c.h \ $(HOSTSDKDIR)/vamp-hostsdk.h diff -r 4912b698f3f7 -r 9c25e2289faa build/Makefile.mingw64 --- a/build/Makefile.mingw64 Tue May 17 13:52:51 2016 +0100 +++ b/build/Makefile.mingw64 Wed May 18 10:33:08 2016 +0100 @@ -134,7 +134,7 @@ $(HOSTSDKDIR)/PluginWrapper.h \ $(HOSTSDKDIR)/PluginConfiguration.h \ $(HOSTSDKDIR)/PluginStaticData.h \ - $(HOSTSDKDIR)/LoadRequest.h \ + $(HOSTSDKDIR)/RequestResponse.h \ $(HOSTSDKDIR)/hostguard.h \ $(HOSTSDKDIR)/host-c.h \ $(HOSTSDKDIR)/vamp-hostsdk.h diff -r 4912b698f3f7 -r 9c25e2289faa build/Makefile.osx --- a/build/Makefile.osx Tue May 17 13:52:51 2016 +0100 +++ b/build/Makefile.osx Wed May 18 10:33:08 2016 +0100 @@ -142,7 +142,7 @@ $(HOSTSDKDIR)/PluginWrapper.h \ $(HOSTSDKDIR)/PluginConfiguration.h \ $(HOSTSDKDIR)/PluginStaticData.h \ - $(HOSTSDKDIR)/LoadRequest.h \ + $(HOSTSDKDIR)/RequestResponse.h \ $(HOSTSDKDIR)/hostguard.h \ $(HOSTSDKDIR)/host-c.h \ $(HOSTSDKDIR)/vamp-hostsdk.h diff -r 4912b698f3f7 -r 9c25e2289faa build/Makefile.osx.106 --- a/build/Makefile.osx.106 Tue May 17 13:52:51 2016 +0100 +++ b/build/Makefile.osx.106 Wed May 18 10:33:08 2016 +0100 @@ -163,7 +163,7 @@ $(HOSTSDKDIR)/PluginWrapper.h \ $(HOSTSDKDIR)/PluginConfiguration.h \ $(HOSTSDKDIR)/PluginStaticData.h \ - $(HOSTSDKDIR)/LoadRequest.h \ + $(HOSTSDKDIR)/RequestResponse.h \ $(HOSTSDKDIR)/hostguard.h \ $(HOSTSDKDIR)/host-c.h \ $(HOSTSDKDIR)/vamp-hostsdk.h diff -r 4912b698f3f7 -r 9c25e2289faa vamp-hostsdk/LoadRequest.h --- a/vamp-hostsdk/LoadRequest.h Tue May 17 13:52:51 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,157 +0,0 @@ -/* -*- 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 -#include - -_VAMP_SDK_HOSTSPACE_BEGIN(LoadRequest.h) - -namespace Vamp { - -class Plugin; - -namespace HostExt { - -/** - * \class LoadRequest 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) { } - - /** - * PluginKey is a string type that is used to identify a plugin - * uniquely within the scope of "the current system". For further - * details \see PluginLoader::PluginKey. - */ - typedef std::string PluginKey; - - /** - * The identifying key for the plugin to be loaded. - */ - PluginKey pluginKey; - - /** - * Sample rate to be passed to the plugin's constructor. - */ - float inputSampleRate; - - /** - * A bitwise OR of the values in the PluginLoader::AdapterFlags - * enumeration, indicating under which circumstances an adapter - * should be used to wrap the original plugin. If adapterFlags is - * 0, no optional adapters will be used. - * - * \see PluginLoader::AdapterFlags, PluginLoader::loadPlugin - */ - int adapterFlags; -}; - -/** - * \class LoadResponse LoadRequest.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) { } - - /** - * A pointer to the loaded plugin, or 0 if loading failed. Caller - * takes ownership of the plugin and must delete it after use. - */ - Plugin *plugin; - - /** - * The static data associated with the loaded plugin, that is, all - * information about it that does not depend on its configuration - * (parameters, programs, initialisation parameters). The contents - * of this structure are only valid if plugin is non-0. - * - * Much of the data in here is duplicated with the plugin itself. - */ - PluginStaticData staticData; - - /** - * The default configuration for this plugin, that is, default - * values for parameters etc. The contents of this structure are - * only valid if plugin is non-0. - */ - PluginConfiguration defaultConfiguration; -}; - -} - -} - -_VAMP_SDK_HOSTSPACE_END(LoadRequest.h) - -#endif diff -r 4912b698f3f7 -r 9c25e2289faa vamp-hostsdk/PluginLoader.h --- a/vamp-hostsdk/PluginLoader.h Tue May 17 13:52:51 2016 +0100 +++ b/vamp-hostsdk/PluginLoader.h Wed May 18 10:33:08 2016 +0100 @@ -43,7 +43,7 @@ #include "hostguard.h" #include "PluginWrapper.h" -#include "LoadRequest.h" +#include "RequestResponse.h" _VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h) diff -r 4912b698f3f7 -r 9c25e2289faa vamp-hostsdk/RequestResponse.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/vamp-hostsdk/RequestResponse.h Wed May 18 10:33:08 2016 +0100 @@ -0,0 +1,157 @@ +/* -*- 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 +#include + +_VAMP_SDK_HOSTSPACE_BEGIN(RequestResponse.h) + +namespace Vamp { + +class Plugin; + +namespace HostExt { + +/** + * \class LoadRequest RequestResponse.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) { } + + /** + * PluginKey is a string type that is used to identify a plugin + * uniquely within the scope of "the current system". For further + * details \see PluginLoader::PluginKey. + */ + typedef std::string PluginKey; + + /** + * The identifying key for the plugin to be loaded. + */ + PluginKey pluginKey; + + /** + * Sample rate to be passed to the plugin's constructor. + */ + float inputSampleRate; + + /** + * A bitwise OR of the values in the PluginLoader::AdapterFlags + * enumeration, indicating under which circumstances an adapter + * should be used to wrap the original plugin. If adapterFlags is + * 0, no optional adapters will be used. + * + * \see PluginLoader::AdapterFlags, PluginLoader::loadPlugin + */ + int adapterFlags; +}; + +/** + * \class LoadResponse RequestResponse.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) { } + + /** + * A pointer to the loaded plugin, or 0 if loading failed. Caller + * takes ownership of the plugin and must delete it after use. + */ + Plugin *plugin; + + /** + * The static data associated with the loaded plugin, that is, all + * information about it that does not depend on its configuration + * (parameters, programs, initialisation parameters). The contents + * of this structure are only valid if plugin is non-0. + * + * Much of the data in here is duplicated with the plugin itself. + */ + PluginStaticData staticData; + + /** + * The default configuration for this plugin, that is, default + * values for parameters etc. The contents of this structure are + * only valid if plugin is non-0. + */ + PluginConfiguration defaultConfiguration; +}; + +} + +} + +_VAMP_SDK_HOSTSPACE_END(RequestResponse.h) + +#endif