SonicVisualiser: WaveFileModel Class Reference

Definition at line 32 of file WaveFileModel.h.


Public Types
typedef std::vector< Range >	RangeBlock
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, size_t)
	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
	WaveFileModel (FileSource source, size_t targetRate=0)
	WaveFileModel (FileSource source, AudioFileReader *reader)
	~WaveFileModel ()
bool	isOK () const
	Return true if the model was constructed successfully.
bool	isReady (int *) 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.
const ZoomConstraint *	getZoomConstraint () const
	If this model imposes a zoom constraint, i.e.
size_t	getFrameCount () const
size_t	getChannelCount () const
	Return the number of distinct channels for this model.
size_t	getSampleRate () const
	Return the frame rate in frames per second.
size_t	getNativeRate () const
	Return the frame rate of the underlying material, if the model itself has already been resampled.
QString	getTitle () const
	Return the "work title" of the model, if known.
QString	getMaker () const
	Return the "artist" or "maker" of the model, if known.
QString	getLocation () const
	Return the location of the data in this model (e.g.
virtual Model *	clone () const
	Return a copy of this model.
float	getValueMinimum () const
	Return the minimum possible value found in this model type.
float	getValueMaximum () const
	Return the minimum possible value found in this model type.
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.
void	setStartFrame (size_t startFrame)
virtual size_t	getData (int channel, size_t start, size_t count, float *buffer) const
	Get the specified set of samples from the given channel of the model in single-precision floating-point format.
virtual size_t	getData (int channel, size_t start, size_t count, double *buffer) const
	Get the specified set of samples from the given channel of the model in double-precision floating-point format.
virtual size_t	getData (size_t fromchannel, size_t tochannel, size_t start, size_t count, float **buffers) const
	Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format.
virtual size_t	getSummaryBlockSize (size_t desired) const
virtual void	getSummaries (size_t channel, size_t start, size_t count, RangeBlock &ranges, size_t &blockSize) const
virtual Range	getSummary (size_t channel, size_t start, size_t count) const
	Return the range from the given start frame, corresponding to the given number of underlying sample frames, summarised at a block size equal to the distance between start and end frames.
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 void	getSummaries (size_t channel, size_t start, size_t count, RangeBlock &ranges, size_t &blockSize) const=0
	Return ranges from the given start frame, corresponding to the given number of underlying sample frames, summarised at the given block size.
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	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 Slots
void	fillTimerTimedOut ()
void	cacheFilled ()
Protected Member Functions
void	initialize ()
void	fillCache ()
Protected Attributes
FileSource	m_source
QString	m_path
AudioFileReader *	m_reader
bool	m_myReader
size_t	m_startFrame
RangeBlock	m_cache [2]
QMutex	m_mutex
RangeCacheFillThread *	m_fillThread
QTimer *	m_updateTimer
size_t	m_lastFillExtent
bool	m_exiting
SampleBlock	m_directRead
size_t	m_lastDirectReadStart
size_t	m_lastDirectReadCount
QMutex	m_directReadMutex
Model *	m_sourceModel
AlignmentModel *	m_alignment
bool	m_aboutToDelete
Static Protected Attributes
static PowerOfSqrtTwoZoomConstraint	m_zoomConstraint
Classes
class	RangeCacheFillThread

Member Typedef Documentation

typedef std::vector<Range> RangeSummarisableTimeValueModel::RangeBlock [inherited]

Definition at line 51 of file RangeSummarisableTimeValueModel.h.

Constructor & Destructor Documentation

WaveFileModel::WaveFileModel	(	FileSource	source,
		size_t	targetRate = `0`
	)

Definition at line 42 of file WaveFileModel.cpp.

References AudioFileReaderFactory::createThreadingReader(), fillCache(), AudioFileReader::getSampleRate(), AudioFileReader::getTitle(), isOK(), FileSource::isOK(), m_path, m_reader, m_source, and FileSource::waitForData().

Referenced by clone().

WaveFileModel::WaveFileModel	(	FileSource	source,
		AudioFileReader *	reader
	)

Definition at line 66 of file WaveFileModel.cpp.

References fillCache(), AudioFileReader::getTitle(), m_path, and m_reader.

WaveFileModel::~WaveFileModel ( )

Definition at line 82 of file WaveFileModel.cpp.

References m_exiting, m_fillThread, m_myReader, and m_reader.

Member Function Documentation

bool WaveFileModel::isOK ( ) const [virtual]

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 91 of file WaveFileModel.cpp.

References AudioFileReader::isOK(), and m_reader.

Referenced by getSummaries(), getSummary(), isReady(), MainWindowBase::openAudio(), SVFileReader::readModel(), WaveFileModel::RangeCacheFillThread::run(), WaveFileModel(), and WritableWaveFileModel::WritableWaveFileModel().

bool WaveFileModel::isReady ( int * completion ) const [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 from Model.

Definition at line 97 of file WaveFileModel.cpp.

References AudioFileReader::getDecodeCompletion(), getEndFrame(), getStartFrame(), isOK(), m_fillThread, m_lastFillExtent, and m_reader.

const ZoomConstraint* WaveFileModel::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 from Model.

Definition at line 44 of file WaveFileModel.h.

References m_zoomConstraint.

size_t WaveFileModel::getFrameCount ( ) const

Definition at line 132 of file WaveFileModel.cpp.

References AudioFileReader::getFrameCount(), and m_reader.

Referenced by getEndFrame(), getSummaries(), and WaveFileModel::RangeCacheFillThread::run().

size_t WaveFileModel::getChannelCount ( ) const [virtual]

Return the number of distinct channels for this model.

Implements DenseTimeValueModel.

Definition at line 139 of file WaveFileModel.cpp.

References AudioFileReader::getChannelCount(), and m_reader.

Referenced by WritableWaveFileModel::getData(), getData(), WritableWaveFileModel::getSummaries(), getSummaries(), WritableWaveFileModel::getSummary(), WaveFileModel::RangeCacheFillThread::run(), MainWindow::setupPaneAndLayerMenus(), and WritableWaveFileModel::toXml().

size_t WaveFileModel::getSampleRate ( ) const [virtual]

Return the frame rate in frames per second.

Implements Model.

Definition at line 146 of file WaveFileModel.cpp.

References AudioFileReader::getSampleRate(), and m_reader.

Referenced by MainWindowBase::ffwd(), getNativeRate(), MainWindowBase::mainModelChanged(), MainWindowBase::playbackFrameChanged(), MainWindowBase::rewind(), and MainWindow::updateDescriptionLabel().

size_t WaveFileModel::getNativeRate ( ) const [virtual]

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

Reimplemented from Model.

Definition at line 153 of file WaveFileModel.cpp.

References AudioFileReader::getNativeRate(), getSampleRate(), and m_reader.

QString WaveFileModel::getTitle ( ) const [virtual]

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

Reimplemented from Model.

Definition at line 162 of file WaveFileModel.cpp.

References AudioFileReader::getTitle(), and m_reader.

QString WaveFileModel::getMaker ( ) const [virtual]

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

Reimplemented from Model.

Definition at line 171 of file WaveFileModel.cpp.

References AudioFileReader::getMaker(), and m_reader.

QString WaveFileModel::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 from Model.

Definition at line 178 of file WaveFileModel.cpp.

References AudioFileReader::getLocation(), and m_reader.

Model * WaveFileModel::clone ( ) const [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.

Implements Model.

Definition at line 125 of file WaveFileModel.cpp.

References m_source, and WaveFileModel().

float WaveFileModel::getValueMinimum ( ) const [inline, virtual]

Return the minimum possible value found in this model type.

(That is, the minimum that would be valid, not the minimum actually found in a particular model).

Implements DenseTimeValueModel.

Definition at line 57 of file WaveFileModel.h.

float WaveFileModel::getValueMaximum ( ) const [inline, virtual]

Return the minimum possible value found in this model type.

(That is, the minimum that would be valid, not the minimum actually found in a particular model).

Implements DenseTimeValueModel.

Definition at line 58 of file WaveFileModel.h.

virtual size_t WaveFileModel::getStartFrame ( ) const [inline, virtual]

Return the first audio frame spanned by the model.

Implements Model.

Definition at line 60 of file WaveFileModel.h.

References m_startFrame.

Referenced by MainWindow::handleOSCMessage(), isReady(), MainWindowBase::rewind(), and MainWindowBase::rewindStart().

virtual size_t WaveFileModel::getEndFrame ( ) const [inline, virtual]

Return the last audio frame spanned by the model.

Implements Model.

Definition at line 61 of file WaveFileModel.h.

References getFrameCount(), and m_startFrame.

Referenced by cacheFilled(), MainWindowBase::ffwd(), MainWindowBase::ffwdEnd(), MainWindow::handleOSCMessage(), isReady(), and MainWindowBase::selectToEnd().

void WaveFileModel::setStartFrame ( size_t startFrame ) [inline]

Definition at line 63 of file WaveFileModel.h.

References m_startFrame.

Referenced by WritableWaveFileModel::setStartFrame(), and WritableWaveFileModel::WritableWaveFileModel().

size_t WaveFileModel::getData	(	int	channel,
		size_t	start,
		size_t	count,
		float *	buffer
	)			const `[virtual]`

Get the specified set of samples from the given channel of the model in single-precision floating-point format.

Return the number of samples actually retrieved. If the channel is given as -1, mix all available channels and return the result.

Implements DenseTimeValueModel.

Definition at line 185 of file WaveFileModel.cpp.

References getChannelCount(), AudioFileReader::getInterleavedFrames(), AudioFileReader::isOK(), m_reader, and m_startFrame.

Referenced by WritableWaveFileModel::getData(), and getData().

size_t WaveFileModel::getData	(	int	channel,
		size_t	start,
		size_t	count,
		double *	buffer
	)			const `[virtual]`

Get the specified set of samples from the given channel of the model in double-precision floating-point format.

Return the number of samples actually retrieved. If the channel is given as -1, mix all available channels and return the result.

Implements DenseTimeValueModel.

Definition at line 247 of file WaveFileModel.cpp.

References getChannelCount(), AudioFileReader::getInterleavedFrames(), AudioFileReader::isOK(), m_reader, and m_startFrame.

size_t WaveFileModel::getData	(	size_t	fromchannel,
		size_t	tochannel,
		size_t	start,
		size_t	count,
		float **	buffers
	)			const `[virtual]`

Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format.

Return the number of sample frames actually retrieved.

Implements DenseTimeValueModel.

Definition at line 300 of file WaveFileModel.cpp.

References getChannelCount(), getData(), AudioFileReader::getInterleavedFrames(), AudioFileReader::isOK(), m_reader, and m_startFrame.

size_t WaveFileModel::getSummaryBlockSize ( size_t desired ) const [virtual]

Implements RangeSummarisableTimeValueModel.

Definition at line 383 of file WaveFileModel.cpp.

References PowerOfSqrtTwoZoomConstraint::getMinCachePower(), PowerOfSqrtTwoZoomConstraint::getNearestBlockSize(), m_zoomConstraint, and ZoomConstraint::RoundDown.

Referenced by WritableWaveFileModel::getSummaryBlockSize().

void WaveFileModel::getSummaries	(	size_t	channel,
		size_t	start,
		size_t	count,
		RangeBlock &	ranges,
		size_t &	blockSize
	)			const `[virtual]`

Definition at line 399 of file WaveFileModel.cpp.

References getChannelCount(), getFrameCount(), AudioFileReader::getInterleavedFrames(), PowerOfSqrtTwoZoomConstraint::getMinCachePower(), PowerOfSqrtTwoZoomConstraint::getNearestBlockSize(), isOK(), m_cache, m_directRead, m_directReadMutex, m_lastDirectReadCount, m_lastDirectReadStart, m_mutex, m_reader, m_startFrame, m_zoomConstraint, and ZoomConstraint::RoundDown.

Referenced by WritableWaveFileModel::getSummaries(), and getSummary().

WaveFileModel::Range WaveFileModel::getSummary	(	size_t	channel,
		size_t	start,
		size_t	count
	)			const `[virtual]`

Return the range from the given start frame, corresponding to the given number of underlying sample frames, summarised at a block size equal to the distance between start and end frames.

Implements RangeSummarisableTimeValueModel.

Definition at line 532 of file WaveFileModel.cpp.

References getSummaries(), isOK(), and m_startFrame.

Referenced by WritableWaveFileModel::getSummary().

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

Return the type of the model.

For display purposes only.

Reimplemented from RangeSummarisableTimeValueModel.

Definition at line 83 of file WaveFileModel.h.

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

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

Reimplemented from Model.

Definition at line 782 of file WaveFileModel.cpp.

References XmlExportable::encodeEntities(), m_path, and Model::toXml().

Referenced by Document::toXml().

void WaveFileModel::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 from Model.

Referenced by cacheFilled(), and fillTimerTimedOut().

void WaveFileModel::modelChanged	(	size_t	,
		size_t
	)			`[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 from Model.

void WaveFileModel::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 from Model.

void WaveFileModel::fillTimerTimedOut ( ) [protected, slot]

Definition at line 604 of file WaveFileModel.cpp.

References WaveFileModel::RangeCacheFillThread::getFillExtent(), m_fillThread, m_lastFillExtent, and modelChanged().

Referenced by fillCache().

void WaveFileModel::cacheFilled ( ) [protected, slot]

Definition at line 624 of file WaveFileModel.cpp.

References getEndFrame(), m_fillThread, m_lastFillExtent, m_mutex, m_updateTimer, and modelChanged().

Referenced by fillCache().

void WaveFileModel::initialize ( ) [protected]

void WaveFileModel::fillCache ( ) [protected]

Definition at line 584 of file WaveFileModel.cpp.

References cacheFilled(), fillTimerTimedOut(), m_fillThread, m_mutex, m_updateTimer, and Thread::start().

Referenced by WaveFileModel().

virtual void RangeSummarisableTimeValueModel::getSummaries	(	size_t	channel,
		size_t	start,
		size_t	count,
		RangeBlock &	ranges,
		size_t &	blockSize
	)			const `[pure virtual, inherited]`

Return ranges from the given start frame, corresponding to the given number of underlying sample frames, summarised at the given block size.

duration / blockSize ranges should ideally be returned.

If the given block size is not supported by this model (according to its zoom constraint), also modify the blockSize parameter so as to return the block size that was actually obtained.

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

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().

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

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