A ModelTransformer turns one data model into another. More...
#include <ModelTransformer.h>
Classes | |
| class | Input |
Public Types | |
| typedef std::vector< Model * > | Models |
| enum | Type { RTThread, NonRTThread } |
Public Slots | |
| void | start () |
Public Member Functions | |
| virtual | ~ModelTransformer () |
| void | abandon () |
| Hint to the processing thread that it should give up, for example because the process is going to exit or we want to get rid of the input model. More... | |
| Model * | 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 models created by the transform or transforms. More... | |
| Models | detachOutputModels () |
| Return the set of output models, also detaching them from the transformer so that they will not be deleted when the transformer is. 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... | |
| virtual Models | detachAdditionalOutputModels () |
| Return the set of additional models, also detaching them from the transformer. More... | |
| QString | getMessage () const |
| Return a warning or error message. More... | |
Protected Member Functions | |
| ModelTransformer (Input input, const Transform &transform) | |
| ModelTransformer (Input input, const Transforms &transforms) | |
| virtual void | run ()=0 |
Protected Attributes | |
| Transforms | m_transforms |
| Input | m_input |
| Models | m_outputs |
| bool | m_detached |
| bool | m_detachedAdd |
| bool | m_abandoned |
| QString | m_message |
Detailed Description
A ModelTransformer turns one data model into another.
Typically in this application, a ModelTransformer might have a DenseTimeValueModel as its input (e.g. an audio waveform) and a SparseOneDimensionalModel (e.g. detected beats) as its output.
The ModelTransformer typically runs in the background, as a separate thread populating the output model. The model is available to the user of the ModelTransformer immediately, but may be initially empty until the background thread has populated it.
Definition at line 38 of file ModelTransformer.h.
Member Typedef Documentation
◆ Models
| typedef std::vector<Model *> ModelTransformer::Models |
Definition at line 43 of file ModelTransformer.h.
Member Enumeration Documentation
◆ Type
|
inherited |
Constructor & Destructor Documentation
◆ ~ModelTransformer()
|
virtual |
Definition at line 36 of file ModelTransformer.cpp.
References getAdditionalOutputModels(), getOutputModels(), m_abandoned, m_detached, and m_detachedAdd.
◆ ModelTransformer() [1/2]
Definition at line 18 of file ModelTransformer.cpp.
References m_transforms.
◆ ModelTransformer() [2/2]
|
protected |
Definition at line 27 of file ModelTransformer.cpp.
Member Function Documentation
◆ abandon()
|
inline |
Hint to the processing thread that it should give up, for example because the process is going to exit or we want to get rid of the input model.
Caller should still wait() and/or delete the transform before assuming its input and output models are no longer required.
Definition at line 68 of file ModelTransformer.h.
References m_abandoned.
Referenced by ModelTransformerFactory::modelAboutToBeDeleted(), and FeatureExtractionModelTransformer::setCompletion().
◆ getInputModel()
|
inline |
Return the input model for the transform.
Definition at line 73 of file ModelTransformer.h.
References ModelTransformer::Input::getModel(), and m_input.
Referenced by RealTimeEffectModelTransformer::getConformingInput(), FeatureExtractionModelTransformer::getConformingInput(), and ModelTransformerFactory::modelAboutToBeDeleted().
◆ getInputChannel()
|
inline |
Return the input channel spec for the transform.
Definition at line 78 of file ModelTransformer.h.
References ModelTransformer::Input::getChannel(), and m_input.
◆ getOutputModels()
|
inline |
Return the set of output models 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.
Definition at line 86 of file ModelTransformer.h.
References m_outputs.
Referenced by detachOutputModels(), ModelTransformerFactory::modelAboutToBeDeleted(), and ~ModelTransformer().
◆ detachOutputModels()
|
inline |
Return the set of output models, also detaching them from the transformer so that they will not be deleted when the transformer is.
The caller takes ownership of the models.
Definition at line 93 of file ModelTransformer.h.
References getOutputModels(), and m_detached.
Referenced by ModelTransformerFactory::transformMultiple().
◆ getAdditionalOutputModels()
|
inlinevirtual |
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 105 of file ModelTransformer.h.
Referenced by detachAdditionalOutputModels(), and ~ModelTransformer().
◆ willHaveAdditionalOutputModels()
|
inlinevirtual |
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 112 of file ModelTransformer.h.
Referenced by ModelTransformerFactory::transformerFinished().
◆ detachAdditionalOutputModels()
|
inlinevirtual |
Return the set of additional models, also detaching them from the transformer.
The caller takes ownership of the models.
Definition at line 118 of file ModelTransformer.h.
References getAdditionalOutputModels(), and m_detachedAdd.
Referenced by ModelTransformerFactory::transformerFinished().
◆ getMessage()
|
inline |
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 129 of file ModelTransformer.h.
References m_message.
Referenced by ModelTransformerFactory::transformMultiple().
◆ start
|
slotinherited |
Definition at line 34 of file Thread.cpp.
References Thread::m_type, and Thread::RTThread.
Referenced by DecodingWavFileReader::DecodingWavFileReader(), WaveFileModel::fillCache(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), DSSIPluginInstance::requestNonRTThread(), FFTDataServer::resume(), FFTDataServer::FillThread::run(), and ModelTransformerFactory::transformMultiple().
◆ run()
|
protectedpure virtualinherited |
Implemented in FFTDataServer::FillThread, DSSIPluginInstance::NonRTPluginThread, MP3FileReader::DecodeThread, WaveFileModel::RangeCacheFillThread, OggVorbisFileReader::DecodeThread, DecodingWavFileReader::DecodeThread, FeatureExtractionModelTransformer, FileReadThread, and RealTimeEffectModelTransformer.
Member Data Documentation
◆ m_transforms
|
protected |
Definition at line 135 of file ModelTransformer.h.
Referenced by FeatureExtractionModelTransformer::createOutputModels(), FeatureExtractionModelTransformer::initialise(), ModelTransformer(), RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), RealTimeEffectModelTransformer::run(), and FeatureExtractionModelTransformer::run().
◆ m_input
|
protected |
Definition at line 136 of file ModelTransformer.h.
Referenced by FeatureExtractionModelTransformer::addFeature(), FeatureExtractionModelTransformer::getFrames(), getInputChannel(), getInputModel(), RealTimeEffectModelTransformer::run(), and FeatureExtractionModelTransformer::run().
◆ m_outputs
|
protected |
Definition at line 137 of file ModelTransformer.h.
Referenced by FeatureExtractionModelTransformer::createOutputModels(), FeatureExtractionModelTransformer::getConformingOutput(), getOutputModels(), FeatureExtractionModelTransformer::isOutput(), RealTimeEffectModelTransformer::RealTimeEffectModelTransformer(), RealTimeEffectModelTransformer::run(), and FeatureExtractionModelTransformer::run().
◆ m_detached
|
protected |
Definition at line 138 of file ModelTransformer.h.
Referenced by detachOutputModels(), and ~ModelTransformer().
◆ m_detachedAdd
|
protected |
Definition at line 139 of file ModelTransformer.h.
Referenced by detachAdditionalOutputModels(), and ~ModelTransformer().
◆ m_abandoned
|
protected |
Definition at line 140 of file ModelTransformer.h.
Referenced by abandon(), RealTimeEffectModelTransformer::run(), FeatureExtractionModelTransformer::run(), and ~ModelTransformer().
◆ m_message
|
protected |
Definition at line 141 of file ModelTransformer.h.
Referenced by getMessage(), FeatureExtractionModelTransformer::initialise(), and FeatureExtractionModelTransformer::run().
The documentation for this class was generated from the following files:
