src/Sound/soundmgr.hxx

   1 // soundmgr.hxx -- 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 #ifndef _SOUNDMGR_HXX
  28 #define _SOUNDMGR_HXX
  29
  30 #ifdef HAVE_CONFIG_H
  31 #  include <config.h>
  32 #endif
  33
  34 #include <simgear/compiler.h>
  35
  36 #include STL_STRING
  37 #include <map>
  38
  39 #include <plib/sl.h>
  40 #include <plib/sm.h>
  41
  42 FG_USING_STD(map);
  43 FG_USING_STD(string);
  44
  45
  46 // manages everything we need to know for an individual sound sample
  47 class FGSimpleSound {
  48
  49     slSample *sample;
  50     slEnvelope *pitch_envelope;
  51     slEnvelope *volume_envelope;
  52     double pitch;
  53     double volume;
  54
  55 public:
  56
  57     FGSimpleSound( string file );
  58     FGSimpleSound( unsigned char *buffer, int len );
  59     ~FGSimpleSound();
  60
  61     inline double get_pitch() const { return pitch; }
  62     inline void set_pitch( double p ) {
  63         pitch = p;
  64         pitch_envelope->setStep( 0, 0.01, pitch );
  65     }
  66     inline double get_volume() const { return volume; }
  67     inline void set_volume( double v ) {
  68         volume = v;
  69         volume_envelope->setStep( 0, 0.01, volume );
  70     }
  71
  72     inline slSample *get_sample() { return sample; }
  73     inline slEnvelope *get_pitch_envelope() { return pitch_envelope; }
  74     inline slEnvelope *get_volume_envelope() { return volume_envelope; }
  75 };
  76
  77
  78 typedef map < string, FGSimpleSound * > sound_map;
  79 typedef sound_map::iterator sound_map_iterator;
  80 typedef sound_map::const_iterator const_sound_map_iterator;
  81
  82
  83 class FGSoundMgr {
  84
  85     slScheduler *audio_sched;
  86     smMixer *audio_mixer;
  87     sound_map sounds;
  88
  89 public:
  90
  91     FGSoundMgr();
  92     ~FGSoundMgr();
  93
  94     // initialize the sound manager
  95     bool init();
  96
  97     // run the audio scheduler
  98     bool update();
  99
 100     // is audio working?
 101     inline bool is_working() const { return !audio_sched->not_working(); }
 102
 103     // add a sound effect, return true if successful
 104     bool add( FGSimpleSound *sound, const string& refname );
 105
 106     // remove a sound effect, return true if successful
 107     bool remove( const string& refname );
 108
 109     // return true of the specified sound exists in the sound manager system
 110     bool exists( const string& refname );
 111
 112     // tell the scheduler to play the indexed sample in a continuous
 113     // loop
 114     bool play_looped( const string& refname );
 115
 116     // tell the scheduler to play the indexed sample once
 117     bool play_once( const string& refname );
 118
 119     // return true of the specified sound is currently being played
 120     bool is_playing( const string& refname );
 121
 122     // immediate stop playing the sound
 123     bool stop( const string& refname );
 124 };
 125
 126
 127 #endif // _SOUNDMGR_HXX
 128
 129