SonicVisualiser: Model Class Reference

Definition at line 34 of file Model.h.


Public Slots
void	aboutToDelete ()
void	sourceModelAboutToBeDeleted ()
Signals
void	modelChanged ()
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
void	modelChanged (size_t startFrame, size_t endFrame)
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
void	completionChanged ()
	Emitted when some internal processing has advanced a stage, but the model has not changed externally.
void	alignmentCompletionChanged ()
	Emitted when the completion percentage changes for the calculation of this model's alignment model.
void	aboutToBeDeleted ()
	Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.
Public Member Functions
virtual	~Model ()
virtual bool	isOK () const=0
	Return true if the model was constructed successfully.
virtual size_t	getStartFrame () const=0
	Return the first audio frame spanned by the model.
virtual size_t	getEndFrame () const=0
	Return the last audio frame spanned by the model.
virtual size_t	getSampleRate () const=0
	Return the frame rate in frames per second.
virtual size_t	getNativeRate () const
	Return the frame rate of the underlying material, if the model itself has already been resampled.
virtual QString	getTitle () const
	Return the "work title" of the model, if known.
virtual QString	getMaker () const
	Return the "artist" or "maker" of the model, if known.
virtual QString	getLocation () const
	Return the location of the data in this model (e.g.
virtual QString	getTypeName () const=0
	Return the type of the model.
virtual Model *	clone () const=0
	Return a copy of this model.
virtual bool	isReady (int *completion=0) const
	Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.
virtual const ZoomConstraint *	getZoomConstraint () const
	If this model imposes a zoom constraint, i.e.
virtual Model *	getSourceModel () const
	If this model was derived from another, return the model it was derived from.
virtual void	setSourceModel (Model *model)
	Set the source model for this model.
virtual void	setAlignment (AlignmentModel *alignment)
	Specify an aligment between this model's timeline and that of a reference model.
virtual const Model *	getAlignmentReference () const
	Return the reference model for the current alignment timeline, if any.
virtual size_t	alignToReference (size_t frame) const
	Return the frame number of the reference model that corresponds to the given frame number in this model.
virtual size_t	alignFromReference (size_t referenceFrame) const
	Return the frame number in this model that corresponds to the given frame number of the reference model.
virtual int	getAlignmentCompletion () const
	Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.
virtual void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream.
virtual QString	toDelimitedDataString (QString) const
virtual QString	toXmlString (QString indent="", QString extraAttributes="") const
	Convert this exportable object to XML in a string.
Static Public Member Functions
static QString	encodeEntities (QString)
static QString	encodeColour (QColor)
static int	getObjectExportId (const void *)
Static Public Attributes
static const int	COMPLETION_UNKNOWN
Protected Member Functions
	Model ()
	Model (const Model &)
Model &	operator= (const Model &)
Protected Attributes
Model *	m_sourceModel
AlignmentModel *	m_alignment
bool	m_aboutToDelete

Constructor & Destructor Documentation

Model::~Model ( ) [virtual]

Definition at line 26 of file Model.cpp.

References aboutToDelete(), PlayParameterRepository::getInstance(), m_aboutToDelete, m_alignment, and PlayParameterRepository::removeModel().

Model::Model ( ) [inline, protected]

Definition at line 233 of file Model.h.

Model::Model ( const Model & ) [protected]

Member Function Documentation

virtual bool Model::isOK ( ) const [pure virtual]

Return true if the model was constructed successfully.

Classes that refer to the model should always test this before use.

Implemented in AggregateWaveModel, AlignmentModel, EditableDenseThreeDimensionalModel, FFTModel, SparseModel< PointType >, WaveFileModel, WritableWaveFileModel, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< AlignmentModel::PathPoint >.

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), WaveformLayer::getChannelArrangement(), WaveformLayer::getCompletion(), WaveformLayer::getFeatureDescription(), SpectrogramLayer::getFeatureDescription(), SpectrogramLayer::getVerticalScaleWidth(), SpectrogramLayer::getXYBinSourceRange(), isReady(), WaveformLayer::paint(), TimeRulerLayer::paint(), SpectrumLayer::paint(), SpectrogramLayer::paint(), SliceLayer::paint(), Colour3DPlotLayer::paint(), WaveformLayer::paintVerticalScale(), SpectrogramLayer::paintVerticalScale(), WaveformLayer::setModel(), SpectrogramLayer::setModel(), and Colour3DPlotLayer::setModel().

virtual size_t Model::getStartFrame ( ) const [pure virtual]

Return the first audio frame spanned by the model.

Referenced by FFTDataServer::FFTDataServer(), Colour3DPlotLayer::fillCache(), SpectrogramLayer::fillTimerTimedOut(), Colour3DPlotLayer::getFeatureDescription(), WaveformLayer::getNormalizeGain(), AlignmentModel::getStartFrame(), SpectrogramLayer::getXBinRange(), Colour3DPlotLayer::paint(), Colour3DPlotLayer::paintDense(), FFTDataServer::FillThread::run(), toXml(), SpectrogramLayer::updateViewMagnitudes(), WavFileWriter::writeModel(), and MainWindowBase::zoomToFit().

virtual size_t Model::getEndFrame ( ) const [pure virtual]

Return the last audio frame spanned by the model.

Referenced by FeatureExtractionModelTransformer::addFeature(), AudioCallbackPlaySource::addModel(), alignFromReference(), alignToReference(), Pane::drawDurationAndRate(), FFTDataServer::FFTDataServer(), Colour3DPlotLayer::fillCache(), SpectrogramLayer::fillTimerTimedOut(), AlignmentModel::getEndFrame(), FFTDataServer::getFillExtent(), WaveformLayer::getNormalizeGain(), SpectrogramLayer::getXBinRange(), Colour3DPlotLayer::paint(), FFTDataServer::FillThread::run(), MainWindowBase::selectVisible(), toXml(), SpectrogramLayer::updateViewMagnitudes(), WavFileWriter::writeModel(), and MainWindowBase::zoomToFit().

virtual size_t Model::getSampleRate ( ) const [pure virtual]

Return the frame rate in frames per second.

virtual size_t Model::getNativeRate ( ) const [inline, virtual]

Return the frame rate of the underlying material, if the model itself has already been resampled.

Reimplemented in WaveFileModel.

Definition at line 67 of file Model.h.

References getSampleRate().

Referenced by Pane::drawDurationAndRate().

QString Model::getTitle ( ) const [virtual]

Return the "work title" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 150 of file Model.cpp.

References getTitle(), and m_sourceModel.

Referenced by Pane::drawWorkTitle(), and getTitle().

QString Model::getMaker ( ) const [virtual]

Return the "artist" or "maker" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 157 of file Model.cpp.

References getMaker(), and m_sourceModel.

Referenced by ModelDataModel::data(), Pane::drawWorkTitle(), and getMaker().

QString Model::getLocation ( ) const [virtual]

Return the location of the data in this model (e.g.

source URL). This should not normally be returned for editable models that have been edited.

Reimplemented in WaveFileModel.

Definition at line 164 of file Model.cpp.

References getLocation(), and m_sourceModel.

Referenced by ModelDataModel::data(), and getLocation().

virtual QString Model::getTypeName ( ) const [pure virtual]

virtual Model* Model::clone ( ) const [pure virtual]

Return a copy of this model.

If the model is not editable, this may be effectively a shallow copy. If the model is editable, however, this operation must properly copy all of the model's editable data.

In general this operation is not useful for non-editable dense models such as waveforms, because there may be no efficient copy operation implemented -- for such models it is better not to copy at all.

Caller owns the returned value.

Referenced by AlignmentModel::clone().

