svcore  1.9
LADSPAPluginInstance Class Reference

#include <LADSPAPluginInstance.h>

Inheritance diagram for LADSPAPluginInstance:
Collaboration diagram for LADSPAPluginInstance:

List of all members.

Public Types

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

Public Member Functions

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

Protected Member Functions

 LADSPAPluginInstance (RealTimePluginFactory *factory, int client, QString identifier, int position, unsigned long sampleRate, size_t blockSize, int idealChannelCount, const LADSPA_Descriptor *descriptor)
void init (int idealChannelCount=0)
void instantiate (unsigned long sampleRate)
void cleanup ()
void activate ()
void deactivate ()
void connectPorts ()

Protected Attributes

int m_client
int m_position
std::vector< LADSPA_Handle > m_instanceHandles
size_t m_instanceCount
const LADSPA_Descriptor * m_descriptor
std::vector< std::pair
< unsigned long, LADSPA_Data * > > 
m_controlPortsIn
std::vector< std::pair
< unsigned long, LADSPA_Data * > > 
m_controlPortsOut
std::vector< int > m_audioPortsIn
std::vector< int > m_audioPortsOut
size_t m_blockSize
sample_t ** m_inputBuffers
sample_t ** m_outputBuffers
bool m_ownBuffers
size_t m_sampleRate
float * m_latencyPort
bool m_run
bool m_bypassed
RealTimePluginFactorym_factory
QString m_identifier
ConfigurationPairMap m_configurationData

Friends

class LADSPAPluginFactory
class PluginFactory

Detailed Description

Definition at line 35 of file LADSPAPluginInstance.h.


Member Typedef Documentation

typedef float RealTimePluginInstance::sample_t [inherited]

Definition at line 80 of file RealTimePluginInstance.h.

typedef std::map<std::string, std::string> RealTimePluginInstance::ConfigurationPairMap [inherited]

Definition at line 141 of file RealTimePluginInstance.h.


Constructor & Destructor Documentation

LADSPAPluginInstance::LADSPAPluginInstance ( RealTimePluginFactory factory,
int  client,
QString  identifier,
int  position,
unsigned long  sampleRate,
size_t  blockSize,
int  idealChannelCount,
const LADSPA_Descriptor *  descriptor 
) [protected]

Member Function Documentation

virtual bool LADSPAPluginInstance::isOK ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 40 of file LADSPAPluginInstance.h.

References m_instanceHandles.

Referenced by LADSPAPluginInstance(), setIdealChannelCount(), and silence().

int LADSPAPluginInstance::getClientId ( ) const [inline]

Definition at line 42 of file LADSPAPluginInstance.h.

References m_client.

virtual QString LADSPAPluginInstance::getPluginIdentifier ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 43 of file LADSPAPluginInstance.h.

References RealTimePluginInstance::m_identifier.

int LADSPAPluginInstance::getPosition ( ) const [inline]

Definition at line 44 of file LADSPAPluginInstance.h.

References m_position.

std::string LADSPAPluginInstance::getIdentifier ( ) const [virtual]

Definition at line 86 of file LADSPAPluginInstance.cpp.

References m_descriptor.

std::string LADSPAPluginInstance::getName ( ) const [virtual]

Definition at line 92 of file LADSPAPluginInstance.cpp.

References m_descriptor.

std::string LADSPAPluginInstance::getDescription ( ) const [virtual]

Definition at line 98 of file LADSPAPluginInstance.cpp.

std::string LADSPAPluginInstance::getMaker ( ) const [virtual]

Definition at line 104 of file LADSPAPluginInstance.cpp.

References m_descriptor.

int LADSPAPluginInstance::getPluginVersion ( ) const [virtual]

Definition at line 110 of file LADSPAPluginInstance.cpp.

std::string LADSPAPluginInstance::getCopyright ( ) const [virtual]

Definition at line 116 of file LADSPAPluginInstance.cpp.

References m_descriptor.

