#include <CSVFeatureWriter.h>

Inheritance diagram for CSVFeatureWriter:

Collaboration diagram for CSVFeatureWriter:

Public Types
typedef vector< Parameter >	ParameterList

Public Member Functions
	CSVFeatureWriter ()

virtual	~CSVFeatureWriter ()

string	getDescription () const override

ParameterList	getSupportedParameters () const override

void	setParameters (map< string, string > &params) override

void	write (QString trackid, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, std::string summaryType="") override

void	finish () override

QString	getWriterTag () const override

void	testOutputFile (QString trackId, TransformId transformId) override
	Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file. More...

void	flush () override

virtual void	setTrackMetadata (QString, TrackMetadata)

virtual void	setNofM (int, int)
	Notify the writer that we are about to start extraction for input file N of M (where N is 1..M). More...

Protected Types
enum	FileWriteSupport { SupportOneFilePerTrackTransform = 1, SupportOneFilePerTrack = 2, SupportOneFileTotal = 4, SupportStdOut = 8 }

typedef pair< QString, TransformId >	TrackTransformPair

typedef map< TrackTransformPair, QString >	FileNameMap

typedef map< TrackTransformPair, QFile * >	FileMap

typedef map< QFile , QTextStream >	FileStreamMap

Protected Member Functions
QTextStream *	getOutputStream (QString, TransformId, QTextCodec *)

TrackTransformPair	getFilenameKey (QString, TransformId)

QString	createOutputFilename (QString, TransformId)

QString	getOutputFilename (QString, TransformId)

QFile *	getOutputFile (QString, TransformId)

virtual void	reviewFileForAppending (QString)

Protected Attributes
FileMap	m_files

FileNameMap	m_filenames

FileStreamMap	m_streams

QTextStream *	m_prevstream

int	m_support

QString	m_extension

QString	m_baseDir

bool	m_manyFiles

QString	m_singleFileName

bool	m_stdout

bool	m_append

bool	m_force

Private Types
typedef pair< QString, Transform >	DataId

typedef map< DataId, Vamp::Plugin::Feature >	PendingFeatures

typedef map< DataId, std::string >	PendingSummaryTypes

Private Member Functions
void	writeFeature (DataId, QTextStream &, const Vamp::Plugin::Feature &f, const Vamp::Plugin::Feature *optionalNextFeature, std::string summaryType)

Private Attributes
QString	m_separator

bool	m_sampleTiming

bool	m_endTimes

bool	m_forceEnd

bool	m_omitFilename

QString	m_prevPrintedTrackId

PendingFeatures	m_pending

PendingSummaryTypes	m_pendingSummaryTypes

int	m_digits

Detailed Description

Definition at line 37 of file CSVFeatureWriter.h.

Member Typedef Documentation

typedef pair<QString, Transform> CSVFeatureWriter::DataId

private

Definition at line 66 of file CSVFeatureWriter.h.

typedef map<DataId, Vamp::Plugin::Feature> CSVFeatureWriter::PendingFeatures

private

Definition at line 67 of file CSVFeatureWriter.h.

typedef map<DataId, std::string> CSVFeatureWriter::PendingSummaryTypes

private

Definition at line 68 of file CSVFeatureWriter.h.

typedef pair<QString, TransformId> FileFeatureWriter::TrackTransformPair

protectedinherited

Definition at line 61 of file FileFeatureWriter.h.

typedef map<TrackTransformPair, QString> FileFeatureWriter::FileNameMap

protectedinherited

Definition at line 62 of file FileFeatureWriter.h.

typedef map<TrackTransformPair, QFile *> FileFeatureWriter::FileMap

protectedinherited

Definition at line 63 of file FileFeatureWriter.h.

typedef map<QFile *, QTextStream *> FileFeatureWriter::FileStreamMap

protectedinherited

Definition at line 64 of file FileFeatureWriter.h.

typedef vector<Parameter> FeatureWriter::ParameterList

inherited

Definition at line 51 of file FeatureWriter.h.

