src/Sound/soundmgr.cxx

   1 // soundmgr.cxx -- Sound effect management class
   2 //
   3 // Sound manager initially written by David Findlay
   4 // <david_j_findlay@yahoo.com.au> 2001
   5 //
   6 // C++-ified by Curtis Olson, started March 2001.
   7 //
   8 // Copyright (C) 2001  Curtis L. Olson - curt@flightgear.org
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 //
  24 // $Id$
  25
  26
  27 #include <simgear/debug/logstream.hxx>
  28 #include <simgear/misc/fgpath.hxx>
  29
  30 #include <Main/globals.hxx>
  31
  32 #include "soundmgr.hxx"
  33
  34
  35 // constructor
  36 FGSimpleSound::FGSimpleSound( string file ) {
  37     FGPath slfile( globals->get_fg_root() );
  38     slfile.append( file );
  39     sample = new slSample ( (char *)slfile.c_str() );
  40     pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  41     volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  42     pitch_envelope->setStep ( 0, 0.01, 1.0 );
  43     volume_envelope->setStep ( 0, 0.01, 1.0 );
  44 }
  45
  46 FGSimpleSound::FGSimpleSound( unsigned char *buffer, int len ) {
  47     sample = new slSample ( buffer, len );
  48     pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  49     volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  50     pitch_envelope->setStep ( 0, 0.01, 1.0 );
  51     volume_envelope->setStep ( 0, 0.01, 1.0 );
  52 }
  53
  54 // destructor
  55 FGSimpleSound::~FGSimpleSound() {
  56     delete pitch_envelope;
  57     delete volume_envelope;
  58     delete sample;
  59 }
  60
  61
  62 // constructor
  63 FGSoundMgr::FGSoundMgr() {
  64     audio_sched = new slScheduler( 8000 );
  65     audio_mixer = new smMixer;
  66
  67     FG_LOG( FG_GENERAL, FG_INFO,
  68             "Rate = " << audio_sched->getRate()
  69             << "  Bps = " << audio_sched->getBps()
  70             << "  Stereo = " << audio_sched->getStereo() );
  71 }
  72
  73 // destructor
  74 FGSoundMgr::~FGSoundMgr() {
  75     sound_map_iterator current = sounds.begin();
  76     sound_map_iterator end = sounds.end();
  77     for ( ; current != end; ++current ) {
  78         FGSimpleSound *s = current->second;
  79         delete s->get_sample();
  80         delete s;
  81     }
  82
  83     delete audio_sched;
  84     delete audio_mixer;
  85 }
  86
  87
  88 // initialize the sound manager
  89 bool FGSoundMgr::init() {
  90     audio_mixer -> setMasterVolume ( 80 ) ;  /* 80% of max volume. */
  91     audio_sched -> setSafetyMargin ( 1.0 ) ;
  92
  93     sound_map_iterator current = sounds.begin();
  94     sound_map_iterator end = sounds.end();
  95     for ( ; current != end; ++current ) {
  96         FGSimpleSound *s = current->second;
  97         delete s->get_sample();
  98         delete s;
  99     }
 100     sounds.clear();
 101
 102     if ( audio_sched->not_working() ) {
 103         return false;
 104     } else {
 105         return true;
 106     }
 107 }
 108
 109
 110 // run the audio scheduler
 111 bool FGSoundMgr::update() {
 112     if ( !audio_sched->not_working() ) {
 113         audio_sched -> update();
 114         return true;
 115     } else {
 116         return false;
 117     }
 118 }
 119
 120
 121 // add a sound effect, return true if successful
 122 bool FGSoundMgr::add( FGSimpleSound *sound, const string& refname  ) {
 123     sounds[refname] = sound;
 124
 125     return true;
 126 }
 127
 128
 129 // remove a sound effect, return true if successful
 130 bool FGSoundMgr::remove( const string& refname ) {
 131
 132     sound_map_iterator it = sounds.find( refname );
 133     if ( it != sounds.end() ) {
 134         // first stop the sound from playing (so we don't bomb the
 135         // audio scheduler)
 136         FGSimpleSound *sample = it->second;
 137
 138         // cout << "Playing " << sample->get_sample()->getPlayCount()
 139         //      << " instances!" << endl;
 140
 141         audio_sched->stopSample( sample->get_sample() );
 142         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
 143                                         NULL,
 144                                         SL_PITCH_ENVELOPE );
 145         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
 146                                         NULL,
 147                                         SL_VOLUME_ENVELOPE );
 148
 149 #if defined ( PLIB_1_2_X )
 150         // if PLIB_1_2_X, we can't reliably remove sounds
 151         // that are currently being played. :-( So, let's just not
 152         // remove them and return false.  The effects of this are that
 153         // the sound sample will continue to finish playing (or
 154         // continue to loop forever.)  And the sound sample will
 155         // remain registered in the plib audio system.  This is a
 156         // memory leak, and eventually this could cause us to max out
 157         // the total number of allowed sound samples in plib, but what
 158         // are you going to do?  Hopefully the plib team will do a new
 159         // stable relase with these problems fixed.
 160
 161         // cout << "plib broken audio, skipping actual remove" << endl;
 162
 163         return false;
 164 #else
 165         // must call audio_sched->update() after stopping the sound
 166         // but before deleting it.
 167         audio_sched -> update();
 168         // cout << "Still playing " << sample->get_sample()->getPlayCount()
 169         //      << " instances!" << endl;
 170
 171         delete sample;
 172         sounds.erase( it );
 173
 174         return true;
 175 #endif
 176    } else {
 177         return false;
 178     }
 179 }
 180
 181
 182 // return true of the specified sound exists in the sound manager system
 183 bool FGSoundMgr::exists( const string& refname ) {
 184     sound_map_iterator it = sounds.find( refname );
 185     if ( it != sounds.end() ) {
 186         return true;
 187    } else {
 188         return false;
 189     }
 190 }
 191
 192
 193 // return a pointer to the FGSimpleSound if the specified sound exists
 194 // in the sound manager system, otherwise return NULL
 195 FGSimpleSound *FGSoundMgr::find( const string& refname ) {
 196     sound_map_iterator it = sounds.find( refname );
 197     if ( it != sounds.end() ) {
 198         return it->second;
 199    } else {
 200         return NULL;
 201     }
 202 }
 203
 204
 205 // tell the scheduler to play the indexed sample in a continuous
 206 // loop
 207 bool FGSoundMgr::play_looped( const string& refname ) {
 208     sound_map_iterator it = sounds.find( refname );
 209     if ( it != sounds.end() ) {
 210         FGSimpleSound *sample = it->second;
 211         audio_sched->loopSample( sample->get_sample() );
 212         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
 213                                         sample->get_pitch_envelope(),
 214                                         SL_PITCH_ENVELOPE );
 215         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
 216                                         sample->get_volume_envelope(),
 217                                         SL_VOLUME_ENVELOPE );
 218
 219         return true;
 220     } else {
 221         return false;
 222     }
 223 }
 224
 225
 226 // tell the scheduler to play the indexed sample once
 227 bool FGSoundMgr::play_once( const string& refname ) {
 228     sound_map_iterator it = sounds.find( refname );
 229     if ( it != sounds.end() ) {
 230         FGSimpleSound *sample = it->second;
 231         audio_sched->stopSample( sample->get_sample() );
 232         audio_sched->playSample( sample->get_sample() );
 233         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
 234                                         sample->get_pitch_envelope(),
 235                                         SL_PITCH_ENVELOPE );
 236         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
 237                                         sample->get_volume_envelope(),
 238                                         SL_VOLUME_ENVELOPE );
 239
 240         return true;
 241     } else {
 242         return false;
 243     }
 244 }
 245
 246
 247 // return true of the specified sound is currently being played
 248 bool FGSoundMgr::is_playing( const string& refname ) {
 249     sound_map_iterator it = sounds.find( refname );
 250     if ( it != sounds.end() ) {
 251         FGSimpleSound *sample = it->second;
 252         return (sample->get_sample()->getPlayCount() > 0 );
 253         return true;
 254     } else {
 255         return false;
 256     }
 257 }
 258
 259
 260 // immediate stop playing the sound
 261 bool FGSoundMgr::stop( const string& refname ) {
 262     sound_map_iterator it = sounds.find( refname );
 263     if ( it != sounds.end() ) {
 264         FGSimpleSound *sample = it->second;
 265         audio_sched->stopSample( sample->get_sample() );
 266         return true;
 267     } else {
 268         return false;
 269     }
 270 }