8260c0f4e05b/code-doc/vamp-sdk_2PluginBase_8h_source.html

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