CLAM::AudioCodecs::Stream Class Reference

#include <AudioCodecs_Stream.hxx>

Inheritance diagram for CLAM::AudioCodecs::Stream:

CLAM::AudioCodecs::MpegAudioStream CLAM::AudioCodecs::OggVorbisAudioStream CLAM::AudioCodecs::PCMAudioStream

List of all members.

Detailed Description

Streams provide I/O to and from an audio file of a given format.

You can get a stream by using a Codec. To add support for a different format you must subclass both the Codec and the Stream.

Todo:
Document Stream methods

Definition at line 44 of file AudioCodecs_Stream.hxx.


Public Member Functions

 Stream ()
virtual ~Stream ()
virtual void SetFOI (const AudioFile &)=0
virtual void PrepareReading ()=0
virtual void PrepareWriting ()=0
virtual void PrepareReadWrite ()=0
virtual void Dispose ()=0
void DeactivateStrictStreaming ()
void ActivateStrictStreaming ()
bool StrictStreaming () const
bool ReadData (int channel, TData *ptr, TSize howmany)
bool ReadData (int *channels, int nchannels, TData **samples, TSize howmany)
void WriteData (int channel, const TData *ptr, TSize howmany)
void WriteData (int *channels, int nchannels, TData **const samples, TSize howmany)
bool WasSomethingRead () const

Protected Member Functions

virtual void DiskToMemoryTransfer ()=0
virtual void MemoryToDiskTransfer ()=0
bool AllChannelsConsumed ()
void ResetConsumedChannels ()
void MarkAllChannelsAsConsumed ()
bool AllChannelsProduced ()
void ResetProducedChannels ()
void MarkAllChannelsAsProduced ()
void SetChannels (TSize nChannels)

Protected Attributes

TSize mChannels
std::vector< bool > mChannelsConsumed
std::vector< bool > mChannelsProduced
bool mStrictStreaming
DataArray mInterleavedData
DataArray mInterleavedDataOut
bool mEOFReached
TSize mFramesToRead
TSize mFramesToWrite
TSize mFramesLastRead

Constructor & Destructor Documentation

CLAM::AudioCodecs::Stream::Stream (  ) 

Definition at line 29 of file AudioCodecs_Stream.cxx.

CLAM::AudioCodecs::Stream::~Stream (  )  [virtual]

Definition at line 34 of file AudioCodecs_Stream.cxx.

Member Function Documentation

