AudioFileReader Class Reference

#include <AudioFileReader.h>

Inherited by CodedAudioFileReader, and WavFileReader.

Inheritance diagram for AudioFileReader:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 27 of file AudioFileReader.h.

Signals

void frameCountChanged ()

Public Member Functions

virtual ~AudioFileReader ()
bool isOK () const
virtual QString getError () const
size_t getFrameCount () const
size_t getChannelCount () const
size_t getSampleRate () const
size_t getNativeRate () 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 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 getInterleavedFrames (size_t start, size_t count, SampleBlock &frames) const=0
 Return interleaved samples for count frames from index start.
virtual void getDeInterleavedFrames (size_t start, size_t count, std::vector< SampleBlock > &frames) const
 Return de-interleaved samples for count frames from index start.
virtual int getDecodeCompletion () const
virtual bool isUpdating () const

Protected Attributes

size_t m_frameCount
size_t m_channelCount
size_t m_sampleRate


Constructor & Destructor Documentation

virtual AudioFileReader::~AudioFileReader (  )  [inline, virtual]

Definition at line 32 of file AudioFileReader.h.


Member Function Documentation

bool AudioFileReader::isOK (  )  const [inline]

Definition at line 34 of file AudioFileReader.h.

References m_channelCount.

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

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

Reimplemented in MP3FileReader, OggVorbisFileReader, ResamplingWavFileReader, and WavFileReader.

Definition at line 36 of file AudioFileReader.h.

size_t AudioFileReader::getFrameCount (  )  const [inline]

Definition at line 38 of file AudioFileReader.h.

References m_frameCount.

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

size_t AudioFileReader::getChannelCount (  )  const [inline]

Definition at line 39 of file AudioFileReader.h.

References m_channelCount.

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

size_t AudioFileReader::getSampleRate (  )  const [inline]

Definition at line 40 of file AudioFileReader.h.

References m_sampleRate.

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

size_t AudioFileReader::getNativeRate (  )  const [inline]

Reimplemented in CodedAudioFileReader.

Definition at line 41 of file AudioFileReader.h.

References m_sampleRate.

Referenced by WaveFileModel::getNativeRate().

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

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

Reimplemented in MP3FileReader, OggVorbisFileReader, ResamplingWavFileReader, and WavFileReader.

Definition at line 47 of file AudioFileReader.h.

Referenced by AudioFileReaderFactory::create(), and WaveFileModel::getLocation().

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

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]

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

virtual void AudioFileReader::getInterleavedFrames ( size_t  start,
size_t  count,
SampleBlock frames 
) const [pure 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.

Implemented in CodedAudioFileReader, and WavFileReader.

Referenced by WaveFileModel::getData(), getDeInterleavedFrames(), WaveFileModel::getSummaries(), and WaveFileModel::RangeCacheFillThread::run().

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

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 getChannelCount(), and getInterleavedFrames().

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

Reimplemented in MP3FileReader, OggVorbisFileReader, ResamplingWavFileReader, and WavFileReader.

Definition at line 87 of file AudioFileReader.h.

Referenced by WaveFileModel::isReady().

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

Reimplemented in MP3FileReader, OggVorbisFileReader, ResamplingWavFileReader, and WavFileReader.

Definition at line 89 of file AudioFileReader.h.

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

void AudioFileReader::frameCountChanged (  )  [signal]

Referenced by WavFileReader::updateFrameCount().


Member Data Documentation

size_t AudioFileReader::m_frameCount [protected]

Definition at line 95 of file AudioFileReader.h.

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

size_t AudioFileReader::m_channelCount [protected]

Definition at line 96 of file AudioFileReader.h.

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

size_t AudioFileReader::m_sampleRate [protected]

Definition at line 97 of file AudioFileReader.h.

Referenced by MP3FileReader::accept(), CodedAudioFileReader::CodedAudioFileReader(), getNativeRate(), 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:32 2008 for SonicVisualiser by  doxygen 1.5.1