StreamSoundSource Class Reference

#include <stream_sound_source.hpp>

Inherits OpenALSoundSource.

List of all members.

Public Types
enum	FadeState { NoFading, FadingOn, FadingOff }
Public Member Functions
	StreamSoundSource ()
virtual	~StreamSoundSource ()
void	set_sound_file (SoundFile *file)
void	set_fading (FadeState state, float fadetime)
FadeState	get_fade_state () const
void	update ()
void	set_looping (bool looping)
bool	get_looping () const
Private Member Functions
bool	fillBufferAndQueue (ALuint buffer)
	StreamSoundSource (const StreamSoundSource &)
StreamSoundSource &	operator= (const StreamSoundSource &)
Private Attributes
SoundFile *	file
ALuint	buffers [STREAMFRAGMENTS]
FadeState	fade_state
float	fade_start_time
float	fade_time
bool	looping
Static Private Attributes
static const size_t	STREAMBUFFERSIZE = 1024 * 500
static const size_t	STREAMFRAGMENTS = 5
static const size_t	STREAMFRAGMENTSIZE = STREAMBUFFERSIZE / STREAMFRAGMENTS

---

Detailed Description

Definition at line 24 of file stream_sound_source.hpp.

---

Member Enumeration Documentation

enum StreamSoundSource::FadeState

Enumerator:

NoFading
FadingOn
FadingOff

Definition at line 32 of file stream_sound_source.hpp.

{ NoFading, FadingOn, FadingOff };

---

Constructor & Destructor Documentation

StreamSoundSource::StreamSoundSource

(

)

Definition at line 23 of file stream_sound_source.cpp.

References buffers, SoundManager::check_al_error(), SoundManager::register_for_update(), sound_manager, and STREAMFRAGMENTS.

                                     :
  file(0), 
  fade_state(NoFading), 
  fade_start_time(),
  fade_time(),
  looping(false)
{
  alGenBuffers(STREAMFRAGMENTS, buffers);
  SoundManager::check_al_error("Couldn't allocate audio buffers: ");
  //add me to update list
  sound_manager->register_for_update( this );
}

StreamSoundSource::~StreamSoundSource

(

)

[virtual]

Definition at line 36 of file stream_sound_source.cpp.

References buffers, SoundManager::check_al_error(), file, SoundManager::remove_from_update(), sound_manager, OpenALSoundSource::stop(), and STREAMFRAGMENTS.

{
  //don't update me any longer
  sound_manager->remove_from_update( this );
  delete file;
  stop();
  alDeleteBuffers(STREAMFRAGMENTS, buffers);
  SoundManager::check_al_error("Couldn't delete audio buffers: ");
}

StreamSoundSource::StreamSoundSource

(

const StreamSoundSource &

)

[private]

---

Member Function Documentation

void StreamSoundSource::set_sound_file

(

SoundFile *

file

)

Definition at line 47 of file stream_sound_source.cpp.

References buffers, file, fillBufferAndQueue(), OpenALSoundSource::source, and STREAMFRAGMENTS.

Referenced by SoundManager::intern_create_sound_source().

{
  delete file;
  file = newfile;

  ALint queued;
  alGetSourcei(source, AL_BUFFERS_QUEUED, &queued);
  for(size_t i = 0; i < STREAMFRAGMENTS - queued; ++i) {
    if(fillBufferAndQueue(buffers[i]) == false)
      break;
  }
}

void StreamSoundSource::set_fading	(	FadeState	state,
		float	fadetime
	)

Definition at line 103 of file stream_sound_source.cpp.

References fade_start_time, fade_state, and real_time.

Referenced by SoundManager::stop_music().

{
  this->fade_state = state;
  this->fade_time = fade_time;
  this->fade_start_time = real_time;
}

FadeState StreamSoundSource::get_fade_state

(

)

const [inline]

Definition at line 35 of file stream_sound_source.hpp.

References fade_state.

Referenced by SoundManager::stop_music().

  {
    return fade_state;
  }

void StreamSoundSource::update

(

)

[virtual]

Reimplemented from OpenALSoundSource.

Definition at line 61 of file stream_sound_source.cpp.

References SoundManager::check_al_error(), fade_start_time, fade_state, fade_time, FadingOff, FadingOn, fillBufferAndQueue(), log_info, looping, NoFading, OpenALSoundSource::play(), OpenALSoundSource::playing(), real_time, OpenALSoundSource::set_gain(), OpenALSoundSource::source, and OpenALSoundSource::stop().

Referenced by SoundManager::update().

{
  ALint processed = 0;
  alGetSourcei(source, AL_BUFFERS_PROCESSED, &processed);
  for(ALint i = 0; i < processed; ++i) {
    ALuint buffer;
    alSourceUnqueueBuffers(source, 1, &buffer);
    SoundManager::check_al_error("Couldn't unqueue audio buffer: ");

    if(fillBufferAndQueue(buffer) == false)
      break;
  }

  if(!playing()) {
    if(processed == 0 || !looping)
      return;

    // we might have to restart the source if we had a buffer underrun
    log_info << "Restarting audio source because of buffer underrun" << std::endl;
    play();
  }

  if(fade_state == FadingOn) {
    float time = real_time - fade_start_time;
    if(time >= fade_time) {
      set_gain(1.0);
      fade_state = NoFading;
    } else {
      set_gain(time / fade_time);
    }
  } else if(fade_state == FadingOff) {
    float time = real_time - fade_start_time;
    if(time >= fade_time) {
      stop();
      fade_state = NoFading;
    } else {
      set_gain( (fade_time-time) / fade_time);
    }
  }
}

void StreamSoundSource::set_looping

(

bool

looping

)

[inline, virtual]

Reimplemented from OpenALSoundSource.

Definition at line 41 of file stream_sound_source.hpp.

  {
    this->looping = looping;
  }

bool StreamSoundSource::get_looping

(

)

const [inline]

Definition at line 45 of file stream_sound_source.hpp.

References looping.

  {
    return looping;
  }

bool StreamSoundSource::fillBufferAndQueue

(

ALuint

buffer

)

[private]

Definition at line 111 of file stream_sound_source.cpp.

References SoundManager::check_al_error(), file, SoundManager::get_sample_format(), looping, SoundFile::rate, SoundFile::read(), SoundFile::reset(), OpenALSoundSource::source, and STREAMFRAGMENTSIZE.

Referenced by set_sound_file(), and update().

{
  // fill buffer
  char* bufferdata = new char[STREAMFRAGMENTSIZE];
  size_t bytesread = 0;
  do {
    bytesread += file->read(bufferdata + bytesread,
                            STREAMFRAGMENTSIZE - bytesread);
    // end of sound file
    if(bytesread < STREAMFRAGMENTSIZE) {
      if(looping)
        file->reset();
      else
        break;
    }
  } while(bytesread < STREAMFRAGMENTSIZE);

  if(bytesread > 0) {
    ALenum format = SoundManager::get_sample_format(file);
    alBufferData(buffer, format, bufferdata, bytesread, file->rate);
    SoundManager::check_al_error("Couldn't refill audio buffer: ");

    alSourceQueueBuffers(source, 1, &buffer);
    SoundManager::check_al_error("Couldn't queue audio buffer: ");
  }
  delete[] bufferdata;

  // return false if there aren't more buffers to fill
  return bytesread >= STREAMFRAGMENTSIZE;
}

StreamSoundSource& StreamSoundSource::operator=

(

const StreamSoundSource &

)

[private]

---

Member Data Documentation

const size_t StreamSoundSource::STREAMBUFFERSIZE = 1024 * 500 [static, private]

Definition at line 51 of file stream_sound_source.hpp.

const size_t StreamSoundSource::STREAMFRAGMENTS = 5 [static, private]

Definition at line 52 of file stream_sound_source.hpp.

Referenced by set_sound_file(), StreamSoundSource(), and ~StreamSoundSource().

const size_t StreamSoundSource::STREAMFRAGMENTSIZE = STREAMBUFFERSIZE / STREAMFRAGMENTS [static, private]

Definition at line 54 of file stream_sound_source.hpp.

Referenced by fillBufferAndQueue().

SoundFile* StreamSoundSource::file [private]

Definition at line 57 of file stream_sound_source.hpp.

Referenced by fillBufferAndQueue(), set_sound_file(), and ~StreamSoundSource().

ALuint StreamSoundSource::buffers[STREAMFRAGMENTS] [private]

Definition at line 58 of file stream_sound_source.hpp.

Referenced by set_sound_file(), StreamSoundSource(), and ~StreamSoundSource().

FadeState StreamSoundSource::fade_state [private]

Definition at line 60 of file stream_sound_source.hpp.

Referenced by get_fade_state(), set_fading(), and update().

float StreamSoundSource::fade_start_time [private]

Definition at line 61 of file stream_sound_source.hpp.

Referenced by set_fading(), and update().

float StreamSoundSource::fade_time [private]

Definition at line 62 of file stream_sound_source.hpp.

Referenced by update().

bool StreamSoundSource::looping [private]

Definition at line 63 of file stream_sound_source.hpp.

Referenced by fillBufferAndQueue(), get_looping(), and update().

---

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

• src/audio/stream_sound_source.hpp
• src/audio/stream_sound_source.cpp

---