svcore  1.9
RealTimePluginInstance Class Reference

#include <RealTimePluginInstance.h>

Inheritance diagram for RealTimePluginInstance:
Collaboration diagram for RealTimePluginInstance:

List of all members.

Public Types

typedef float sample_t
typedef std::map< std::string,
std::string > 
ConfigurationPairMap

Public Member Functions

virtual ~RealTimePluginInstance ()
virtual bool isOK () const =0
virtual QString getPluginIdentifier () const =0
virtual void run (const Vamp::RealTime &blockStartTime, size_t count=0)=0
 Run for one block, starting at the given time.
virtual size_t getBufferSize () const =0
virtual size_t getAudioInputCount () const =0
virtual size_t getAudioOutputCount () const =0
virtual sample_t ** getAudioInputBuffers ()=0
virtual sample_t ** getAudioOutputBuffers ()=0
virtual size_t getControlOutputCount () const =0
virtual float getControlOutputValue (size_t n) const =0
virtual std::string getProgram (int, int) const
virtual unsigned int getParameterCount () const =0
virtual void setParameterValue (unsigned int parameter, float value)=0
virtual float getParameterValue (unsigned int parameter) const =0
virtual float getParameterDefault (unsigned int parameter) const =0
virtual int getParameterDisplayHint (unsigned int parameter) const =0
virtual std::string configure (std::string, std::string)
virtual void sendEvent (const Vamp::RealTime &, const void *)
virtual void clearEvents ()
virtual bool isBypassed () const =0
virtual void setBypassed (bool value)=0
virtual size_t getLatency ()=0
virtual void silence ()=0
virtual void discardEvents ()
virtual void setIdealChannelCount (size_t channels)=0
void setFactory (RealTimePluginFactory *f)
virtual std::string getType () const
virtual ConfigurationPairMap getConfigurePairs ()

Protected Member Functions

 RealTimePluginInstance (RealTimePluginFactory *factory, QString identifier)

Protected Attributes

RealTimePluginFactorym_factory
QString m_identifier
ConfigurationPairMap m_configurationData

Friends

class PluginFactory

Detailed Description

Definition at line 77 of file RealTimePluginInstance.h.


Member Typedef Documentation

Definition at line 80 of file RealTimePluginInstance.h.

typedef std::map<std::string, std::string> RealTimePluginInstance::ConfigurationPairMap

Definition at line 141 of file RealTimePluginInstance.h.


Constructor & Destructor Documentation

RealTimePluginInstance::RealTimePluginInstance ( RealTimePluginFactory factory,
QString  identifier 
) [inline, protected]

Definition at line 147 of file RealTimePluginInstance.h.


Member Function Documentation

virtual bool RealTimePluginInstance::isOK ( ) const [pure virtual]
virtual QString RealTimePluginInstance::getPluginIdentifier ( ) const [pure virtual]
virtual void RealTimePluginInstance::run ( const Vamp::RealTime &  blockStartTime,
size_t  count = 0 
) [pure virtual]

Run for one block, starting at the given time.

The start time may be of interest to synths etc that may have queued events waiting. Other plugins can ignore it. The count, if zero, defaults to our fixed buffer size.

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by RealTimeEffectModelTransformer::run().

virtual size_t RealTimePluginInstance::getBufferSize ( ) const [pure virtual]
virtual size_t RealTimePluginInstance::getAudioInputCount ( ) const [pure virtual]
virtual float RealTimePluginInstance::getControlOutputValue ( size_t  n) const [pure virtual]
virtual std::string RealTimePluginInstance::getProgram ( int  ,
int   
) const [inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 111 of file RealTimePluginInstance.h.

virtual unsigned int RealTimePluginInstance::getParameterCount ( ) const [pure virtual]
virtual void RealTimePluginInstance::setParameterValue ( unsigned int  parameter,
float  value 
) [pure virtual]
virtual float RealTimePluginInstance::getParameterValue ( unsigned int  parameter) const [pure virtual]
virtual float RealTimePluginInstance::getParameterDefault ( unsigned int  parameter) const [pure virtual]
virtual int RealTimePluginInstance::getParameterDisplayHint ( unsigned int  parameter) const [pure virtual]
virtual std::string RealTimePluginInstance::configure ( std::string  ,
std::string   
) [inline, virtual]
virtual void RealTimePluginInstance::sendEvent ( const Vamp::RealTime &  ,
const void *   
) [inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 123 of file RealTimePluginInstance.h.

virtual void RealTimePluginInstance::clearEvents ( ) [inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 125 of file RealTimePluginInstance.h.

virtual bool RealTimePluginInstance::isBypassed ( ) const [pure virtual]
virtual void RealTimePluginInstance::setBypassed ( bool  value) [pure virtual]
virtual size_t RealTimePluginInstance::getLatency ( ) [pure virtual]
virtual void RealTimePluginInstance::silence ( ) [pure virtual]
virtual void RealTimePluginInstance::discardEvents ( ) [inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 134 of file RealTimePluginInstance.h.

virtual void RealTimePluginInstance::setIdealChannelCount ( size_t  channels) [pure virtual]

Definition at line 137 of file RealTimePluginInstance.h.

References m_factory.

virtual std::string RealTimePluginInstance::getType ( ) const [inline, virtual]

Reimplemented in DSSIPluginInstance, and LADSPAPluginInstance.

Definition at line 139 of file RealTimePluginInstance.h.


Friends And Related Function Documentation

friend class PluginFactory [friend]

Definition at line 155 of file RealTimePluginInstance.h.


Member Data Documentation


The documentation for this class was generated from the following files: