SVFileReader loads Sonic Visualiser XML files. More...

#include <SVFileReader.h>

Inheritance diagram for SVFileReader:

Collaboration diagram for SVFileReader:

Classes
struct	PendingAggregateRec

Public Types
enum	FileType { SVSessionFile, SVLayerFile, UnknownFileType }

Signals
void	modelRegenerationFailed (QString layerName, QString transformName, QString message)

void	modelRegenerationWarning (QString layerName, QString transformName, QString message)

Public Member Functions
	SVFileReader (Document *document, SVFileReaderPaneCallback &callback, QString location="")

virtual	~SVFileReader ()

void	parse (const QString &xmlData)

void	parse (QXmlInputSource &source)

bool	isOK ()

QString	getErrorString () const

void	setCurrentPane (Pane *pane)

bool	startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts) override

bool	characters (const QString &) override

bool	endElement (const QString &namespaceURI, const QString &localName, const QString &qName) override

bool	error (const QXmlParseException &exception) override

bool	fatalError (const QXmlParseException &exception) override

Static Public Member Functions
static FileType	identifyXmlFile (QString path)

Protected Types
typedef XmlExportable::ExportId	ExportId

Protected Member Functions
bool	readWindow (const QXmlAttributes &)

bool	readModel (const QXmlAttributes &)

bool	readView (const QXmlAttributes &)

bool	readLayer (const QXmlAttributes &)

bool	readDatasetStart (const QXmlAttributes &)

bool	addBinToDataset (const QXmlAttributes &)

bool	addPointToDataset (const QXmlAttributes &)

bool	addRowToDataset (const QXmlAttributes &)

bool	readRowData (const QString &)

bool	readDerivation (const QXmlAttributes &)

bool	readPlayParameters (const QXmlAttributes &)

bool	readPlugin (const QXmlAttributes &)

bool	readPluginForTransform (const QXmlAttributes &)

bool	readPluginForPlayback (const QXmlAttributes &)

bool	readTransform (const QXmlAttributes &)

bool	readParameter (const QXmlAttributes &)

bool	readSelection (const QXmlAttributes &)

bool	readMeasurement (const QXmlAttributes &)

void	makeAggregateModels ()

void	addUnaddedModels ()

bool	haveModel (ExportId id)

Protected Attributes
Document *	m_document

SVFileReaderPaneCallback &	m_paneCallback

QString	m_location

Pane *	m_currentPane

std::map< ExportId, Layer * >	m_layers

std::map< ExportId, ModelId >	m_models

std::map< ExportId, Path * >	m_paths

std::set< ModelId >	m_addedModels

std::map< ExportId, PendingAggregateRec >	m_pendingAggregates

std::map< ExportId, ExportId >	m_awaitingDatasets

ExportId	m_currentDataset

Layer *	m_currentLayer

ModelId	m_currentDerivedModel

ExportId	m_pendingDerivedModel

std::shared_ptr< PlayParameters >	m_currentPlayParameters

Transform	m_currentTransform

ModelId	m_currentTransformSource

int	m_currentTransformChannel

bool	m_currentTransformIsNewStyle

QString	m_datasetSeparator

bool	m_inRow

bool	m_inLayer

bool	m_inView

bool	m_inData

bool	m_inSelections

int	m_rowNumber

QString	m_errorString

bool	m_ok

Detailed Description

SVFileReader loads Sonic Visualiser XML files.

(The SV file format is bzipped XML.)

Some notes about the SV XML format follow. We're very lazy with our XML: there's no schema or DTD, and we depend heavily on elements being in a particular order.

    <sv>

    <data>

      <!-- The data section contains definitions of both models and
           visual layers.  Layers are considered data in the document;
           the structure of views that displays the layers is not. -->

      <!-- id numbers are unique within the data type (i.e. no two
           models can have the same id, but a model can have the same
           id as a layer, etc).  SV generates its id numbers just for
           the purpose of cross-referencing within the current file;
           they don't necessarily have any meaning once the file has
           been loaded. -->

      <model id="0" name="..." type="..." ... />
      <model id="1" name="..." type="..." ... />

      <!-- Models that have data associated with them store it
           in a neighbouring dataset element.  The dataset must follow
           the model and precede any derivation or layer elements that
           refer to the model. -->

      <model id="2" name="..." type="..." dataset="0" ... />

      <dataset id="0" type="..."> 
        <point frame="..." value="..." ... />
      </dataset>

      <!-- Where one model is derived from another via a transform,
           it has an associated derivation element.  This must follow
           both the source and target model elements.  The source and
           model attributes give the source model id and target model
           id respectively.  A model can have both dataset and
           derivation elements; if it does, dataset must appear first. 
           If the model's data are not stored, but instead the model
           is to be regenerated completely from the transform when 
           the session is reloaded, then the model should have _only_
           a derivation element, and no model element should appear
           for it at all. -->

      <derivation type="transform" source="0" model="2" channel="-1">
        <transform id="vamp:soname:pluginid:output" ... />
      </derivation>

      <!-- Note that the derivation element just described replaces
           this earlier formulation, which had more attributes in the
           derivation element and a plugin element describing plugin
           parameters and properties.  What we actually read and
           write these days is a horrid composite of the two formats,
           for backward compatibility reasons. -->

      <derivation source="0" model="2" transform="vamp:soname:pluginid:output" ...>
        <plugin id="pluginid" ... />
      </derivation>

      <!-- The playparameters element lists playback settings for
           a model. -->

      <playparameters mute="false" pan="0" gain="1" model="1" ... />

      <!-- Layer elements.  The models must have already been defined.
           The same model may appear in more than one layer (of more
           than one type). -->

      <layer id="1" type="..." name="..." model="0" ... />
      <layer id="2" type="..." name="..." model="1" ... />

    </data>


    <display>

      <!-- The display element contains visual structure for the
           layers.  It's simpler than the data section. -->

      <!-- Overall preferred window size for this session. (Now
           deprecated, it wasn't a good idea to try to persist this) -->

      <window width="..." height="..."/>

      <!-- List of view elements to stack up.  Each one contains
           a list of layers in stacking order, back to front. -->

      <view type="pane" ...>
        <layer id="1"/>
        <layer id="2"/>
      </view>

      <!-- The layer elements just refer to layers defined in the
           data section, so they don't have to have any attributes
           other than the id.  For sort-of-historical reasons SV
           actually does repeat the other attributes here, but
           it doesn't need to. -->

      <view type="pane" ...>
        <layer id="2"/>
      <view>

    </display>


    <!-- List of selected regions by audio frame extents. -->

    <selections>
      <selection start="..." end="..."/>
    </selections>


    </sv>

Definition at line 166 of file SVFileReader.h.

Member Typedef Documentation

typedef XmlExportable::ExportId SVFileReader::ExportId

protected

Definition at line 247 of file SVFileReader.h.

Member Enumeration Documentation

enum SVFileReader::FileType

Enumerator
SVSessionFile
SVLayerFile
UnknownFileType

Definition at line 199 of file SVFileReader.h.

Constructor & Destructor Documentation

SVFileReader::SVFileReader	(	Document *	document,
		SVFileReaderPaneCallback &	callback,
		QString	location = `""`
	)

Definition at line 55 of file SVFileReader.cpp.

SVFileReader::~SVFileReader ( )

virtual

Definition at line 101 of file SVFileReader.cpp.

References m_addedModels, m_awaitingDatasets, m_models, and m_paths.

Member Function Documentation

void SVFileReader::parse ( const QString & xmlData )

Definition at line 79 of file SVFileReader.cpp.

void SVFileReader::parse ( QXmlInputSource & source )

Definition at line 87 of file SVFileReader.cpp.

References m_ok.

bool SVFileReader::isOK ( )

Definition at line 96 of file SVFileReader.cpp.

References m_ok.

QString SVFileReader::getErrorString ( ) const

inline

Definition at line 180 of file SVFileReader.h.

void SVFileReader::setCurrentPane ( Pane * pane )

inline

Definition at line 183 of file SVFileReader.h.

bool SVFileReader::startElement	(	const QString &	namespaceURI,
		const QString &	localName,
		const QString &	qName,
		const QXmlAttributes &	atts
	)

override

Definition at line 137 of file SVFileReader.cpp.

References addBinToDataset(), addPointToDataset(), addRowToDataset(), addUnaddedModels(), m_inData, m_inSelections, m_inView, makeAggregateModels(), readDatasetStart(), readDerivation(), readLayer(), readMeasurement(), readModel(), readParameter(), readPlayParameters(), readPlugin(), readSelection(), readTransform(), readView(), and readWindow().

bool SVFileReader::characters ( const QString & text )

override

Definition at line 263 of file SVFileReader.cpp.

References m_inRow, m_rowNumber, and readRowData().

bool SVFileReader::endElement	(	const QString &	namespaceURI,
		const QString &	localName,
		const QString &	qName
	)

override

bool SVFileReader::error ( const QXmlParseException & exception )

override

Definition at line 368 of file SVFileReader.cpp.

References m_errorString.

bool SVFileReader::fatalError ( const QXmlParseException & exception )

override

Definition at line 380 of file SVFileReader.cpp.

References m_errorString.

SVFileReader::FileType SVFileReader::identifyXmlFile ( QString path )

static

Definition at line 1636 of file SVFileReader.cpp.

References SVFileIdentifier::getType(), and SVFileIdentifier::parse().

Referenced by MainWindowBase::openLayer(), and MainWindowBase::openSession().

void SVFileReader::modelRegenerationFailed	(	QString	layerName,
		QString	transformName,
		QString	message
	)

signal

Referenced by endElement().

void SVFileReader::modelRegenerationWarning	(	QString	layerName,
		QString	transformName,
		QString	message
	)

signal

Referenced by endElement().

bool SVFileReader::readWindow ( const QXmlAttributes & )

protected

Definition at line 400 of file SVFileReader.cpp.

Referenced by startElement().

bool SVFileReader::readModel ( const QXmlAttributes & attributes )

protected

Definition at line 489 of file SVFileReader.cpp.

References Document::getMainModel(), haveModel(), m_addedModels, m_awaitingDatasets, m_document, m_location, m_models, m_paths, m_pendingAggregates, READ_MANDATORY, Document::setIncomplete(), and Document::setMainModel().

Referenced by startElement().

bool SVFileReader::readView ( const QXmlAttributes & attributes )

protected

Definition at line 831 of file SVFileReader.cpp.

References SVFileReaderPaneCallback::addPane(), m_currentPane, m_paneCallback, and READ_MANDATORY.

Referenced by startElement().

bool SVFileReader::readLayer ( const QXmlAttributes & attributes )

protected

Definition at line 897 of file SVFileReader.cpp.

References Document::addLayerToView(), Document::createLayer(), Document::deleteLayer(), haveModel(), m_currentLayer, m_currentPane, m_document, m_inData, m_inLayer, m_layers, m_models, and Document::setModel().

Referenced by startElement().

bool SVFileReader::readDatasetStart ( const QXmlAttributes & attributes )

protected

Definition at line 1028 of file SVFileReader.cpp.

References haveModel(), m_awaitingDatasets, m_currentDataset, m_datasetSeparator, m_models, m_paths, and READ_MANDATORY.

Referenced by startElement().

bool SVFileReader::addBinToDataset ( const QXmlAttributes & attributes )

protected

Definition at line 1186 of file SVFileReader.cpp.

References haveModel(), m_currentDataset, and m_models.

Referenced by startElement().

bool SVFileReader::addPointToDataset ( const QXmlAttributes & attributes )

protected

Definition at line 1095 of file SVFileReader.cpp.

References haveModel(), m_currentDataset, m_models, m_paths, and READ_MANDATORY.

Referenced by startElement().

bool SVFileReader::addRowToDataset ( const QXmlAttributes & attributes )

protected

Definition at line 1220 of file SVFileReader.cpp.

References m_inRow, and m_rowNumber.

Referenced by startElement().

bool SVFileReader::readRowData ( const QString & text )

protected

Definition at line 1240 of file SVFileReader.cpp.

References haveModel(), m_currentDataset, m_datasetSeparator, m_models, and m_rowNumber.

Referenced by characters().

bool SVFileReader::readDerivation ( const QXmlAttributes & attributes )

protected

Definition at line 1287 of file SVFileReader.cpp.

References Document::getMainModel(), haveModel(), m_currentDerivedModel, m_currentTransform, m_currentTransformChannel, m_currentTransformIsNewStyle, m_currentTransformSource, m_document, m_models, and m_pendingDerivedModel.

Referenced by startElement().

bool SVFileReader::readPlayParameters ( const QXmlAttributes & attributes )

protected

Definition at line 1380 of file SVFileReader.cpp.

References haveModel(), m_currentPlayParameters, and m_models.

Referenced by startElement().

bool SVFileReader::readPlugin ( const QXmlAttributes & attributes )

protected

Definition at line 1435 of file SVFileReader.cpp.

References m_currentPlayParameters, m_pendingDerivedModel, readPluginForPlayback(), and readPluginForTransform().

Referenced by startElement().

bool SVFileReader::readPluginForTransform ( const QXmlAttributes & attributes )

protected

Definition at line 1448 of file SVFileReader.cpp.

References m_currentTransform, and m_currentTransformIsNewStyle.

Referenced by readPlugin().

bool SVFileReader::readPluginForPlayback ( const QXmlAttributes & attributes )

protected

Definition at line 1472 of file SVFileReader.cpp.

References m_currentPlayParameters.

Referenced by readPlugin().

bool SVFileReader::readTransform ( const QXmlAttributes & attributes )

protected

Definition at line 1486 of file SVFileReader.cpp.

References m_currentTransform, and m_pendingDerivedModel.

Referenced by startElement().

bool SVFileReader::readParameter ( const QXmlAttributes & attributes )

protected

Definition at line 1499 of file SVFileReader.cpp.

References m_currentTransform, and m_pendingDerivedModel.

Referenced by startElement().

bool SVFileReader::readSelection ( const QXmlAttributes & attributes )

protected

Definition at line 1520 of file SVFileReader.cpp.

References SVFileReaderPaneCallback::addSelection(), m_paneCallback, and READ_MANDATORY.

Referenced by startElement().

bool SVFileReader::readMeasurement ( const QXmlAttributes & attributes )

protected

Definition at line 1533 of file SVFileReader.cpp.

References m_currentLayer, and m_inLayer.

Referenced by startElement().

void SVFileReader::makeAggregateModels ( )

protected

Definition at line 410 of file SVFileReader.cpp.

References SVFileReader::PendingAggregateRec::components, m_models, m_pendingAggregates, and SVFileReader::PendingAggregateRec::name.

Referenced by addUnaddedModels(), and startElement().

void SVFileReader::addUnaddedModels ( )

protected

Definition at line 467 of file SVFileReader.cpp.

References Document::addNonDerivedModel(), m_addedModels, m_document, m_models, and makeAggregateModels().

Referenced by endElement(), and startElement().

bool SVFileReader::haveModel ( ExportId id )

inlineprotected

Definition at line 249 of file SVFileReader.h.

Referenced by addBinToDataset(), addPointToDataset(), endElement(), readDatasetStart(), readDerivation(), readLayer(), readModel(), readPlayParameters(), and readRowData().

Member Data Documentation

Document* SVFileReader::m_document

protected

Definition at line 259 of file SVFileReader.h.

Referenced by addUnaddedModels(), endElement(), readDerivation(), readLayer(), and readModel().

SVFileReaderPaneCallback& SVFileReader::m_paneCallback

protected

Definition at line 260 of file SVFileReader.h.

Referenced by readSelection(), and readView().

QString SVFileReader::m_location

protected

Definition at line 261 of file SVFileReader.h.

Referenced by readModel().

Pane* SVFileReader::m_currentPane

protected

Definition at line 262 of file SVFileReader.h.

Referenced by readLayer(), and readView().

std::map<ExportId, Layer *> SVFileReader::m_layers

protected

Definition at line 263 of file SVFileReader.h.

Referenced by readLayer().

std::map<ExportId, ModelId> SVFileReader::m_models

protected

Definition at line 264 of file SVFileReader.h.

Referenced by addBinToDataset(), addPointToDataset(), addUnaddedModels(), endElement(), makeAggregateModels(), readDatasetStart(), readDerivation(), readLayer(), readModel(), readPlayParameters(), readRowData(), and ~SVFileReader().

std::map<ExportId, Path *> SVFileReader::m_paths

protected

Definition at line 265 of file SVFileReader.h.

Referenced by addPointToDataset(), readDatasetStart(), readModel(), and ~SVFileReader().

std::set<ModelId> SVFileReader::m_addedModels

protected

Definition at line 266 of file SVFileReader.h.

Referenced by addUnaddedModels(), endElement(), readModel(), and ~SVFileReader().

std::map<ExportId, PendingAggregateRec> SVFileReader::m_pendingAggregates

protected

Definition at line 267 of file SVFileReader.h.

Referenced by makeAggregateModels(), and readModel().

std::map<ExportId, ExportId> SVFileReader::m_awaitingDatasets

protected

Definition at line 275 of file SVFileReader.h.

Referenced by endElement(), readDatasetStart(), readModel(), and ~SVFileReader().

ExportId SVFileReader::m_currentDataset

protected

Definition at line 280 of file SVFileReader.h.

Referenced by addBinToDataset(), addPointToDataset(), endElement(), readDatasetStart(), and readRowData().

Layer* SVFileReader::m_currentLayer

protected

Definition at line 282 of file SVFileReader.h.

Referenced by readLayer(), and readMeasurement().

ModelId SVFileReader::m_currentDerivedModel

protected

Definition at line 283 of file SVFileReader.h.

Referenced by endElement(), and readDerivation().

ExportId SVFileReader::m_pendingDerivedModel

protected

Definition at line 284 of file SVFileReader.h.

Referenced by endElement(), readDerivation(), readParameter(), readPlugin(), and readTransform().

std::shared_ptr<PlayParameters> SVFileReader::m_currentPlayParameters

protected

Definition at line 285 of file SVFileReader.h.

Referenced by endElement(), readPlayParameters(), readPlugin(), and readPluginForPlayback().

Transform SVFileReader::m_currentTransform

protected

Definition at line 286 of file SVFileReader.h.

Referenced by endElement(), readDerivation(), readParameter(), readPluginForTransform(), and readTransform().

ModelId SVFileReader::m_currentTransformSource

protected

Definition at line 287 of file SVFileReader.h.

Referenced by endElement(), and readDerivation().

int SVFileReader::m_currentTransformChannel

protected

Definition at line 288 of file SVFileReader.h.

Referenced by endElement(), and readDerivation().

bool SVFileReader::m_currentTransformIsNewStyle

protected

Definition at line 289 of file SVFileReader.h.

Referenced by readDerivation(), and readPluginForTransform().

QString SVFileReader::m_datasetSeparator

protected

Definition at line 290 of file SVFileReader.h.

Referenced by readDatasetStart(), and readRowData().

bool SVFileReader::m_inRow

protected

Definition at line 291 of file SVFileReader.h.

Referenced by addRowToDataset(), characters(), and endElement().

bool SVFileReader::m_inLayer

protected

Definition at line 292 of file SVFileReader.h.

Referenced by endElement(), readLayer(), and readMeasurement().

bool SVFileReader::m_inView

protected

Definition at line 293 of file SVFileReader.h.

Referenced by endElement(), and startElement().

bool SVFileReader::m_inData

protected

Definition at line 294 of file SVFileReader.h.

Referenced by endElement(), SVFileIdentifier::endElement(), readLayer(), startElement(), and SVFileIdentifier::startElement().

bool SVFileReader::m_inSelections

protected

Definition at line 295 of file SVFileReader.h.

Referenced by endElement(), and startElement().

int SVFileReader::m_rowNumber

protected

Definition at line 296 of file SVFileReader.h.

Referenced by addRowToDataset(), characters(), and readRowData().

QString SVFileReader::m_errorString

protected

Definition at line 297 of file SVFileReader.h.

Referenced by error(), and fatalError().

bool SVFileReader::m_ok

protected

Definition at line 298 of file SVFileReader.h.

Referenced by isOK(), and parse().

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

SV Libraries »

SV App Framework

Classes

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation