vamp-sdk/PluginBase.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_BASE_H_
#define _VAMP_SDK_PLUGIN_BASE_H_

#include <string>
#include <vector>

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

namespace Vamp {

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

    virtual unsigned int getVampApiVersion() const { return 2; }

    virtual std::string getIdentifier() const = 0;

    virtual std::string getName() const = 0;

    virtual std::string getDescription() const = 0;
    
    virtual std::string getMaker() const = 0;

    virtual std::string getCopyright() const = 0;

    virtual int getPluginVersion() const = 0;


    struct ParameterDescriptor
    {
        std::string identifier;

        std::string name;

        std::string description;

        std::string unit;

        float minValue;

        float maxValue;

        float defaultValue;
        
        bool isQuantized;

        float quantizeStep;

        std::vector<std::string> valueNames;

        ParameterDescriptor() : // the defaults are invalid: you must set them
            minValue(0), 
            maxValue(0), 
            defaultValue(0), 
            isQuantized(false),
            quantizeStep(0) { }
    };

    typedef std::vector<ParameterDescriptor> ParameterList;

    virtual ParameterList getParameterDescriptors() const {
        return ParameterList();
    }

    virtual float getParameter(std::string) const { return 0.0; }

    virtual void setParameter(std::string, float) { } 

    
    typedef std::vector<std::string> ProgramList;

    virtual ProgramList getPrograms() const { return ProgramList(); }

    virtual std::string getCurrentProgram() const { return ""; }

    virtual void selectProgram(std::string) { }

    virtual std::string getType() const = 0;
};

}

_VAMP_SDK_PLUGSPACE_END(PluginBase.h)

#endif