CLAM::AudioCodecs::OggVorbisAudioStream Class Reference

#include <OggVorbisAudioStream.hxx>

Inheritance diagram for CLAM::AudioCodecs::OggVorbisAudioStream:

CLAM::AudioCodecs::Stream

List of all members.

Detailed Description

Definition at line 43 of file OggVorbisAudioStream.hxx.


Public Member Functions

 OggVorbisAudioStream ()
 OggVorbisAudioStream (const AudioFile &file)
 ~OggVorbisAudioStream ()
void SetFOI (const AudioFile &file)
void PrepareReading ()
void PrepareWriting ()
void PrepareReadWrite ()
void Dispose ()

Protected Member Functions

void AudioFileToNative (const AudioFile &file)
void DiskToMemoryTransfer ()
void MemoryToDiskTransfer ()
void VorbisI_EncoderSetup ()
void WriteBitstreamHeader ()
void DoVorbisAnalysis ()
void PushAnalysisBlocksOntoOggStream ()
void ConsumeDecodedSamples ()

Protected Attributes

std::string mName
FILE * mFileHandle
OggVorbis_File mNativeFileParams
int mCurrentSection
bool mValidFileParams
vorbis_info mStreamInfo
vorbis_comment mFileComments
ogg_stream_state mOggStreamState
ogg_page mOggPage
ogg_packet mOggPacket
vorbis_dsp_state mDSPState
vorbis_block mVorbisBlock
int mEncodedSampleRate
int mEncodedChannels
bool mEncoding
int mOffset
Array< TInt16 > mBlockBuffer
std::vector< std::deque< TData > > mEncodeBuffer
std::deque< TInt16 > mDecodeBuffer
TSize mLastBytesRead

Static Protected Attributes

static const TSize mMaxBlockSize = 4096 / sizeof(TInt16)
static const TSize mAnalysisWindowSize = 1024

Constructor & Destructor Documentation

CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream (  ) 

Definition at line 45 of file OggVorbisAudioStream.cxx.

References mBlockBuffer, and mMaxBlockSize.

CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream ( const AudioFile &  file  ) 

Definition at line 53 of file OggVorbisAudioStream.cxx.

References mBlockBuffer, mMaxBlockSize, and SetFOI().

CLAM::AudioCodecs::OggVorbisAudioStream::~OggVorbisAudioStream (  ) 

Definition at line 62 of file OggVorbisAudioStream.cxx.

References Dispose(), and mValidFileParams.

Member Function Documentation

