SonicVisualiser: NoteModel Class Reference

Definition at line 89 of file NoteModel.h.


Public Types
typedef Note	Point
typedef std::multiset< Note, typename Note::OrderComparator >	PointList
typedef PointList::iterator	PointListIterator
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
	NoteModel (size_t sampleRate, size_t resolution, bool notifyOnAdd=true)
	NoteModel (size_t sampleRate, size_t resolution, float valueMinimum, float valueMaximum, bool notifyOnAdd=true)
float	getValueQuantization () const
void	setValueQuantization (float q)
virtual PointList	getPoints (long start, long end) const
	Notes have a duration, so this returns all points that span any of the given range (as well as the usual additional few before and after).
virtual PointList	getPoints (long frame) const
	Notes have a duration, so this returns all points that span the given frame.
QString	getTypeName () const
	Return the type of the model.
virtual void	toXml (QTextStream &out, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream.
virtual float	getValueMinimum () const
virtual float	getValueMaximum () const
virtual QString	getScaleUnits () const
virtual void	setScaleUnits (QString units)
virtual void	addPoint (const Note &point)
	Add a point.
virtual void	deletePoint (const Note &point)
	Remove a point.
virtual bool	isOK () const
	Return true if the model was constructed successfully.
virtual size_t	getStartFrame () const
	Return the first audio frame spanned by the model.
virtual size_t	getEndFrame () const
	Return the last audio frame spanned by the model.
virtual size_t	getSampleRate () const
	Return the frame rate in frames per second.
virtual Model *	clone () const
	Return a copy of this model.
virtual size_t	getResolution () const
virtual void	setResolution (size_t resolution)
virtual bool	isEmpty () const
	Return whether the model is empty or not.
virtual size_t	getPointCount () const
	Get the total number of points in the model.
virtual const PointList &	getPoints () const
	Get all points.
virtual PointList	getPreviousPoints (long frame) const
	Return all points that share the nearest frame number prior to the given one at which there are any points.
virtual PointList	getNextPoints (long frame) const
	Return all points that share the nearest frame number subsequent to the given one at which there are any points.
virtual void	clear ()
	Remove all points.
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 void	setCompletion (int completion, bool update=true)
virtual int	getCompletion () const
virtual bool	hasTextLabels () const
virtual QString	toDelimitedDataString (QString delimiter) const
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 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 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 Attributes
float	m_valueQuantization
float	m_valueMinimum
float	m_valueMaximum
bool	m_haveExtents
QString	m_units
size_t	m_sampleRate
size_t	m_resolution
bool	m_notifyOnAdd
long	m_sinceLastNotifyMin
long	m_sinceLastNotifyMax
bool	m_hasTextLabels
PointList	m_points
size_t	m_pointCount
QMutex	m_mutex
int	m_completion
Model *	m_sourceModel
AlignmentModel *	m_alignment
bool	m_aboutToDelete

Member Typedef Documentation

typedef Note SparseModel< Note >::Point [inherited]

Definition at line 60 of file SparseModel.h.

typedef std::multiset<Note , typename Note ::OrderComparator> SparseModel< Note >::PointList [inherited]

Definition at line 62 of file SparseModel.h.

typedef PointList::iterator SparseModel< Note >::PointListIterator [inherited]

Definition at line 63 of file SparseModel.h.

Constructor & Destructor Documentation

NoteModel::NoteModel	(	size_t	sampleRate,
		size_t	resolution,
		bool	notifyOnAdd = `true`
	)			`[inline]`

Definition at line 92 of file NoteModel.h.

References PlayParameterRepository::addModel(), and PlayParameterRepository::getInstance().

NoteModel::NoteModel	(	size_t	sampleRate,
		size_t	resolution,
		float	valueMinimum,
		float	valueMaximum,
		bool	notifyOnAdd = `true`
	)			`[inline]`

Definition at line 101 of file NoteModel.h.

References PlayParameterRepository::addModel(), and PlayParameterRepository::getInstance().

Member Function Documentation

float NoteModel::getValueQuantization ( ) const [inline]

Definition at line 112 of file NoteModel.h.

References m_valueQuantization.

Referenced by NoteLayer::getFeatureDescription(), and NoteLayer::paint().

void NoteModel::setValueQuantization ( float q ) [inline]

Definition at line 113 of file NoteModel.h.

References m_valueQuantization.

Referenced by MIDIFileReader::loadTrack(), and SVFileReader::readModel().

NoteModel::PointList NoteModel::getPoints	(	long	start,
		long	end
	)			const `[virtual]`

Notes have a duration, so this returns all points that span any of the given range (as well as the usual additional few before and after).

Consequently this can be very slow (optimised data structures still to be done!).

Reimplemented from SparseModel< Note >.

Definition at line 19 of file NoteModel.cpp.

References SparseModel< Note >::m_mutex, and SparseModel< Note >::m_points.

Referenced by NoteLayer::copy(), NoteLayer::deleteSelection(), NoteLayer::getLocalPoints(), AudioGenerator::mixNoteModel(), NoteLayer::moveSelection(), NoteLayer::paint(), NoteLayer::resizeSelection(), and NoteLayer::snapToFeatureFrame().

NoteModel::PointList NoteModel::getPoints ( long frame ) const [virtual]

Notes have a duration, so this returns all points that span the given frame.

Consequently this can be very slow (optimised data structures still to be done!).

Reimplemented from SparseModel< Note >.

Definition at line 48 of file NoteModel.cpp.

References SparseModel< Note >::m_mutex, SparseModel< Note >::m_points, and SparseModel< Note >::m_resolution.

QString NoteModel::getTypeName ( ) const [inline, virtual]

Return the type of the model.

For display purposes only.

Reimplemented from SparseValueModel< Note >.

Definition at line 130 of file NoteModel.h.

virtual void NoteModel::toXml	(	QTextStream &	out,
		QString	indent = `""`,
		QString	extraAttributes = `""`
	)			const `[inline, virtual]`

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

Reimplemented from SparseValueModel< Note >.

Definition at line 132 of file NoteModel.h.

References m_valueQuantization, and SparseValueModel< PointType >::toXml().

virtual float SparseValueModel< Note >::getValueMinimum ( ) const [inline, virtual, inherited]

Definition at line 58 of file SparseValueModel.h.

virtual float SparseValueModel< Note >::getValueMaximum ( ) const [inline, virtual, inherited]

Definition at line 59 of file SparseValueModel.h.

virtual QString SparseValueModel< Note >::getScaleUnits ( ) const [inline, virtual, inherited]

Definition at line 61 of file SparseValueModel.h.

virtual void SparseValueModel< Note >::setScaleUnits ( QString units ) [inline, virtual, inherited]

Definition at line 62 of file SparseValueModel.h.

virtual void SparseValueModel< Note >::addPoint ( const Note & point ) [inline, virtual, inherited]

Add a point.

Reimplemented from SparseModel< Note >.

Definition at line 67 of file SparseValueModel.h.

virtual void SparseValueModel< Note >::deletePoint ( const Note & point ) [inline, virtual, inherited]

Remove a point.

Points are not necessarily unique, so this function will remove the first point that compares equal to the supplied one using Point::Comparator. Other identical points may remain in the model.

Reimplemented from SparseModel< Note >.

Definition at line 87 of file SparseValueModel.h.

virtual bool SparseModel< Note >::isOK ( ) const [inline, virtual, inherited]

Return true if the model was constructed successfully.

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

Implements Model.

Definition at line 43 of file SparseModel.h.

virtual size_t SparseModel< Note >::getStartFrame ( ) const [virtual, inherited]

Return the first audio frame spanned by the model.

Implements Model.

virtual size_t SparseModel< Note >::getEndFrame ( ) const [virtual, inherited]

Return the last audio frame spanned by the model.

Implements Model.

virtual size_t SparseModel< Note >::getSampleRate ( ) const [inline, virtual, inherited]

Return the frame rate in frames per second.

Implements Model.

Definition at line 46 of file SparseModel.h.

virtual Model* SparseModel< Note >::clone ( ) const [virtual, inherited]

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.

Implements Model.

virtual size_t SparseModel< Note >::getResolution ( ) const [inline, virtual, inherited]

Definition at line 55 of file SparseModel.h.

virtual void SparseModel< Note >::setResolution ( size_t resolution ) [virtual, inherited]

virtual bool SparseModel< Note >::isEmpty ( ) const [virtual, inherited]

Return whether the model is empty or not.

virtual size_t SparseModel< Note >::getPointCount ( ) const [virtual, inherited]

Get the total number of points in the model.

virtual const PointList& SparseModel< Note >::getPoints ( ) const [inline, virtual, inherited]

Get all points.

Definition at line 92 of file SparseModel.h.

virtual PointList SparseModel< Note >::getPreviousPoints ( long frame ) const [virtual, inherited]

Return all points that share the nearest frame number prior to the given one at which there are any points.

virtual PointList SparseModel< Note >::getNextPoints ( long frame ) const [virtual, inherited]

Return all points that share the nearest frame number subsequent to the given one at which there are any points.

virtual void SparseModel< Note >::clear ( ) [virtual, inherited]

Remove all points.

virtual bool SparseModel< Note >::isReady ( int * completion = 0 ) const [inline, virtual, inherited]

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 from Model.

Definition at line 124 of file SparseModel.h.

virtual void SparseModel< Note >::setCompletion	(	int	completion,
		bool	update = `true`
	)			`[virtual, inherited]`

virtual int SparseModel< Note >::getCompletion ( ) const [inline, virtual, inherited]

Definition at line 131 of file SparseModel.h.

virtual bool SparseModel< Note >::hasTextLabels ( ) const [inline, virtual, inherited]

Definition at line 133 of file SparseModel.h.

virtual QString SparseModel< Note >::toDelimitedDataString ( QString delimiter ) const [inline, virtual, inherited]

Reimplemented from Model.

Definition at line 141 of file SparseModel.h.

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

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 Model::getSampleRate().

Referenced by Pane::drawDurationAndRate().

QString Model::getTitle ( ) const [virtual, inherited]

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

Reimplemented in WaveFileModel.

Definition at line 150 of file Model.cpp.

References Model::getTitle(), and Model::m_sourceModel.

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

QString Model::getMaker ( ) const [virtual, inherited]

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

Reimplemented in WaveFileModel.

Definition at line 157 of file Model.cpp.

References Model::getMaker(), and Model::m_sourceModel.

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

QString Model::getLocation ( ) const [virtual, inherited]

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 Model::getLocation(), and Model::m_sourceModel.

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

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

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, inherited]

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 Model::m_sourceModel.

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

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

Set the source model for this model.

Definition at line 49 of file Model.cpp.

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

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

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

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 Model::aboutToDelete(), Model::alignmentCompletionChanged(), Model::completionChanged(), and Model::m_alignment.

Referenced by Document::alignModel().

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

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

Definition at line 101 of file Model.cpp.

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

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

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

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 Model::getEndFrame(), AlignmentModel::getReferenceModel(), Model::m_alignment, Model::m_sourceModel, and AlignmentModel::toReference().

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

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

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(), Model::getEndFrame(), Model::m_alignment, and Model::m_sourceModel.

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

int Model::getAlignmentCompletion ( ) const [virtual, inherited]

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(), Model::m_alignment, and Model::m_sourceModel.

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

void Model::aboutToDelete ( ) [slot, inherited]

Definition at line 67 of file Model.cpp.

References Model::aboutToBeDeleted(), and Model::m_aboutToDelete.

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

void Model::sourceModelAboutToBeDeleted ( ) [slot, inherited]

Reimplemented in FFTModel.

Definition at line 83 of file Model.cpp.

References Model::m_sourceModel.

Referenced by Model::setSourceModel().

void Model::modelChanged ( ) [signal, inherited]

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, inherited]`

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, inherited]

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 Model::setAlignment(), SparseModel< PointType >::setCompletion(), and EditableDenseThreeDimensionalModel::setCompletion().

void Model::alignmentCompletionChanged ( ) [signal, inherited]

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

Referenced by Model::setAlignment(), and Model::setSourceModel().

void Model::aboutToBeDeleted ( ) [signal, inherited]

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 Model::aboutToDelete(), and Model::setSourceModel().