VampPluginSDK: PluginBase.h Source File

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     Copyright 2006 Chris Cannam.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 #ifndef _VAMP_PLUGIN_BASE_H_
cannam@0: 00038 #define _VAMP_PLUGIN_BASE_H_
cannam@0: 00039 
cannam@0: 00040 #include <string>
cannam@0: 00041 #include <vector>
cannam@0: 00042 
cannam@0: 00043 #define VAMP_SDK_VERSION "1.2"
cannam@0: 00044 
cannam@0: 00045 namespace Vamp {
cannam@0: 00046 
cannam@0: 00059 class PluginBase 
cannam@0: 00060 {
cannam@0: 00061 public:
cannam@0: 00062     virtual ~PluginBase() { }
cannam@0: 00063 
cannam@0: 00067     virtual unsigned int getVampApiVersion() const { return 1; }
cannam@0: 00068 
cannam@0: 00082     virtual std::string getIdentifier() const = 0;
cannam@0: 00083 
cannam@0: 00092     virtual std::string getName() const = 0;
cannam@0: 00093 
cannam@0: 00102     virtual std::string getDescription() const = 0;
cannam@0: 00103     
cannam@0: 00110     virtual std::string getMaker() const = 0;
cannam@0: 00111 
cannam@0: 00117     virtual std::string getCopyright() const = 0;
cannam@0: 00118 
cannam@0: 00122     virtual int getPluginVersion() const = 0;
cannam@0: 00123 
cannam@0: 00124 
cannam@0: 00125     struct ParameterDescriptor
cannam@0: 00126     {
cannam@0: 00132         std::string identifier;
cannam@0: 00133 
cannam@0: 00137         std::string name;
cannam@0: 00138 
cannam@0: 00143         std::string description;
cannam@0: 00144 
cannam@0: 00148         std::string unit;
cannam@0: 00149 
cannam@0: 00153         float minValue;
cannam@0: 00154 
cannam@0: 00158         float maxValue;
cannam@0: 00159 
cannam@0: 00166         float defaultValue;
cannam@0: 00167         
cannam@0: 00172         bool isQuantized;
cannam@0: 00173 
cannam@0: 00179         float quantizeStep;
cannam@0: 00180 
cannam@0: 00192         std::vector<std::string> valueNames;
cannam@0: 00193     };
cannam@0: 00194 
cannam@0: 00195     typedef std::vector<ParameterDescriptor> ParameterList;
cannam@0: 00196 
cannam@0: 00200     virtual ParameterList getParameterDescriptors() const {
cannam@0: 00201         return ParameterList();
cannam@0: 00202     }
cannam@0: 00203 
cannam@0: 00208     virtual float getParameter(std::string) const { return 0.0; }
cannam@0: 00209 
cannam@0: 00214     virtual void setParameter(std::string, float) { } 
cannam@0: 00215 
cannam@0: 00216     
cannam@0: 00217     typedef std::vector<std::string> ProgramList;
cannam@0: 00218 
cannam@0: 00229     virtual ProgramList getPrograms() const { return ProgramList(); }
cannam@0: 00230 
cannam@0: 00234     virtual std::string getCurrentProgram() const { return ""; }
cannam@0: 00235 
cannam@0: 00240     virtual void selectProgram(std::string) { }
cannam@0: 00241 
cannam@0: 00247     virtual std::string getType() const = 0;
cannam@0: 00248 };
cannam@0: 00249 
cannam@0: 00250 }
cannam@0: 00251 
cannam@0: 00252 #endif
cannam@0: