vamp-sdk/Plugin.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Vamp

    An API for audio analysis and feature extraction plugins.

    Centre for Digital Music, Queen Mary, University of London.
    Copyright 2006 Chris Cannam.
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Except as contained in this notice, the names of the Centre for
    Digital Music; Queen Mary, University of London; and Chris Cannam
    shall not be used in advertising or otherwise to promote the sale,
    use or other dealings in this Software without prior written
    authorization.
*/

#ifndef _VAMP_SDK_PLUGIN_H_
#define _VAMP_SDK_PLUGIN_H_

#include <string>
#include <vector>
#include <map>

#include "PluginBase.h"
#include "RealTime.h"

#include "plugguard.h"
_VAMP_SDK_PLUGSPACE_BEGIN(Plugin.h)

namespace Vamp {

class Plugin : public PluginBase
{
public:
    virtual ~Plugin() { }

    virtual bool initialise(size_t inputChannels,
                            size_t stepSize,
                            size_t blockSize) = 0;

    virtual void reset() = 0;

    enum InputDomain { TimeDomain, FrequencyDomain };
    
    virtual InputDomain getInputDomain() const = 0;

    virtual size_t getPreferredBlockSize() const { return 0; }

    virtual size_t getPreferredStepSize() const { return 0; }

    virtual size_t getMinChannelCount() const { return 1; }

    virtual size_t getMaxChannelCount() const { return 1; }

    struct OutputDescriptor
    {
        std::string identifier;

        std::string name;

        std::string description;

        std::string unit;

        bool hasFixedBinCount;

        size_t binCount;

        std::vector<std::string> binNames;

        bool hasKnownExtents;

        float minValue;

        float maxValue;

        bool isQuantized;

        float quantizeStep;

        enum SampleType {

            OneSamplePerStep,

            FixedSampleRate,

            VariableSampleRate
        };

        SampleType sampleType;

        float sampleRate;

        bool hasDuration;

        OutputDescriptor() : // defaults for mandatory non-class-type members
            hasFixedBinCount(false),
            binCount(0),
            hasKnownExtents(false),
            minValue(0),
            maxValue(0),
            isQuantized(false),
            quantizeStep(0),
            sampleType(OneSamplePerStep), 
            sampleRate(0), 
            hasDuration(false) { }
    };

    typedef std::vector<OutputDescriptor> OutputList;

    virtual OutputList getOutputDescriptors() const = 0;

    struct Feature
    {
        bool hasTimestamp;

        RealTime timestamp;

        bool hasDuration;

        RealTime duration;
        
        std::vector<float> values;

        std::string label;

        Feature() : // defaults for mandatory non-class-type members
            hasTimestamp(false), hasDuration(false) { }
    };

    typedef std::vector<Feature> FeatureList;

    typedef std::map<int, FeatureList> FeatureSet; // key is output no

    virtual FeatureSet process(const float *const *inputBuffers,
                               RealTime timestamp) = 0;

    virtual FeatureSet getRemainingFeatures() = 0;

    virtual std::string getType() const { return "Feature Extraction Plugin"; }

    float getInputSampleRate() const { return m_inputSampleRate; }
    
protected:
    Plugin(float inputSampleRate) :
        m_inputSampleRate(inputSampleRate) { }

    float m_inputSampleRate;
};

}

_VAMP_SDK_PLUGSPACE_END(Plugin.h)

#endif