#include <RealTimeEffectModelTransformer.h>

Inheritance diagram for RealTimeEffectModelTransformer:

Collaboration diagram for RealTimeEffectModelTransformer:

Public Types
typedef std::vector< ModelId >	Models

enum	Type { RTThread, NonRTThread }

Public Slots
void	start ()

Public Member Functions
	RealTimeEffectModelTransformer (Input input, const Transform &transform)

virtual	~RealTimeEffectModelTransformer ()

void	abandon ()
	Hint to the processing thread that it should give up, for example because the process is going to exit or the model/document context is being replaced. More...

bool	isAbandoned () const
	Return true if the processing thread is being or has been abandoned, i.e. More...

ModelId	getInputModel ()
	Return the input model for the transform. More...

int	getInputChannel ()
	Return the input channel spec for the transform. More...

Models	getOutputModels ()
	Return the set of output model IDs created by the transform or transforms. More...

virtual Models	getAdditionalOutputModels ()
	Return any additional models that were created during processing. More...

virtual bool	willHaveAdditionalOutputModels ()
	Return true if the current transform is one that may produce additional models (to be retrieved through getAdditionalOutputModels above). More...

QString	getMessage () const
	Return a warning or error message. More...

Protected Member Functions
void	run () override

void	awaitOutputModels () override

Protected Attributes
QString	m_units

std::shared_ptr< RealTimePluginInstance >	m_plugin

int	m_outputNo

Transforms	m_transforms

Input	m_input

Models	m_outputs

bool	m_abandoned

QString	m_message

Detailed Description

Definition at line 24 of file RealTimeEffectModelTransformer.h.

Member Typedef Documentation

typedef std::vector<ModelId> ModelTransformer::Models

inherited

Definition at line 42 of file ModelTransformer.h.

Member Enumeration Documentation

enum Thread::Type

inherited

Enumerator
RTThread
NonRTThread

Definition at line 29 of file Thread.h.

Constructor & Destructor Documentation

RealTimeEffectModelTransformer::RealTimeEffectModelTransformer	(	Input	input,
		const Transform &	transform
	)

RealTimeEffectModelTransformer::~RealTimeEffectModelTransformer ( )

virtual

Definition at line 109 of file RealTimeEffectModelTransformer.cpp.

Member Function Documentation

void RealTimeEffectModelTransformer::run ( )

overrideprotectedvirtual

Implements Thread.

Definition at line 114 of file RealTimeEffectModelTransformer.cpp.

References ModelTransformer::abandon(), RealTime::frame2RealTime(), ModelTransformer::Input::getChannel(), Transform::getDuration(), ModelTransformer::getInputModel(), Transform::getStartTime(), ModelTransformer::m_abandoned, ModelTransformer::m_input, m_outputNo, ModelTransformer::m_outputs, m_plugin, ModelTransformer::m_transforms, RealTime::realTime2Frame(), and SVDEBUG.

void RealTimeEffectModelTransformer::awaitOutputModels ( )

inlineoverrideprotectedvirtual

Implements ModelTransformer.

Definition at line 34 of file RealTimeEffectModelTransformer.h.

void ModelTransformer::abandon ( )

inlineinherited

Hint to the processing thread that it should give up, for example because the process is going to exit or the model/document context is being replaced.

Caller should still wait() to be sure that processing has ended.

Definition at line 66 of file ModelTransformer.h.

References ModelTransformer::m_abandoned.

Referenced by FeatureExtractionModelTransformer::addFeature(), run(), and FeatureExtractionModelTransformer::run().

bool ModelTransformer::isAbandoned ( ) const

inlineinherited

Return true if the processing thread is being or has been abandoned, i.e.

if abandon() has been called.

Definition at line 72 of file ModelTransformer.h.

References ModelTransformer::m_abandoned.

Referenced by ModelTransformerFactory::transformerFinished().

ModelId ModelTransformer::getInputModel ( )

inlineinherited

Return the input model for the transform.

Definition at line 77 of file ModelTransformer.h.

References ModelTransformer::Input::getModel(), and ModelTransformer::m_input.

Referenced by FeatureExtractionModelTransformer::addFeature(), FeatureExtractionModelTransformer::createOutputModels(), FeatureExtractionModelTransformer::getFrames(), FeatureExtractionModelTransformer::initialise(), RealTimeEffectModelTransformer(), run(), and FeatureExtractionModelTransformer::run().

int ModelTransformer::getInputChannel ( )

inlineinherited

Return the input channel spec for the transform.

Definition at line 82 of file ModelTransformer.h.

References ModelTransformer::Input::getChannel(), and ModelTransformer::m_input.

Models ModelTransformer::getOutputModels ( )

inlineinherited

Return the set of output model IDs created by the transform or transforms.

Returns an empty list if any transform could not be initialised; an error message may be available via getMessage() in this situation. The returned models have been added to ModelById.

Definition at line 91 of file ModelTransformer.h.

References ModelTransformer::awaitOutputModels(), and ModelTransformer::m_outputs.

Referenced by ModelTransformerFactory::transformMultiple().

virtual Models ModelTransformer::getAdditionalOutputModels ( )

inlinevirtualinherited

Return any additional models that were created during processing.

This might happen if, for example, a transform was configured to split a multi-bin output into separate single-bin models as it processed. These should not be queried until after the transform has completed.

Reimplemented in FeatureExtractionModelTransformer.

Definition at line 103 of file ModelTransformer.h.

Referenced by ModelTransformerFactory::transformerFinished().

virtual bool ModelTransformer::willHaveAdditionalOutputModels ( )

inlinevirtualinherited

Return true if the current transform is one that may produce additional models (to be retrieved through getAdditionalOutputModels above).

Reimplemented in FeatureExtractionModelTransformer.

Definition at line 110 of file ModelTransformer.h.

Referenced by ModelTransformerFactory::transformerFinished().

QString ModelTransformer::getMessage ( ) const

inlineinherited

Return a warning or error message.

If getOutputModel returned a null pointer, this should contain a fatal error message for the transformer; otherwise it may contain a warning to show to the user about e.g. suboptimal block size or whatever.

Definition at line 118 of file ModelTransformer.h.

References ModelTransformer::awaitOutputModels(), ModelTransformer::m_message, and ModelTransformer::ModelTransformer().

Referenced by ModelTransformerFactory::transformerFinished(), and ModelTransformerFactory::transformMultiple().

void Thread::start ( )

slotinherited

Definition at line 34 of file Thread.cpp.

References Thread::m_type, and Thread::RTThread.

Referenced by BQAFileReader::BQAFileReader(), DecodingWavFileReader::DecodingWavFileReader(), ReadOnlyWaveFileModel::fillCache(), MP3FileReader::MP3FileReader(), DSSIPluginInstance::requestNonRTThread(), and ModelTransformerFactory::transformMultiple().