cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ cannam@0: cannam@0: /* cannam@2: Vamp cannam@2: cannam@2: An API for audio analysis and feature extraction plugins. cannam@2: cannam@0: Centre for Digital Music, Queen Mary, University of London. cannam@2: Copyright 2006 Chris Cannam. cannam@2: cannam@2: Permission is hereby granted, free of charge, to any person cannam@2: obtaining a copy of this software and associated documentation cannam@2: files (the "Software"), to deal in the Software without cannam@2: restriction, including without limitation the rights to use, copy, cannam@2: modify, merge, publish, distribute, sublicense, and/or sell copies cannam@2: of the Software, and to permit persons to whom the Software is cannam@2: furnished to do so, subject to the following conditions: cannam@2: cannam@2: The above copyright notice and this permission notice shall be cannam@2: included in all copies or substantial portions of the Software. cannam@2: cannam@2: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@2: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@2: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND cannam@6: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR cannam@2: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@2: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@2: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@2: cannam@2: Except as contained in this notice, the names of the Centre for cannam@2: Digital Music; Queen Mary, University of London; and Chris Cannam cannam@2: shall not be used in advertising or otherwise to promote the sale, cannam@2: use or other dealings in this Software without prior written cannam@2: authorization. cannam@0: */ cannam@0: cannam@230: #ifndef _VAMP_SDK_PLUGIN_BASE_H_ cannam@230: #define _VAMP_SDK_PLUGIN_BASE_H_ cannam@0: cannam@0: #include cannam@0: #include cannam@0: cannam@234: #define VAMP_SDK_VERSION "2.0" cannam@234: #define VAMP_SDK_MAJOR_VERSION 2 cannam@234: #define VAMP_SDK_MINOR_VERSION 0 cannam@234: cannam@230: #include "plugguard.h" cannam@233: _VAMP_SDK_PLUGSPACE_BEGIN(PluginBase.h) cannam@24: cannam@0: namespace Vamp { cannam@0: cannam@0: /** cannam@0: * A base class for plugins with optional configurable parameters, cannam@53: * programs, etc. The Vamp::Plugin is derived from this, and cannam@53: * individual Vamp plugins should derive from that. cannam@0: * cannam@53: * This class does not provide the necessary interfaces to instantiate cannam@53: * or run a plugin. It only specifies an interface for retrieving cannam@53: * those controls that the host may wish to show to the user for cannam@53: * editing. It could meaningfully be subclassed by real-time plugins cannam@53: * or other sorts of plugin as well as Vamp plugins. cannam@0: */ cannam@0: cannam@0: class PluginBase cannam@0: { cannam@0: public: cannam@20: virtual ~PluginBase() { } cannam@20: cannam@0: /** cannam@50: * Get the Vamp API compatibility level of the plugin. cannam@50: */ cannam@167: virtual unsigned int getVampApiVersion() const { return 2; } cannam@50: cannam@50: /** cannam@0: * Get the computer-usable name of the plugin. This should be cannam@0: * reasonably short and contain no whitespace or punctuation cannam@134: * characters. It may only contain the characters [a-zA-Z0-9_-]. cannam@47: * This is the authoritative way for a program to identify a cannam@47: * plugin within a given library. cannam@47: * cannam@47: * This text may be visible to the user, but it should not be the cannam@47: * main text used to identify a plugin to the user (that will be cannam@49: * the name, below). cannam@49: * cannam@49: * Example: "zero_crossings" cannam@49: */ cannam@49: virtual std::string getIdentifier() const = 0; cannam@49: cannam@49: /** cannam@49: * Get a human-readable name or title of the plugin. This cannam@49: * should be brief and self-contained, as it may be used to cannam@49: * identify the plugin to the user in isolation (i.e. without also cannam@49: * showing the plugin's "identifier"). cannam@49: * cannam@49: * Example: "Zero Crossings" cannam@0: */ cannam@0: virtual std::string getName() const = 0; cannam@0: cannam@0: /** cannam@49: * Get a human-readable description for the plugin, typically cannam@49: * a line of text that may optionally be displayed in addition cannam@49: * to the plugin's "name". May be empty if the name has said cannam@49: * it all already. cannam@49: * cannam@49: * Example: "Detect and count zero crossing points" cannam@0: */ cannam@0: virtual std::string getDescription() const = 0; cannam@0: cannam@0: /** cannam@0: * Get the name of the author or vendor of the plugin in cannam@47: * human-readable form. This should be a short identifying text, cannam@47: * as it may be used to label plugins from the same source in a cannam@47: * menu or similar. cannam@0: */ cannam@0: virtual std::string getMaker() const = 0; cannam@0: cannam@0: /** cannam@47: * Get the copyright statement or licensing summary for the cannam@47: * plugin. This can be an informative text, without the same cannam@47: * presentation constraints as mentioned for getMaker above. cannam@47: */ cannam@47: virtual std::string getCopyright() const = 0; cannam@47: cannam@47: /** cannam@0: * Get the version number of the plugin. cannam@0: */ cannam@0: virtual int getPluginVersion() const = 0; cannam@0: cannam@0: cannam@0: struct ParameterDescriptor cannam@0: { cannam@0: /** cannam@0: * The name of the parameter, in computer-usable form. Should cannam@0: * be reasonably short, and may only contain the characters cannam@134: * [a-zA-Z0-9_-]. cannam@0: */ cannam@49: std::string identifier; cannam@49: cannam@49: /** cannam@49: * The human-readable name of the parameter. cannam@49: */ cannam@0: std::string name; cannam@0: cannam@0: /** cannam@49: * A human-readable short text describing the parameter. May be cannam@49: * empty if the name has said it all already. cannam@0: */ cannam@0: std::string description; cannam@0: cannam@0: /** cannam@0: * The unit of the parameter, in human-readable form. cannam@0: */ cannam@0: std::string unit; cannam@0: cannam@0: /** cannam@0: * The minimum value of the parameter. cannam@0: */ cannam@0: float minValue; cannam@0: cannam@0: /** cannam@0: * The maximum value of the parameter. cannam@0: */ cannam@0: float maxValue; cannam@0: cannam@0: /** cannam@24: * The default value of the parameter. The plugin should cannam@24: * ensure that parameters have this value on initialisation cannam@24: * (i.e. the host is not required to explicitly set parameters cannam@24: * if it wants to use their default values). cannam@0: */ cannam@0: float defaultValue; cannam@0: cannam@0: /** cannam@0: * True if the parameter values are quantized to a particular cannam@0: * resolution. cannam@0: */ cannam@0: bool isQuantized; cannam@0: cannam@0: /** cannam@0: * Quantization resolution of the parameter values (e.g. 1.0 cannam@0: * if they are all integers). Undefined if isQuantized is cannam@0: * false. cannam@0: */ cannam@0: float quantizeStep; cannam@9: cannam@9: /** cannam@9: * Names for the quantized values. If isQuantized is true, cannam@9: * this may either be empty or contain one string for each of cannam@9: * the quantize steps from minValue up to maxValue inclusive. cannam@9: * Undefined if isQuantized is false. cannam@9: * cannam@9: * If these names are provided, they should be shown to the cannam@9: * user in preference to the values themselves. The user may cannam@9: * never see the actual numeric values unless they are also cannam@9: * encoded in the names. cannam@9: */ cannam@9: std::vector valueNames; cannam@167: cannam@167: ParameterDescriptor() : // the defaults are invalid: you must set them cannam@167: minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { } cannam@0: }; cannam@0: cannam@0: typedef std::vector ParameterList; cannam@0: cannam@0: /** cannam@0: * Get the controllable parameters of this plugin. cannam@0: */ cannam@0: virtual ParameterList getParameterDescriptors() const { cannam@0: return ParameterList(); cannam@0: } cannam@0: cannam@0: /** cannam@49: * Get the value of a named parameter. The argument is the identifier cannam@0: * field from that parameter's descriptor. cannam@0: */ cannam@0: virtual float getParameter(std::string) const { return 0.0; } cannam@0: cannam@0: /** cannam@49: * Set a named parameter. The first argument is the identifier field cannam@0: * from that parameter's descriptor. cannam@0: */ cannam@0: virtual void setParameter(std::string, float) { } cannam@0: cannam@0: cannam@0: typedef std::vector ProgramList; cannam@0: cannam@0: /** cannam@64: * Get the program settings available in this plugin. A program cannam@64: * is a named shorthand for a set of parameter values; changing cannam@64: * the program may cause the plugin to alter the values of its cannam@64: * published parameters (and/or non-public internal processing cannam@64: * parameters). The host should re-read the plugin's parameter cannam@64: * values after setting a new program. cannam@64: * cannam@0: * The programs must have unique names. cannam@0: */ cannam@0: virtual ProgramList getPrograms() const { return ProgramList(); } cannam@0: cannam@0: /** cannam@0: * Get the current program. cannam@0: */ cannam@0: virtual std::string getCurrentProgram() const { return ""; } cannam@0: cannam@0: /** cannam@0: * Select a program. (If the given program name is not one of the cannam@0: * available programs, do nothing.) cannam@0: */ cannam@0: virtual void selectProgram(std::string) { } cannam@47: cannam@47: /** cannam@47: * Get the type of plugin. This is to be implemented by the cannam@47: * immediate subclass, not by actual plugins. Do not attempt to cannam@47: * implement this in plugin code. cannam@47: */ cannam@47: virtual std::string getType() const = 0; cannam@0: }; cannam@0: cannam@0: } cannam@0: cannam@233: _VAMP_SDK_PLUGSPACE_END(PluginBase.h) cannam@230: cannam@0: #endif