svcore  1.9
Public Types | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
CodedAudioFileReader Class Reference

#include <CodedAudioFileReader.h>

Inheritance diagram for CodedAudioFileReader:
Inheritance graph
[legend]
Collaboration diagram for CodedAudioFileReader:
Collaboration graph
[legend]

Public Types

enum  CacheMode { CacheInTemporaryFile, CacheInMemory }
 
typedef std::map< QString, QString > TagMap
 

Signals

void progress (int)
 
void frameCountChanged ()
 

Public Member Functions

virtual ~CodedAudioFileReader ()
 
virtual void getInterleavedFrames (int start, int count, SampleBlock &frames) const
 Return interleaved samples for count frames from index start. More...
 
virtual int getNativeRate () const
 
virtual bool isQuicklySeekable () const
 Intermediate cache means all CodedAudioFileReaders are quickly seekable. More...
 
bool isOK () const
 
virtual QString getError () const
 
int getFrameCount () const
 
int getChannelCount () const
 
int getSampleRate () const
 
virtual QString getLocation () const
 Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example). More...
 
virtual QString getTitle () const
 Return the title of the work in the audio file, if known. More...
 
virtual QString getMaker () const
 Return the "maker" of the work in the audio file, if known. More...
 
virtual TagMap getTags () const
 
virtual void getDeInterleavedFrames (int start, int count, std::vector< SampleBlock > &frames) const
 Return de-interleaved samples for count frames from index start. More...
 
virtual int getDecodeCompletion () const
 
virtual bool isUpdating () const
 

Protected Member Functions

 CodedAudioFileReader (CacheMode cacheMode, int targetRate, bool normalised)
 
void initialiseDecodeCache ()
 
void addSamplesToDecodeCache (float **samples, int nframes)
 
void addSamplesToDecodeCache (float *samplesInterleaved, int nframes)
 
void addSamplesToDecodeCache (const SampleBlock &interleaved)
 
void finishDecodeCache ()
 
bool isDecodeCacheInitialised () const
 
void startSerialised (QString id)
 
void endSerialised ()
 

Protected Attributes

QMutex m_cacheMutex
 
CacheMode m_cacheMode
 
SampleBlock m_data
 
QReadWriteLock m_dataLock
 
bool m_initialised
 
Serialiser * m_serialiser
 
int m_fileRate
 
QString m_cacheFileName
 
SNDFILE * m_cacheFileWritePtr
 
WavFileReader * m_cacheFileReader
 
float * m_cacheWriteBuffer
 
int m_cacheWriteBufferIndex
 
int m_cacheWriteBufferSize
 
Resampler * m_resampler
 
float * m_resampleBuffer
 
int m_fileFrameCount
 
bool m_normalised
 
float m_max
 
float m_gain
 
int m_frameCount
 
int m_channelCount
 
int m_sampleRate
 

Private Member Functions

void pushBuffer (float *interleaved, int sz, bool final)
 
void pushBufferResampling (float *interleaved, int sz, float ratio, bool final)
 
void pushBufferNonResampling (float *interleaved, int sz)
 

Detailed Description

Definition at line 29 of file CodedAudioFileReader.h.

Member Typedef Documentation

◆ TagMap

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

Definition at line 65 of file AudioFileReader.h.

Member Enumeration Documentation

◆ CacheMode

enum CodedAudioFileReader::CacheMode
Enumerator
CacheInTemporaryFile 
CacheInMemory 

Definition at line 36 of file CodedAudioFileReader.h.

Constructor & Destructor Documentation

◆ ~CodedAudioFileReader()

CodedAudioFileReader::~CodedAudioFileReader ( )
virtual

Definition at line 55 of file CodedAudioFileReader.cpp.

References endSerialised(), m_cacheFileName, m_cacheFileReader, m_cacheFileWritePtr, m_cacheMutex, m_cacheWriteBuffer, m_resampleBuffer, m_resampler, and SVDEBUG.

◆ CodedAudioFileReader()

CodedAudioFileReader::CodedAudioFileReader ( CacheMode  cacheMode,
int  targetRate,
bool  normalised 
)
protected

Definition at line 30 of file CodedAudioFileReader.cpp.

References AudioFileReader::m_frameCount, AudioFileReader::m_sampleRate, and SVDEBUG.

Member Function Documentation

◆ getInterleavedFrames()

void CodedAudioFileReader::getInterleavedFrames ( int  start,
int  count,
SampleBlock &  frames 
) const
virtual

Return interleaved samples for count frames from index start.

The resulting sample block will contain count * getChannelCount() samples (or fewer if end of file is reached).

The subclass implementations of this function must be thread-safe – that is, safe to call from multiple threads with different arguments on the same object at the same time.

Implements AudioFileReader.

Definition at line 409 of file CodedAudioFileReader.cpp.

References CacheInMemory, CacheInTemporaryFile, WavFileReader::getInterleavedFrames(), AudioFileReader::isOK(), m_cacheFileReader, m_cacheMode, AudioFileReader::m_channelCount, m_data, m_dataLock, m_gain, m_initialised, m_normalised, and SVDEBUG.

◆ getNativeRate()

virtual int CodedAudioFileReader::getNativeRate ( ) const
inlinevirtual

Reimplemented from AudioFileReader.

Definition at line 44 of file CodedAudioFileReader.h.

References m_fileRate.

◆ isQuicklySeekable()

virtual bool CodedAudioFileReader::isQuicklySeekable ( ) const
inlinevirtual

Intermediate cache means all CodedAudioFileReaders are quickly seekable.

Implements AudioFileReader.

Definition at line 47 of file CodedAudioFileReader.h.

◆ progress

void CodedAudioFileReader::progress ( int  )
signal

Referenced by DecodingWavFileReader::addBlock(), and OggVorbisFileReader::readPacket().

◆ initialiseDecodeCache()

void CodedAudioFileReader::initialiseDecodeCache ( )
protected

Definition at line 97 of file CodedAudioFileReader.cpp.

References CacheInMemory, CacheInTemporaryFile, Resampler::FastestTolerable, WavFileReader::getError(), TempDirectory::getInstance(), AudioFileReader::isOK(), m_cacheFileName, m_cacheFileReader, m_cacheFileWritePtr, m_cacheMode, m_cacheMutex, m_cacheWriteBuffer, m_cacheWriteBufferIndex, m_cacheWriteBufferSize, AudioFileReader::m_channelCount, m_data, m_fileRate, m_initialised, m_resampleBuffer, m_resampler, AudioFileReader::m_sampleRate, and SVDEBUG.

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), and DecodingWavFileReader::DecodingWavFileReader().

◆ addSamplesToDecodeCache() [1/3]

void CodedAudioFileReader::addSamplesToDecodeCache ( float **  samples,
int  nframes 
)
protected

Definition at line 179 of file CodedAudioFileReader.cpp.

References m_cacheFileReader, m_cacheMutex, m_cacheWriteBuffer, m_cacheWriteBufferIndex, m_cacheWriteBufferSize, AudioFileReader::m_channelCount, m_initialised, pushBuffer(), and WavFileReader::updateFrameCount().

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), and DecodingWavFileReader::addBlock().

◆ addSamplesToDecodeCache() [2/3]

void CodedAudioFileReader::addSamplesToDecodeCache ( float *  samplesInterleaved,
int  nframes 
)
protected

Definition at line 209 of file CodedAudioFileReader.cpp.

References m_cacheFileReader, m_cacheMutex, m_cacheWriteBuffer, m_cacheWriteBufferIndex, m_cacheWriteBufferSize, AudioFileReader::m_channelCount, m_initialised, pushBuffer(), and WavFileReader::updateFrameCount().

◆ addSamplesToDecodeCache() [3/3]

void CodedAudioFileReader::addSamplesToDecodeCache ( const SampleBlock &  interleaved)
protected

Definition at line 239 of file CodedAudioFileReader.cpp.

References m_cacheFileReader, m_cacheMutex, m_cacheWriteBuffer, m_cacheWriteBufferIndex, m_cacheWriteBufferSize, AudioFileReader::m_channelCount, m_initialised, pushBuffer(), and WavFileReader::updateFrameCount().

◆ finishDecodeCache()

void CodedAudioFileReader::finishDecodeCache ( )
protected

Definition at line 266 of file CodedAudioFileReader.cpp.

References CacheInTemporaryFile, m_cacheFileReader, m_cacheFileWritePtr, m_cacheMode, m_cacheMutex, m_cacheWriteBuffer, m_cacheWriteBufferIndex, AudioFileReader::m_channelCount, m_initialised, m_resampleBuffer, m_resampler, pushBuffer(), and WavFileReader::updateFrameCount().

Referenced by DecodingWavFileReader::DecodingWavFileReader(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), DecodingWavFileReader::DecodeThread::run(), OggVorbisFileReader::DecodeThread::run(), and MP3FileReader::DecodeThread::run().

◆ isDecodeCacheInitialised()

bool CodedAudioFileReader::isDecodeCacheInitialised ( ) const
inlineprotected

Definition at line 67 of file CodedAudioFileReader.h.

References m_initialised.

Referenced by MP3FileReader::accept(), DecodingWavFileReader::DecodingWavFileReader(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), DecodingWavFileReader::DecodeThread::run(), OggVorbisFileReader::DecodeThread::run(), and MP3FileReader::DecodeThread::run().

◆ startSerialised()

void CodedAudioFileReader::startSerialised ( QString  id)
protected

Definition at line 79 of file CodedAudioFileReader.cpp.

References m_serialiser, and SVDEBUG.

Referenced by MP3FileReader::accept(), DecodingWavFileReader::DecodeThread::run(), and OggVorbisFileReader::DecodeThread::run().

◆ endSerialised()

void CodedAudioFileReader::endSerialised ( )
protected

Definition at line 88 of file CodedAudioFileReader.cpp.

References Serialiser::getId(), m_serialiser, and SVDEBUG.

Referenced by DecodingWavFileReader::DecodingWavFileReader(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), DecodingWavFileReader::DecodeThread::run(), OggVorbisFileReader::DecodeThread::run(), MP3FileReader::DecodeThread::run(), and ~CodedAudioFileReader().

◆ pushBuffer()

void CodedAudioFileReader::pushBuffer ( float *  interleaved,
int  sz,
bool  final 
)
private

Definition at line 298 of file CodedAudioFileReader.cpp.

References m_fileFrameCount, m_fileRate, m_resampler, AudioFileReader::m_sampleRate, pushBufferNonResampling(), and pushBufferResampling().

Referenced by addSamplesToDecodeCache(), and finishDecodeCache().

◆ pushBufferResampling()

void CodedAudioFileReader::pushBufferResampling ( float *  interleaved,
int  sz,
float  ratio,
bool  final 
)
private

Definition at line 361 of file CodedAudioFileReader.cpp.

References AudioFileReader::m_channelCount, m_fileFrameCount, AudioFileReader::m_frameCount, m_resampleBuffer, m_resampler, pushBufferNonResampling(), Resampler::resampleInterleaved(), and SVDEBUG.

Referenced by pushBuffer().

◆ pushBufferNonResampling()

void CodedAudioFileReader::pushBufferNonResampling ( float *  interleaved,
int  sz 
)
private

Definition at line 315 of file CodedAudioFileReader.cpp.

References CacheInMemory, CacheInTemporaryFile, TempDirectory::getInstance(), m_cacheFileWritePtr, m_cacheMode, AudioFileReader::m_channelCount, m_data, m_dataLock, AudioFileReader::m_frameCount, m_gain, m_max, m_normalised, and MUNLOCK_SAMPLEBLOCK.

Referenced by pushBuffer(), and pushBufferResampling().

◆ isOK()

bool AudioFileReader::isOK ( ) const
inlineinherited

Definition at line 35 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by AudioFileReaderFactory::create(), DecodingWavFileReader::DecodingWavFileReader(), WaveFileModel::getData(), getInterleavedFrames(), initialiseDecodeCache(), and WaveFileModel::isOK().

◆ getError()

virtual QString AudioFileReader::getError ( ) const
inlinevirtualinherited

Reimplemented in OggVorbisFileReader, MP3FileReader, DecodingWavFileReader, and WavFileReader.

Definition at line 37 of file AudioFileReader.h.

Referenced by AudioFileReaderFactory::create().

◆ getFrameCount()

int AudioFileReader::getFrameCount ( ) const
inlineinherited

Definition at line 39 of file AudioFileReader.h.

References AudioFileReader::m_frameCount.

Referenced by DecodingWavFileReader::addBlock(), DecodingWavFileReader::DecodingWavFileReader(), WaveFileModel::getFrameCount(), and DecodingWavFileReader::DecodeThread::run().

◆ getChannelCount()

int AudioFileReader::getChannelCount ( ) const
inlineinherited

Definition at line 40 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by WritableWaveFileModel::addSamples(), DecodingWavFileReader::DecodingWavFileReader(), WaveFileModel::getChannelCount(), and AudioFileReader::getDeInterleavedFrames().

◆ getSampleRate()

int AudioFileReader::getSampleRate ( ) const
inlineinherited

Definition at line 41 of file AudioFileReader.h.

References AudioFileReader::m_sampleRate.

Referenced by AudioFileReaderFactory::create(), DecodingWavFileReader::DecodingWavFileReader(), WaveFileModel::getSampleRate(), and WaveFileModel::WaveFileModel().

◆ getLocation()

virtual QString AudioFileReader::getLocation ( ) const
inlinevirtualinherited

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

Reimplemented in OggVorbisFileReader, MP3FileReader, DecodingWavFileReader, and WavFileReader.

Definition at line 49 of file AudioFileReader.h.

Referenced by WaveFileModel::getLocation().

◆ getTitle()

virtual QString AudioFileReader::getTitle ( ) const
inlinevirtualinherited

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.

Reimplemented in OggVorbisFileReader, and MP3FileReader.

Definition at line 56 of file AudioFileReader.h.

Referenced by WaveFileModel::getTitle(), and WaveFileModel::WaveFileModel().

◆ getMaker()

virtual QString AudioFileReader::getMaker ( ) const
inlinevirtualinherited

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

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

Reimplemented in OggVorbisFileReader, and MP3FileReader.

Definition at line 63 of file AudioFileReader.h.

Referenced by WaveFileModel::getMaker().

◆ getTags()

virtual TagMap AudioFileReader::getTags ( ) const
inlinevirtualinherited

Reimplemented in OggVorbisFileReader, and MP3FileReader.

Definition at line 66 of file AudioFileReader.h.

◆ getDeInterleavedFrames()

void AudioFileReader::getDeInterleavedFrames ( int  start,
int  count,
std::vector< SampleBlock > &  frames 
) 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 19 of file AudioFileReader.cpp.

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

◆ getDecodeCompletion()

virtual int AudioFileReader::getDecodeCompletion ( ) const
inlinevirtualinherited

Reimplemented in OggVorbisFileReader, MP3FileReader, WavFileReader, and DecodingWavFileReader.

Definition at line 99 of file AudioFileReader.h.

Referenced by WaveFileModel::isReady().

◆ isUpdating()

virtual bool AudioFileReader::isUpdating ( ) const
inlinevirtualinherited

Reimplemented in OggVorbisFileReader, MP3FileReader, WavFileReader, and DecodingWavFileReader.

Definition at line 101 of file AudioFileReader.h.

Referenced by WaveFileModel::RangeCacheFillThread::run().

◆ frameCountChanged

void AudioFileReader::frameCountChanged ( )
signalinherited

Referenced by WavFileReader::updateFrameCount().

Member Data Documentation

◆ m_cacheMutex

QMutex CodedAudioFileReader::m_cacheMutex
protected

Definition at line 78 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), finishDecodeCache(), initialiseDecodeCache(), and ~CodedAudioFileReader().

◆ m_cacheMode

CacheMode CodedAudioFileReader::m_cacheMode
protected

Definition at line 79 of file CodedAudioFileReader.h.

Referenced by MP3FileReader::accept(), finishDecodeCache(), getInterleavedFrames(), initialiseDecodeCache(), pushBufferNonResampling(), DecodingWavFileReader::DecodeThread::run(), and OggVorbisFileReader::DecodeThread::run().

◆ m_data

SampleBlock CodedAudioFileReader::m_data
protected

Definition at line 80 of file CodedAudioFileReader.h.

Referenced by getInterleavedFrames(), initialiseDecodeCache(), and pushBufferNonResampling().

◆ m_dataLock

QReadWriteLock CodedAudioFileReader::m_dataLock
mutableprotected

Definition at line 81 of file CodedAudioFileReader.h.

Referenced by getInterleavedFrames(), and pushBufferNonResampling().

◆ m_initialised

bool CodedAudioFileReader::m_initialised
protected

Definition at line 82 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), finishDecodeCache(), getInterleavedFrames(), initialiseDecodeCache(), and isDecodeCacheInitialised().

◆ m_serialiser

Serialiser* CodedAudioFileReader::m_serialiser
protected

Definition at line 83 of file CodedAudioFileReader.h.

Referenced by endSerialised(), and startSerialised().

◆ m_fileRate

int CodedAudioFileReader::m_fileRate
protected

Definition at line 84 of file CodedAudioFileReader.h.

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), DecodingWavFileReader::addBlock(), DecodingWavFileReader::DecodingWavFileReader(), getNativeRate(), initialiseDecodeCache(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), and pushBuffer().

◆ m_cacheFileName

QString CodedAudioFileReader::m_cacheFileName
protected

Definition at line 86 of file CodedAudioFileReader.h.

Referenced by initialiseDecodeCache(), and ~CodedAudioFileReader().

◆ m_cacheFileWritePtr

SNDFILE* CodedAudioFileReader::m_cacheFileWritePtr
protected

Definition at line 87 of file CodedAudioFileReader.h.

Referenced by finishDecodeCache(), initialiseDecodeCache(), pushBufferNonResampling(), and ~CodedAudioFileReader().

◆ m_cacheFileReader

WavFileReader* CodedAudioFileReader::m_cacheFileReader
protected

Definition at line 88 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), finishDecodeCache(), getInterleavedFrames(), initialiseDecodeCache(), and ~CodedAudioFileReader().

◆ m_cacheWriteBuffer

float* CodedAudioFileReader::m_cacheWriteBuffer
protected

Definition at line 89 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), finishDecodeCache(), initialiseDecodeCache(), and ~CodedAudioFileReader().

◆ m_cacheWriteBufferIndex

int CodedAudioFileReader::m_cacheWriteBufferIndex
protected

Definition at line 90 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), finishDecodeCache(), and initialiseDecodeCache().

◆ m_cacheWriteBufferSize

int CodedAudioFileReader::m_cacheWriteBufferSize
protected

Definition at line 91 of file CodedAudioFileReader.h.

Referenced by addSamplesToDecodeCache(), and initialiseDecodeCache().

◆ m_resampler

Resampler* CodedAudioFileReader::m_resampler
protected

Definition at line 93 of file CodedAudioFileReader.h.

Referenced by finishDecodeCache(), initialiseDecodeCache(), pushBuffer(), pushBufferResampling(), and ~CodedAudioFileReader().

◆ m_resampleBuffer

float* CodedAudioFileReader::m_resampleBuffer
protected

Definition at line 94 of file CodedAudioFileReader.h.

Referenced by finishDecodeCache(), initialiseDecodeCache(), pushBufferResampling(), and ~CodedAudioFileReader().

◆ m_fileFrameCount

int CodedAudioFileReader::m_fileFrameCount
protected

Definition at line 95 of file CodedAudioFileReader.h.

Referenced by pushBuffer(), and pushBufferResampling().

◆ m_normalised

bool CodedAudioFileReader::m_normalised
protected

Definition at line 97 of file CodedAudioFileReader.h.

Referenced by getInterleavedFrames(), and pushBufferNonResampling().

◆ m_max

float CodedAudioFileReader::m_max
protected

Definition at line 98 of file CodedAudioFileReader.h.

Referenced by pushBufferNonResampling().

◆ m_gain

float CodedAudioFileReader::m_gain
protected

Definition at line 99 of file CodedAudioFileReader.h.

Referenced by getInterleavedFrames(), and pushBufferNonResampling().

◆ m_frameCount

int AudioFileReader::m_frameCount
protectedinherited

Definition at line 107 of file AudioFileReader.h.

Referenced by MP3FileReader::accept(), CodedAudioFileReader(), AudioFileReader::getFrameCount(), pushBufferNonResampling(), pushBufferResampling(), WavFileReader::updateFrameCount(), and WavFileReader::WavFileReader().

◆ m_channelCount

int AudioFileReader::m_channelCount
protectedinherited

Definition at line 108 of file AudioFileReader.h.

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), addSamplesToDecodeCache(), DecodingWavFileReader::DecodingWavFileReader(), finishDecodeCache(), AudioFileReader::getChannelCount(), getInterleavedFrames(), WavFileReader::getInterleavedFrames(), initialiseDecodeCache(), AudioFileReader::isOK(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), pushBufferNonResampling(), pushBufferResampling(), MP3FileReader::DecodeThread::run(), WavFileReader::updateFrameCount(), and WavFileReader::WavFileReader().

◆ m_sampleRate

int AudioFileReader::m_sampleRate
protectedinherited

Definition at line 109 of file AudioFileReader.h.

Referenced by MP3FileReader::accept(), DecodingWavFileReader::addBlock(), CodedAudioFileReader(), AudioFileReader::getNativeRate(), AudioFileReader::getSampleRate(), initialiseDecodeCache(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), pushBuffer(), WavFileReader::updateFrameCount(), and WavFileReader::WavFileReader().

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