#include <ModelTransformerFactory.h>

Inheritance diagram for ModelTransformerFactory:

Collaboration diagram for ModelTransformerFactory:

Classes
class	AdditionalModelHandler

class	UserConfigurator

Signals
void	transformFailed (QString transformName, QString message)

Public Member Functions
virtual	~ModelTransformerFactory ()

ModelTransformer::Input	getConfigurationForTransform (Transform &transform, std::vector< ModelId > candidateInputModels, ModelId defaultInputModel, AudioPlaySource source=0, sv_frame_t startFrame=0, sv_frame_t duration=0, UserConfigurator configurator=0)
	Fill out the configuration for the given transform (may include asking the user by calling back on the UserConfigurator). More...

ModelId	transform (const Transform &transform, const ModelTransformer::Input &input, QString &message, AdditionalModelHandler *handler=0)
	Return the output model resulting from applying the named transform to the given input model. More...

std::vector< ModelId >	transformMultiple (const Transforms &transform, const ModelTransformer::Input &input, QString &message, AdditionalModelHandler *handler=0)
	Return the multiple output models resulting from applying the named transforms to the given input model. More...

bool	haveRunningTransformers () const

Static Public Member Functions
static ModelTransformerFactory *	getInstance ()

Protected Types
typedef std::map< TransformId, QString >	TransformerConfigurationMap

typedef std::set< ModelTransformer * >	TransformerSet

typedef std::map< ModelTransformer , AdditionalModelHandler >	HandlerMap

Protected Slots
void	transformerFinished ()

Protected Member Functions
ModelTransformer *	createTransformer (const Transforms &transforms, const ModelTransformer::Input &input)

Protected Attributes
QMutex	m_mutex

TransformerConfigurationMap	m_lastConfigurations

TransformerSet	m_runningTransformers

HandlerMap	m_handlers

Static Protected Attributes
static ModelTransformerFactory *	m_instance = new ModelTransformerFactory

Detailed Description

Definition at line 36 of file ModelTransformerFactory.h.

Member Typedef Documentation

typedef std::map<TransformId, QString> ModelTransformerFactory::TransformerConfigurationMap

protected

Definition at line 164 of file ModelTransformerFactory.h.

typedef std::set<ModelTransformer *> ModelTransformerFactory::TransformerSet

protected

Definition at line 167 of file ModelTransformerFactory.h.

typedef std::map<ModelTransformer *, AdditionalModelHandler *> ModelTransformerFactory::HandlerMap

protected

Definition at line 170 of file ModelTransformerFactory.h.

Constructor & Destructor Documentation

ModelTransformerFactory::~ModelTransformerFactory ( )

virtual

Definition at line 55 of file ModelTransformerFactory.cpp.

Member Function Documentation

ModelTransformerFactory * ModelTransformerFactory::getInstance ( )

static

Definition at line 50 of file ModelTransformerFactory.cpp.

References m_instance.

ModelTransformer::Input ModelTransformerFactory::getConfigurationForTransform	(	Transform &	transform,
		std::vector< ModelId >	candidateInputModels,
		ModelId	defaultInputModel,
		AudioPlaySource *	source = `0`,
		sv_frame_t	startFrame = `0`,
		sv_frame_t	duration = `0`,
		UserConfigurator *	configurator = `0`
	)

Fill out the configuration for the given transform (may include asking the user by calling back on the UserConfigurator).

Returns the selected input model and channel if the transform is acceptable, or an input with no model if the operation should be cancelled. Audio play source may be used to audition effects plugins, if provided.

!! This will need revision – we'll have to have a callback

Definition at line 60 of file ModelTransformerFactory.cpp.

References ModelTransformerFactory::UserConfigurator::configure(), TypedById< Item, Id >::get(), Transform::getIdentifier(), TransformFactory::getInstance(), Transform::getPluginIdentifier(), AudioPlaySource::getSourceSampleRate(), AudioPlaySource::getTargetBlockSize(), AudioPlaySource::getTargetChannelCount(), in_range_for(), FeatureExtractionPluginFactory::instance(), RealTimePluginFactory::instanceFor(), FeatureExtractionPluginFactory::instantiatePlugin(), RealTimePluginFactory::instantiatePlugin(), m_lastConfigurations, m_mutex, PluginXml::setParametersFromXml(), SVDEBUG, and XmlExportable::toXmlString().

ModelId ModelTransformerFactory::transform	(	const Transform &	transform,
		const ModelTransformer::Input &	input,
		QString &	message,
		AdditionalModelHandler *	handler = `0`
	)

Return the output model resulting from applying the named transform to the given input model.

The transform may still be working in the background when the model is returned; check the output model's isReady completion status for more details. To cancel a background transform, call abandon() on its model.

If the transform is unknown or the input model is not an appropriate type for the given transform, or if some other problem occurs, return 0. Set message if there is any error or warning to report.

Some transforms may return additional models at the end of processing. (For example, a transform that splits an output into multiple one-per-bin models.) If an additionalModelHandler is provided here, its moreModelsAvailable method will be called when those models become available, and ownership of those models will be transferred to the handler. Otherwise (if the handler is null) any such models will be discarded.

The returned model is owned by the caller and must be deleted when no longer needed.

Definition at line 207 of file ModelTransformerFactory.cpp.

References ModelTransformer::Input::getModel(), SVDEBUG, and transformMultiple().

Referenced by ModelTransformerFactory::AdditionalModelHandler::~AdditionalModelHandler().

vector< ModelId > ModelTransformerFactory::transformMultiple	(	const Transforms &	transform,
		const ModelTransformer::Input &	input,
		QString &	message,
		AdditionalModelHandler *	handler = `0`
	)

Return the multiple output models resulting from applying the named transforms to the given input model.

The transforms may differ only in output identifier for the plugin: they must all use the same plugin, parameters, and programs. The plugin will be run once only, but more than one output will be harvested (as appropriate). Models will be returned in the same order as the transforms were given. The plugin may still be working in the background when the model is returned; check the output models' isReady completion statuses for more details. To cancel a background transform, call abandon() on its model.

If a transform is unknown or the transforms are insufficiently closely related or the input model is not an appropriate type for the given transform, or if some other problem occurs, return 0. Set message if there is any error or warning to report.

Some transforms may return additional models at the end of processing. (For example, a transform that splits an output into multiple one-per-bin models.) If an additionalModelHandler is provided here, its moreModelsAvailable method will be called when those models become available, and ownership of those models will be transferred to the handler. Otherwise (if the handler is null) any such models will be discarded. Note that calling abandon() on any one of the models returned by transformMultiple is sufficient to cancel all background transform activity associated with these output models.

The returned models are owned by the caller and must be deleted when no longer needed.

Definition at line 222 of file ModelTransformerFactory.cpp.

References createTransformer(), TypedById< Item, Id >::get(), TransformFactory::getInstance(), ModelTransformer::getMessage(), ModelTransformer::Input::getModel(), ModelTransformer::getOutputModels(), TransformFactory::getTransformFriendlyName(), in_range_for(), m_handlers, m_mutex, m_runningTransformers, Thread::start(), SVDEBUG, and transformerFinished().