vamp-sdk/Plugin.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_SDK_PLUGIN_H_
00038 #define _VAMP_SDK_PLUGIN_H_
00039 
00040 #include <string>
00041 #include <vector>
00042 #include <map>
00043 
00044 #include "PluginBase.h"
00045 #include "RealTime.h"
00046 
00047 #include "plugguard.h"
00048 _VAMP_SDK_PLUGSPACE_BEGIN(Plugin.h)
00049 
00050 namespace Vamp {
00051 
00124 class Plugin : public PluginBase
00125 {
00126 public:
00127     virtual ~Plugin() { }
00128 
00141     virtual bool initialise(size_t inputChannels,
00142                             size_t stepSize,
00143                             size_t blockSize) = 0;
00144 
00150     virtual void reset() = 0;
00151 
00152     enum InputDomain { TimeDomain, FrequencyDomain };
00153     
00164     virtual InputDomain getInputDomain() const = 0;
00165 
00174     virtual size_t getPreferredBlockSize() const { return 0; }
00175 
00189     virtual size_t getPreferredStepSize() const { return 0; }
00190 
00194     virtual size_t getMinChannelCount() const { return 1; }
00195 
00199     virtual size_t getMaxChannelCount() const { return 1; }
00200 
00201     struct OutputDescriptor
00202     {
00209         std::string identifier;
00210 
00215         std::string name;
00216 
00222         std::string description;
00223 
00227         std::string unit;
00228 
00234         bool hasFixedBinCount;
00235 
00242         size_t binCount;
00243 
00248         std::vector<std::string> binNames;
00249 
00255         bool hasKnownExtents;
00256 
00261         float minValue;
00262 
00267         float maxValue;
00268 
00273         bool isQuantized;
00274 
00280         float quantizeStep;
00281 
00282         enum SampleType {
00283 
00285             OneSamplePerStep,
00286 
00288             FixedSampleRate,
00289 
00291             VariableSampleRate
00292         };
00293 
00297         SampleType sampleType;
00298 
00309         float sampleRate;
00310 
00315         bool hasDuration;
00316 
00317         OutputDescriptor() : // defaults for mandatory non-class-type members
00318             hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
00319             sampleType(OneSamplePerStep), hasDuration(false) { }
00320     };
00321 
00322     typedef std::vector<OutputDescriptor> OutputList;
00323 
00329     virtual OutputList getOutputDescriptors() const = 0;
00330 
00331     struct Feature
00332     {
00339         bool hasTimestamp;
00340 
00347         RealTime timestamp;
00348 
00355         bool hasDuration;
00356 
00362         RealTime duration;
00363         
00369         std::vector<float> values;
00370 
00374         std::string label;
00375 
00376         Feature() : // defaults for mandatory non-class-type members
00377             hasTimestamp(false), hasDuration(false) { }
00378     };
00379 
00380     typedef std::vector<Feature> FeatureList;
00381 
00382     typedef std::map<int, FeatureList> FeatureSet; // key is output no
00383 
00411     virtual FeatureSet process(const float *const *inputBuffers,
00412                                RealTime timestamp) = 0;
00413 
00418     virtual FeatureSet getRemainingFeatures() = 0;
00419 
00425     virtual std::string getType() const { return "Feature Extraction Plugin"; }
00426 
00427 protected:
00428     Plugin(float inputSampleRate) :
00429         m_inputSampleRate(inputSampleRate) { }
00430 
00431     float m_inputSampleRate;
00432 };
00433 
00434 }
00435 
00436 _VAMP_SDK_PLUGSPACE_END(Plugin.h)
00437 
00438 #endif
00439 
00440 
00441 

Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by  doxygen 1.5.6