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