RealTimePluginFactory Class Reference

#include <RealTimePluginFactory.h>

Inherited by LADSPAPluginFactory.

Inheritance diagram for RealTimePluginFactory:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 46 of file RealTimePluginFactory.h.

Public Member Functions

virtual ~RealTimePluginFactory ()
virtual void discoverPlugins ()=0
 Look up the plugin path and find the plugins in it.
virtual const std::vector<
QString > & 
getPluginIdentifiers () const=0
 Return a reference to a list of all plugin identifiers that can be created by this factory.
virtual void enumeratePlugins (std::vector< QString > &list)=0
 Append to the given list descriptions of all the available plugins and their ports.
virtual const RealTimePluginDescriptorgetPluginDescriptor (QString identifier) const=0
 Get some basic information about a plugin (rapidly).
virtual RealTimePluginInstanceinstantiatePlugin (QString identifier, int clientId, int position, unsigned int sampleRate, unsigned int blockSize, unsigned int channels)=0
 Instantiate a plugin.
virtual QString getPluginCategory (QString identifier)=0
 Get category metadata about a plugin (without instantiating it).

Static Public Member Functions

static RealTimePluginFactoryinstance (QString pluginType)
static RealTimePluginFactoryinstanceFor (QString identifier)
static std::vector< QString > getAllPluginIdentifiers ()
static void enumerateAllPlugins (std::vector< QString > &)
static void setSampleRate (int sampleRate)

Protected Member Functions

 RealTimePluginFactory ()
virtual void releasePlugin (RealTimePluginInstance *, QString identifier)=0

Static Protected Attributes

static int m_sampleRate

Friends

class RealTimePluginInstance


Constructor & Destructor Documentation

RealTimePluginFactory::~RealTimePluginFactory (  )  [virtual]

Definition at line 37 of file RealTimePluginFactory.cpp.

RealTimePluginFactory::RealTimePluginFactory (  )  [inline, protected]

Definition at line 98 of file RealTimePluginFactory.h.


Member Function Documentation

RealTimePluginFactory * RealTimePluginFactory::instance ( QString  pluginType  )  [static]

Definition at line 42 of file RealTimePluginFactory.cpp.

References _dssiInstance, _ladspaInstance, and LADSPAPluginFactory::discoverPlugins().

Referenced by enumerateAllPlugins(), getAllPluginIdentifiers(), instanceFor(), LADSPAPluginFactory::instantiatePlugin(), DSSIPluginFactory::instantiatePlugin(), LADSPAPluginFactory::releasePlugin(), and DSSIPluginInstance::runGrouped().

RealTimePluginFactory * RealTimePluginFactory::instanceFor ( QString  identifier  )  [static]

Definition at line 66 of file RealTimePluginFactory.cpp.

References instance(), and PluginIdentifier::parseIdentifier().

Referenced by ModelTransformerFactory::createTransformer(), PropertyBox::editPlugin(), ModelTransformerFactory::getConfigurationForTransform(), TransformFactory::getTransformChannelRange(), TransformFactory::instantiateDefaultPluginFor(), AudioGenerator::loadPlugin(), TransformFactory::populateRealTimePlugins(), and RealTimeEffectModelTransformer::RealTimeEffectModelTransformer().

std::vector< QString > RealTimePluginFactory::getAllPluginIdentifiers (  )  [static]

Definition at line 74 of file RealTimePluginFactory.cpp.

References getPluginIdentifiers(), instance(), and RestoreStartupLocale().

Referenced by TransformFactory::populateRealTimePlugins().

void RealTimePluginFactory::enumerateAllPlugins ( std::vector< QString > &   )  [static]

Definition at line 109 of file RealTimePluginFactory.cpp.

References enumeratePlugins(), and instance().

static void RealTimePluginFactory::setSampleRate ( int  sampleRate  )  [inline, static]

Definition at line 56 of file RealTimePluginFactory.h.

References m_sampleRate.

virtual void RealTimePluginFactory::discoverPlugins (  )  [pure virtual]

Look up the plugin path and find the plugins in it.

Called automatically after construction of a factory.

Implemented in LADSPAPluginFactory.

virtual const std::vector<QString>& RealTimePluginFactory::getPluginIdentifiers (  )  const [pure virtual]

Return a reference to a list of all plugin identifiers that can be created by this factory.

Implemented in LADSPAPluginFactory.

Referenced by getAllPluginIdentifiers().

virtual void RealTimePluginFactory::enumeratePlugins ( std::vector< QString > &  list  )  [pure virtual]

Append to the given list descriptions of all the available plugins and their ports.

This is in a standard format, see the LADSPA implementation for details.

Implemented in DSSIPluginFactory, and LADSPAPluginFactory.

Referenced by enumerateAllPlugins().

virtual const RealTimePluginDescriptor* RealTimePluginFactory::getPluginDescriptor ( QString  identifier  )  const [pure virtual]

Get some basic information about a plugin (rapidly).

Implemented in LADSPAPluginFactory.

Referenced by ModelTransformerFactory::getConfigurationForTransform(), and TransformFactory::populateRealTimePlugins().

virtual RealTimePluginInstance* RealTimePluginFactory::instantiatePlugin ( QString  identifier,
int  clientId,
int  position,
unsigned int  sampleRate,
unsigned int  blockSize,
unsigned int  channels 
) [pure virtual]

Instantiate a plugin.

Implemented in DSSIPluginFactory, and LADSPAPluginFactory.

Referenced by PropertyBox::editPlugin(), ModelTransformerFactory::getConfigurationForTransform(), TransformFactory::instantiateDefaultPluginFor(), AudioGenerator::loadPlugin(), and RealTimeEffectModelTransformer::RealTimeEffectModelTransformer().

virtual QString RealTimePluginFactory::getPluginCategory ( QString  identifier  )  [pure virtual]

Get category metadata about a plugin (without instantiating it).

Implemented in LADSPAPluginFactory.

Referenced by TransformFactory::populateRealTimePlugins().

virtual void RealTimePluginFactory::releasePlugin ( RealTimePluginInstance ,
QString  identifier 
) [protected, pure virtual]

Implemented in LADSPAPluginFactory.

Referenced by RealTimePluginInstance::~RealTimePluginInstance().


Friends And Related Function Documentation

friend class RealTimePluginInstance [friend]

Definition at line 102 of file RealTimePluginFactory.h.


Member Data Documentation

int RealTimePluginFactory::m_sampleRate [static, protected]

Definition at line 104 of file RealTimePluginFactory.h.

Referenced by LADSPAPluginFactory::getPortMaximum(), LADSPAPluginFactory::getPortMinimum(), and setSampleRate().


The documentation for this class was generated from the following files:
Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by  doxygen 1.5.1