void LADSPAPluginInstance::run ( const Vamp::RealTime &  blockStartTime,
size_t  count = 0 
) [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.

Implements RealTimePluginInstance.

Definition at line 534 of file LADSPAPluginInstance.cpp.

References m_blockSize, m_descriptor, m_instanceHandles, and m_run.

Referenced by getLatency().

unsigned int LADSPAPluginInstance::getParameterCount ( ) const [virtual]

Implements RealTimePluginInstance.

Definition at line 468 of file LADSPAPluginInstance.cpp.

References m_controlPortsIn.

float LADSPAPluginInstance::getParameterValue ( unsigned int  parameter) const [virtual]

Implements RealTimePluginInstance.

Definition at line 501 of file LADSPAPluginInstance.cpp.

References m_controlPortsIn.

Referenced by getParameter().

float LADSPAPluginInstance::getParameter ( std::string  id) const [virtual]

Definition at line 194 of file LADSPAPluginInstance.cpp.

References getParameterValue(), m_controlPortsIn, and m_descriptor.

void LADSPAPluginInstance::setParameter ( std::string  id,
float  value 
) [virtual]

Definition at line 206 of file LADSPAPluginInstance.cpp.

References m_controlPortsIn, m_descriptor, setParameterValue(), and SVDEBUG.

virtual size_t LADSPAPluginInstance::getBufferSize ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 65 of file LADSPAPluginInstance.h.

References m_blockSize.

virtual size_t LADSPAPluginInstance::getAudioInputCount ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 66 of file LADSPAPluginInstance.h.

References m_audioPortsIn, and m_instanceCount.

Referenced by getLatency().

virtual size_t LADSPAPluginInstance::getAudioOutputCount ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 67 of file LADSPAPluginInstance.h.

References m_audioPortsOut, and m_instanceCount.

virtual sample_t** LADSPAPluginInstance::getAudioInputBuffers ( ) [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 68 of file LADSPAPluginInstance.h.

References m_inputBuffers.

virtual sample_t** LADSPAPluginInstance::getAudioOutputBuffers ( ) [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 69 of file LADSPAPluginInstance.h.

References m_outputBuffers.

virtual size_t LADSPAPluginInstance::getControlOutputCount ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 71 of file LADSPAPluginInstance.h.

References m_controlPortsOut.

float LADSPAPluginInstance::getControlOutputValue ( size_t  n) const [virtual]

Implements RealTimePluginInstance.

Definition at line 494 of file LADSPAPluginInstance.cpp.

References m_controlPortsOut.

virtual bool LADSPAPluginInstance::isBypassed ( ) const [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 74 of file LADSPAPluginInstance.h.

References m_bypassed.

virtual void LADSPAPluginInstance::setBypassed ( bool  bypassed) [inline, virtual]

Implements RealTimePluginInstance.

Definition at line 75 of file LADSPAPluginInstance.h.

References m_bypassed.

void LADSPAPluginInstance::silence ( ) [virtual]

Implements RealTimePluginInstance.

Definition at line 310 of file LADSPAPluginInstance.cpp.

References activate(), deactivate(), and isOK().

Referenced by setIdealChannelCount().

void LADSPAPluginInstance::setIdealChannelCount ( size_t  channels) [virtual]

!! don't we need to reallocate inputBuffers and outputBuffers?

Implements RealTimePluginInstance.

Definition at line 319 of file LADSPAPluginInstance.cpp.

References activate(), cleanup(), connectPorts(), deactivate(), instantiate(), isOK(), m_audioPortsIn, m_instanceCount, m_sampleRate, and silence().

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

Reimplemented from RealTimePluginInstance.

Definition at line 82 of file LADSPAPluginInstance.h.

void LADSPAPluginInstance::init ( int  idealChannelCount = 0) [protected]
void LADSPAPluginInstance::instantiate ( unsigned long  sampleRate) [protected]
void LADSPAPluginInstance::cleanup ( ) [protected]

Definition at line 561 of file LADSPAPluginInstance.cpp.

References m_descriptor, and m_instanceHandles.

Referenced by setIdealChannelCount(), and ~LADSPAPluginInstance().

void LADSPAPluginInstance::activate ( ) [protected]

Definition at line 404 of file LADSPAPluginInstance.cpp.

References m_descriptor, and m_instanceHandles.

Referenced by LADSPAPluginInstance(), setIdealChannelCount(), and silence().

void LADSPAPluginInstance::deactivate ( ) [protected]

Definition at line 550 of file LADSPAPluginInstance.cpp.

References m_descriptor, and m_instanceHandles.

Referenced by setIdealChannelCount(), silence(), and ~LADSPAPluginInstance().

virtual std::string RealTimePluginInstance::getProgram ( int  ,
int   
) const [inline, virtual, inherited]

Reimplemented in DSSIPluginInstance.

Definition at line 111 of file RealTimePluginInstance.h.

virtual std::string RealTimePluginInstance::configure ( std::string  ,
std::string   
) [inline, virtual, inherited]
virtual void RealTimePluginInstance::sendEvent ( const Vamp::RealTime &  ,
const void *   
) [inline, virtual, inherited]

Reimplemented in DSSIPluginInstance.

Definition at line 123 of file RealTimePluginInstance.h.

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

Reimplemented in DSSIPluginInstance.

Definition at line 125 of file RealTimePluginInstance.h.

virtual void RealTimePluginInstance::discardEvents ( ) [inline, virtual, inherited]

Reimplemented in DSSIPluginInstance.

Definition at line 134 of file RealTimePluginInstance.h.

void RealTimePluginInstance::setFactory ( RealTimePluginFactory f) [inline, inherited]

Definition at line 137 of file RealTimePluginInstance.h.

References RealTimePluginInstance::m_factory.


Friends And Related Function Documentation

friend class LADSPAPluginFactory [friend]

Definition at line 86 of file LADSPAPluginInstance.h.

friend class PluginFactory [friend, inherited]

Definition at line 155 of file RealTimePluginInstance.h.


Member Data Documentation

Definition at line 109 of file LADSPAPluginInstance.h.

Referenced by getClientId().

Definition at line 110 of file LADSPAPluginInstance.h.

Referenced by getPosition().

std::vector<LADSPA_Handle> LADSPAPluginInstance::m_instanceHandles [protected]
std::vector<std::pair<unsigned long, LADSPA_Data*> > LADSPAPluginInstance::m_controlPortsOut [protected]

Definition at line 121 of file LADSPAPluginInstance.h.

Referenced by getBufferSize(), getLatency(), and run().

Definition at line 124 of file LADSPAPluginInstance.h.

Referenced by LADSPAPluginInstance(), and ~LADSPAPluginInstance().

Definition at line 125 of file LADSPAPluginInstance.h.

Referenced by setIdealChannelCount().

Definition at line 126 of file LADSPAPluginInstance.h.

Referenced by getLatency(), and init().

bool LADSPAPluginInstance::m_run [protected]

Definition at line 127 of file LADSPAPluginInstance.h.

Referenced by getLatency(), and run().

Definition at line 129 of file LADSPAPluginInstance.h.

Referenced by isBypassed(), and setBypassed().


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