#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. More...

virtual RealTimePluginInstance *	instantiatePlugin (QString identifier, int clientId, int position, unsigned int sampleRate, unsigned int blockSize, unsigned int channels)
	Instantiate a plugin. More...

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 const RealTimePluginDescriptor *	getPluginDescriptor (QString identifier) const
	Get some basic information about a plugin (rapidly). 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 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 ()
	!! More...

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

Detailed Description

Definition at line 33 of file DSSIPluginFactory.h.

Member Typedef Documentation

◆ LibraryHandleMap

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

protectedinherited

Definition at line 91 of file LADSPAPluginFactory.h.

Constructor & Destructor Documentation

◆ ~DSSIPluginFactory()

DSSIPluginFactory::~DSSIPluginFactory ( )

virtual

Definition at line 53 of file DSSIPluginFactory.cpp.

◆ DSSIPluginFactory()

DSSIPluginFactory::DSSIPluginFactory ( )

protected

!!

Definition at line 43 of file DSSIPluginFactory.cpp.

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

Member Function Documentation

◆ enumeratePlugins()

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

◆ instantiatePlugin()

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.

◆ getPluginPath()

std::vector< QString > DSSIPluginFactory::getPluginPath ( )

protectedvirtual

Reimplemented from LADSPAPluginFactory.

Definition at line 206 of file DSSIPluginFactory.cpp.

References DEFAULT_DSSI_PATH, and PATH_SEPARATOR.

Referenced by getLRDFPath().

◆ getLRDFPath()

std::vector< QString > DSSIPluginFactory::getLRDFPath ( QString & baseUri )

protectedvirtual

Reimplemented from LADSPAPluginFactory.

Definition at line 254 of file DSSIPluginFactory.cpp.

References getPluginPath().

◆ discoverPluginsFrom()

void DSSIPluginFactory::discoverPluginsFrom ( QString soName )

protectedvirtual

◆ getLADSPADescriptor()

const LADSPA_Descriptor * DSSIPluginFactory::getLADSPADescriptor ( QString identifier )

protectedvirtual

Reimplemented from LADSPAPluginFactory.

Definition at line 197 of file DSSIPluginFactory.cpp.

References getDSSIDescriptor().

◆ getDSSIDescriptor()

const DSSI_Descriptor * DSSIPluginFactory::getDSSIDescriptor ( QString identifier )

protectedvirtual

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

◆ discoverPlugins()

void LADSPAPluginFactory::discoverPlugins ( )

virtualinherited

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

◆ getPluginIdentifiers()

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

virtualinherited

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.

◆ getPluginDescriptor()

const RealTimePluginDescriptor * LADSPAPluginFactory::getPluginDescriptor ( QString identifier ) const

virtualinherited

Get some basic information about a plugin (rapidly).

Implements RealTimePluginFactory.

Definition at line 135 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_rtDescriptors.

◆ getPluginCategory()

QString LADSPAPluginFactory::getPluginCategory ( QString identifier )

virtualinherited

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

Implements RealTimePluginFactory.

Definition at line 890 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_taxonomy.

◆ getPortMinimum()

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

◆ getPortMaximum()

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

◆ getPortDefault()

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

◆ getPortQuantization()

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

◆ getPortDisplayHint()

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

◆ generateTaxonomy()

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

protectedvirtualinherited

Definition at line 860 of file LADSPAPluginFactory.cpp.

References LADSPAPluginFactory::m_lrdfTaxonomy.

Referenced by LADSPAPluginFactory::discoverPlugins().

◆ generateFallbackCategories()

void LADSPAPluginFactory::generateFallbackCategories ( )

protectedvirtualinherited

Definition at line 812 of file LADSPAPluginFactory.cpp.

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

Referenced by LADSPAPluginFactory::discoverPlugins().

◆ releasePlugin()

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

protectedvirtualinherited

Implements RealTimePluginFactory.

Definition at line 363 of file LADSPAPluginFactory.cpp.

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

◆ loadLibrary()

void LADSPAPluginFactory::loadLibrary ( QString soName )

protectedinherited

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

◆ unloadLibrary()

void LADSPAPluginFactory::unloadLibrary ( QString soName )

protectedinherited

Definition at line 508 of file LADSPAPluginFactory.cpp.

References DLCLOSE, and LADSPAPluginFactory::m_libraryHandles.

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

◆ unloadUnusedLibraries()

void LADSPAPluginFactory::unloadUnusedLibraries ( )

protectedinherited

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

◆ instance()

RealTimePluginFactory * RealTimePluginFactory::instance ( QString pluginType )

staticinherited

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(), LADSPAPluginFactory::releasePlugin(), DSSIPluginInstance::requestNonRTThread(), and DSSIPluginInstance::runGrouped().

◆ instanceFor()

RealTimePluginFactory * RealTimePluginFactory::instanceFor ( QString identifier )

staticinherited

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

◆ getAllPluginIdentifiers()

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

staticinherited

Definition at line 73 of file RealTimePluginFactory.cpp.

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

Referenced by TransformFactory::populateRealTimePlugins().

◆ enumerateAllPlugins()

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

staticinherited

Definition at line 110 of file RealTimePluginFactory.cpp.

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

◆ 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 49 of file DSSIPluginFactory.h.

Member Data Documentation

◆ m_hostDescriptor

DSSI_Host_Descriptor DSSIPluginFactory::m_hostDescriptor

protected

Definition at line 60 of file DSSIPluginFactory.h.

Referenced by DSSIPluginFactory(), and getDSSIDescriptor().

◆ m_identifiers

std::vector<QString> LADSPAPluginFactory::m_identifiers

protectedinherited

Definition at line 82 of file LADSPAPluginFactory.h.

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

◆ m_rtDescriptors

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

protectedinherited

Definition at line 83 of file LADSPAPluginFactory.h.

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

◆ m_taxonomy

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

protectedinherited

Definition at line 85 of file LADSPAPluginFactory.h.

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

◆ m_lrdfTaxonomy

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

protectedinherited

Definition at line 86 of file LADSPAPluginFactory.h.

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

◆ m_portDefaults

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

protectedinherited

Definition at line 87 of file LADSPAPluginFactory.h.

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

◆ m_instances

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

protectedinherited

Definition at line 89 of file LADSPAPluginFactory.h.

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

◆ m_libraryHandles

LibraryHandleMap LADSPAPluginFactory::m_libraryHandles

protectedinherited

Definition at line 92 of file LADSPAPluginFactory.h.

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

◆ m_sampleRate

int RealTimePluginFactory::m_sampleRate = 48000

staticprotectedinherited

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

◆ LibraryHandleMap

Constructor & Destructor Documentation

◆ ~DSSIPluginFactory()

◆ DSSIPluginFactory()

Member Function Documentation

◆ enumeratePlugins()

◆ instantiatePlugin()

◆ getPluginPath()

◆ getLRDFPath()

◆ discoverPluginsFrom()

◆ getLADSPADescriptor()

◆ getDSSIDescriptor()

◆ discoverPlugins()

◆ getPluginIdentifiers()

◆ getPluginDescriptor()

◆ getPluginCategory()

◆ getPortMinimum()

◆ getPortMaximum()

◆ getPortDefault()

◆ getPortQuantization()

◆ getPortDisplayHint()

◆ generateTaxonomy()

◆ generateFallbackCategories()

◆ releasePlugin()

◆ loadLibrary()

◆ unloadLibrary()

◆ unloadUnusedLibraries()

◆ instance()

◆ instanceFor()

◆ getAllPluginIdentifiers()

◆ enumerateAllPlugins()

◆ setSampleRate()

Friends And Related Function Documentation

◆ RealTimePluginFactory

Member Data Documentation

◆ m_hostDescriptor

◆ m_identifiers

◆ m_rtDescriptors

◆ m_taxonomy

◆ m_lrdfTaxonomy

◆ m_portDefaults

◆ m_instances

◆ m_libraryHandles

◆ m_sampleRate