#include <DSSIPluginFactory.h>

Inheritance diagram for DSSIPluginFactory:

Collaboration diagram for DSSIPluginFactory:

Public Member Functions
virtual	~DSSIPluginFactory ()
virtual void	enumeratePlugins (std::vector< QString > &list)
	Append to the given list descriptions of all the available plugins and their ports.
virtual RealTimePluginInstance *	instantiatePlugin (QString identifier, int clientId, int position, unsigned int sampleRate, unsigned int blockSize, unsigned int channels)
	Instantiate a plugin.
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 const RealTimePluginDescriptor *	getPluginDescriptor (QString identifier) const
	Get some basic information about a plugin (rapidly).
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 RealTimePluginFactory *	instance (QString pluginType)
static RealTimePluginFactory *	instanceFor (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
	DSSIPluginFactory ()
	!!
virtual std::vector< QString >	getPluginPath ()
virtual std::vector< QString >	getLRDFPath (QString &baseUri)
virtual void	discoverPluginsFrom (QString soName)
virtual const LADSPA_Descriptor *	getLADSPADescriptor (QString identifier)
virtual const DSSI_Descriptor *	getDSSIDescriptor (QString identifier)
virtual void	generateTaxonomy (QString uri, QString base)
virtual void	generateFallbackCategories ()
virtual void	releasePlugin (RealTimePluginInstance *, QString)
void	loadLibrary (QString soName)
void	unloadLibrary (QString soName)
void	unloadUnusedLibraries ()
Protected Attributes
DSSI_Host_Descriptor	m_hostDescriptor
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 33 of file DSSIPluginFactory.h.

Member Typedef Documentation

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

Definition at line 91 of file LADSPAPluginFactory.h.

Constructor & Destructor Documentation

DSSIPluginFactory::~DSSIPluginFactory ( ) [virtual]

Definition at line 53 of file DSSIPluginFactory.cpp.

DSSIPluginFactory::DSSIPluginFactory ( ) [protected]

!!

Definition at line 43 of file DSSIPluginFactory.cpp.

References m_hostDescriptor, DSSIPluginInstance::midiSend(), DSSIPluginInstance::requestMidiSend(), and DSSIPluginInstance::requestNonRTThread().

Member Function Documentation

void DSSIPluginFactory::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.

Reimplemented from LADSPAPluginFactory.

Definition at line 59 of file DSSIPluginFactory.cpp.

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

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

Instantiate a plugin.

Reimplemented from LADSPAPluginFactory.

Definition at line 113 of file DSSIPluginFactory.cpp.

References getDSSIDescriptor(), RealTimePluginFactory::instance(), and LADSPAPluginFactory::m_instances.

std::vector< QString > DSSIPluginFactory::getPluginPath ( ) [protected, virtual]

Reimplemented from LADSPAPluginFactory.

Definition at line 206 of file DSSIPluginFactory.cpp.

References DEFAULT_DSSI_PATH, and PATH_SEPARATOR.

Referenced by getLRDFPath().

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

Reimplemented from LADSPAPluginFactory.

Definition at line 254 of file DSSIPluginFactory.cpp.

References getPluginPath().

void DSSIPluginFactory::discoverPluginsFrom ( QString soName ) [protected, virtual]

const LADSPA_Descriptor * DSSIPluginFactory::getLADSPADescriptor ( QString identifier ) [protected, virtual]

Reimplemented from LADSPAPluginFactory.

Definition at line 197 of file DSSIPluginFactory.cpp.

References getDSSIDescriptor().

const DSSI_Descriptor * DSSIPluginFactory::getDSSIDescriptor ( QString identifier ) [protected, virtual]

Definition at line 140 of file DSSIPluginFactory.cpp.

References PluginIdentifier::BUILTIN_PLUGIN_SONAME, DLSYM, SamplePlayer::getDescriptor(), LADSPAPluginFactory::loadLibrary(), m_hostDescriptor, LADSPAPluginFactory::m_libraryHandles, and PluginIdentifier::parseIdentifier().

Referenced by enumeratePlugins(), getLADSPADescriptor(), and instantiatePlugin().

void LADSPAPluginFactory::discoverPlugins ( ) [virtual, inherited]

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 LADSPAPluginFactory::discoverPluginsFrom(), LADSPAPluginFactory::generateFallbackCategories(), LADSPAPluginFactory::generateTaxonomy(), LADSPAPluginFactory::getLRDFPath(), LADSPAPluginFactory::getPluginPath(), and PLUGIN_GLOB.

Referenced by RealTimePluginFactory::instance().

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

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 LADSPAPluginFactory::m_identifiers.

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

Get some basic information about a plugin (rapidly).

Implements RealTimePluginFactory.

Definition at line 135 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_rtDescriptors.

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

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

Implements RealTimePluginFactory.

Definition at line 890 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_taxonomy.

float LADSPAPluginFactory::getPortMinimum	(	const LADSPA_Descriptor *	descriptor,
		int	port
	)		`[inherited]`

Definition at line 148 of file LADSPAPluginFactory.cpp.

References RealTimePluginFactory::m_sampleRate.

Referenced by enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), LADSPAPluginInstance::getParameterDescriptors(), DSSIPluginInstance::getParameterDescriptors(), LADSPAPluginFactory::getPortDefault(), LADSPAPluginFactory::getPortQuantization(), LADSPAPluginInstance::setParameterValue(), and DSSIPluginInstance::setParameterValue().

