#include <DecodingWavFileReader.h>

Inheritance diagram for DecodingWavFileReader:

Collaboration diagram for DecodingWavFileReader:

Classes
class	DecodeThread

Public Types
enum	CacheMode { CacheInTemporaryFile, CacheInMemory }

enum	DecodeMode { DecodeAtOnce, DecodeThreaded }

typedef std::map< QString, QString >	TagMap
	Return any tag pairs picked up from the audio file. More...

Public Slots
void	cancelled ()

Signals
void	progress (int)

void	frameCountChanged ()

Public Member Functions
	DecodingWavFileReader (FileSource source, DecodeMode decodeMode, CacheMode cacheMode, sv_samplerate_t targetRate=0, bool normalised=false, ProgressReporter *reporter=0)

virtual	~DecodingWavFileReader ()

QString	getTitle () const override
	Return the title of the work in the audio file, if known. More...

QString	getMaker () const override
	Return the "maker" of the work in the audio file, if known. More...

QString	getError () const override
	If isOK() is false, return an error string. More...

QString	getLocation () const override
	Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example). More...

int	getDecodeCompletion () const override
	Return a percentage value indicating how far through decoding the audio file we are. More...

bool	isUpdating () const override
	Return true if decoding is still in progress and the frame count may change. More...

floatvec_t	getInterleavedFrames (sv_frame_t start, sv_frame_t count) const override
	Return interleaved samples for count frames from index start. More...

sv_samplerate_t	getNativeRate () const override
	Return the native samplerate of the file. More...

QString	getLocalFilename () const override
	Return the local file path of the audio data. More...

bool	isQuicklySeekable () const override
	Intermediate cache means all CodedAudioFileReaders are quickly seekable. More...

bool	isOK () const
	Return true if the file was opened successfully and no error has subsequently occurred. More...

sv_frame_t	getFrameCount () const
	Return the number of audio sample frames (i.e. More...

int	getChannelCount () const
	Return the number of channels in the file. More...

sv_samplerate_t	getSampleRate () const
	Return the samplerate at which the file is being read. More...

virtual TagMap	getTags () const

virtual std::vector< floatvec_t >	getDeInterleavedFrames (sv_frame_t start, sv_frame_t count) const
	Return de-interleaved samples for count frames from index start. More...

Static Public Member Functions
static void	getSupportedExtensions (std::set< QString > &extensions)

static bool	supportsExtension (QString ext)

static bool	supportsContentType (QString type)

static bool	supports (FileSource &source)

Protected Member Functions
void	addBlock (const floatvec_t &frames)

void	initialiseDecodeCache ()

void	setFramesToTrim (sv_frame_t fromStart, sv_frame_t fromEnd)

void	addSamplesToDecodeCache (float **samples, sv_frame_t nframes)

void	addSamplesToDecodeCache (float *samplesInterleaved, sv_frame_t nframes)

void	addSamplesToDecodeCache (const floatvec_t &interleaved)

void	finishDecodeCache ()

bool	isDecodeCacheInitialised () const

void	startSerialised (QString id, const std::atomic< bool > *cancelled)

void	endSerialised ()

Protected Attributes
FileSource	m_source

QString	m_title

QString	m_maker

QString	m_path

QString	m_error

std::atomic< bool >	m_cancelled

sv_frame_t	m_processed

int	m_completion

WavFileReader *	m_original

ProgressReporter *	m_reporter

DecodeThread *	m_decodeThread

QMutex	m_cacheMutex

CacheMode	m_cacheMode

floatvec_t	m_data

QMutex	m_dataLock

bool	m_initialised

Serialiser *	m_serialiser

sv_samplerate_t	m_fileRate

QString	m_cacheFileName

SNDFILE *	m_cacheFileWritePtr

WavFileReader *	m_cacheFileReader

float *	m_cacheWriteBuffer

sv_frame_t	m_cacheWriteBufferIndex

sv_frame_t	m_cacheWriteBufferFrames

breakfastquay::Resampler *	m_resampler

float *	m_resampleBuffer

int	m_resampleBufferFrames

sv_frame_t	m_fileFrameCount

bool	m_normalised

float	m_max

float	m_gain

sv_frame_t	m_trimFromStart

sv_frame_t	m_trimFromEnd

sv_frame_t	m_clippedCount

sv_frame_t	m_firstNonzero

sv_frame_t	m_lastNonzero

sv_frame_t	m_frameCount

int	m_channelCount

sv_samplerate_t	m_sampleRate

Detailed Description

Definition at line 29 of file DecodingWavFileReader.h.

Member Typedef Documentation

typedef std::map<QString, QString> AudioFileReader::TagMap

inherited

Return any tag pairs picked up from the audio file.

See also getTitle and getMaker, and note that a reader which does not implement getTags may still return values from those.

Definition at line 117 of file AudioFileReader.h.

Member Enumeration Documentation

enum CodedAudioFileReader::CacheMode

inherited

Enumerator
CacheInTemporaryFile
CacheInMemory

Definition at line 47 of file CodedAudioFileReader.h.

enum CodedAudioFileReader::DecodeMode

inherited

Enumerator
DecodeAtOnce
DecodeThreaded

Definition at line 52 of file CodedAudioFileReader.h.

Constructor & Destructor Documentation

DecodingWavFileReader::DecodingWavFileReader	(	FileSource	source,
		DecodeMode	decodeMode,
		CacheMode	cacheMode,
		sv_samplerate_t	targetRate = `0`,
		bool	normalised = `false`,
		ProgressReporter *	reporter = `0`
	)

DecodingWavFileReader::~DecodingWavFileReader ( )

virtual

Definition at line 107 of file DecodingWavFileReader.cpp.

References m_cancelled, m_decodeThread, and m_original.

Member Function Documentation

QString DecodingWavFileReader::getTitle ( ) const

inlineoverridevirtual

Return the title of the work in the audio file, if known.

This may be implemented by subclasses that support file tagging. This is not the same thing as the file name.

Implements AudioFileReader.

Definition at line 41 of file DecodingWavFileReader.h.

References m_title.

QString DecodingWavFileReader::getMaker ( ) const

inlineoverridevirtual

Return the "maker" of the work in the audio file, if known.

This could represent almost anything (band, composer, conductor, artist etc).

Implements AudioFileReader.

Definition at line 42 of file DecodingWavFileReader.h.

References m_maker.

QString DecodingWavFileReader::getError ( ) const

inlineoverridevirtual

If isOK() is false, return an error string.

Reimplemented from AudioFileReader.

Definition at line 44 of file DecodingWavFileReader.h.

References m_error.

QString DecodingWavFileReader::getLocation ( ) const

inlineoverridevirtual

Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example).

This might be a remote URL.

See also getLocation().

Implements AudioFileReader.

Definition at line 61 of file CodedAudioFileReader.h.

bool CodedAudioFileReader::isQuicklySeekable ( ) const

inlineoverridevirtualinherited

Intermediate cache means all CodedAudioFileReaders are quickly seekable.

Implements AudioFileReader.

Definition at line 64 of file CodedAudioFileReader.h.

void CodedAudioFileReader::progress ( int )

signalinherited

Referenced by addBlock().

void CodedAudioFileReader::initialiseDecodeCache ( )

protectedinherited

Definition at line 127 of file CodedAudioFileReader.cpp.

Referenced by MP3FileReader::accept(), BQAFileReader::BQAFileReader(), and DecodingWavFileReader().

void CodedAudioFileReader::setFramesToTrim	(	sv_frame_t	fromStart,
		sv_frame_t	fromEnd
	)

protectedinherited

Definition at line 101 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_trimFromEnd, and CodedAudioFileReader::m_trimFromStart.

Referenced by MP3FileReader::filter(), and MP3FileReader::MP3FileReader().

void CodedAudioFileReader::addSamplesToDecodeCache	(	float **	samples,
		sv_frame_t	nframes
	)

protectedinherited

Definition at line 251 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, AudioFileReader::m_channelCount, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

Referenced by MP3FileReader::accept(), addBlock(), and BQAFileReader::BQAFileReader().

void CodedAudioFileReader::addSamplesToDecodeCache	(	float *	samplesInterleaved,
		sv_frame_t	nframes
	)

protectedinherited

Definition at line 276 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, AudioFileReader::m_channelCount, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

void CodedAudioFileReader::addSamplesToDecodeCache ( const floatvec_t & interleaved )

protectedinherited

Definition at line 301 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

void CodedAudioFileReader::finishDecodeCache ( )

protectedinherited

Definition at line 321 of file CodedAudioFileReader.cpp.

Referenced by BQAFileReader::BQAFileReader(), DecodingWavFileReader(), and MP3FileReader::MP3FileReader().

bool CodedAudioFileReader::isDecodeCacheInitialised ( ) const

inlineprotectedinherited

Definition at line 87 of file CodedAudioFileReader.h.

Referenced by MP3FileReader::accept(), BQAFileReader::BQAFileReader(), DecodingWavFileReader(), and MP3FileReader::MP3FileReader().

void CodedAudioFileReader::startSerialised	(	QString	id,
		const std::atomic< bool > *	cancelled
	)

protectedinherited

Definition at line 108 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

Referenced by MP3FileReader::accept().

void CodedAudioFileReader::endSerialised ( )

protectedinherited

Definition at line 118 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

Referenced by BQAFileReader::BQAFileReader(), DecodingWavFileReader(), MP3FileReader::MP3FileReader(), and CodedAudioFileReader::~CodedAudioFileReader().

bool AudioFileReader::isOK ( ) const

inlineinherited

Return true if the file was opened successfully and no error has subsequently occurred.

Definition at line 38 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by AudioFileReaderFactory::createReader(), DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getData(), CodedAudioFileReader::getInterleavedFrames(), ReadOnlyWaveFileModel::getMultiChannelData(), CodedAudioFileReader::initialiseDecodeCache(), and ReadOnlyWaveFileModel::isOK().

sv_frame_t AudioFileReader::getFrameCount ( ) const

inlineinherited

Return the number of audio sample frames (i.e.

samples per channel) in the file.

Definition at line 49 of file AudioFileReader.h.

References AudioFileReader::m_frameCount.

Referenced by addBlock(), DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getFrameCount(), and WritableWaveFileModel::normaliseToTarget().

int AudioFileReader::getChannelCount ( ) const

inlineinherited

Return the number of channels in the file.

Definition at line 54 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by WritableWaveFileModel::addSamples(), DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getChannelCount(), and AudioFileReader::getDeInterleavedFrames().

sv_samplerate_t AudioFileReader::getSampleRate ( ) const

inlineinherited

Return the samplerate at which the file is being read.

This is the rate requested when the file was opened, which may differ from the native rate of the file (in which case the file will be resampled as it is read).

Definition at line 62 of file AudioFileReader.h.

References AudioFileReader::m_sampleRate.

Referenced by AudioFileReaderFactory::createReader(), DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getSampleRate(), and ReadOnlyWaveFileModel::ReadOnlyWaveFileModel().

virtual TagMap AudioFileReader::getTags ( ) const

inlinevirtualinherited

Reimplemented in MP3FileReader.

Definition at line 118 of file AudioFileReader.h.

References AudioFileReader::isQuicklySeekable().

vector< floatvec_t > AudioFileReader::getDeInterleavedFrames	(	sv_frame_t	start,
		sv_frame_t	count
	)		const

virtualinherited

Return de-interleaved samples for count frames from index start.

Implemented in this class (it calls getInterleavedFrames and de-interleaves). The resulting vector will contain getChannelCount() sample blocks of count samples each (or fewer if end of file is reached).

Definition at line 21 of file AudioFileReader.cpp.

References AudioFileReader::getChannelCount(), and AudioFileReader::getInterleavedFrames().

Referenced by AudioFileReader::isUpdating().

void AudioFileReader::frameCountChanged ( )

signalinherited

Referenced by AudioFileReader::isUpdating(), and WavFileReader::updateFrameCount().