svcore  1.9
LADSPAPluginFactory Class Reference

#include <LADSPAPluginFactory.h>

Inheritance diagram for LADSPAPluginFactory:
Collaboration diagram for LADSPAPluginFactory:

List of all members.

Public Member Functions

virtual ~LADSPAPluginFactory ()
virtual void discoverPlugins ()
 Look up the plugin path and find the plugins in it.
virtual const std::vector
< QString > & 
getPluginIdentifiers () const
 Return a reference to a list of all plugin identifiers that can be created by this factory.
virtual void enumeratePlugins (std::vector< QString > &list)
 Append to the given list descriptions of all the available plugins and their ports.
virtual const
RealTimePluginDescriptor
getPluginDescriptor (QString identifier) const
 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)
 Instantiate a plugin.
virtual QString getPluginCategory (QString identifier)
 Get category metadata about a plugin (without instantiating it).
float getPortMinimum (const LADSPA_Descriptor *, int port)
float getPortMaximum (const LADSPA_Descriptor *, int port)
float getPortDefault (const LADSPA_Descriptor *, int port)
float getPortQuantization (const LADSPA_Descriptor *, int port)
int getPortDisplayHint (const LADSPA_Descriptor *, int port)

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 Types

typedef std::map< QString, void * > LibraryHandleMap

Protected Member Functions

 LADSPAPluginFactory ()
virtual std::vector< QString > getPluginPath ()
virtual std::vector< QString > getLRDFPath (QString &baseUri)
virtual void discoverPluginsFrom (QString soName)
virtual void generateTaxonomy (QString uri, QString base)
virtual void generateFallbackCategories ()
virtual void releasePlugin (RealTimePluginInstance *, QString)
virtual const LADSPA_Descriptor * getLADSPADescriptor (QString identifier)
void loadLibrary (QString soName)
void unloadLibrary (QString soName)
void unloadUnusedLibraries ()

Protected Attributes

std::vector< QString > m_identifiers
std::map< QString,
RealTimePluginDescriptor * > 
m_rtDescriptors
std::map< QString, QString > m_taxonomy
std::map< unsigned long, QString > m_lrdfTaxonomy
std::map< unsigned long,
std::map< int, float > > 
m_portDefaults
std::set
< RealTimePluginInstance * > 
m_instances
LibraryHandleMap m_libraryHandles

Static Protected Attributes

static int m_sampleRate = 48000

Friends

class RealTimePluginFactory
class RealTimePluginInstance

Detailed Description

Definition at line 34 of file LADSPAPluginFactory.h.


Member Typedef Documentation

typedef std::map<QString, void *> LADSPAPluginFactory::LibraryHandleMap [protected]

Definition at line 91 of file LADSPAPluginFactory.h.


Constructor & Destructor Documentation

Definition at line 44 of file LADSPAPluginFactory.cpp.


Member Function Documentation

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

Called automatically after construction of a factory.

Implements RealTimePluginFactory.

Definition at line 632 of file LADSPAPluginFactory.cpp.

References discoverPluginsFrom(), generateFallbackCategories(), generateTaxonomy(), getLRDFPath(), getPluginPath(), and PLUGIN_GLOB.

Referenced by RealTimePluginFactory::instance().

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

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

Implements RealTimePluginFactory.

Definition at line 67 of file LADSPAPluginFactory.cpp.

References m_identifiers.

void LADSPAPluginFactory::enumeratePlugins ( std::vector< QString > &  list) [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.

Implements RealTimePluginFactory.

Reimplemented in DSSIPluginFactory.

Definition at line 73 of file LADSPAPluginFactory.cpp.

References PortType::Audio, PortType::Control, getLADSPADescriptor(), getPortDefault(), getPortDisplayHint(), getPortMaximum(), getPortMinimum(), PortType::Input, m_identifiers, m_taxonomy, PortType::Output, and unloadUnusedLibraries().

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

Get some basic information about a plugin (rapidly).

Implements RealTimePluginFactory.

Definition at line 135 of file LADSPAPluginFactory.cpp.

References m_rtDescriptors.

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

Instantiate a plugin.

Implements RealTimePluginFactory.

Reimplemented in DSSIPluginFactory.

Definition at line 331 of file LADSPAPluginFactory.cpp.

References getLADSPADescriptor(), RealTimePluginFactory::instance(), m_instances, and SVDEBUG.

QString LADSPAPluginFactory::getPluginCategory ( QString  identifier) [virtual]

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

Implements RealTimePluginFactory.

Definition at line 890 of file LADSPAPluginFactory.cpp.

References m_taxonomy.

std::vector< QString > LADSPAPluginFactory::getPluginPath ( ) [protected, virtual]
std::vector< QString > LADSPAPluginFactory::getLRDFPath ( QString &  baseUri) [protected, virtual]

Reimplemented in DSSIPluginFactory.

Definition at line 608 of file LADSPAPluginFactory.cpp.

References getPluginPath().

Referenced by discoverPlugins().

void LADSPAPluginFactory::generateTaxonomy ( QString  uri,
QString  base 
) [protected, virtual]

Definition at line 860 of file LADSPAPluginFactory.cpp.

References m_lrdfTaxonomy.

Referenced by discoverPlugins().

void LADSPAPluginFactory::generateFallbackCategories ( ) [protected, virtual]

Definition at line 812 of file LADSPAPluginFactory.cpp.

References PluginIdentifier::canonicalise(), getPluginPath(), and m_taxonomy.

Referenced by discoverPlugins().

const LADSPA_Descriptor * LADSPAPluginFactory::getLADSPADescriptor ( QString  identifier) [protected, virtual]
void LADSPAPluginFactory::unloadLibrary ( QString  soName) [protected]

Definition at line 508 of file LADSPAPluginFactory.cpp.

References DLCLOSE, and m_libraryHandles.

Referenced by releasePlugin(), and unloadUnusedLibraries().

void RealTimePluginFactory::enumerateAllPlugins ( std::vector< QString > &  list) [static, inherited]
static void RealTimePluginFactory::setSampleRate ( int  sampleRate) [inline, static, inherited]

Definition at line 58 of file RealTimePluginFactory.h.

References RealTimePluginFactory::m_sampleRate.


Friends And Related Function Documentation

friend class RealTimePluginFactory [friend]

Reimplemented in DSSIPluginFactory.

Definition at line 64 of file LADSPAPluginFactory.h.

friend class RealTimePluginInstance [friend, inherited]

Definition at line 104 of file RealTimePluginFactory.h.


Member Data Documentation

std::map<unsigned long, QString> LADSPAPluginFactory::m_lrdfTaxonomy [protected]
std::map<unsigned long, std::map<int, float> > LADSPAPluginFactory::m_portDefaults [protected]
int RealTimePluginFactory::m_sampleRate = 48000 [static, protected, inherited]

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