CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions
CLAM::AudioCodecs::PCMAudioStream Class Reference

#include <PCMAudioStream.hxx>

List of all members.

Public Member Functions

 PCMAudioStream (const AudioFile &file)
 ~PCMAudioStream ()
void PrepareReading ()
 Open the stream in read mode.
void PrepareWriting ()
 Open the stream in write mode.
void Dispose ()
 Close the stream.
void SeekTo (long unsigned framePosition)
- Public Member Functions inherited from CLAM::AudioCodecs::Stream
 Stream ()
virtual ~Stream ()
virtual void SeekTo (unsigned long framePosition)
 Moves the current position to framePosition. If such functionality is not supported by the stream it will be ignored.
virtual unsigned long GetFramePosition () const
 Returns the current frame position.
bool ReadData (int channel, TData *buffer, unsigned nFrames)
 Read a picked channel.
bool ReadData (TData **buffers, unsigned nFrames)
 Read all the channels.
bool ReadData (int *channels, int nchannels, TData **buffers, unsigned nFrames)
 Read many picked channels.
void WriteData (int channel, const TData *buffer, unsigned nFrames)
 Read a picked channel (Do it has sense?)
void WriteData (TData **const buffers, unsigned nFrames)
 Read all the channels.
void WriteData (int *channels, int nchannels, TData **const buffers, unsigned nFrames)
 Read many picked channels (Do it has sense?)

Protected Member Functions

void DiskToMemoryTransfer ()
 Move data from the file to mInterleavedData.
void MemoryToDiskTransfer ()
 Move data from mInterleavedData to the file.
- Protected Member Functions inherited from CLAM::AudioCodecs::Stream
void SetChannels (unsigned nChannels)

Additional Inherited Members

- Protected Attributes inherited from CLAM::AudioCodecs::Stream
unsigned mChannels
std::vector< TDatamInterleavedData
bool mEOFReached
unsigned mFramesLastRead
unsigned long mFramePosition

Detailed Description

Definition at line 39 of file PCMAudioStream.hxx.


Constructor & Destructor Documentation

CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream ( const AudioFile file)
CLAM::AudioCodecs::PCMAudioStream::~PCMAudioStream ( )

Definition at line 49 of file PCMAudioStream.cxx.

References Dispose().


Member Function Documentation

void CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer ( )
protectedvirtual
void CLAM::AudioCodecs::PCMAudioStream::Dispose ( )
virtual

Close the stream.

Implements CLAM::AudioCodecs::Stream.

Definition at line 76 of file PCMAudioStream.cxx.

References NULL.

Referenced by ~PCMAudioStream().

void CLAM::AudioCodecs::PCMAudioStream::MemoryToDiskTransfer ( )
protectedvirtual

Move data from mInterleavedData to the file.

Implements CLAM::AudioCodecs::Stream.

Definition at line 110 of file PCMAudioStream.cxx.

References CLAM_DEBUG_ASSERT, CLAM_sf_writef, CLAM::AudioCodecs::Stream::mChannels, and CLAM::AudioCodecs::Stream::mInterleavedData.

void CLAM::AudioCodecs::PCMAudioStream::PrepareReading ( )
virtual

Open the stream in read mode.

Implements CLAM::AudioCodecs::Stream.

Definition at line 54 of file PCMAudioStream.cxx.

References CLAM_ASSERT, CLAM::AudioCodecs::Stream::mEOFReached, CLAM::AudioCodecs::Stream::mFramePosition, and NULL.

void CLAM::AudioCodecs::PCMAudioStream::PrepareWriting ( )
virtual

Open the stream in write mode.

Implements CLAM::AudioCodecs::Stream.

Definition at line 66 of file PCMAudioStream.cxx.

References CLAM_ASSERT, and NULL.

void CLAM::AudioCodecs::PCMAudioStream::SeekTo ( long unsigned  framePosition)

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