float LADSPAPluginFactory::getPortMaximum	(	const LADSPA_Descriptor *	descriptor,
		int	port
	)		`[inherited]`

Definition at line 175 of file LADSPAPluginFactory.cpp.

References RealTimePluginFactory::m_sampleRate.

Referenced by enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), LADSPAPluginInstance::getParameterDescriptors(), DSSIPluginInstance::getParameterDescriptors(), LADSPAPluginFactory::getPortDefault(), LADSPAPluginFactory::getPortQuantization(), LADSPAPluginInstance::setParameterValue(), and DSSIPluginInstance::setParameterValue().

float LADSPAPluginFactory::getPortDefault	(	const LADSPA_Descriptor *	descriptor,
		int	port
	)		`[inherited]`

!! No -- the min and max have already been multiplied by the rate,

Definition at line 198 of file LADSPAPluginFactory.cpp.

References Preferences::getInstance(), LADSPAPluginFactory::getPortMaximum(), LADSPAPluginFactory::getPortMinimum(), Preferences::getTuningFrequency(), and LADSPAPluginFactory::m_portDefaults.

Referenced by LADSPAPluginInstance::connectPorts(), DSSIPluginInstance::connectPorts(), enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), LADSPAPluginInstance::getParameterDefault(), DSSIPluginInstance::getParameterDefault(), LADSPAPluginInstance::getParameterDescriptors(), and DSSIPluginInstance::getParameterDescriptors().

float LADSPAPluginFactory::getPortQuantization	(	const LADSPA_Descriptor *	descriptor,
		int	port
	)		`[inherited]`

Definition at line 302 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::getPortDisplayHint(), LADSPAPluginFactory::getPortMaximum(), LADSPAPluginFactory::getPortMinimum(), PortHint::Integer, and PortHint::Toggled.

Referenced by LADSPAPluginInstance::getParameterDescriptors(), and DSSIPluginInstance::getParameterDescriptors().

int LADSPAPluginFactory::getPortDisplayHint	(	const LADSPA_Descriptor *	descriptor,
		int	port
	)		`[inherited]`

Definition at line 316 of file LADSPAPluginFactory.cpp.

References PortHint::Integer, PortHint::Logarithmic, PortHint::NoHint, and PortHint::Toggled.

Referenced by enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), LADSPAPluginInstance::getParameterDisplayHint(), DSSIPluginInstance::getParameterDisplayHint(), and LADSPAPluginFactory::getPortQuantization().

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

Definition at line 860 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_lrdfTaxonomy.

Referenced by LADSPAPluginFactory::discoverPlugins().

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

Definition at line 812 of file LADSPAPluginFactory.cpp.

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

Referenced by LADSPAPluginFactory::discoverPlugins().

void LADSPAPluginFactory::releasePlugin	(	RealTimePluginInstance *	instance,
		QString	identifier
	)		`[protected, virtual, inherited]`

Implements RealTimePluginFactory.

Definition at line 363 of file LADSPAPluginFactory.cpp.

References PluginIdentifier::BUILTIN_PLUGIN_SONAME, LADSPAPluginFactory::m_instances, PluginIdentifier::parseIdentifier(), SVDEBUG, and LADSPAPluginFactory::unloadLibrary().

void LADSPAPluginFactory::loadLibrary ( QString soName ) [protected, inherited]

Definition at line 447 of file LADSPAPluginFactory.cpp.

References DLERROR, DLOPEN, LADSPAPluginFactory::getPluginPath(), LADSPAPluginFactory::m_libraryHandles, PLUGIN_GLOB, and SVDEBUG.

Referenced by getDSSIDescriptor(), and LADSPAPluginFactory::getLADSPADescriptor().

void LADSPAPluginFactory::unloadLibrary ( QString soName ) [protected, inherited]

Definition at line 508 of file LADSPAPluginFactory.cpp.

References DLCLOSE, and LADSPAPluginFactory::m_libraryHandles.

Referenced by LADSPAPluginFactory::releasePlugin(), and LADSPAPluginFactory::unloadUnusedLibraries().

void LADSPAPluginFactory::unloadUnusedLibraries ( ) [protected, inherited]

Definition at line 519 of file LADSPAPluginFactory.cpp.

References PluginIdentifier::BUILTIN_PLUGIN_SONAME, LADSPAPluginFactory::m_instances, LADSPAPluginFactory::m_libraryHandles, PluginIdentifier::parseIdentifier(), and LADSPAPluginFactory::unloadLibrary().

Referenced by enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), and LADSPAPluginFactory::~LADSPAPluginFactory().

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

Definition at line 43 of file RealTimePluginFactory.cpp.

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

Referenced by RealTimePluginFactory::enumerateAllPlugins(), RealTimePluginFactory::getAllPluginIdentifiers(), RealTimePluginFactory::instanceFor(), instantiatePlugin(), LADSPAPluginFactory::instantiatePlugin(), DSSIPluginInstance::requestNonRTThread(), and DSSIPluginInstance::runGrouped().

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

Definition at line 65 of file RealTimePluginFactory.cpp.

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

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

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

Definition at line 73 of file RealTimePluginFactory.cpp.

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

Referenced by TransformFactory::populateRealTimePlugins().

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

Definition at line 110 of file RealTimePluginFactory.cpp.

References RealTimePluginFactory::enumeratePlugins(), RealTimePluginFactory::instance(), and RestoreStartupLocale().

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 from LADSPAPluginFactory.

Definition at line 49 of file DSSIPluginFactory.h.

friend class RealTimePluginInstance [friend, inherited]

Definition at line 104 of file RealTimePluginFactory.h.

Member Data Documentation

DSSI_Host_Descriptor DSSIPluginFactory::m_hostDescriptor [protected]

Definition at line 60 of file DSSIPluginFactory.h.

Referenced by DSSIPluginFactory(), and getDSSIDescriptor().

std::vector<QString> LADSPAPluginFactory::m_identifiers [protected, inherited]

Definition at line 82 of file LADSPAPluginFactory.h.

Referenced by discoverPluginsFrom(), LADSPAPluginFactory::discoverPluginsFrom(), enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), and LADSPAPluginFactory::getPluginIdentifiers().

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

Definition at line 83 of file LADSPAPluginFactory.h.

Referenced by discoverPluginsFrom(), LADSPAPluginFactory::discoverPluginsFrom(), and LADSPAPluginFactory::getPluginDescriptor().

std::map<QString, QString> LADSPAPluginFactory::m_taxonomy [protected, inherited]

Definition at line 85 of file LADSPAPluginFactory.h.

Referenced by discoverPluginsFrom(), LADSPAPluginFactory::discoverPluginsFrom(), enumeratePlugins(), LADSPAPluginFactory::enumeratePlugins(), LADSPAPluginFactory::generateFallbackCategories(), and LADSPAPluginFactory::getPluginCategory().

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

Definition at line 86 of file LADSPAPluginFactory.h.

Referenced by discoverPluginsFrom(), LADSPAPluginFactory::discoverPluginsFrom(), and LADSPAPluginFactory::generateTaxonomy().

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

Definition at line 87 of file LADSPAPluginFactory.h.

Referenced by discoverPluginsFrom(), LADSPAPluginFactory::discoverPluginsFrom(), and LADSPAPluginFactory::getPortDefault().

std::set<RealTimePluginInstance *> LADSPAPluginFactory::m_instances [protected, inherited]

Definition at line 89 of file LADSPAPluginFactory.h.

Referenced by instantiatePlugin(), LADSPAPluginFactory::instantiatePlugin(), LADSPAPluginFactory::releasePlugin(), LADSPAPluginFactory::unloadUnusedLibraries(), and LADSPAPluginFactory::~LADSPAPluginFactory().

LibraryHandleMap LADSPAPluginFactory::m_libraryHandles [protected, inherited]

Definition at line 92 of file LADSPAPluginFactory.h.

Referenced by getDSSIDescriptor(), LADSPAPluginFactory::getLADSPADescriptor(), LADSPAPluginFactory::loadLibrary(), LADSPAPluginFactory::unloadLibrary(), and LADSPAPluginFactory::unloadUnusedLibraries().

int RealTimePluginFactory::m_sampleRate = 48000 [static, protected, inherited]

Definition at line 106 of file RealTimePluginFactory.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation