RealTimePluginInstance Class Reference

#include <RealTimePluginInstance.h>

Inherited by DSSIPluginInstance, and LADSPAPluginInstance.

Inheritance diagram for RealTimePluginInstance:

[legend]Collaboration diagram for RealTimePluginInstance:

[legend]List of all members.

---

Detailed Description

Definition at line 75 of file RealTimePluginInstance.h.

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)=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
RealTimePluginFactory *	m_factory
QString	m_identifier
ConfigurationPairMap	m_configurationData
Friends
class	PluginFactory

---

Member Typedef Documentation

typedef float RealTimePluginInstance::sample_t

Definition at line 78 of file RealTimePluginInstance.h.

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

Definition at line 137 of file RealTimePluginInstance.h.

---

Constructor & Destructor Documentation

RealTimePluginInstance::~RealTimePluginInstance

(

)

[virtual]

Definition at line 29 of file RealTimePluginInstance.cpp.

References m_factory, m_identifier, and RealTimePluginFactory::releasePlugin().

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

Definition at line 143 of file RealTimePluginInstance.h.

---

Member Function Documentation

virtual bool RealTimePluginInstance::isOK

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual QString RealTimePluginInstance::getPluginIdentifier

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual void RealTimePluginInstance::run

(

const Vamp::RealTime &

blockStartTime

)

[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.

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), AudioGenerator::mixNoteModel(), AudioGenerator::mixSparseOneDimensionalModel(), and RealTimeEffectModelTransformer::run().

virtual size_t RealTimePluginInstance::getBufferSize

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), and RealTimeEffectModelTransformer::run().

virtual size_t RealTimePluginInstance::getAudioInputCount

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), and RealTimeEffectModelTransformer::run().

virtual size_t RealTimePluginInstance::getAudioOutputCount

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), AudioGenerator::mixNoteModel(), AudioGenerator::mixSparseOneDimensionalModel(), and RealTimeEffectModelTransformer::RealTimeEffectModelTransformer().

virtual sample_t** RealTimePluginInstance::getAudioInputBuffers

(

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), and RealTimeEffectModelTransformer::run().

virtual sample_t** RealTimePluginInstance::getAudioOutputBuffers

(

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioCallbackPlaySource::applyAuditioningEffect(), AudioGenerator::mixNoteModel(), AudioGenerator::mixSparseOneDimensionalModel(), and RealTimeEffectModelTransformer::run().

virtual size_t RealTimePluginInstance::getControlOutputCount

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), and RealTimeEffectModelTransformer::run().

virtual float RealTimePluginInstance::getControlOutputValue

(

size_t

n

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by RealTimeEffectModelTransformer::run().

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

Reimplemented in DSSIPluginInstance.

Definition at line 107 of file RealTimePluginInstance.h.

Referenced by AudioGenerator::loadPlugin().

virtual unsigned int RealTimePluginInstance::getParameterCount

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioGenerator::loadPlugin().

virtual void RealTimePluginInstance::setParameterValue	(	unsigned int	parameter,
		float	value
	)			[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioGenerator::loadPlugin().

virtual float RealTimePluginInstance::getParameterValue

(

unsigned int

parameter

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual float RealTimePluginInstance::getParameterDefault

(

unsigned int

parameter

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioGenerator::loadPlugin().

virtual int RealTimePluginInstance::getParameterDisplayHint

(

unsigned int

parameter

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by PluginParameterBox::populate().

virtual std::string RealTimePluginInstance::configure	(	std::string	,
		std::string
	)			[inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 117 of file RealTimePluginInstance.h.

Referenced by PluginXml::setParameters(), TransformFactory::setPluginParameters(), and AudioGenerator::setSampleDir().

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

Reimplemented in DSSIPluginInstance.

Definition at line 119 of file RealTimePluginInstance.h.

Referenced by AudioGenerator::mixNoteModel(), and AudioGenerator::mixSparseOneDimensionalModel().

virtual void RealTimePluginInstance::clearEvents

(

)

[inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 121 of file RealTimePluginInstance.h.

virtual bool RealTimePluginInstance::isBypassed

(

)

const [pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual void RealTimePluginInstance::setBypassed

(

bool

value

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual size_t RealTimePluginInstance::getLatency

(

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioGenerator::mixNoteModel(), AudioGenerator::mixSparseOneDimensionalModel(), and RealTimeEffectModelTransformer::run().

virtual void RealTimePluginInstance::silence

(

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

virtual void RealTimePluginInstance::discardEvents

(

)

[inline, virtual]

Reimplemented in DSSIPluginInstance.

Definition at line 130 of file RealTimePluginInstance.h.

virtual void RealTimePluginInstance::setIdealChannelCount

(

size_t

channels

)

[pure virtual]

Implemented in DSSIPluginInstance, and LADSPAPluginInstance.

Referenced by AudioGenerator::loadPlugin().

void RealTimePluginInstance::setFactory

(

RealTimePluginFactory *

f

)

[inline]

Definition at line 133 of file RealTimePluginInstance.h.

References m_factory.

virtual std::string RealTimePluginInstance::getType

(

)

const [inline, virtual]

Reimplemented in DSSIPluginInstance, and LADSPAPluginInstance.

Definition at line 135 of file RealTimePluginInstance.h.

virtual ConfigurationPairMap RealTimePluginInstance::getConfigurePairs

(

)

[inline, virtual]

Definition at line 138 of file RealTimePluginInstance.h.

References m_configurationData.

Referenced by TransformFactory::setParametersFromPlugin(), and PluginXml::toXml().

---

Friends And Related Function Documentation

friend class PluginFactory [friend]

Definition at line 151 of file RealTimePluginInstance.h.

---

Member Data Documentation

RealTimePluginFactory* RealTimePluginInstance::m_factory [protected]

Definition at line 146 of file RealTimePluginInstance.h.

Referenced by LADSPAPluginInstance::connectPorts(), DSSIPluginInstance::connectPorts(), LADSPAPluginInstance::getParameterDefault(), DSSIPluginInstance::getParameterDefault(), LADSPAPluginInstance::getParameterDescriptors(), DSSIPluginInstance::getParameterDescriptors(), LADSPAPluginInstance::getParameterDisplayHint(), DSSIPluginInstance::getParameterDisplayHint(), setFactory(), LADSPAPluginInstance::setParameterValue(), DSSIPluginInstance::setParameterValue(), and ~RealTimePluginInstance().

QString RealTimePluginInstance::m_identifier [protected]

Definition at line 147 of file RealTimePluginInstance.h.

Referenced by DSSIPluginInstance::cleanup(), DSSIPluginInstance::deactivate(), DSSIPluginInstance::detachFromGroup(), LADSPAPluginInstance::getPluginIdentifier(), DSSIPluginInstance::getPluginIdentifier(), DSSIPluginInstance::initialiseGroupMembership(), DSSIPluginInstance::runGrouped(), and ~RealTimePluginInstance().

ConfigurationPairMap RealTimePluginInstance::m_configurationData [protected]

Definition at line 149 of file RealTimePluginInstance.h.

Referenced by DSSIPluginInstance::configure(), and getConfigurePairs().

---

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

• RealTimePluginInstance.h
• RealTimePluginInstance.cpp

---