virtual bool Model::isReady ( int * completion = 0 ) const [inline, virtual]

Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.

The default implementation is appropriate for a thread that does not background any work but carries out all its calculation from the constructor or accessors.

If "completion" is non-NULL, this function should return through it an estimated percentage value showing how far through the background operation it thinks it is (for progress reporting). If it has no way to calculate progress, it may return the special value COMPLETION_UNKNOWN.

Reimplemented in AggregateWaveModel, AlignmentModel, SparseModel< PointType >, WaveFileModel, WritableWaveFileModel, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< AlignmentModel::PathPoint >.

Definition at line 120 of file Model.h.

References isOK().

Referenced by FFTDataServer::fillColumn(), SpectrogramLayer::getAdjustedYBinSourceRange(), WaveformLayer::getCompletion(), SpectrogramLayer::getXYBinSourceRange(), WaveformLayer::paint(), SpectrumLayer::paint(), SpectrogramLayer::paint(), SliceLayer::paint(), Colour3DPlotLayer::paint(), RealTimeEffectModelTransformer::run(), FFTDataServer::FillThread::run(), and FeatureExtractionModelTransformer::run().

virtual const ZoomConstraint* Model::getZoomConstraint ( ) const [inline, virtual]

If this model imposes a zoom constraint, i.e.

some limit to the set of resolutions at which its data can meaningfully be displayed, then return it.

Reimplemented in AggregateWaveModel, AlignmentModel, WaveFileModel, and WritableWaveFileModel.

Definition at line 132 of file Model.h.

Referenced by WaveformLayer::getZoomConstraint(), and Colour3DPlotLayer::getZoomConstraint().

virtual Model* Model::getSourceModel ( ) const [inline, virtual]

If this model was derived from another, return the model it was derived from.

The assumption is that the source model's alignment will also apply to this model, unless some other property (such as a specific alignment model set on this model) indicates otherwise.

Definition at line 143 of file Model.h.

References m_sourceModel.

Referenced by View::checkProgress(), and Pane::paintEvent().

void Model::setSourceModel ( Model * model ) [virtual]

Set the source model for this model.

Definition at line 49 of file Model.cpp.

References aboutToBeDeleted(), alignmentCompletionChanged(), m_sourceModel, and sourceModelAboutToBeDeleted().

Referenced by Document::addDerivedModel(), FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(), and FFTModel::FFTModel().

void Model::setAlignment ( AlignmentModel * alignment ) [virtual]

Specify an aligment between this model's timeline and that of a reference model.

The alignment model records both the reference and the alignment. This model takes ownership of the alignment model.

Definition at line 89 of file Model.cpp.

References aboutToDelete(), alignmentCompletionChanged(), completionChanged(), and m_alignment.

Referenced by Document::alignModel().

const Model * Model::getAlignmentReference ( ) const [virtual]

Return the reference model for the current alignment timeline, if any.

Definition at line 101 of file Model.cpp.

References getAlignmentReference(), AlignmentModel::getReferenceModel(), m_alignment, and m_sourceModel.

Referenced by Layer::alignFromReference(), Document::alignModel(), Layer::alignToReference(), Pane::drawAlignmentStatus(), View::getAligningModel(), and getAlignmentReference().

size_t Model::alignToReference ( size_t frame ) const [virtual]

Return the frame number of the reference model that corresponds to the given frame number in this model.

Definition at line 111 of file Model.cpp.

References getEndFrame(), AlignmentModel::getReferenceModel(), m_alignment, m_sourceModel, and AlignmentModel::toReference().

Referenced by ViewManager::alignPlaybackFrameToReference(), View::alignToReference(), and Layer::alignToReference().

size_t Model::alignFromReference ( size_t referenceFrame ) const [virtual]

Return the frame number in this model that corresponds to the given frame number of the reference model.

Definition at line 124 of file Model.cpp.

References AlignmentModel::fromReference(), getEndFrame(), m_alignment, and m_sourceModel.

Referenced by View::alignFromReference(), Layer::alignFromReference(), ViewManager::alignReferenceToPlaybackFrame(), and View::getAlignedPlaybackFrame().

int Model::getAlignmentCompletion ( ) const [virtual]

Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.

Definition at line 136 of file Model.cpp.

References AlignmentModel::isReady(), m_alignment, and m_sourceModel.

Referenced by View::checkProgress(), and Pane::drawAlignmentStatus().

void Model::toXml	(	QTextStream &	stream,
		QString	indent = `""`,
		QString	extraAttributes = `""`
	)			const `[virtual]`

Stream this exportable object out to XML on a text stream.

Implements XmlExportable.

Reimplemented in AggregateWaveModel, EditableDenseThreeDimensionalModel, ImageModel, NoteModel, SparseModel< PointType >, SparseValueModel< PointType >, TextModel, WaveFileModel, WritableWaveFileModel, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, SparseModel< AlignmentModel::PathPoint >, SparseValueModel< Note >, and SparseValueModel< TimeValuePoint >.

Definition at line 171 of file Model.cpp.

References XmlExportable::encodeEntities(), getEndFrame(), XmlExportable::getObjectExportId(), getSampleRate(), and getStartFrame().

Referenced by WritableWaveFileModel::toXml(), WaveFileModel::toXml(), SparseModel< PointType >::toXml(), and EditableDenseThreeDimensionalModel::toXml().

virtual QString Model::toDelimitedDataString ( QString ) const [inline, virtual]

Reimplemented in EditableDenseThreeDimensionalModel, SparseModel< PointType >, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< AlignmentModel::PathPoint >.

Definition at line 189 of file Model.h.

Referenced by CSVFileWriter::write().

void Model::aboutToDelete ( ) [slot]

Definition at line 67 of file Model.cpp.

References aboutToBeDeleted(), and m_aboutToDelete.

Referenced by Document::releaseModel(), setAlignment(), Document::setMainModel(), SpectrumLayer::setModel(), SpectrumLayer::setupFFT(), Document::~Document(), ~Model(), and SpectrumLayer::~SpectrumLayer().

void Model::sourceModelAboutToBeDeleted ( ) [slot]

Reimplemented in FFTModel.

Definition at line 83 of file Model.cpp.

References m_sourceModel.

Referenced by setSourceModel().

void Model::modelChanged ( ) [signal]

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by SparseValueModel< TimeValuePoint >::addPoint(), SparseModel< PointType >::addPoint(), SparseModel< PointType >::clear(), SparseValueModel< TimeValuePoint >::deletePoint(), SparseModel< PointType >::deletePoint(), EditableDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), SparseModel< PointType >::setCompletion(), EditableDenseThreeDimensionalModel::setCompletion(), SparseModel< PointType >::setResolution(), and WritableWaveFileModel::WritableWaveFileModel().

void Model::modelChanged	(	size_t	startFrame,
		size_t	endFrame
	)			`[signal]`

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

void Model::completionChanged ( ) [signal]

Emitted when some internal processing has advanced a stage, but the model has not changed externally.

Views should respond by updating any progress meters or other monitoring, but not refreshing the actual view.

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by setAlignment(), SparseModel< PointType >::setCompletion(), and EditableDenseThreeDimensionalModel::setCompletion().

void Model::alignmentCompletionChanged ( ) [signal]

Emitted when the completion percentage changes for the calculation of this model's alignment model.

Referenced by setAlignment(), and setSourceModel().

void Model::aboutToBeDeleted ( ) [signal]

Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.

Note that this depends on an external agent such as a Document object or owning model telling the model that it is about to delete it; there is nothing in the model to guarantee that this signal will be emitted before the actual deletion.

Referenced by aboutToDelete(), and setSourceModel().

Model& Model::operator= ( const Model & ) [protected]