void CLAM::AudioCodecs::OggVorbisAudioStream::SetFOI ( const AudioFile &  file  )  [virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 68 of file OggVorbisAudioStream.cxx.

References AudioFileToNative(), Dispose(), and mValidFileParams.

Referenced by OggVorbisAudioStream().

void CLAM::AudioCodecs::OggVorbisAudioStream::PrepareReading (  )  [virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 87 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT, CLAM::AudioCodecs::Stream::MarkAllChannelsAsConsumed(), mCurrentSection, mFileHandle, mName, mNativeFileParams, mValidFileParams, NULL, and CLAM::AudioCodecs::Stream::SetChannels().

void CLAM::AudioCodecs::OggVorbisAudioStream::PrepareWriting (  )  [virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 122 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT, CLAM::AudioCodecs::Stream::MarkAllChannelsAsProduced(), mEncoding, mFileHandle, mName, NULL, and VorbisI_EncoderSetup().

void CLAM::AudioCodecs::OggVorbisAudioStream::PrepareReadWrite (  )  [virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 205 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT.

void CLAM::AudioCodecs::OggVorbisAudioStream::Dispose (  )  [virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 210 of file OggVorbisAudioStream.cxx.

References DoVorbisAnalysis(), mDSPState, mEncodeBuffer, mEncoding, mFileComments, mFileHandle, mNativeFileParams, mOggStreamState, mStreamInfo, mValidFileParams, mVorbisBlock, and PushAnalysisBlocksOntoOggStream().

Referenced by SetFOI(), and ~OggVorbisAudioStream().

void CLAM::AudioCodecs::OggVorbisAudioStream::AudioFileToNative ( const AudioFile &  file  )  [protected]

Definition at line 76 of file OggVorbisAudioStream.cxx.

References CLAM::AudioFile::GetHeader(), CLAM::AudioFile::GetLocation(), mEncodeBuffer, mEncodedChannels, mEncodedSampleRate, and mName.

Referenced by SetFOI().

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

Implements CLAM::AudioCodecs::Stream.

Definition at line 264 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT, ConsumeDecodedSamples(), HOST_ENDIANESS, mBlockBuffer, mCurrentSection, mDecodeBuffer, mEncodedChannels, CLAM::AudioCodecs::Stream::mEOFReached, CLAM::AudioCodecs::Stream::mFramesLastRead, CLAM::AudioCodecs::Stream::mInterleavedData, mLastBytesRead, mMaxBlockSize, and mNativeFileParams.

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

Implements CLAM::AudioCodecs::Stream.

Definition at line 310 of file OggVorbisAudioStream.cxx.

References DoVorbisAnalysis(), mAnalysisWindowSize, mEncodeBuffer, mEncodedChannels, and CLAM::AudioCodecs::Stream::mInterleavedDataOut.

void CLAM::AudioCodecs::OggVorbisAudioStream::VorbisI_EncoderSetup (  )  [protected]

Definition at line 138 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT, mDSPState, mEncodedChannels, mEncodedSampleRate, mFileComments, mOggStreamState, mStreamInfo, mVorbisBlock, CLAM::AudioCodecs::Stream::SetChannels(), and WriteBitstreamHeader().

Referenced by PrepareWriting().

void CLAM::AudioCodecs::OggVorbisAudioStream::WriteBitstreamHeader (  )  [protected]

Definition at line 170 of file OggVorbisAudioStream.cxx.

References mDSPState, mFileComments, mFileHandle, mOggPage, and mOggStreamState.

Referenced by VorbisI_EncoderSetup().

void CLAM::AudioCodecs::OggVorbisAudioStream::DoVorbisAnalysis (  )  [protected]

Definition at line 373 of file OggVorbisAudioStream.cxx.

References mAnalysisWindowSize, mDSPState, mEncodeBuffer, mEncodedChannels, and PushAnalysisBlocksOntoOggStream().

Referenced by Dispose(), and MemoryToDiskTransfer().

void CLAM::AudioCodecs::OggVorbisAudioStream::PushAnalysisBlocksOntoOggStream (  )  [protected]

Definition at line 339 of file OggVorbisAudioStream.cxx.

References mDSPState, mFileHandle, mOggPacket, mOggPage, mOggStreamState, mVorbisBlock, and NULL.

Referenced by Dispose(), and DoVorbisAnalysis().

void CLAM::AudioCodecs::OggVorbisAudioStream::ConsumeDecodedSamples (  )  [protected]

Definition at line 245 of file OggVorbisAudioStream.cxx.

References CLAM_ASSERT, mDecodeBuffer, and CLAM::AudioCodecs::Stream::mInterleavedData.

Referenced by DiskToMemoryTransfer().

Member Data Documentation

std::string CLAM::AudioCodecs::OggVorbisAudioStream::mName [protected]

Definition at line 72 of file OggVorbisAudioStream.hxx.

Referenced by AudioFileToNative(), PrepareReading(), and PrepareWriting().

FILE* CLAM::AudioCodecs::OggVorbisAudioStream::mFileHandle [protected]

Definition at line 73 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), PrepareReading(), PrepareWriting(), PushAnalysisBlocksOntoOggStream(), and WriteBitstreamHeader().

OggVorbis_File CLAM::AudioCodecs::OggVorbisAudioStream::mNativeFileParams [protected]

Definition at line 74 of file OggVorbisAudioStream.hxx.

Referenced by DiskToMemoryTransfer(), Dispose(), and PrepareReading().

int CLAM::AudioCodecs::OggVorbisAudioStream::mCurrentSection [protected]

Definition at line 75 of file OggVorbisAudioStream.hxx.

Referenced by DiskToMemoryTransfer(), and PrepareReading().

bool CLAM::AudioCodecs::OggVorbisAudioStream::mValidFileParams [protected]

Definition at line 76 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), PrepareReading(), SetFOI(), and ~OggVorbisAudioStream().

vorbis_info CLAM::AudioCodecs::OggVorbisAudioStream::mStreamInfo [protected]

Definition at line 79 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), and VorbisI_EncoderSetup().

vorbis_comment CLAM::AudioCodecs::OggVorbisAudioStream::mFileComments [protected]

Definition at line 80 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), VorbisI_EncoderSetup(), and WriteBitstreamHeader().

ogg_stream_state CLAM::AudioCodecs::OggVorbisAudioStream::mOggStreamState [protected]

Definition at line 82 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), PushAnalysisBlocksOntoOggStream(), VorbisI_EncoderSetup(), and WriteBitstreamHeader().

ogg_page CLAM::AudioCodecs::OggVorbisAudioStream::mOggPage [protected]

Definition at line 83 of file OggVorbisAudioStream.hxx.

Referenced by PushAnalysisBlocksOntoOggStream(), and WriteBitstreamHeader().

ogg_packet CLAM::AudioCodecs::OggVorbisAudioStream::mOggPacket [protected]

Definition at line 84 of file OggVorbisAudioStream.hxx.

Referenced by PushAnalysisBlocksOntoOggStream().

vorbis_dsp_state CLAM::AudioCodecs::OggVorbisAudioStream::mDSPState [protected]

Definition at line 85 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), DoVorbisAnalysis(), PushAnalysisBlocksOntoOggStream(), VorbisI_EncoderSetup(), and WriteBitstreamHeader().

vorbis_block CLAM::AudioCodecs::OggVorbisAudioStream::mVorbisBlock [protected]

Definition at line 86 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), PushAnalysisBlocksOntoOggStream(), and VorbisI_EncoderSetup().

int CLAM::AudioCodecs::OggVorbisAudioStream::mEncodedSampleRate [protected]

Definition at line 88 of file OggVorbisAudioStream.hxx.

Referenced by AudioFileToNative(), and VorbisI_EncoderSetup().

int CLAM::AudioCodecs::OggVorbisAudioStream::mEncodedChannels [protected]

Definition at line 89 of file OggVorbisAudioStream.hxx.

Referenced by AudioFileToNative(), DiskToMemoryTransfer(), DoVorbisAnalysis(), MemoryToDiskTransfer(), and VorbisI_EncoderSetup().

bool CLAM::AudioCodecs::OggVorbisAudioStream::mEncoding [protected]

Definition at line 90 of file OggVorbisAudioStream.hxx.

Referenced by Dispose(), and PrepareWriting().

int CLAM::AudioCodecs::OggVorbisAudioStream::mOffset [protected]

Definition at line 91 of file OggVorbisAudioStream.hxx.

const TSize CLAM::AudioCodecs::OggVorbisAudioStream::mMaxBlockSize = 4096 / sizeof(TInt16) [static, protected]

Definition at line 93 of file OggVorbisAudioStream.hxx.

Referenced by DiskToMemoryTransfer(), and OggVorbisAudioStream().

const TSize CLAM::AudioCodecs::OggVorbisAudioStream::mAnalysisWindowSize = 1024 [static, protected]

Definition at line 94 of file OggVorbisAudioStream.hxx.

Referenced by DoVorbisAnalysis(), and MemoryToDiskTransfer().

Array<TInt16> CLAM::AudioCodecs::OggVorbisAudioStream::mBlockBuffer [protected]

Definition at line 95 of file OggVorbisAudioStream.hxx.

Referenced by DiskToMemoryTransfer(), and OggVorbisAudioStream().

std::vector<std::deque<TData> > CLAM::AudioCodecs::OggVorbisAudioStream::mEncodeBuffer [protected]

Definition at line 96 of file OggVorbisAudioStream.hxx.

Referenced by AudioFileToNative(), Dispose(), DoVorbisAnalysis(), and MemoryToDiskTransfer().

std::deque<TInt16> CLAM::AudioCodecs::OggVorbisAudioStream::mDecodeBuffer [protected]

Definition at line 97 of file OggVorbisAudioStream.hxx.

Referenced by ConsumeDecodedSamples(), and DiskToMemoryTransfer().

TSize CLAM::AudioCodecs::OggVorbisAudioStream::mLastBytesRead [protected]

Definition at line 99 of file OggVorbisAudioStream.hxx.

Referenced by DiskToMemoryTransfer().

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