Member Enumeration Documentation

enum FileFeatureWriter::FileWriteSupport

protectedinherited

Enumerator
SupportOneFilePerTrackTransform
SupportOneFilePerTrack
SupportOneFileTotal
SupportStdOut

Definition at line 51 of file FileFeatureWriter.h.

Constructor & Destructor Documentation

CSVFeatureWriter::CSVFeatureWriter ( )

Definition at line 31 of file CSVFeatureWriter.cpp.

CSVFeatureWriter::~CSVFeatureWriter ( )

virtual

Definition at line 45 of file CSVFeatureWriter.cpp.

Member Function Documentation

string CSVFeatureWriter::getDescription ( ) const

overridevirtual

Implements FeatureWriter.

Definition at line 50 of file CSVFeatureWriter.cpp.

CSVFeatureWriter::ParameterList CSVFeatureWriter::getSupportedParameters ( ) const

overridevirtual

Reimplemented from FeatureWriter.

Definition at line 56 of file CSVFeatureWriter.cpp.

References FeatureWriter::Parameter::description, FileFeatureWriter::getSupportedParameters(), FeatureWriter::Parameter::hasArg, and FeatureWriter::Parameter::name.

void CSVFeatureWriter::setParameters ( map< string, string > & params )

overridevirtual

Reimplemented from FeatureWriter.

Definition at line 95 of file CSVFeatureWriter.cpp.

References m_digits, m_endTimes, m_forceEnd, m_omitFilename, m_sampleTiming, m_separator, FileFeatureWriter::setParameters(), SVCERR, and SVDEBUG.

void CSVFeatureWriter::write	(	QString	trackid,
		const Transform &	transform,
		const Vamp::Plugin::OutputDescriptor &	output,
		const Vamp::Plugin::FeatureList &	features,
		std::string	summaryType = `""`
	)

overridevirtual

Implements FeatureWriter.

Definition at line 130 of file CSVFeatureWriter.cpp.

References Transform::getIdentifier(), FileFeatureWriter::getOutputStream(), m_forceEnd, m_pending, m_pendingSummaryTypes, and writeFeature().

void CSVFeatureWriter::finish ( )

overridevirtual

Implements FeatureWriter.

Definition at line 183 of file CSVFeatureWriter.cpp.

References FileFeatureWriter::getOutputStream(), m_pending, m_pendingSummaryTypes, and writeFeature().

QString CSVFeatureWriter::getWriterTag ( ) const

inlineoverridevirtual

Implements FeatureWriter.

Definition at line 56 of file CSVFeatureWriter.h.

void CSVFeatureWriter::writeFeature	(	DataId	,
		QTextStream &	,
		const Vamp::Plugin::Feature &	f,
		const Vamp::Plugin::Feature *	optionalNextFeature,
		std::string	summaryType
	)

private

Definition at line 207 of file CSVFeatureWriter.cpp.

References Transform::getSampleRate(), m_digits, m_endTimes, m_omitFilename, m_prevPrintedTrackId, m_sampleTiming, m_separator, FileFeatureWriter::m_singleFileName, FileFeatureWriter::m_stdout, RealTime::realTime2Frame(), and RealTime::toString().

Referenced by finish(), and write().

void FileFeatureWriter::testOutputFile	(	QString	,
		TransformId
	)

overridevirtualinherited

Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file.

This is called to test the output stream before processing begins. The writer may legitimately succeed here but still fail later – this is really an optimisation to ensure that easy-to-recognise failure cases fail early.

Reimplemented from FeatureWriter.

Definition at line 231 of file FileFeatureWriter.cpp.

References FileFeatureWriter::createOutputFilename(), FileFeatureWriter::m_singleFileName, and FileFeatureWriter::m_stdout.

void FileFeatureWriter::flush ( )

overridevirtualinherited

Reimplemented from FeatureWriter.

Definition at line 347 of file FileFeatureWriter.cpp.

References FileFeatureWriter::m_prevstream.