virtual void CLAM::AudioCodecs::Stream::SetFOI ( const AudioFile &   )  [pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

virtual void CLAM::AudioCodecs::Stream::PrepareReading (  )  [pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

Referenced by CLAM::MultiChannelAudioFileReader::ConcreteStart(), and CLAM::MonoAudioFileReader::ConcreteStart().

virtual void CLAM::AudioCodecs::Stream::PrepareWriting (  )  [pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

Referenced by CLAM::MultiChannelAudioFileWriter::ConcreteStart(), and CLAM::MonoAudioFileWriter::ConcreteStart().

virtual void CLAM::AudioCodecs::Stream::PrepareReadWrite (  )  [pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

virtual void CLAM::AudioCodecs::Stream::Dispose (  )  [pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

Referenced by CLAM::MultiChannelAudioFileWriter::ConcreteStop(), CLAM::MultiChannelAudioFileReader::ConcreteStop(), CLAM::MonoAudioFileWriter::ConcreteStop(), and CLAM::MonoAudioFileReader::ConcreteStop().

void CLAM::AudioCodecs::Stream::DeactivateStrictStreaming (  )  [inline]

Definition at line 118 of file AudioCodecs_Stream.hxx.

References mStrictStreaming.

Referenced by CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteStart(), and CLAM::MonoAudioFileReader::Do().

void CLAM::AudioCodecs::Stream::ActivateStrictStreaming (  )  [inline]

Definition at line 113 of file AudioCodecs_Stream.hxx.

References mStrictStreaming.

bool CLAM::AudioCodecs::Stream::StrictStreaming (  )  const [inline]

Definition at line 123 of file AudioCodecs_Stream.hxx.

References mStrictStreaming.

bool CLAM::AudioCodecs::Stream::ReadData ( int  channel,
TData *  ptr,
TSize  howmany 
)

Definition at line 124 of file AudioCodecs_Stream.cxx.

References mChannels, mChannelsConsumed, mEOFReached, mFramesLastRead, and mInterleavedData.

Referenced by CLAM::MultiChannelAudioFileReader::Do(), and CLAM::MonoAudioFileReader::Do().

bool CLAM::AudioCodecs::Stream::ReadData ( int *  channels,
int  nchannels,
TData **  samples,
TSize  howmany 
)

Definition at line 150 of file AudioCodecs_Stream.cxx.

References mChannels, mChannelsConsumed, mEOFReached, mFramesLastRead, and mInterleavedData.

void CLAM::AudioCodecs::Stream::WriteData ( int  channel,
const TData *  ptr,
TSize  howmany 
)

Definition at line 204 of file AudioCodecs_Stream.cxx.

References AllChannelsProduced(), mChannels, mChannelsProduced, MemoryToDiskTransfer(), and mInterleavedDataOut.

Referenced by CLAM::MultiChannelAudioFileWriter::Do(), and CLAM::MonoAudioFileWriter::Do().

void CLAM::AudioCodecs::Stream::WriteData ( int *  channels,
int  nchannels,
TData **const   samples,
TSize  howmany 
)

Definition at line 226 of file AudioCodecs_Stream.cxx.

References AllChannelsProduced(), mChannels, mChannelsProduced, MemoryToDiskTransfer(), and mInterleavedDataOut.

bool CLAM::AudioCodecs::Stream::WasSomethingRead (  )  const [inline]

Definition at line 107 of file AudioCodecs_Stream.hxx.

References mFramesLastRead.

virtual void CLAM::AudioCodecs::Stream::DiskToMemoryTransfer (  )  [protected, pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

virtual void CLAM::AudioCodecs::Stream::MemoryToDiskTransfer (  )  [protected, pure virtual]

Implemented in CLAM::AudioCodecs::MpegAudioStream, CLAM::AudioCodecs::OggVorbisAudioStream, and CLAM::AudioCodecs::PCMAudioStream.

Referenced by WriteData().

bool CLAM::AudioCodecs::Stream::AllChannelsConsumed (  )  [protected]

Definition at line 67 of file AudioCodecs_Stream.cxx.

References mChannelsConsumed.

void CLAM::AudioCodecs::Stream::ResetConsumedChannels (  )  [protected]

Definition at line 86 of file AudioCodecs_Stream.cxx.

References mChannelsConsumed.

void CLAM::AudioCodecs::Stream::MarkAllChannelsAsConsumed (  )  [protected]

Definition at line 78 of file AudioCodecs_Stream.cxx.

References mChannelsConsumed.

Referenced by CLAM::AudioCodecs::PCMAudioStream::PrepareReading(), CLAM::AudioCodecs::OggVorbisAudioStream::PrepareReading(), CLAM::AudioCodecs::MpegAudioStream::PrepareReading(), and CLAM::AudioCodecs::PCMAudioStream::PrepareReadWrite().

bool CLAM::AudioCodecs::Stream::AllChannelsProduced (  )  [protected]

Definition at line 38 of file AudioCodecs_Stream.cxx.

References mChannelsProduced.

Referenced by WriteData().

void CLAM::AudioCodecs::Stream::ResetProducedChannels (  )  [protected]

Definition at line 59 of file AudioCodecs_Stream.cxx.

References mChannelsProduced.

void CLAM::AudioCodecs::Stream::MarkAllChannelsAsProduced (  )  [protected]

Definition at line 49 of file AudioCodecs_Stream.cxx.

References mChannelsProduced.

Referenced by CLAM::AudioCodecs::PCMAudioStream::PrepareReadWrite(), CLAM::AudioCodecs::PCMAudioStream::PrepareWriting(), and CLAM::AudioCodecs::OggVorbisAudioStream::PrepareWriting().

void CLAM::AudioCodecs::Stream::SetChannels ( TSize  nChannels  )  [protected]

Definition at line 265 of file AudioCodecs_Stream.cxx.

References mChannels, mChannelsConsumed, and mChannelsProduced.

Referenced by CLAM::AudioCodecs::OggVorbisAudioStream::PrepareReading(), CLAM::AudioCodecs::MpegAudioStream::PrepareReading(), CLAM::AudioCodecs::PCMAudioStream::SetFOI(), and CLAM::AudioCodecs::OggVorbisAudioStream::VorbisI_EncoderSetup().

Member Data Documentation

TSize CLAM::AudioCodecs::Stream::mChannels [protected]

Definition at line 87 of file AudioCodecs_Stream.hxx.

Referenced by ReadData(), SetChannels(), and WriteData().

std::vector<bool> CLAM::AudioCodecs::Stream::mChannelsConsumed [protected]

Definition at line 88 of file AudioCodecs_Stream.hxx.

Referenced by AllChannelsConsumed(), MarkAllChannelsAsConsumed(), ReadData(), ResetConsumedChannels(), and SetChannels().

std::vector<bool> CLAM::AudioCodecs::Stream::mChannelsProduced [protected]

Definition at line 89 of file AudioCodecs_Stream.hxx.

Referenced by AllChannelsProduced(), MarkAllChannelsAsProduced(), ResetProducedChannels(), SetChannels(), and WriteData().

bool CLAM::AudioCodecs::Stream::mStrictStreaming [protected]

Definition at line 90 of file AudioCodecs_Stream.hxx.

Referenced by ActivateStrictStreaming(), DeactivateStrictStreaming(), and StrictStreaming().

DataArray CLAM::AudioCodecs::Stream::mInterleavedData [protected]

Definition at line 91 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::OggVorbisAudioStream::ConsumeDecodedSamples(), CLAM::AudioCodecs::MpegAudioStream::ConsumeDecodedSamples(), CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::OggVorbisAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::MpegAudioStream::DiskToMemoryTransfer(), and ReadData().

DataArray CLAM::AudioCodecs::Stream::mInterleavedDataOut [protected]

Definition at line 92 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::PCMAudioStream::MemoryToDiskTransfer(), CLAM::AudioCodecs::OggVorbisAudioStream::MemoryToDiskTransfer(), and WriteData().

bool CLAM::AudioCodecs::Stream::mEOFReached [protected]

Definition at line 93 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::OggVorbisAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::MpegAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::PCMAudioStream::PrepareReading(), CLAM::AudioCodecs::PCMAudioStream::PrepareReadWrite(), and ReadData().

TSize CLAM::AudioCodecs::Stream::mFramesToRead [protected]

Definition at line 94 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer().

TSize CLAM::AudioCodecs::Stream::mFramesToWrite [protected]

Definition at line 95 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::PCMAudioStream::MemoryToDiskTransfer().

TSize CLAM::AudioCodecs::Stream::mFramesLastRead [protected]

Definition at line 96 of file AudioCodecs_Stream.hxx.

Referenced by CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::OggVorbisAudioStream::DiskToMemoryTransfer(), CLAM::AudioCodecs::MpegAudioStream::DiskToMemoryTransfer(), ReadData(), and WasSomethingRead().

The documentation for this class was generated from the following files:
Generated on Tue Aug 12 22:33:51 2008 for CLAM by  doxygen 1.5.5