ResamplingWavFileReader Class Reference

#include <ResamplingWavFileReader.h>

Inheritance diagram for ResamplingWavFileReader:

[legend]Collaboration diagram for ResamplingWavFileReader:

Detailed Description

Definition at line 28 of file ResamplingWavFileReader.h.

Public Types

enum ResampleMode { ResampleAtOnce, ResampleThreaded }

enum CacheMode { CacheInTemporaryFile, CacheInMemory }

Signals

void progress (int)

void frameCountChanged ()

Public Member Functions

ResamplingWavFileReader (FileSource source, ResampleMode resampleMode, CacheMode cacheMode, size_t targetRate=0)

virtual ~ResamplingWavFileReader ()

virtual QString getError () const

virtual QString getLocation () const

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

virtual int getDecodeCompletion () const

virtual bool isUpdating () const

virtual void getInterleavedFrames (size_t start, size_t count, SampleBlock &frames) const

Return interleaved samples for count frames from index start.

virtual size_t getNativeRate () const

bool isOK () const

size_t getFrameCount () const

size_t getChannelCount () const

size_t getSampleRate () const

virtual QString getTitle () const

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

virtual QString getMaker () const

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

virtual void getDeInterleavedFrames (size_t start, size_t count, std::vector< SampleBlock > &frames) const

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

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 SampleBlock &frames)

void initialiseDecodeCache ()

void addSamplesToDecodeCache (float **samples, size_t nframes)

void addSamplesToDecodeCache (float *samplesInterleaved, size_t nframes)

void addSamplesToDecodeCache (const SampleBlock &interleaved)

void finishDecodeCache ()

bool isDecodeCacheInitialised () const

void startSerialised (QString id)

void endSerialised ()

Protected Attributes

FileSource m_source

QString m_path

QString m_error

bool m_cancelled

size_t m_processed

int m_completion

WavFileReader * m_original

QProgressDialog * m_progress

DecodeThread * m_decodeThread

QMutex m_cacheMutex

CacheMode m_cacheMode

SampleBlock m_data

bool m_initialised

Serialiser * m_serialiser

size_t m_fileRate

QString m_cacheFileName

SNDFILE * m_cacheFileWritePtr

WavFileReader * m_cacheFileReader

float * m_cacheWriteBuffer

size_t m_cacheWriteBufferIndex

size_t m_cacheWriteBufferSize

Resampler * m_resampler

float * m_resampleBuffer

size_t m_frameCount

size_t m_channelCount

size_t m_sampleRate

Classes

class DecodeThread

Member Enumeration Documentation

enum ResamplingWavFileReader::ResampleMode

Enumerator:

ResampleAtOnce
ResampleThreaded

Definition at line 31 of file ResamplingWavFileReader.h.

enum CodedAudioFileReader::CacheMode [inherited]

Enumerator:

CacheInTemporaryFile
CacheInMemory

Definition at line 35 of file CodedAudioFileReader.h.

Constructor & Destructor Documentation

ResamplingWavFileReader::ResamplingWavFileReader	(	FileSource	source,
		ResampleMode	resampleMode,
		CacheMode	cacheMode,
		size_t	targetRate = `0`
	)

ResamplingWavFileReader::~ResamplingWavFileReader ( ) [virtual]

Definition at line 98 of file ResamplingWavFileReader.cpp.

References m_cancelled, m_decodeThread, and m_original.

Member Function Documentation

virtual QString ResamplingWavFileReader::getError ( ) const [inline, virtual]

Reimplemented from AudioFileReader.

Definition at line 42 of file ResamplingWavFileReader.h.

References m_error.

virtual QString ResamplingWavFileReader::getLocation ( ) const [inline, virtual]

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

Reimplemented from AudioFileReader.

Definition at line 43 of file ResamplingWavFileReader.h.

References FileSource::getLocation(), and m_source.

void ResamplingWavFileReader::getSupportedExtensions ( std::set< QString > & extensions ) [static]

Definition at line 168 of file ResamplingWavFileReader.cpp.

References WavFileReader::getSupportedExtensions().

bool ResamplingWavFileReader::supportsExtension ( QString ext ) [static]

Definition at line 174 of file ResamplingWavFileReader.cpp.

References WavFileReader::supportsExtension().

bool ResamplingWavFileReader::supportsContentType ( QString type ) [static]

Definition at line 180 of file ResamplingWavFileReader.cpp.

References WavFileReader::supportsContentType().

bool ResamplingWavFileReader::supports ( FileSource & source ) [static]

Definition at line 186 of file ResamplingWavFileReader.cpp.

References WavFileReader::supports().

virtual int ResamplingWavFileReader::getDecodeCompletion ( ) const [inline, virtual]

Reimplemented from AudioFileReader.

Definition at line 49 of file ResamplingWavFileReader.h.

References m_completion.

virtual bool ResamplingWavFileReader::isUpdating ( ) const [inline, virtual]

Reimplemented from AudioFileReader.

Definition at line 51 of file ResamplingWavFileReader.h.

References m_decodeThread.

void ResamplingWavFileReader::addBlock ( const SampleBlock & frames ) [protected]

Definition at line 142 of file ResamplingWavFileReader.cpp.

References CodedAudioFileReader::addSamplesToDecodeCache(), AudioFileReader::getFrameCount(), m_cancelled, m_completion, m_original, m_processed, m_progress, and CodedAudioFileReader::progress().

Referenced by ResamplingWavFileReader(), and ResamplingWavFileReader::DecodeThread::run().

void CodedAudioFileReader::getInterleavedFrames	(	size_t	start,
		size_t	count,
		SampleBlock &	frames
	)			const `[virtual, inherited]`

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 342 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::CacheInMemory, CodedAudioFileReader::CacheInTemporaryFile, AudioFileReader::isOK(), CodedAudioFileReader::m_cacheFileReader, CodedAudioFileReader::m_cacheMode, AudioFileReader::m_channelCount, CodedAudioFileReader::m_data, and CodedAudioFileReader::m_initialised.

virtual size_t CodedAudioFileReader::getNativeRate ( ) const [inline, virtual, inherited]

Reimplemented from AudioFileReader.

Definition at line 43 of file CodedAudioFileReader.h.

References CodedAudioFileReader::m_fileRate.

void CodedAudioFileReader::progress ( int ) [signal, inherited]

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

void CodedAudioFileReader::initialiseDecodeCache ( ) [protected, inherited]

Definition at line 89 of file CodedAudioFileReader.cpp.

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

void CodedAudioFileReader::addSamplesToDecodeCache	(	float **	samples,
		size_t	nframes
	)			`[protected, inherited]`

Definition at line 170 of file CodedAudioFileReader.cpp.

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

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

void CodedAudioFileReader::addSamplesToDecodeCache	(	float *	samplesInterleaved,
		size_t	nframes
	)			`[protected, inherited]`

Definition at line 200 of file CodedAudioFileReader.cpp.

void CodedAudioFileReader::addSamplesToDecodeCache ( const SampleBlock & interleaved ) [protected, inherited]

Definition at line 230 of file CodedAudioFileReader.cpp.

void CodedAudioFileReader::finishDecodeCache ( ) [protected, inherited]

bool CodedAudioFileReader::isDecodeCacheInitialised ( ) const [inline, protected, inherited]

Definition at line 56 of file CodedAudioFileReader.h.

References CodedAudioFileReader::m_initialised.

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

void CodedAudioFileReader::startSerialised ( QString id ) [protected, inherited]

Definition at line 71 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

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

void CodedAudioFileReader::endSerialised ( ) [protected, inherited]

Definition at line 80 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

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

bool AudioFileReader::isOK ( ) const [inline, inherited]

Definition at line 34 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

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

size_t AudioFileReader::getFrameCount ( ) const [inline, inherited]

Definition at line 38 of file AudioFileReader.h.

References AudioFileReader::m_frameCount.

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

size_t AudioFileReader::getChannelCount ( ) const [inline, inherited]

Definition at line 39 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

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

size_t AudioFileReader::getSampleRate ( ) const [inline, inherited]

Definition at line 40 of file AudioFileReader.h.

References AudioFileReader::m_sampleRate.

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

virtual QString AudioFileReader::getTitle ( ) const [inline, virtual, inherited]

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 MP3FileReader, and OggVorbisFileReader.

Definition at line 54 of file AudioFileReader.h.

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

virtual QString AudioFileReader::getMaker ( ) const [inline, virtual, inherited]

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

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

Reimplemented in MP3FileReader, and OggVorbisFileReader.

Definition at line 61 of file AudioFileReader.h.

Referenced by WaveFileModel::getMaker().

void AudioFileReader::getDeInterleavedFrames	(	size_t	start,
		size_t	count,
		std::vector< SampleBlock > &	frames
	)			const `[virtual, inherited]`

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().

void AudioFileReader::frameCountChanged ( ) [signal, inherited]

Referenced by WavFileReader::updateFrameCount().

Member Data Documentation

FileSource ResamplingWavFileReader::m_source [protected]

Definition at line 56 of file ResamplingWavFileReader.h.

Referenced by getLocation().

QString ResamplingWavFileReader::m_path [protected]

Definition at line 57 of file ResamplingWavFileReader.h.

Referenced by ResamplingWavFileReader().

QString ResamplingWavFileReader::m_error [protected]

Definition at line 58 of file ResamplingWavFileReader.h.

Referenced by getError(), and ResamplingWavFileReader().

bool ResamplingWavFileReader::m_cancelled [protected]

Definition at line 59 of file ResamplingWavFileReader.h.

Referenced by addBlock(), ResamplingWavFileReader(), ResamplingWavFileReader::DecodeThread::run(), and ~ResamplingWavFileReader().

size_t ResamplingWavFileReader::m_processed [protected]

Definition at line 60 of file ResamplingWavFileReader.h.

Referenced by addBlock().

int ResamplingWavFileReader::m_completion [protected]

Definition at line 61 of file ResamplingWavFileReader.h.

Referenced by addBlock(), getDecodeCompletion(), and ResamplingWavFileReader::DecodeThread::run().

WavFileReader* ResamplingWavFileReader::m_original [protected]

Definition at line 63 of file ResamplingWavFileReader.h.

Referenced by addBlock(), ResamplingWavFileReader(), ResamplingWavFileReader::DecodeThread::run(), and ~ResamplingWavFileReader().

QProgressDialog* ResamplingWavFileReader::m_progress [protected]

Definition at line 64 of file ResamplingWavFileReader.h.

Referenced by addBlock(), and ResamplingWavFileReader().

DecodeThread* ResamplingWavFileReader::m_decodeThread [protected]

Definition at line 78 of file ResamplingWavFileReader.h.

Referenced by isUpdating(), ResamplingWavFileReader(), and ~ResamplingWavFileReader().

QMutex CodedAudioFileReader::m_cacheMutex [protected, inherited]

Definition at line 65 of file CodedAudioFileReader.h.

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

CacheMode CodedAudioFileReader::m_cacheMode [protected, inherited]

Definition at line 66 of file CodedAudioFileReader.h.

Referenced by MP3FileReader::accept(), CodedAudioFileReader::finishDecodeCache(), CodedAudioFileReader::getInterleavedFrames(), CodedAudioFileReader::initialiseDecodeCache(), CodedAudioFileReader::pushBuffer(), ResamplingWavFileReader::DecodeThread::run(), and OggVorbisFileReader::DecodeThread::run().

SampleBlock CodedAudioFileReader::m_data [protected, inherited]

Definition at line 67 of file CodedAudioFileReader.h.

Referenced by CodedAudioFileReader::getInterleavedFrames(), CodedAudioFileReader::initialiseDecodeCache(), and CodedAudioFileReader::pushBuffer().

bool CodedAudioFileReader::m_initialised [protected, inherited]

Definition at line 68 of file CodedAudioFileReader.h.

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

Serialiser* CodedAudioFileReader::m_serialiser [protected, inherited]

Definition at line 69 of file CodedAudioFileReader.h.

Referenced by CodedAudioFileReader::endSerialised(), and CodedAudioFileReader::startSerialised().

size_t CodedAudioFileReader::m_fileRate [protected, inherited]

Definition at line 70 of file CodedAudioFileReader.h.

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), CodedAudioFileReader::getNativeRate(), CodedAudioFileReader::initialiseDecodeCache(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), CodedAudioFileReader::pushBuffer(), and ResamplingWavFileReader().

QString CodedAudioFileReader::m_cacheFileName [protected, inherited]

Definition at line 72 of file CodedAudioFileReader.h.

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

SNDFILE* CodedAudioFileReader::m_cacheFileWritePtr [protected, inherited]

Definition at line 73 of file CodedAudioFileReader.h.

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

WavFileReader* CodedAudioFileReader::m_cacheFileReader [protected, inherited]

Definition at line 74 of file CodedAudioFileReader.h.

float* CodedAudioFileReader::m_cacheWriteBuffer [protected, inherited]

Definition at line 75 of file CodedAudioFileReader.h.

size_t CodedAudioFileReader::m_cacheWriteBufferIndex [protected, inherited]

Definition at line 76 of file CodedAudioFileReader.h.

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

size_t CodedAudioFileReader::m_cacheWriteBufferSize [protected, inherited]

Definition at line 77 of file CodedAudioFileReader.h.

Referenced by CodedAudioFileReader::addSamplesToDecodeCache(), and CodedAudioFileReader::initialiseDecodeCache().

Resampler* CodedAudioFileReader::m_resampler [protected, inherited]

Definition at line 79 of file CodedAudioFileReader.h.

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

float* CodedAudioFileReader::m_resampleBuffer [protected, inherited]

Definition at line 80 of file CodedAudioFileReader.h.

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

size_t AudioFileReader::m_frameCount [protected, inherited]

Definition at line 95 of file AudioFileReader.h.

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

size_t AudioFileReader::m_channelCount [protected, inherited]

Definition at line 96 of file AudioFileReader.h.

Referenced by MP3FileReader::accept(), OggVorbisFileReader::acceptFrames(), CodedAudioFileReader::addSamplesToDecodeCache(), CodedAudioFileReader::finishDecodeCache(), AudioFileReader::getChannelCount(), WavFileReader::getInterleavedFrames(), CodedAudioFileReader::getInterleavedFrames(), CodedAudioFileReader::initialiseDecodeCache(), AudioFileReader::isOK(), MP3FileReader::MP3FileReader(), OggVorbisFileReader::OggVorbisFileReader(), CodedAudioFileReader::pushBuffer(), ResamplingWavFileReader(), MP3FileReader::DecodeThread::run(), WavFileReader::updateFrameCount(), and WavFileReader::WavFileReader().

size_t AudioFileReader::m_sampleRate [protected, inherited]

Definition at line 97 of file AudioFileReader.h.

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

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

Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by

1.5.1


Public Types
enum	ResampleMode { ResampleAtOnce, ResampleThreaded }
enum	CacheMode { CacheInTemporaryFile, CacheInMemory }
Signals
void	progress (int)
void	frameCountChanged ()
Public Member Functions
	ResamplingWavFileReader (FileSource source, ResampleMode resampleMode, CacheMode cacheMode, size_t targetRate=0)
virtual	~ResamplingWavFileReader ()
virtual QString	getError () const
virtual QString	getLocation () const
	Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example).
virtual int	getDecodeCompletion () const
virtual bool	isUpdating () const
virtual void	getInterleavedFrames (size_t start, size_t count, SampleBlock &frames) const
	Return interleaved samples for count frames from index start.
virtual size_t	getNativeRate () const
bool	isOK () const
size_t	getFrameCount () const
size_t	getChannelCount () const
size_t	getSampleRate () const
virtual QString	getTitle () const
	Return the title of the work in the audio file, if known.
virtual QString	getMaker () const
	Return the "maker" of the work in the audio file, if known.
virtual void	getDeInterleavedFrames (size_t start, size_t count, std::vector< SampleBlock > &frames) const
	Return de-interleaved samples for count frames from index start.
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 SampleBlock &frames)
void	initialiseDecodeCache ()
void	addSamplesToDecodeCache (float **samples, size_t nframes)
void	addSamplesToDecodeCache (float *samplesInterleaved, size_t nframes)
void	addSamplesToDecodeCache (const SampleBlock &interleaved)
void	finishDecodeCache ()
bool	isDecodeCacheInitialised () const
void	startSerialised (QString id)
void	endSerialised ()
Protected Attributes
FileSource	m_source
QString	m_path
QString	m_error
bool	m_cancelled
size_t	m_processed
int	m_completion
WavFileReader *	m_original
QProgressDialog *	m_progress
DecodeThread *	m_decodeThread
QMutex	m_cacheMutex
CacheMode	m_cacheMode
SampleBlock	m_data
bool	m_initialised
Serialiser *	m_serialiser
size_t	m_fileRate
QString	m_cacheFileName
SNDFILE *	m_cacheFileWritePtr
WavFileReader *	m_cacheFileReader
float *	m_cacheWriteBuffer
size_t	m_cacheWriteBufferIndex
size_t	m_cacheWriteBufferSize
Resampler *	m_resampler
float *	m_resampleBuffer
size_t	m_frameCount
size_t	m_channelCount
size_t	m_sampleRate
Classes
class	DecodeThread