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/sg_path.hxx>
  29
  30 #include <Main/globals.hxx>
  31
  32 #include "soundmgr.hxx"
  33
  34 #define FG_SOUND_SAFETY_MULT 3
  35 #define FG_MAX_SOUND_SAFETY ( 1.0 / FG_SOUND_SAFETY_MULT )
  36
  37 //
  38 // SimpleSound
  39 //
  40
  41 // constructor
  42 FGSimpleSound::FGSimpleSound( string file )
  43   : pitch(1.0),
  44     volume(1.0)
  45 {
  46     SGPath slfile( globals->get_fg_root() );
  47     slfile.append( file );
  48     sample = new slSample ( (char *)slfile.c_str() );
  49     pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  50     volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  51     pitch_envelope->setStep ( 0, 0.01, 1.0 );
  52     volume_envelope->setStep ( 0, 0.01, 1.0 );
  53 }
  54
  55 FGSimpleSound::FGSimpleSound( unsigned char *buffer, int len )
  56   : pitch(1.0),
  57     volume(1.0)
  58 {
  59     sample = new slSample ( buffer, len );
  60     pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  61     volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
  62     pitch_envelope->setStep ( 0, 0.01, 1.0 );
  63     volume_envelope->setStep ( 0, 0.01, 1.0 );
  64 }
  65
  66 // destructor
  67 FGSimpleSound::~FGSimpleSound() {
  68     delete pitch_envelope;
  69     delete volume_envelope;
  70     delete sample;
  71 }
  72
  73 void FGSimpleSound::play( slScheduler *sched, bool looped ) {
  74
  75     // make sure sound isn't already playing
  76     if ( sample->getPlayCount() > 0 ) {
  77        sched->stopSample(sample);
  78     //   return;
  79     }
  80
  81     if ( looped ) {
  82         sched->loopSample(sample);
  83     } else {
  84         sched->playSample(sample);
  85     }
  86
  87     sched->addSampleEnvelope(sample, 0, 0, pitch_envelope, SL_PITCH_ENVELOPE);
  88     sched->addSampleEnvelope(sample, 0, 1, volume_envelope, SL_VOLUME_ENVELOPE);
  89 }
  90
  91 void FGSimpleSound::stop( slScheduler *sched, bool quick ) {
  92
  93     sched->stopSample( sample );
  94 }
  95
  96 //
  97 // Sound Manager
  98 //
  99
 100 // constructor
 101 FGSoundMgr::FGSoundMgr() {
 102     audio_sched = new slScheduler( 8000 );
 103     if ( audio_sched->notWorking() ) {
 104         SG_LOG( SG_GENERAL, SG_ALERT, "Audio initialization failed!" );
 105     } else {
 106         audio_sched -> setMaxConcurrent ( 6 );
 107
 108         audio_mixer = new smMixer;
 109
 110         SG_LOG( SG_GENERAL, SG_INFO,
 111                 "Rate = " << audio_sched->getRate()
 112                 << "  Bps = " << audio_sched->getBps()
 113                 << "  Stereo = " << audio_sched->getStereo() );
 114     }
 115 }
 116
 117 // destructor
 118
 119 FGSoundMgr::~FGSoundMgr() {
 120
 121     //
 122     // Remove the samples from the sample manager.
 123     //
 124     sample_map_iterator sample_current = samples.begin();
 125     sample_map_iterator sample_end = samples.end();
 126     for ( ; sample_current != sample_end; ++sample_current ) {
 127         sample_ref *sr = sample_current->second;
 128         delete sr->sample;
 129         delete sr;
 130     }
 131
 132     //
 133     // Remove the sounds from the sound manager.
 134     //
 135     sound_map_iterator sound_current = sounds.begin();
 136     sound_map_iterator sound_end = sounds.end();
 137     for ( ; sound_current != sound_end; ++sound_current ) {
 138         FGSimpleSound *s = sound_current->second;
 139         delete s;
 140     }
 141
 142     delete audio_sched;
 143     delete audio_mixer;
 144 }
 145
 146
 147 // initialize the sound manager
 148 void FGSoundMgr::init() {
 149     last.stamp();
 150     safety = FG_MAX_SOUND_SAFETY;
 151
 152     // audio_mixer -> setMasterVolume ( 80 ) ;  /* 80% of max volume. */
 153     audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
 154
 155
 156     //
 157     // Remove the samples from the sample manager.
 158     //
 159     sample_map_iterator sample_current = samples.begin();
 160     sample_map_iterator sample_end = samples.end();
 161     for ( ; sample_current != sample_end; ++sample_current ) {
 162         sample_ref *sr = sample_current->second;
 163         delete sr->sample;
 164         delete sr;
 165     }
 166     samples.clear();
 167
 168     //
 169     // Remove the sounds from the sound manager.
 170     //
 171     sound_map_iterator sound_current = sounds.begin();
 172     sound_map_iterator sound_end = sounds.end();
 173     for ( ; sound_current != sound_end; ++sound_current ) {
 174         FGSimpleSound *s = sound_current->second;
 175         delete s->get_sample();
 176         delete s;
 177     }
 178     sounds.clear();
 179
 180 }
 181
 182 void FGSoundMgr::bind ()
 183 {
 184   // no properties yet
 185 }
 186
 187 void FGSoundMgr::unbind ()
 188 {
 189   // no properties yet
 190 }
 191
 192
 193 // run the audio scheduler
 194 void FGSoundMgr::update(int dt) {
 195     SGTimeStamp current;
 196     current.stamp();
 197
 198     double elapsed = (double)(current - last) / 1000000.0;
 199     last = current;
 200
 201     if ( elapsed > safety ) {
 202         safety = elapsed;
 203     } else {
 204         safety = safety * 0.99 + elapsed * 0.01;
 205     }
 206     if ( safety > FG_MAX_SOUND_SAFETY ) {
 207         safety = FG_MAX_SOUND_SAFETY;
 208     }
 209     // cout << "safety = " << safety << endl;
 210     audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
 211
 212     if ( !audio_sched->not_working() )
 213         audio_sched -> update();
 214 }
 215
 216
 217 void
 218 FGSoundMgr::pause ()
 219 {
 220   audio_sched->pauseSample(0, 0);
 221 }
 222
 223
 224 void
 225 FGSoundMgr::resume ()
 226 {
 227   audio_sched->resumeSample(0, 0);
 228 }
 229
 230
 231 // add a sound effect, return true if successful
 232 bool FGSoundMgr::add( FGSimpleSound *sound, const string& refname ) {
 233
 234     sound_map_iterator sound_it = sounds.find( refname );
 235     if ( sound_it != sounds.end() ) {
 236         // sound already exists
 237         return false;
 238     }
 239
 240     sample_map_iterator sample_it = samples.find( refname );
 241     if ( sample_it != samples.end() ) {
 242         // this sound has existed in the past and it's sample is still
 243         // here, delete the sample so we can replace it.
 244         samples.erase( sample_it );
 245     }
 246
 247     sample_ref *sr = new sample_ref;
 248
 249     sr->n=1;
 250     sr->sample = sound->get_sample();
 251     samples[refname] = sr;
 252
 253     sounds[refname] = sound;
 254
 255     return true;
 256 }
 257
 258
 259 // add a sound from a file, return the sample if successful, else return NULL
 260 FGSimpleSound *FGSoundMgr::add( const string& refname, const string &file ) {
 261      FGSimpleSound *sound;
 262
 263     if (file.empty())
 264        return NULL;
 265
 266     sample_map_iterator it = samples.find(file);
 267     if (it == samples.end()) {
 268        sound = new FGSimpleSound(file);
 269        sounds[refname] = sound;
 270
 271        sample_ref *sr = new sample_ref;
 272
 273        sr->n=1;
 274        sr->sample = sound->get_sample();
 275        samples[file] = sr;
 276
 277     } else {
 278        sample_ref *sr = it->second;
 279
 280        sr->n++;
 281        sound =
 282            new FGSimpleSound(sr->sample->getBuffer(), sr->sample->getLength());
 283        sounds[refname] = sound;
 284
 285     }
 286
 287     return sound;
 288 }
 289
 290
 291 // remove a sound effect, return true if successful
 292 bool FGSoundMgr::remove( const string& refname ) {
 293
 294     sound_map_iterator it = sounds.find( refname );
 295     if ( it != sounds.end() ) {
 296         // first stop the sound from playing (so we don't bomb the
 297         // audio scheduler)
 298         FGSimpleSound *sample = it->second;
 299
 300         // cout << "Playing " << sample->get_sample()->getPlayCount()
 301         //      << " instances!" << endl;
 302
 303         audio_sched->stopSample( sample->get_sample() );
 304         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
 305                                         NULL,
 306                                         SL_PITCH_ENVELOPE );
 307         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
 308                                         NULL,
 309                                         SL_VOLUME_ENVELOPE );
 310
 311         // must call audio_sched->update() after stopping the sound
 312         // but before deleting it.
 313         audio_sched -> update();
 314         // cout << "Still playing " << sample->get_sample()->getPlayCount()
 315         //      << " instances!" << endl;
 316
 317         //
 318         // FIXME:
 319         // Due to the change in the sound manager, samples live
 320         // until the sound manager gets removed.
 321         //
 322         // delete sample;
 323         sounds.erase( it );
 324
 325         // cout << "sndmgr: removed -> " << refname << endl;
 326         return true;
 327     } else {
 328         // cout << "sndmgr: failed remove -> " << refname << endl;
 329         return false;
 330     }
 331 }
 332
 333
 334 // return true of the specified sound exists in the sound manager system
 335 bool FGSoundMgr::exists( const string& refname ) {
 336     sound_map_iterator it = sounds.find( refname );
 337     if ( it != sounds.end() ) {
 338         return true;
 339    } else {
 340         return false;
 341     }
 342 }
 343
 344
 345 // return a pointer to the FGSimpleSound if the specified sound exists
 346 // in the sound manager system, otherwise return NULL
 347 FGSimpleSound *FGSoundMgr::find( const string& refname ) {
 348     sound_map_iterator it = sounds.find( refname );
 349     if ( it != sounds.end() ) {
 350         return it->second;
 351     } else {
 352         return NULL;
 353     }
 354 }
 355
 356
 357 // tell the scheduler to play the indexed sample in a continuous
 358 // loop
 359 bool FGSoundMgr::play_looped( const string& refname ) {
 360    FGSimpleSound *sample;
 361
 362     if ((sample = find( refname )) == NULL)
 363        return false;
 364
 365     sample->play(audio_sched, true);
 366     return true;
 367 }
 368
 369
 370 // tell the scheduler to play the indexed sample once
 371 bool FGSoundMgr::play_once( const string& refname ) {
 372     FGSimpleSound *sample;
 373
 374     if ((sample = find( refname )) == NULL)
 375        return false;
 376
 377     sample->play(audio_sched, false);
 378     return true;
 379 }
 380
 381
 382 // return true of the specified sound is currently being played
 383 bool FGSoundMgr::is_playing( const string& refname ) {
 384     FGSimpleSound *sample;
 385
 386     if ((sample = find( refname )) == NULL)
 387        return false;
 388
 389     return (sample->get_sample()->getPlayCount() > 0 );
 390 }
 391
 392
 393 // immediate stop playing the sound
 394 bool FGSoundMgr::stop( const string& refname ) {
 395     FGSimpleSound *sample;
 396
 397     if ((sample = find( refname )) == NULL)
 398        return false;
 399
 400     audio_sched->stopSample( sample->get_sample() );
 401     return true;
 402 }