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     safety = FG_MAX_SOUND_SAFETY;
 150
 151     // audio_mixer -> setMasterVolume ( 80 ) ;  /* 80% of max volume. */
 152     audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
 153
 154
 155     //
 156     // Remove the samples from the sample manager.
 157     //
 158     sample_map_iterator sample_current = samples.begin();
 159     sample_map_iterator sample_end = samples.end();
 160     for ( ; sample_current != sample_end; ++sample_current ) {
 161         sample_ref *sr = sample_current->second;
 162         delete sr->sample;
 163         delete sr;
 164     }
 165     samples.clear();
 166
 167     //
 168     // Remove the sounds from the sound manager.
 169     //
 170     sound_map_iterator sound_current = sounds.begin();
 171     sound_map_iterator sound_end = sounds.end();
 172     for ( ; sound_current != sound_end; ++sound_current ) {
 173         FGSimpleSound *s = sound_current->second;
 174         delete s->get_sample();
 175         delete s;
 176     }
 177     sounds.clear();
 178
 179 }
 180
 181 void FGSoundMgr::bind ()
 182 {
 183   // no properties yet
 184 }
 185
 186 void FGSoundMgr::unbind ()
 187 {
 188   // no properties yet
 189 }
 190
 191
 192 // run the audio scheduler
 193 void FGSoundMgr::update( double dt ) {
 194     if ( dt > safety ) {
 195         safety = dt;
 196     } else {
 197         safety = safety * 0.99 + dt * 0.01;
 198     }
 199     if ( safety > FG_MAX_SOUND_SAFETY ) {
 200         safety = FG_MAX_SOUND_SAFETY;
 201     }
 202     // cout << "safety = " << safety << endl;
 203     audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
 204
 205     if ( !audio_sched->not_working() )
 206         audio_sched -> update();
 207 }
 208
 209
 210 void
 211 FGSoundMgr::pause ()
 212 {
 213   audio_sched->pauseSample(0, 0);
 214 }
 215
 216
 217 void
 218 FGSoundMgr::resume ()
 219 {
 220   audio_sched->resumeSample(0, 0);
 221 }
 222
 223
 224 // add a sound effect, return true if successful
 225 bool FGSoundMgr::add( FGSimpleSound *sound, const string& refname ) {
 226
 227     sound_map_iterator sound_it = sounds.find( refname );
 228     if ( sound_it != sounds.end() ) {
 229         // sound already exists
 230         return false;
 231     }
 232
 233     sample_map_iterator sample_it = samples.find( refname );
 234     if ( sample_it != samples.end() ) {
 235         // this sound has existed in the past and it's sample is still
 236         // here, delete the sample so we can replace it.
 237         samples.erase( sample_it );
 238     }
 239
 240     sample_ref *sr = new sample_ref;
 241
 242     sr->n=1;
 243     sr->sample = sound->get_sample();
 244     samples[refname] = sr;
 245
 246     sounds[refname] = sound;
 247
 248     return true;
 249 }
 250
 251
 252 // add a sound from a file, return the sample if successful, else return NULL
 253 FGSimpleSound *FGSoundMgr::add( const string& refname, const string &file ) {
 254      FGSimpleSound *sound;
 255
 256     if (file.empty())
 257        return NULL;
 258
 259     sample_map_iterator it = samples.find(file);
 260     if (it == samples.end()) {
 261        sound = new FGSimpleSound(file);
 262        sounds[refname] = sound;
 263
 264        sample_ref *sr = new sample_ref;
 265
 266        sr->n=1;
 267        sr->sample = sound->get_sample();
 268        samples[file] = sr;
 269
 270     } else {
 271        sample_ref *sr = it->second;
 272
 273        sr->n++;
 274        sound =
 275            new FGSimpleSound(sr->sample->getBuffer(), sr->sample->getLength());
 276        sounds[refname] = sound;
 277
 278     }
 279
 280     return sound;
 281 }
 282
 283
 284 // remove a sound effect, return true if successful
 285 bool FGSoundMgr::remove( const string& refname ) {
 286
 287     sound_map_iterator it = sounds.find( refname );
 288     if ( it != sounds.end() ) {
 289         // first stop the sound from playing (so we don't bomb the
 290         // audio scheduler)
 291         FGSimpleSound *sample = it->second;
 292
 293         // cout << "Playing " << sample->get_sample()->getPlayCount()
 294         //      << " instances!" << endl;
 295
 296         audio_sched->stopSample( sample->get_sample() );
 297         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
 298                                         NULL,
 299                                         SL_PITCH_ENVELOPE );
 300         audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
 301                                         NULL,
 302                                         SL_VOLUME_ENVELOPE );
 303
 304         // must call audio_sched->update() after stopping the sound
 305         // but before deleting it.
 306         audio_sched -> update();
 307         // cout << "Still playing " << sample->get_sample()->getPlayCount()
 308         //      << " instances!" << endl;
 309
 310         //
 311         // FIXME:
 312         // Due to the change in the sound manager, samples live
 313         // until the sound manager gets removed.
 314         //
 315         // delete sample;
 316         sounds.erase( it );
 317
 318         // cout << "sndmgr: removed -> " << refname << endl;
 319         return true;
 320     } else {
 321         // cout << "sndmgr: failed remove -> " << refname << endl;
 322         return false;
 323     }
 324 }
 325
 326
 327 // return true of the specified sound exists in the sound manager system
 328 bool FGSoundMgr::exists( const string& refname ) {
 329     sound_map_iterator it = sounds.find( refname );
 330     if ( it != sounds.end() ) {
 331         return true;
 332    } else {
 333         return false;
 334     }
 335 }
 336
 337
 338 // return a pointer to the FGSimpleSound if the specified sound exists
 339 // in the sound manager system, otherwise return NULL
 340 FGSimpleSound *FGSoundMgr::find( const string& refname ) {
 341     sound_map_iterator it = sounds.find( refname );
 342     if ( it != sounds.end() ) {
 343         return it->second;
 344     } else {
 345         return NULL;
 346     }
 347 }
 348
 349
 350 // tell the scheduler to play the indexed sample in a continuous
 351 // loop
 352 bool FGSoundMgr::play_looped( const string& refname ) {
 353    FGSimpleSound *sample;
 354
 355     if ((sample = find( refname )) == NULL)
 356        return false;
 357
 358     sample->play(audio_sched, true);
 359     return true;
 360 }
 361
 362
 363 // tell the scheduler to play the indexed sample once
 364 bool FGSoundMgr::play_once( const string& refname ) {
 365     FGSimpleSound *sample;
 366
 367     if ((sample = find( refname )) == NULL)
 368        return false;
 369
 370     sample->play(audio_sched, false);
 371     return true;
 372 }
 373
 374
 375 // return true of the specified sound is currently being played
 376 bool FGSoundMgr::is_playing( const string& refname ) {
 377     FGSimpleSound *sample;
 378
 379     if ((sample = find( refname )) == NULL)
 380        return false;
 381
 382     return (sample->get_sample()->getPlayCount() > 0 );
 383 }
 384
 385
 386 // immediate stop playing the sound
 387 bool FGSoundMgr::stop( const string& refname ) {
 388     FGSimpleSound *sample;
 389
 390     if ((sample = find( refname )) == NULL)
 391        return false;
 392
 393     audio_sched->stopSample( sample->get_sample() );
 394     return true;
 395 }