Chris@0: /* -*- c-basic-offset: 4 -*-  vi:set ts=8 sts=4 sw=4: */
Chris@0: 
Chris@0: /*
Chris@0:     A waveform viewer and audio annotation editor.
Chris@2:     Chris Cannam, Queen Mary University of London, 2005-2006
Chris@0:     
Chris@0:     This is experimental software.  Not for distribution.
Chris@0: */
Chris@0: 
Chris@0: /*
Chris@0:    This is a modified version of a source file from the 
Chris@0:    Rosegarden MIDI and audio sequencer and notation editor.
Chris@0:    This file copyright 2000-2005 Chris Cannam.
Chris@0: */
Chris@0: 
Chris@0: #ifndef _REALTIME_PLUGIN_INSTANCE_H_
Chris@0: #define _REALTIME_PLUGIN_INSTANCE_H_
Chris@0: 
Chris@0: #include <QString>
Chris@0: #include <QStringList>
Chris@0: #include <vector>
Chris@0: 
Chris@0: #include "base/RealTime.h"
Chris@0: 
Chris@0: class RealTimePluginFactory;
Chris@0: 	
Chris@0: /**
Chris@0:  * RealTimePluginInstance is a very trivial interface that an audio
Chris@0:  * process can use to refer to an instance of a plugin without needing
Chris@0:  * to know what type of plugin it is.
Chris@0:  *
Chris@0:  * The audio code calls run() on an instance that has been passed to
Chris@0:  * it, and assumes that the passing code has already initialised the
Chris@0:  * plugin, connected its inputs and outputs and so on, and that there
Chris@0:  * is an understanding in place about the sizes of the buffers in use
Chris@0:  * by the plugin.  All of this depends on the subclass implementation.
Chris@0:  */
Chris@0: 
Chris@0: // These names are taken from LADSPA, but the values are not
Chris@0: // guaranteed to match
Chris@0: 
Chris@0: namespace PortType { // ORable
Chris@0:     static const int Input   = 1;
Chris@0:     static const int Output  = 2;
Chris@0:     static const int Control = 4;
Chris@0:     static const int Audio   = 8;
Chris@0: }
Chris@0: 
Chris@0: namespace PortHint { // ORable
Chris@0:     static const int NoHint  = 0;
Chris@0:     static const int Toggled = 1;
Chris@0:     static const int Integer = 2;
Chris@0:     static const int Logarithmic = 4;
Chris@0:     static const int SampleRate = 8;
Chris@0: }
Chris@0: 
Chris@0: class RealTimePluginInstance
Chris@0: {
Chris@0: public:
Chris@0:     typedef float sample_t;
Chris@0: 
Chris@0:     virtual ~RealTimePluginInstance();
Chris@0: 
Chris@0:     virtual bool isOK() const = 0;
Chris@0: 
Chris@0:     virtual QString getIdentifier() const = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Run for one block, starting at the given time.  The start time
Chris@0:      * may be of interest to synths etc that may have queued events
Chris@0:      * waiting.  Other plugins can ignore it.
Chris@0:      */
Chris@0:     virtual void run(const RealTime &blockStartTime) = 0;
Chris@0:     
Chris@0:     virtual size_t getBufferSize() const = 0;
Chris@0: 
Chris@0:     virtual size_t getAudioInputCount() const = 0;
Chris@0:     virtual size_t getAudioOutputCount() const = 0;
Chris@0: 
Chris@0:     virtual sample_t **getAudioInputBuffers() = 0;
Chris@0:     virtual sample_t **getAudioOutputBuffers() = 0;
Chris@0: 
Chris@0:     virtual QStringList getPrograms() const { return QStringList(); }
Chris@0:     virtual QString getCurrentProgram() const { return QString(); }
Chris@0:     virtual QString getProgram(int /* bank */, int /* program */) const { return QString(); }
Chris@0:     virtual unsigned long getProgram(QString /* name */) const { return 0; } // bank << 16 + program
Chris@0:     virtual void selectProgram(QString) { }
Chris@0: 
Chris@0:     virtual unsigned int getParameterCount() const = 0;
Chris@0:     virtual void setParameterValue(unsigned int parameter, float value) = 0;
Chris@0:     virtual float getParameterValue(unsigned int parameter) const = 0;
Chris@0:     virtual float getParameterDefault(unsigned int parameter) const = 0;
Chris@0: 
Chris@0:     virtual QString configure(QString /* key */, QString /* value */) { return QString(); }
Chris@0: 
Chris@0:     virtual void sendEvent(const RealTime & /* eventTime */,
Chris@0: 			   const void * /* event */) { }
Chris@10:     virtual void clearEvents() { }
Chris@0: 
Chris@0:     virtual bool isBypassed() const = 0;
Chris@0:     virtual void setBypassed(bool value) = 0;
Chris@0: 
Chris@0:     // This should be called after setup, but while not actually playing.
Chris@0:     virtual size_t getLatency() = 0;
Chris@0: 
Chris@0:     virtual void silence() = 0;
Chris@0:     virtual void discardEvents() { }
Chris@0:     virtual void setIdealChannelCount(size_t channels) = 0; // must also silence(); may also re-instantiate
Chris@0: 
Chris@0:     void setFactory(RealTimePluginFactory *f) { m_factory = f; } // ew
Chris@0: 
Chris@0: protected:
Chris@0:     RealTimePluginInstance(RealTimePluginFactory *factory, QString identifier) :
Chris@0: 	m_factory(factory), m_identifier(identifier) { }
Chris@0: 
Chris@0:     RealTimePluginFactory *m_factory;
Chris@0:     QString m_identifier;
Chris@0: 
Chris@0:     friend class PluginFactory;
Chris@0: };
Chris@0: 
Chris@0: 
Chris@0: #endif