CLAM::AudioCodecs::PCMAudioStream Class Reference

#include <PCMAudioStream.hxx>

Inheritance diagram for CLAM::AudioCodecs::PCMAudioStream:

List of all members.

---

Detailed Description

Definition at line 39 of file PCMAudioStream.hxx.

Public Member Functions
	PCMAudioStream ()
	PCMAudioStream (const AudioFile &file)
	~PCMAudioStream ()
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 ()
Protected Attributes
SNDFILE *	mFileHandle
SF_INFO	mNativeFileParams
std::string	mName

---

Constructor & Destructor Documentation

CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream

(

)

Definition at line 39 of file PCMAudioStream.cxx.

References mNativeFileParams.

CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream

(

const AudioFile &

file

)

Definition at line 45 of file PCMAudioStream.cxx.

References SetFOI().

CLAM::AudioCodecs::PCMAudioStream::~PCMAudioStream

(

)

Definition at line 52 of file PCMAudioStream.cxx.

References mFileHandle.

---

Member Function Documentation

void CLAM::AudioCodecs::PCMAudioStream::SetFOI

(

const AudioFile &

file

)

[virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 68 of file PCMAudioStream.cxx.

References AudioFileToNative(), Dispose(), mNativeFileParams, and CLAM::AudioCodecs::Stream::SetChannels().

Referenced by PCMAudioStream().

void CLAM::AudioCodecs::PCMAudioStream::PrepareReading

(

)

[virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 75 of file PCMAudioStream.cxx.

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

void CLAM::AudioCodecs::PCMAudioStream::PrepareWriting

(

)

[virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 87 of file PCMAudioStream.cxx.

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

void CLAM::AudioCodecs::PCMAudioStream::PrepareReadWrite

(

)

[virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 100 of file PCMAudioStream.cxx.

References CLAM_ASSERT, CLAM::AudioCodecs::Stream::MarkAllChannelsAsConsumed(), CLAM::AudioCodecs::Stream::MarkAllChannelsAsProduced(), CLAM::AudioCodecs::Stream::mEOFReached, mFileHandle, mName, mNativeFileParams, and NULL.

void CLAM::AudioCodecs::PCMAudioStream::Dispose

(

)

[virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 114 of file PCMAudioStream.cxx.

References mFileHandle, and NULL.

Referenced by SetFOI().

void CLAM::AudioCodecs::PCMAudioStream::AudioFileToNative

(

const AudioFile &

file

)

[protected]

Definition at line 60 of file PCMAudioStream.cxx.

References CLAM::AudioFile::GetHeader(), CLAM::AudioFile::GetLocation(), mName, and mNativeFileParams.

Referenced by SetFOI().

void CLAM::AudioCodecs::PCMAudioStream::DiskToMemoryTransfer

(

)

[protected, virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 123 of file PCMAudioStream.cxx.

References CLAM_sf_read, CLAM::Array< T >::GetPtr(), CLAM::AudioCodecs::Stream::mEOFReached, mFileHandle, CLAM::AudioCodecs::Stream::mFramesLastRead, CLAM::AudioCodecs::Stream::mFramesToRead, CLAM::AudioCodecs::Stream::mInterleavedData, mNativeFileParams, and CLAM::Array< T >::Size().

void CLAM::AudioCodecs::PCMAudioStream::MemoryToDiskTransfer

(

)

[protected, virtual]

Implements CLAM::AudioCodecs::Stream.

Definition at line 155 of file PCMAudioStream.cxx.

References CLAM_DEBUG_ASSERT, CLAM_sf_write, CLAM::Array< T >::GetPtr(), mFileHandle, CLAM::AudioCodecs::Stream::mFramesToWrite, and CLAM::AudioCodecs::Stream::mInterleavedDataOut.

---

Member Data Documentation

SNDFILE* CLAM::AudioCodecs::PCMAudioStream::mFileHandle [protected]

Definition at line 61 of file PCMAudioStream.hxx.

Referenced by DiskToMemoryTransfer(), Dispose(), MemoryToDiskTransfer(), PrepareReading(), PrepareReadWrite(), PrepareWriting(), and ~PCMAudioStream().

SF_INFO CLAM::AudioCodecs::PCMAudioStream::mNativeFileParams [protected]

Definition at line 62 of file PCMAudioStream.hxx.

Referenced by AudioFileToNative(), DiskToMemoryTransfer(), PCMAudioStream(), PrepareReading(), PrepareReadWrite(), PrepareWriting(), and SetFOI().

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

Definition at line 63 of file PCMAudioStream.hxx.

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

---

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

• PCMAudioStream.hxx
• PCMAudioStream.cxx

---