SoundManager Class Reference

#include <sound_manager.hpp>

List of all members.

Public Member Functions
	SoundManager ()
virtual	~SoundManager ()
void	enable_sound (bool sound_enabled)
SoundSource *	create_sound_source (const std::string &filename)
	Creates a new sound source object which plays the specified soundfile.
void	play (const std::string &name, const Vector &pos=Vector(-1,-1))
	Convenience function to simply play a sound at a given position.
void	manage_source (SoundSource *source)
	Adds the source to the list of managed sources (= the source gets deleted when it finished playing).
void	preload (const std::string &name)
	preloads a sound, so that you don't get a lag later when playing it
void	set_listener_position (const Vector &position)
void	set_listener_velocity (const Vector &velocity)
void	enable_music (bool music_enabled)
void	play_music (const std::string &filename, bool fade=false)
void	stop_music (float fadetime=0)
bool	is_music_enabled ()
bool	is_sound_enabled ()
bool	is_audio_enabled ()
void	update ()
void	register_for_update (StreamSoundSource *sss)
void	remove_from_update (StreamSoundSource *sss)
Private Types
typedef std::map< std::string, ALuint >	SoundBuffers
typedef std::vector< OpenALSoundSource * >	SoundSources
typedef std::vector< StreamSoundSource * >	StreamSoundSources
Private Member Functions
OpenALSoundSource *	intern_create_sound_source (const std::string &filename)
	creates a new sound source, might throw exceptions, never returns NULL
void	print_openal_version ()
void	check_alc_error (const char *message)
	SoundManager (const SoundManager &)
SoundManager &	operator= (const SoundManager &)
Static Private Member Functions
static ALuint	load_file_into_buffer (SoundFile *file)
static ALenum	get_sample_format (SoundFile *file)
static void	check_al_error (const char *message)
Private Attributes
ALCdevice *	device
ALCcontext *	context
bool	sound_enabled
SoundBuffers	buffers
SoundSources	sources
StreamSoundSources	update_list
StreamSoundSource *	music_source
bool	music_enabled
std::string	current_music
Friends
class	OpenALSoundSource
class	StreamSoundSource

---

Detailed Description

Definition at line 34 of file sound_manager.hpp.

---

Member Typedef Documentation

typedef std::map<std::string, ALuint> SoundManager::SoundBuffers [private]

Definition at line 102 of file sound_manager.hpp.

typedef std::vector<OpenALSoundSource*> SoundManager::SoundSources [private]

Definition at line 104 of file sound_manager.hpp.

typedef std::vector<StreamSoundSource*> SoundManager::StreamSoundSources [private]

Definition at line 107 of file sound_manager.hpp.

---

Constructor & Destructor Documentation

SoundManager::SoundManager

(

)

Definition at line 30 of file sound_manager.cpp.

References check_al_error(), check_alc_error(), context, device, log_warning, music_enabled, print_openal_version(), and sound_enabled.

                           :
  device(0), 
  context(0), 
  sound_enabled(false), 
  buffers(),
  sources(),
  update_list(),
  music_source(0),
  music_enabled(false),
  current_music()
{
  try {
    device = alcOpenDevice(0);
    if (device == NULL) {
      throw std::runtime_error("Couldn't open audio device.");
    }

    int attributes[] = { 0 };
    context = alcCreateContext(device, attributes);
    check_alc_error("Couldn't create audio context: ");
    alcMakeContextCurrent(context);
    check_alc_error("Couldn't select audio context: ");

    check_al_error("Audio error after init: ");
    sound_enabled = true;
    music_enabled = true;
  } catch(std::exception& e) {
    if(context != NULL) {
      alcDestroyContext(context);
      context = NULL; 
    }
    if(device != NULL) {
      alcCloseDevice(device);
      device = NULL;
    }
    log_warning << "Couldn't initialize audio device: " << e.what() << std::endl;
    print_openal_version();
  }
}

SoundManager::~SoundManager

(

)

[virtual]

Definition at line 70 of file sound_manager.cpp.

References buffers, context, device, music_source, and sources.

{
  delete music_source;

  for(SoundSources::iterator i = sources.begin(); i != sources.end(); ++i) {
    delete *i;
  }

  for(SoundBuffers::iterator i = buffers.begin(); i != buffers.end(); ++i) {
    ALuint buffer = i->second;
    alDeleteBuffers(1, &buffer);
  }

  if(context != NULL) {
    alcDestroyContext(context);
    context = NULL;
  }
  if(device != NULL) {
    alcCloseDevice(device);
    device = NULL;
  }
}

SoundManager::SoundManager

(

const SoundManager &

)

[private]

---

Member Function Documentation

void SoundManager::enable_sound

(

bool

sound_enabled

)

Definition at line 241 of file sound_manager.cpp.

References device, and sound_enabled.

Referenced by Main::init_audio(), and OptionsMenu::menu_action().

{
  if(device == NULL)
    return;

  sound_enabled = enable;
}

SoundSource * SoundManager::create_sound_source

(

const std::string &

filename

)

Creates a new sound source object which plays the specified soundfile.

You are responsible for deleting the sound source later (this will stop the sound). This function never throws exceptions, but might return a DummySoundSource

Definition at line 150 of file sound_manager.cpp.

References create_dummy_sound_source(), intern_create_sound_source(), log_warning, and sound_enabled.

Referenced by WillOWisp::activate(), TreeWillOWisp::activate(), Flame::activate(), Dart::activate(), Bomb::Bomb(), and AmbientSound::start_playing().

{
  if(!sound_enabled)
    return create_dummy_sound_source();

  try {
    return intern_create_sound_source(filename);
  } catch(std::exception &e) {
    log_warning << "Couldn't create audio source: " << e.what() << std::endl;
    return create_dummy_sound_source();
  }
}

void SoundManager::play	(	const std::string &	name,
		const Vector &	pos = Vector(-1,-1)
	)

Convenience function to simply play a sound at a given position.

Definition at line 187 of file sound_manager.cpp.

References intern_create_sound_source(), log_warning, sound_enabled, sources, Vector::x, and Vector::y.

Referenced by Yeti::active_update(), GhostTree::active_update(), Sector::add_bullet(), PlayerStatus::add_coins(), Trampoline::collision(), PushButton::collision(), PowerUp::collision(), Lantern::collision(), GrowUp::collision(), Flower::collision(), Firefly::collision(), MoleRock::collision_badguy(), Dart::collision_badguy(), WillOWisp::collision_player(), MoleRock::collision_player(), Dart::collision_player(), Rock::collision_solid(), Snail::collision_solid(), MrIceBlock::collision_solid(), MoleRock::collision_solid(), Dart::collision_solid(), Stumpy::collision_squished(), Snail::collision_squished(), MrTree::collision_squished(), Mole::collision_squished(), Dispenser::collision_squished(), Player::collision_tile(), Player::do_backflip(), Player::do_jump(), Switch::event(), Door::event(), Explosion::explode(), DartTrap::fire(), Thunderstorm::flash(), Player::handle_horizontal_input(), InvisibleBlock::hit(), Totem::jump_on(), Player::kill(), KamikazeSnowball::kill_collision(), Mole::kill_fall(), BadGuy::kill_fall(), BadGuy::kill_squished(), Player::make_invincible(), scripting::play_sound(), Toad::set_state(), SkullyHop::set_state(), MrIceBlock::set_state(), Yeti::take_hit(), Mole::throw_rock(), Thunderstorm::thunder(), Brick::try_break(), BonusBlock::try_open(), worldmap::WorldMap::update(), and Fireworks::update().

{
  if(!sound_enabled)
    return;

  try {
    std::auto_ptr<OpenALSoundSource> source
      (intern_create_sound_source(filename));

    if(pos.x < 0 || pos.y < 0) {
      source->set_relative(true);
    } else {
      source->set_position(pos);
    }
    source->play();
    sources.push_back(source.release());
  } catch(std::exception& e) {
    log_warning << "Couldn't play sound " << filename << ": " << e.what() << std::endl;
  }
}

void SoundManager::manage_source

(

SoundSource *

source

)

Adds the source to the list of managed sources (= the source gets deleted when it finished playing).

Definition at line 209 of file sound_manager.cpp.

References sources.

{
  assert(source != NULL);

  OpenALSoundSource* openal_source = dynamic_cast<OpenALSoundSource*> (source);
  if(openal_source != NULL) {
    sources.push_back(openal_source);
  }
}

void SoundManager::preload

(

const std::string &

name

)

preloads a sound, so that you don't get a lag later when playing it

Definition at line 164 of file sound_manager.cpp.

References buffers, load_file_into_buffer(), load_sound_file(), log_warning, and sound_enabled.

Referenced by AmbientSound::AmbientSound(), BadGuy::BadGuy(), Block::Block(), Coin::Coin(), Dart::Dart(), DartTrap::DartTrap(), Dispenser::Dispenser(), Door::Door(), Explosion::Explosion(), Firefly::Firefly(), Fireworks::Fireworks(), Flame::Flame(), Flower::Flower(), GhostTree::GhostTree(), GrowUp::GrowUp(), Haywire::Haywire(), InvisibleBlock::InvisibleBlock(), KamikazeSnowball::KamikazeSnowball(), Lantern::Lantern(), Mole::Mole(), MoleRock::MoleRock(), MrBomb::MrBomb(), MrIceBlock::MrIceBlock(), MrTree::MrTree(), Player::Player(), PlayerStatus::PlayerStatus(), PowerUp::PowerUp(), PushButton::PushButton(), Rock::Rock(), Sector::Sector(), ShortFuse::ShortFuse(), SkullyHop::SkullyHop(), Snail::Snail(), Stumpy::Stumpy(), Switch::Switch(), Thunderstorm::Thunderstorm(), Toad::Toad(), Totem::Totem(), Trampoline::Trampoline(), TreeWillOWisp::TreeWillOWisp(), WillOWisp::WillOWisp(), worldmap::WorldMap::WorldMap(), and Yeti::Yeti().

{
  if(!sound_enabled)
    return;

  SoundBuffers::iterator i = buffers.find(filename);
  // already loaded?
  if(i != buffers.end())
    return;
  try {
    std::auto_ptr<SoundFile> file (load_sound_file(filename));
    // only keep small files
    if(file->size >= 100000)
      return;

    ALuint buffer = load_file_into_buffer(file.get());
    buffers.insert(std::make_pair(filename, buffer));
  } catch(std::exception& e) {
    log_warning << "Error while preloading sound file: " << e.what() << std::endl;
  }
}

void SoundManager::set_listener_position

(

const Vector &

position

)

Definition at line 312 of file sound_manager.cpp.

References Vector::x, and Vector::y.

Referenced by GameSession::update().

{
  static Uint32 lastticks = SDL_GetTicks();

  Uint32 current_ticks = SDL_GetTicks();
  if(current_ticks - lastticks < 300)
    return;
  lastticks = current_ticks;

  alListener3f(AL_POSITION, pos.x, pos.y, 0);
}

void SoundManager::set_listener_velocity

(

const Vector &

velocity

)

Definition at line 325 of file sound_manager.cpp.

References Vector::x, and Vector::y.

{
  alListener3f(AL_VELOCITY, vel.x, vel.y, 0);
}

void SoundManager::enable_music

(

bool

music_enabled

)

Definition at line 250 of file sound_manager.cpp.

References current_music, device, music_enabled, music_source, and play_music().

Referenced by Main::init_audio(), and OptionsMenu::menu_action().

{
  if(device == NULL)
    return;

  music_enabled = enable;
  if(music_enabled) {
    play_music(current_music);
  } else {
    if(music_source) {
      delete music_source;
      music_source = NULL;
    }
  }
}

void SoundManager::play_music	(	const std::string &	filename,
		bool	fade = false
	)

Definition at line 281 of file sound_manager.cpp.

References current_music, StreamSoundSource::FadingOn, load_sound_file(), log_warning, music_enabled, music_source, and StreamSoundSource.

Referenced by enable_music(), Sector::play_music(), scripting::play_music(), worldmap::WorldMap::setup(), TextScroller::setup(), and GameSession::start_sequence().

{
  if(filename == current_music && music_source != NULL)
    return;
  current_music = filename;
  if(!music_enabled)
    return;

  if(filename == "") {
    delete music_source;
    music_source = NULL;
    return;
  }

  try {
    std::auto_ptr<StreamSoundSource> newmusic (new StreamSoundSource());
    newmusic->set_sound_file(load_sound_file(filename));
    newmusic->set_looping(true);
    newmusic->set_relative(true);
    if(fade)
      newmusic->set_fading(StreamSoundSource::FadingOn, .5f);
    newmusic->play();

    delete music_source;
    music_source = newmusic.release();
  } catch(std::exception& e) {
    log_warning << "Couldn't play music file '" << filename << "': " << e.what() << std::endl;
  }
}

void SoundManager::stop_music

(

float

fadetime = 0

)

Definition at line 267 of file sound_manager.cpp.

References current_music, StreamSoundSource::FadingOff, StreamSoundSource::get_fade_state(), music_source, and StreamSoundSource::set_fading().

Referenced by MainMenu::check_menu(), ContribWorldMenu::check_menu(), Player::kill(), Sector::play_music(), and GameSession::restart_level().

{
  if(fadetime > 0) {
    if(music_source
       && music_source->get_fade_state() != StreamSoundSource::FadingOff)
      music_source->set_fading(StreamSoundSource::FadingOff, fadetime);
  } else {
    delete music_source;
    music_source = NULL;
  }
  current_music = "";
}

bool SoundManager::is_music_enabled

(

)

[inline]

Definition at line 67 of file sound_manager.hpp.

{ return music_enabled; }

bool SoundManager::is_sound_enabled

(

)

[inline]

Definition at line 68 of file sound_manager.hpp.

{ return sound_enabled; }

bool SoundManager::is_audio_enabled

(

)

[inline]

Definition at line 70 of file sound_manager.hpp.

References context, and device.

Referenced by OptionsMenu::OptionsMenu().

                          {
    return device != 0 && context != 0;
  }

void SoundManager::update

(

)

Definition at line 331 of file sound_manager.cpp.

References check_alc_error(), context, music_source, sources, StreamSoundSource::update(), and update_list.

Referenced by ScreenManager::run(), and Main::wait_for_event().

{
  static Uint32 lasttime = SDL_GetTicks();
  Uint32 now = SDL_GetTicks();

  if(now - lasttime < 300)
    return;
  lasttime = now;

  // update and check for finished sound sources
  for(SoundSources::iterator i = sources.begin(); i != sources.end(); ) {
    OpenALSoundSource* source = *i;

    source->update();

    if(!source->playing()) {
      delete source;
      i = sources.erase(i);
    } else {
      ++i;
    }
  }
  // check streaming sounds
  if(music_source) {
    music_source->update();
  }

  if (context)
  {
    alcProcessContext(context);
    check_alc_error("Error while processing audio context: ");
  }

  //run update() for stream_sound_source
  StreamSoundSources::iterator s = update_list.begin();
  while( s != update_list.end() ){
    (*s)->update();
    s++;
  }
}

void SoundManager::register_for_update

(

StreamSoundSource *

sss

)

Definition at line 220 of file sound_manager.cpp.

References update_list.

Referenced by StreamSoundSource::StreamSoundSource().

                                                         {
  if( sss != NULL ){
    update_list.push_back( sss );
  }
}

void SoundManager::remove_from_update

(

StreamSoundSource *

sss

)

Definition at line 227 of file sound_manager.cpp.

References update_list.

Referenced by StreamSoundSource::~StreamSoundSource().

                                                         {
  if( sss != NULL ){
    StreamSoundSources::iterator i = update_list.begin();
    while( i != update_list.end() ){
      if( *i == sss ){
        i = update_list.erase(i);
      } else {
        i++;
      }
    }
  }
}

OpenALSoundSource * SoundManager::intern_create_sound_source

(

const std::string &

filename

)

[private]

creates a new sound source, might throw exceptions, never returns NULL

Definition at line 117 of file sound_manager.cpp.

References buffers, load_file_into_buffer(), load_sound_file(), log_debug, OpenALSoundSource, StreamSoundSource::set_sound_file(), sound_enabled, and StreamSoundSource.

Referenced by create_sound_source(), and play().

{
  assert(sound_enabled);

  std::auto_ptr<OpenALSoundSource> source (new OpenALSoundSource());

  ALuint buffer;

  // reuse an existing static sound buffer
  SoundBuffers::iterator i = buffers.find(filename);
  if(i != buffers.end()) {
    buffer = i->second;
  } else {
    // Load sound file
    std::auto_ptr<SoundFile> file (load_sound_file(filename));

    if(file->size < 100000) {
      buffer = load_file_into_buffer(file.get());
      buffers.insert(std::make_pair(filename, buffer));
    } else {
      StreamSoundSource* source = new StreamSoundSource();
      source->set_sound_file(file.release());
      return source;
    }

    log_debug << "Uncached sound \"" << filename << "\" requested to be played" << std::endl;
  }

  alSourcei(source->source, AL_BUFFER, buffer);
  return source.release();
}

ALuint SoundManager::load_file_into_buffer

(

SoundFile *

file

)

[static, private]

Definition at line 94 of file sound_manager.cpp.

References check_al_error(), get_sample_format(), SoundFile::rate, SoundFile::read(), and SoundFile::size.

Referenced by intern_create_sound_source(), and preload().

{
  ALenum format = get_sample_format(file);
  ALuint buffer;
  alGenBuffers(1, &buffer);
  check_al_error("Couldn't create audio buffer: ");
  char* samples = new char[file->size];
  try {
    file->read(samples, file->size);
    alBufferData(buffer, format, samples,
                 static_cast<ALsizei> (file->size),
                 static_cast<ALsizei> (file->rate));
    check_al_error("Couldn't fill audio buffer: ");
  } catch(...) {
    delete[] samples;
    throw;
  }
  delete[] samples;

  return buffer;
}

ALenum SoundManager::get_sample_format

(

SoundFile *

file

)

[static, private]

Definition at line 373 of file sound_manager.cpp.

References SoundFile::bits_per_sample, and SoundFile::channels.

Referenced by StreamSoundSource::fillBufferAndQueue(), and load_file_into_buffer().

{
  if(file->channels == 2) {
    if(file->bits_per_sample == 16) {
      return AL_FORMAT_STEREO16;
    } else if(file->bits_per_sample == 8) {
      return AL_FORMAT_STEREO8;
    } else {
      throw std::runtime_error("Only 16 and 8 bit samples supported");
    }
  } else if(file->channels == 1) {
    if(file->bits_per_sample == 16) {
      return AL_FORMAT_MONO16;
    } else if(file->bits_per_sample == 8) {
      return AL_FORMAT_MONO8;
    } else {
      throw std::runtime_error("Only 16 and 8 bit samples supported");
    }
  }

  throw std::runtime_error("Only 1 and 2 channel samples supported");
}

void SoundManager::print_openal_version

(

)

[private]

Definition at line 397 of file sound_manager.cpp.

References log_info.

Referenced by SoundManager().

{
  log_info << "OpenAL Vendor: " << alGetString(AL_VENDOR) << std::endl;
  log_info << "OpenAL Version: " << alGetString(AL_VERSION) << std::endl;
  log_info << "OpenAL Renderer: " << alGetString(AL_RENDERER) << std::endl;
  log_info << "OpenAl Extensions: " << alGetString(AL_EXTENSIONS) << std::endl;
}

void SoundManager::check_alc_error

(

const char *

message

)

[private]

Definition at line 406 of file sound_manager.cpp.

References device.

Referenced by SoundManager(), and update().

{
  int err = alcGetError(device);
  if(err != ALC_NO_ERROR) {
    std::stringstream msg;
    msg << message << alcGetString(device, err);
    throw std::runtime_error(msg.str());
  }
}

void SoundManager::check_al_error

(

const char *

message

)

[static, private]

Definition at line 417 of file sound_manager.cpp.

Referenced by StreamSoundSource::fillBufferAndQueue(), load_file_into_buffer(), OpenALSoundSource::OpenALSoundSource(), OpenALSoundSource::play(), SoundManager(), OpenALSoundSource::stop(), StreamSoundSource::StreamSoundSource(), StreamSoundSource::update(), and StreamSoundSource::~StreamSoundSource().

{
  int err = alGetError();
  if(err != AL_NO_ERROR) {
    std::stringstream msg;
    msg << message << alGetString(err);
    throw std::runtime_error(msg.str());
  }
}

SoundManager& SoundManager::operator=

(

const SoundManager &

)

[private]

---

Friends And Related Function Documentation

friend class OpenALSoundSource [friend]

Definition at line 86 of file sound_manager.hpp.

Referenced by intern_create_sound_source().

friend class StreamSoundSource [friend]

Definition at line 87 of file sound_manager.hpp.

Referenced by intern_create_sound_source(), and play_music().

---

Member Data Documentation

ALCdevice* SoundManager::device [private]

Definition at line 98 of file sound_manager.hpp.

Referenced by check_alc_error(), enable_music(), enable_sound(), is_audio_enabled(), SoundManager(), and ~SoundManager().

ALCcontext* SoundManager::context [private]

Definition at line 99 of file sound_manager.hpp.

Referenced by is_audio_enabled(), SoundManager(), update(), and ~SoundManager().

bool SoundManager::sound_enabled [private]

Definition at line 100 of file sound_manager.hpp.

Referenced by create_sound_source(), enable_sound(), intern_create_sound_source(), play(), preload(), and SoundManager().

SoundBuffers SoundManager::buffers [private]

Definition at line 103 of file sound_manager.hpp.

Referenced by intern_create_sound_source(), preload(), and ~SoundManager().

SoundSources SoundManager::sources [private]

Definition at line 105 of file sound_manager.hpp.

Referenced by manage_source(), play(), update(), and ~SoundManager().

StreamSoundSources SoundManager::update_list [private]

Definition at line 108 of file sound_manager.hpp.

Referenced by register_for_update(), remove_from_update(), and update().

StreamSoundSource* SoundManager::music_source [private]

Definition at line 110 of file sound_manager.hpp.

Referenced by enable_music(), play_music(), stop_music(), update(), and ~SoundManager().

bool SoundManager::music_enabled [private]

Definition at line 112 of file sound_manager.hpp.

Referenced by enable_music(), play_music(), and SoundManager().

std::string SoundManager::current_music [private]

Definition at line 113 of file sound_manager.hpp.

Referenced by enable_music(), play_music(), and stop_music().

---

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

• src/audio/sound_manager.hpp
• src/audio/sound_manager.cpp

---