pcce::OggStream Class Reference

#include <OggStream.h>

List of all members.

Public Member Functions
	OggStream (const std::string fileName, tOpenALSourcePtr source)
	~OggStream ()
bool	IsPlaying ()
void	Play ()
void	Pause ()
void	Stop ()
void	Update ()
tOpenALSourcePtr	GetSource ()
void	SetSource (tOpenALSourcePtr source)
Private Types
enum	tStreamState { ssPlaying, ssPaused, ssStopped }
Private Member Functions
unsigned int	QueuedBufferCount ()
void	EmptyQueuedBuffers ()
unsigned int	ProcessedBuffers ()
bool	FillBuffer (ALuint &buffer)
void	QueueBuffer (const ALuint &buffer)
Private Attributes
tStreamState	mState
tOpenALSourcePtr	mSource
OggFile	mFile
ALenum	mFormat
ALsizei	mFreq
ALuint	mBuffers [sBufferCount]
unsigned int	mQueuedBuffers
unsigned int	mProcessedBuffers
bool	mStreamActive
Static Private Attributes
static const size_t	sBufferCount = 2

---

Detailed Description

Definition at line 43 of file OggStream.h.

---

Member Enumeration Documentation

enum pcce::OggStream::tStreamState [private]

Enumerator:

ssPlaying
ssPaused
ssStopped

Definition at line 61 of file OggStream.h.

{ ssPlaying, ssPaused, ssStopped } tStreamState;

---

Constructor & Destructor Documentation

OggStream::OggStream	(	const std::string	fileName,
		tOpenALSourcePtr	source
	)

Definition at line 37 of file OggStream.cpp.

References pcce::ClearALError(), pcce::OggFile::GetChannelCount(), pcce::OggFile::GetFrequency(), mBuffers, mFile, mFormat, mFreq, pcce::OggFile::Open(), PCCE_AL_CHECK, PCCE_THROW, and sBufferCount.

                                                                     :
  mState(ssStopped),
  mSource(source),
  mFile(fileName),
  mQueuedBuffers(0),
  mProcessedBuffers(0),
  mStreamActive(false)
{
  mFile.Open();
  switch (mFile.GetChannelCount()) {
    case 1:
      mFormat = AL_FORMAT_MONO16;
      break;
    case 2:
      mFormat = AL_FORMAT_STEREO16;
      break;
    default:
      PCCE_THROW("Ogg file must have 1 or 2 channels");
  }
  mFreq = mFile.GetFrequency();

  ClearALError();
  alGenBuffers(sBufferCount, mBuffers);
  PCCE_AL_CHECK();
}

OggStream::~OggStream

(

)

Definition at line 63 of file OggStream.cpp.

References pcce::ClearALError(), mBuffers, mSource, sBufferCount, and Stop().

                      {
  try {
    if (mSource) {
      Stop();
    }
  } catch (Exception&) {
  }
  
  ClearALError();
  alDeleteBuffers(sBufferCount, mBuffers);
  ClearALError();
}

---

Member Function Documentation

bool OggStream::IsPlaying

(

)

Definition at line 76 of file OggStream.cpp.

References mProcessedBuffers, and mQueuedBuffers.

                          {
  return mProcessedBuffers == mQueuedBuffers;
}

void OggStream::Play

(

)

Definition at line 80 of file OggStream.cpp.

References pcce::ClearALError(), FillBuffer(), mBuffers, mSource, mState, mStreamActive, PCCE_AL_CHECK, PCCE_CHECK, QueueBuffer(), sBufferCount, ssPlaying, and Update().

                     {
  PCCE_CHECK(mSource, "Cannot play OggStream without source");
  
  if (mState != ssPlaying) {
    if (!mStreamActive) {
      for (size_t i = 0; i < sBufferCount; ++i) {
        mStreamActive = FillBuffer(mBuffers[i]);
        if (!mStreamActive) {
          break;
        }
        QueueBuffer(mBuffers[i]);
      }
    }

    mState = ssPlaying;
  }
  
  Update();
  
  ClearALError();
  alSourcePlay(mSource->GetSource());
  PCCE_AL_CHECK();
}

void OggStream::Pause

(

)

Definition at line 104 of file OggStream.cpp.

References pcce::ClearALError(), mSource, mState, PCCE_AL_CHECK, PCCE_CHECK, ssPaused, and ssStopped.

                      {
  PCCE_CHECK(mSource, "Cannot pause OggStream without source");
  
  PCCE_CHECK(mState != ssStopped, "Cannot pause stopped OggStream");
  
  mState = ssPaused;

  ClearALError();
  alSourcePause(mSource->GetSource());
  PCCE_AL_CHECK();
}

void OggStream::Stop

(

)

Definition at line 116 of file OggStream.cpp.

References pcce::ClearALError(), EmptyQueuedBuffers(), mFile, mProcessedBuffers, mQueuedBuffers, mSource, mState, mStreamActive, PCCE_AL_CHECK, PCCE_CHECK, pcce::OggFile::Rewind(), and ssStopped.

Referenced by SetSource(), and ~OggStream().

                     {
  PCCE_CHECK(mSource, "Cannot stop OggStream without source");
  
  if (mState != ssStopped) {
    mState = ssStopped;

    ClearALError();
    alSourceStop(mSource->GetSource());
    PCCE_AL_CHECK();

    EmptyQueuedBuffers();

    mFile.Rewind();
    mQueuedBuffers = 0;
    mProcessedBuffers = 0;

    mStreamActive = false;
  }
}

void OggStream::Update

(

)

Definition at line 136 of file OggStream.cpp.

References pcce::ClearALError(), FillBuffer(), mProcessedBuffers, mSource, mStreamActive, PCCE_AL_CHECK, PCCE_CHECK, ProcessedBuffers(), QueueBuffer(), and sBufferCount.

Referenced by Play().

                       {
  PCCE_CHECK(mSource, "Cannot update OggStream without source");
  
  unsigned int processed;
  ALuint buffers[sBufferCount];

  processed = ProcessedBuffers();
  if (processed == 0) {
    return;
  }
  
  PCCE_CHECK(processed <= sBufferCount, "OggStream::Update: More buffers processed than allocated");
  
  mProcessedBuffers += processed;
  
  ClearALError();
  alSourceUnqueueBuffers(mSource->GetSource(), processed, buffers);
  PCCE_AL_CHECK();
  
  if (!mStreamActive) {
    return;
  }
  
  for (size_t i = 0; i < processed; ++i) {
    mStreamActive = FillBuffer(buffers[i]);
    if (!mStreamActive) {
      break;
    }
    QueueBuffer(buffers[i]);
  }
}

tOpenALSourcePtr OggStream::GetSource

(

)

Definition at line 168 of file OggStream.cpp.

References mSource.

                                      {
  return mSource;
}

void OggStream::SetSource

(

tOpenALSourcePtr

source

)

Definition at line 172 of file OggStream.cpp.

References mSource, and Stop().

                                                 {
  if (mSource) {
    Stop();
  }
  mSource = source;
  // Assign it to the right buffers!
}

unsigned int OggStream::QueuedBufferCount

(

)

[private]

Definition at line 180 of file OggStream.cpp.

References pcce::ClearALError(), mSource, PCCE_AL_CHECK, and PCCE_CHECK.

Referenced by EmptyQueuedBuffers().

                                          {
  PCCE_CHECK(mSource, "OggStream::QueuedBufferCount: mSource is not set");
  
  ALint queued;
  ClearALError();
  alGetSourcei(mSource->GetSource(), AL_BUFFERS_QUEUED, &queued);
  PCCE_AL_CHECK();
  
  if (queued < 0) {
    queued = 0;
  }
  return queued;
}

void OggStream::EmptyQueuedBuffers

(

)

[private]

Definition at line 194 of file OggStream.cpp.

References pcce::ClearALError(), pcce::GetALErrorStr(), mSource, PCCE_CHECK, PCCE_THROW, QueuedBufferCount(), and sBufferCount.

Referenced by Stop().

                                   {
  unsigned int queued;
  ALuint buffers[sBufferCount];
  
  PCCE_CHECK(mSource, "OggStream: mSource is not valid");

  queued = QueuedBufferCount();
  if (queued == 0) {
    return;
  }
  
  PCCE_CHECK(queued <= sBufferCount, "OggStream::EmptyQueuedBuffers: More buffers queued than allocated");
  
  if (!alIsSource(mSource->GetSource())) {
    PCCE_THROW("Not source");
  }
  ClearALError();
  alSourceUnqueueBuffers(mSource->GetSource(), queued, buffers);
  //PCCE_AL_CHECK();
  ALenum error = alGetError();
  if (AL_NO_ERROR != error) {
    PCCE_THROW(GetALErrorStr(error));
  }
  
  PCCE_CHECK(QueuedBufferCount() == 0, "didnt unqueue");
}

unsigned int OggStream::ProcessedBuffers

(

)

[private]

Definition at line 221 of file OggStream.cpp.

References pcce::ClearALError(), mSource, PCCE_AL_CHECK, and PCCE_CHECK.

Referenced by Update().

                                         {
  PCCE_CHECK(mSource, "OggStream::ProcessedBuffers: mSource is not set");
  
  ALint processed;
  
  ClearALError();
  alGetSourcei(mSource->GetSource(), AL_BUFFERS_PROCESSED, &processed);
  PCCE_AL_CHECK();
  
  if (processed < 0) {
    processed = 0;
  }
  return processed;
}

bool OggStream::FillBuffer

(

ALuint &

buffer

)

[private]

Definition at line 236 of file OggStream.cpp.

References BUFFER_SIZE, pcce::ClearALError(), mFile, mFormat, mFreq, PCCE_AL_CHECK, and pcce::OggFile::Read().

Referenced by Play(), and Update().

                                         {
  const size_t BUFFER_SIZE = 65536;
  size_t readCount;
  tCharVector data;
  
  readCount = mFile.Read(BUFFER_SIZE, data);
  // If readCount is 0, we hit the end of the file
  if (readCount == 0) {
    return false;
  }
  
  ClearALError();
  alBufferData(buffer, mFormat, &data[0], data.size(), mFreq);
  PCCE_AL_CHECK();
  
  return true;
}

void OggStream::QueueBuffer

(

const ALuint &

buffer

)

[private]

Definition at line 254 of file OggStream.cpp.

References pcce::ClearALError(), mQueuedBuffers, mSource, PCCE_AL_CHECK, and PCCE_CHECK.

Referenced by Play(), and Update().

                                                {
  PCCE_CHECK(mSource, "Cannot queue buffer without a source");
  
  ClearALError();
  alSourceQueueBuffers(mSource->GetSource(), 1, &buffer);
  PCCE_AL_CHECK();
  
  ++mQueuedBuffers;
}

---

Member Data Documentation

const size_t pcce::OggStream::sBufferCount = 2 [static, private]

Definition at line 60 of file OggStream.h.

Referenced by EmptyQueuedBuffers(), OggStream(), Play(), Update(), and ~OggStream().

tStreamState pcce::OggStream::mState [private]

Definition at line 63 of file OggStream.h.

Referenced by Pause(), Play(), and Stop().

tOpenALSourcePtr pcce::OggStream::mSource [private]

Definition at line 64 of file OggStream.h.

Referenced by EmptyQueuedBuffers(), GetSource(), Pause(), Play(), ProcessedBuffers(), QueueBuffer(), QueuedBufferCount(), SetSource(), Stop(), Update(), and ~OggStream().

OggFile pcce::OggStream::mFile [private]

Definition at line 65 of file OggStream.h.

Referenced by FillBuffer(), OggStream(), and Stop().

ALenum pcce::OggStream::mFormat [private]

Definition at line 66 of file OggStream.h.

Referenced by FillBuffer(), and OggStream().

ALsizei pcce::OggStream::mFreq [private]

Definition at line 67 of file OggStream.h.

Referenced by FillBuffer(), and OggStream().

ALuint pcce::OggStream::mBuffers[sBufferCount] [private]

Definition at line 68 of file OggStream.h.

Referenced by OggStream(), Play(), and ~OggStream().

unsigned int pcce::OggStream::mQueuedBuffers [private]

Definition at line 69 of file OggStream.h.

Referenced by IsPlaying(), QueueBuffer(), and Stop().

unsigned int pcce::OggStream::mProcessedBuffers [private]

Definition at line 70 of file OggStream.h.

Referenced by IsPlaying(), Stop(), and Update().

bool pcce::OggStream::mStreamActive [private]

Definition at line 71 of file OggStream.h.

Referenced by Play(), Stop(), and Update().

---

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

• include/OggStream.h
• src/OggStream.cpp