cannam@21:
vamp-sdk/PluginBase.h

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@21: 00002 
cannam@21: 00003 /*
cannam@21: 00004     Vamp
cannam@21: 00005 
cannam@21: 00006     An API for audio analysis and feature extraction plugins.
cannam@21: 00007 
cannam@21: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@21: 00009     Copyright 2006 Chris Cannam.
cannam@21: 00010   
cannam@21: 00011     Permission is hereby granted, free of charge, to any person
cannam@21: 00012     obtaining a copy of this software and associated documentation
cannam@21: 00013     files (the "Software"), to deal in the Software without
cannam@21: 00014     restriction, including without limitation the rights to use, copy,
cannam@21: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@21: 00016     of the Software, and to permit persons to whom the Software is
cannam@21: 00017     furnished to do so, subject to the following conditions:
cannam@21: 00018 
cannam@21: 00019     The above copyright notice and this permission notice shall be
cannam@21: 00020     included in all copies or substantial portions of the Software.
cannam@21: 00021 
cannam@21: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@21: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@21: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@21: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@21: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@21: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@21: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@21: 00029 
cannam@21: 00030     Except as contained in this notice, the names of the Centre for
cannam@21: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@21: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@21: 00033     use or other dealings in this Software without prior written
cannam@21: 00034     authorization.
cannam@21: 00035 */
cannam@21: 00036 
cannam@21: 00037 #ifndef _VAMP_SDK_PLUGIN_BASE_H_
cannam@21: 00038 #define _VAMP_SDK_PLUGIN_BASE_H_
cannam@21: 00039 
cannam@21: 00040 #include <string>
cannam@21: 00041 #include <vector>
cannam@21: 00042 
cannam@21: 00043 #define VAMP_SDK_VERSION "2.0"
cannam@21: 00044 #define VAMP_SDK_MAJOR_VERSION 2
cannam@21: 00045 #define VAMP_SDK_MINOR_VERSION 0
cannam@21: 00046 
cannam@21: 00047 #include "plugguard.h"
cannam@21: 00048 _VAMP_SDK_PLUGSPACE_BEGIN(PluginBase.h)
cannam@21: 00049 
cannam@21: 00050 namespace Vamp {
cannam@21: 00051 
cannam@21: 00064 class PluginBase 
cannam@21: 00065 {
cannam@21: 00066 public:
cannam@35: 00067     virtual ~PluginBase() { }
cannam@21: 00068 
cannam@35: 00072     virtual unsigned int getVampApiVersion() const { return 2; }
cannam@21: 00073 
cannam@21: 00087     virtual std::string getIdentifier() const = 0;
cannam@21: 00088 
cannam@21: 00097     virtual std::string getName() const = 0;
cannam@21: 00098 
cannam@21: 00107     virtual std::string getDescription() const = 0;
cannam@21: 00108     
cannam@21: 00115     virtual std::string getMaker() const = 0;
cannam@21: 00116 
cannam@21: 00122     virtual std::string getCopyright() const = 0;
cannam@21: 00123 
cannam@21: 00127     virtual int getPluginVersion() const = 0;
cannam@21: 00128 
cannam@21: 00129 
cannam@21: 00130     struct ParameterDescriptor
cannam@21: 00131     {
cannam@35: 00137         std::string identifier;
cannam@21: 00138 
cannam@35: 00142         std::string name;
cannam@21: 00143 
cannam@35: 00148         std::string description;
cannam@21: 00149 
cannam@35: 00153         std::string unit;
cannam@21: 00154 
cannam@35: 00158         float minValue;
cannam@21: 00159 
cannam@35: 00163         float maxValue;
cannam@21: 00164 
cannam@35: 00171         float defaultValue;
cannam@21: 00172         
cannam@35: 00177         bool isQuantized;
cannam@21: 00178 
cannam@35: 00184         float quantizeStep;
cannam@21: 00185 
cannam@35: 00197         std::vector<std::string> valueNames;
cannam@21: 00198 
cannam@35: 00199         ParameterDescriptor() : // the defaults are invalid: you must set them
cannam@21: 00200             minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
cannam@21: 00201     };
cannam@21: 00202 
cannam@21: 00203     typedef std::vector<ParameterDescriptor> ParameterList;
cannam@21: 00204 
cannam@35: 00208     virtual ParameterList getParameterDescriptors() const {
cannam@21: 00209         return ParameterList();
cannam@21: 00210     }
cannam@21: 00211 
cannam@35: 00216     virtual float getParameter(std::string) const { return 0.0; }
cannam@21: 00217 
cannam@35: 00222     virtual void setParameter(std::string, float) { } 
cannam@21: 00223 
cannam@21: 00224     
cannam@21: 00225     typedef std::vector<std::string> ProgramList;
cannam@21: 00226 
cannam@35: 00237     virtual ProgramList getPrograms() const { return ProgramList(); }
cannam@21: 00238 
cannam@35: 00242     virtual std::string getCurrentProgram() const { return ""; }
cannam@21: 00243 
cannam@35: 00248     virtual void selectProgram(std::string) { }
cannam@21: 00249 
cannam@21: 00255     virtual std::string getType() const = 0;
cannam@21: 00256 };
cannam@21: 00257 
cannam@21: 00258 }
cannam@21: 00259 
cannam@21: 00260 _VAMP_SDK_PLUGSPACE_END(PluginBase.h)
cannam@21: 00261 
cannam@21: 00262 #endif
cannam@21: