svcore  1.9
WritableWaveFileModel Class Reference

#include <WritableWaveFileModel.h>

Inheritance diagram for WritableWaveFileModel:
Collaboration diagram for WritableWaveFileModel:

List of all members.

Public Types

typedef std::vector< RangeRangeBlock

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 modelChangedWithin (int startFrame, int 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 ready ()
 Emitted when internal processing is complete (i.e.
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

 WritableWaveFileModel (int sampleRate, int channels, QString path="")
 ~WritableWaveFileModel ()
virtual bool addSamples (float **samples, int count)
 Call addSamples to append a block of samples to the end of the file.
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.
virtual void setCompletion (int completion)
virtual int getCompletion () const
const ZoomConstraintgetZoomConstraint () const
 If this model imposes a zoom constraint, i.e.
int getFrameCount () const
int getChannelCount () const
 Return the number of distinct channels for this model.
int getSampleRate () const
 Return the frame rate in frames per second.
virtual Modelclone () 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 int getStartFrame () const
 Return the first audio frame spanned by the model.
virtual int getEndFrame () const
 Return the last audio frame spanned by the model.
void setStartFrame (int startFrame)
virtual int getData (int channel, int start, int count, float *buffer) const
 Get the specified set of samples from the given channel of the model in single-precision floating-point format.
virtual int getData (int channel, int start, int count, double *buffer) const
 Get the specified set of samples from the given channel of the model in double-precision floating-point format.
virtual int getData (int fromchannel, int tochannel, int start, int count, float **buffer) const
 Get the specified set of samples from given contiguous range of channels of the model in single-precision floating-point format.
virtual int getSummaryBlockSize (int desired) const
virtual void getSummaries (int channel, int start, int count, RangeBlock &ranges, int &blockSize) const
 Return ranges from the given start frame, corresponding to the given number of underlying sample frames, summarised at the given block size.
virtual Range getSummary (int channel, int start, int 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 bool canPlay () const
virtual QString getDefaultPlayClipId () const
virtual QString toDelimitedDataStringSubset (QString delimiter, int f0, int f1) const
virtual int 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 void abandon ()
 Mark the model as abandoning.
virtual bool isAbandoning () const
 Query whether the model has been marked as abandoning.
virtual ModelgetSourceModel () 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 AlignmentModelgetAlignment () const
 Retrieve the alignment model for this model.
virtual const ModelgetAlignmentReference () const
 Return the reference model for the current alignment timeline, if any.
virtual int alignToReference (int frame) const
 Return the frame number of the reference model that corresponds to the given frame number in this model.
virtual int alignFromReference (int 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.
void setRDFTypeURI (QString uri)
 Set the event, feature, or signal type URI for the features contained in this model, according to the Audio Features RDF ontology.
QString getRDFTypeURI () const
 Retrieve the event, feature, or signal type URI for the features contained in this model, if previously set with setRDFTypeURI.
virtual QString toDelimitedDataString (QString delimiter) const
virtual QString toXmlString (QString indent="", QString extraAttributes="") const
 Convert this exportable object to XML in a string.
virtual bool getDefaultPlayAudible () const

Static Public Member Functions

static QString encodeEntities (QString)
static QString encodeColour (int r, int g, int b)
static int getObjectExportId (const void *)

Static Public Attributes

static const int COMPLETION_UNKNOWN = -1

Protected Attributes

WaveFileModelm_model
WavFileWriterm_writer
WavFileReaderm_reader
int m_sampleRate
int m_channels
int m_frameCount
int m_startFrame
int m_completion
Modelm_sourceModel
AlignmentModelm_alignment
QString m_typeUri
bool m_abandoning
bool m_aboutToDelete

Detailed Description

Definition at line 24 of file WritableWaveFileModel.h.


Member Typedef Documentation

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

Definition at line 64 of file RangeSummarisableTimeValueModel.h.


Constructor & Destructor Documentation


Member Function Documentation

bool WritableWaveFileModel::addSamples ( float **  samples,
int  count 
) [virtual]

Call addSamples to append a block of samples to the end of the file.

Caller should also call setCompletion to update the progress of this file, if it has a known end point, and should call setCompletion(100) when the file has been written.

Definition at line 108 of file WritableWaveFileModel.cpp.

References AudioFileReader::getChannelCount(), WavFileWriter::getError(), m_frameCount, m_reader, m_writer, SVDEBUG, WavFileReader::updateFrameCount(), and WavFileWriter::writeSamples().

Referenced by RealTimeEffectModelTransformer::run().

bool WritableWaveFileModel::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 142 of file WritableWaveFileModel.cpp.

References WavFileWriter::isOK(), and m_writer.

bool WritableWaveFileModel::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 150 of file WritableWaveFileModel.cpp.

References m_completion.

void WritableWaveFileModel::setCompletion ( int  completion) [virtual]
virtual int WritableWaveFileModel::getCompletion ( ) const [inline, virtual]

Definition at line 44 of file WritableWaveFileModel.h.

References m_completion.

const ZoomConstraint* WritableWaveFileModel::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 46 of file WritableWaveFileModel.h.

Definition at line 166 of file WritableWaveFileModel.cpp.

References m_frameCount.

Referenced by getEndFrame().

int WritableWaveFileModel::getChannelCount ( ) const [inline, virtual]

Return the number of distinct channels for this model.

Implements DenseTimeValueModel.

Definition at line 52 of file WritableWaveFileModel.h.

References m_channels.

int WritableWaveFileModel::getSampleRate ( ) const [inline, virtual]

Return the frame rate in frames per second.

Implements Model.

Definition at line 53 of file WritableWaveFileModel.h.

References m_sampleRate.

Model * WritableWaveFileModel::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 173 of file WritableWaveFileModel.cpp.

float WritableWaveFileModel::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 WritableWaveFileModel.h.

float WritableWaveFileModel::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 WritableWaveFileModel.h.

virtual int WritableWaveFileModel::getStartFrame ( ) const [inline, virtual]

Return the first audio frame spanned by the model.

Implements Model.

Definition at line 60 of file WritableWaveFileModel.h.

References m_startFrame.

virtual int WritableWaveFileModel::getEndFrame ( ) const [inline, virtual]

Return the last audio frame spanned by the model.

Implements Model.

Definition at line 61 of file WritableWaveFileModel.h.

References getFrameCount(), and m_startFrame.

int WritableWaveFileModel::getData ( int  channel,
int  start,
int  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 180 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

int WritableWaveFileModel::getData ( int  channel,
int  start,
int  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 188 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

int WritableWaveFileModel::getData ( int  fromchannel,
int  tochannel,
int  start,
int  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 196 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getData(), and m_model.

int WritableWaveFileModel::getSummaryBlockSize ( int  desired) const [virtual]
void WritableWaveFileModel::getSummaries ( int  channel,
int  start,
int  count,
RangeBlock ranges,
int &  blockSize 
) const [virtual]

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.

Implements RangeSummarisableTimeValueModel.

Definition at line 212 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getSummaries(), and m_model.

WritableWaveFileModel::Range WritableWaveFileModel::getSummary ( int  channel,
int  start,
int  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 222 of file WritableWaveFileModel.cpp.

References WaveFileModel::getChannelCount(), WaveFileModel::getSummary(), and m_model.

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

Return the type of the model.

For display purposes only.

Reimplemented from RangeSummarisableTimeValueModel.

Definition at line 82 of file WritableWaveFileModel.h.

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

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

Reimplemented from Model.

Definition at line 229 of file WritableWaveFileModel.cpp.

References XmlExportable::encodeEntities(), WaveFileModel::getChannelCount(), WavFileWriter::getPath(), m_model, and m_writer.

virtual bool DenseTimeValueModel::canPlay ( ) const [inline, virtual, inherited]

Reimplemented from Playable.

Definition at line 87 of file DenseTimeValueModel.h.

virtual QString DenseTimeValueModel::getDefaultPlayClipId ( ) const [inline, virtual, inherited]

Reimplemented from Playable.

Definition at line 88 of file DenseTimeValueModel.h.

QString DenseTimeValueModel::toDelimitedDataStringSubset ( QString  delimiter,
int  f0,
int  f1 
) const [virtual, inherited]

Reimplemented from Model.

Definition at line 32 of file DenseTimeValueModel.cpp.

References DenseTimeValueModel::getChannelCount(), and DenseTimeValueModel::getData().

virtual int 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 69 of file Model.h.

References Model::getSampleRate().

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

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

Reimplemented in WaveFileModel.

Definition at line 153 of file Model.cpp.

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

Referenced by Model::getTitle().

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

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

Reimplemented in WaveFileModel.

Definition at line 160 of file Model.cpp.

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

Referenced by 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 167 of file Model.cpp.

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

Referenced by Model::getLocation().

virtual void Model::abandon ( ) [inline, virtual, inherited]

Mark the model as abandoning.

This means that the application no longer needs it, so it can stop doing any background calculations it may be involved in. Note that as far as the model API is concerned, this does nothing more than tell the model to return true from isAbandoning(). The actual response to this will depend on the model's context -- it's possible nothing at all will change.

Definition at line 118 of file Model.h.

References Model::m_abandoning.

virtual bool Model::isAbandoning ( ) const [inline, virtual, inherited]

Query whether the model has been marked as abandoning.

Definition at line 125 of file Model.h.

References Model::m_abandoning.

Referenced by FeatureExtractionModelTransformer::setCompletion().

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 165 of file Model.h.

References Model::m_sourceModel.

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 82 of file Model.cpp.

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

const AlignmentModel * Model::getAlignment ( ) const [virtual, inherited]

Retrieve the alignment model for this model.

This is not a generally useful function, as the alignment you really want may be performed by the source model instead. You should normally use getAlignmentReference, alignToReference and alignFromReference instead of this. The main intended application for this function is in streaming out alignments to the session file.

Definition at line 94 of file Model.cpp.

References Model::m_alignment.

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

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

Definition at line 100 of file Model.cpp.

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

Referenced by Model::getAlignmentReference().

int Model::alignToReference ( int  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 110 of file Model.cpp.

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

Referenced by Model::alignToReference().

int Model::alignFromReference ( int  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 125 of file Model.cpp.

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

Referenced by Model::alignFromReference().

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 139 of file Model.cpp.

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

Referenced by Model::getAlignmentCompletion().

void Model::setRDFTypeURI ( QString  uri) [inline, inherited]

Set the event, feature, or signal type URI for the features contained in this model, according to the Audio Features RDF ontology.

Definition at line 223 of file Model.h.

References Model::m_typeUri.

Referenced by FeatureExtractionModelTransformer::createOutputModels(), FeatureExtractionModelTransformer::getAdditionalModel(), RDFImporterImpl::getDataModelsDense(), and RDFImporterImpl::getDataModelsSparse().

QString Model::getRDFTypeURI ( ) const [inline, inherited]

Retrieve the event, feature, or signal type URI for the features contained in this model, if previously set with setRDFTypeURI.

Definition at line 230 of file Model.h.

References Model::m_typeUri.

Referenced by FeatureExtractionModelTransformer::getAdditionalModel().

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

Reimplemented in FFTModel, and Dense3DModelPeakCache.

Definition at line 76 of file Model.cpp.

References Model::m_sourceModel.

Referenced by Model::setSourceModel().

void Model::modelChangedWithin ( int  startFrame,
int  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, and AlignmentModel.

Referenced by WaveFileModel::cacheFilled(), WaveFileModel::fillTimerTimedOut(), EditableDenseThreeDimensionalModel::setColumn(), EditableDenseThreeDimensionalModel::setCompletion(), and WritableWaveFileModel().

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, and AlignmentModel.

Referenced by Model::setAlignment(), and EditableDenseThreeDimensionalModel::setCompletion().

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

Emitted when internal processing is complete (i.e.

when isReady() would return true, with completion at 100).

Referenced by WaveFileModel::cacheFilled(), WaveFileModel::isReady(), AggregateWaveModel::isReady(), and SparseModel< RegionRec >::isReady().

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

QString XmlExportable::toXmlString ( QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by ModelTransformerFactory::getConfigurationForTransform(), and RDFTransformFactoryImpl::getTransforms().

QString XmlExportable::encodeColour ( int  r,
int  g,
int  b 
) [static, inherited]

Definition at line 54 of file XmlExportable.cpp.

int XmlExportable::getObjectExportId ( const void *  object) [static, inherited]
virtual bool Playable::getDefaultPlayAudible ( ) const [inline, virtual, inherited]

Reimplemented in SparseTimeValueModel.

Definition at line 28 of file Playable.h.

Referenced by PlayParameterRepository::addPlayable().


Member Data Documentation

Definition at line 92 of file WritableWaveFileModel.h.

Referenced by getSampleRate().

Definition at line 93 of file WritableWaveFileModel.h.

Referenced by getChannelCount().

Definition at line 94 of file WritableWaveFileModel.h.

Referenced by addSamples(), and getFrameCount().

Definition at line 96 of file WritableWaveFileModel.h.

Referenced by getCompletion(), isReady(), and setCompletion().

const int Model::COMPLETION_UNKNOWN = -1 [static, inherited]

Definition at line 147 of file Model.h.

QString Model::m_typeUri [protected, inherited]

Definition at line 303 of file Model.h.

Referenced by Model::getRDFTypeURI(), and Model::setRDFTypeURI().

bool Model::m_abandoning [protected, inherited]

Definition at line 304 of file Model.h.

Referenced by Model::abandon(), and Model::isAbandoning().

bool Model::m_aboutToDelete [protected, inherited]

Definition at line 305 of file Model.h.

Referenced by Model::aboutToDelete(), and Model::~Model().


The documentation for this class was generated from the following files: