svcore  1.9
LADSPAPluginFactory Class Reference

#include <LADSPAPluginFactory.h>

Inheritance diagram for LADSPAPluginFactory:
Collaboration diagram for LADSPAPluginFactory:

Public Member Functions

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

Detailed Description

Definition at line 34 of file LADSPAPluginFactory.h.

Member Typedef Documentation

◆ LibraryHandleMap

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

Definition at line 91 of file LADSPAPluginFactory.h.

Constructor & Destructor Documentation

◆ ~LADSPAPluginFactory()

LADSPAPluginFactory::~LADSPAPluginFactory ( )
virtual

Definition at line 51 of file LADSPAPluginFactory.cpp.

References m_instances, and unloadUnusedLibraries().

◆ LADSPAPluginFactory()

LADSPAPluginFactory::LADSPAPluginFactory ( )
protected

Definition at line 44 of file LADSPAPluginFactory.cpp.

Member Function Documentation

◆ discoverPlugins()

void LADSPAPluginFactory::discoverPlugins ( )
virtual

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().

◆ getPluginIdentifiers()

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.

◆ enumeratePlugins()

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().

◆ getPluginDescriptor()

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.

◆ instantiatePlugin()

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.

◆ getPluginCategory()

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.

◆ getPortMinimum()

◆ getPortMaximum()

◆ getPortDefault()

◆ getPortQuantization()

float LADSPAPluginFactory::getPortQuantization ( const LADSPA_Descriptor *  descriptor,
int  port 
)

◆ getPortDisplayHint()

int LADSPAPluginFactory::getPortDisplayHint ( const LADSPA_Descriptor *  descriptor,
int  port 
)

◆ getPluginPath()

std::vector< QString > LADSPAPluginFactory::getPluginPath ( )
protectedvirtual

◆ getLRDFPath()

std::vector< QString > LADSPAPluginFactory::getLRDFPath ( QString &  baseUri)
protectedvirtual

Reimplemented in DSSIPluginFactory.

Definition at line 608 of file LADSPAPluginFactory.cpp.

References getPluginPath().

Referenced by discoverPlugins().

◆ discoverPluginsFrom()

◆ generateTaxonomy()

void LADSPAPluginFactory::generateTaxonomy ( QString  uri,
QString  base 
)
protectedvirtual

Definition at line 860 of file LADSPAPluginFactory.cpp.

References m_lrdfTaxonomy.

Referenced by discoverPlugins().

◆ generateFallbackCategories()

void LADSPAPluginFactory::generateFallbackCategories ( )
protectedvirtual

Definition at line 812 of file LADSPAPluginFactory.cpp.

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

Referenced by discoverPlugins().

◆ releasePlugin()

void LADSPAPluginFactory::releasePlugin ( RealTimePluginInstance instance,
QString  identifier 
)
protectedvirtual

◆ getLADSPADescriptor()

const LADSPA_Descriptor * LADSPAPluginFactory::getLADSPADescriptor ( QString  identifier)
protectedvirtual

◆ loadLibrary()

void LADSPAPluginFactory::loadLibrary ( QString  soName)
protected

◆ unloadLibrary()

void LADSPAPluginFactory::unloadLibrary ( QString  soName)
protected

Definition at line 508 of file LADSPAPluginFactory.cpp.

References DLCLOSE, and m_libraryHandles.

Referenced by releasePlugin(), and unloadUnusedLibraries().

◆ unloadUnusedLibraries()

◆ instance()

◆ instanceFor()

◆ getAllPluginIdentifiers()

std::vector< QString > RealTimePluginFactory::getAllPluginIdentifiers ( )
staticinherited

◆ enumerateAllPlugins()

void RealTimePluginFactory::enumerateAllPlugins ( std::vector< QString > &  list)
staticinherited

◆ setSampleRate()

static void RealTimePluginFactory::setSampleRate ( int  sampleRate)
inlinestaticinherited

Definition at line 58 of file RealTimePluginFactory.h.

References RealTimePluginFactory::m_sampleRate.

Friends And Related Function Documentation

◆ RealTimePluginFactory

friend class RealTimePluginFactory
friend

Definition at line 64 of file LADSPAPluginFactory.h.

Member Data Documentation

◆ m_identifiers

std::vector<QString> LADSPAPluginFactory::m_identifiers
protected

◆ m_rtDescriptors

std::map<QString, RealTimePluginDescriptor *> LADSPAPluginFactory::m_rtDescriptors
protected

◆ m_taxonomy

std::map<QString, QString> LADSPAPluginFactory::m_taxonomy
protected

◆ m_lrdfTaxonomy

std::map<unsigned long, QString> LADSPAPluginFactory::m_lrdfTaxonomy
protected

◆ m_portDefaults

std::map<unsigned long, std::map<int, float> > LADSPAPluginFactory::m_portDefaults
protected

◆ m_instances

std::set<RealTimePluginInstance *> LADSPAPluginFactory::m_instances
protected

◆ m_libraryHandles

LibraryHandleMap LADSPAPluginFactory::m_libraryHandles
protected

◆ m_sampleRate

int RealTimePluginFactory::m_sampleRate = 48000
staticprotectedinherited

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