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