PluginBase.h

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

Generated on Thu Jun 19 16:06:38 2008 for VampPluginSDK by  doxygen 1.5.6