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 #include <simgear/timing/timestamp.hxx>
  43
  44 #include <Main/fgfs.hxx>
  45
  46 SG_USING_STD(map);
  47 SG_USING_STD(string);
  48
  49
  50 // manages everything we need to know for an individual sound sample
  51 class FGSimpleSound {
  52
  53 private:
  54
  55     slSample *sample;
  56     slEnvelope *pitch_envelope;
  57     slEnvelope *volume_envelope;
  58     double pitch;
  59     double volume;
  60
  61 public:
  62
  63     FGSimpleSound( string file );
  64     FGSimpleSound( unsigned char *buffer, int len );
  65     ~FGSimpleSound();
  66
  67     void play( slScheduler *sched, bool looped );
  68     void stop( slScheduler *sched, bool quick = true );
  69
  70     inline void play_once( slScheduler *sched ) { play( sched, false); }
  71     inline void play_looped( slScheduler *sched ) { play( sched, true); }
  72     inline bool is_playing( ) {
  73         return ( sample->getPlayCount() > 0 );
  74     }
  75
  76     inline double get_pitch() const { return pitch; }
  77     inline void set_pitch( double p ) {
  78        pitch = p;
  79        pitch_envelope->setStep( 0, 0.01, pitch );
  80     }
  81     inline double get_volume() const { return volume; }
  82     inline void set_volume( double v ) {
  83        volume = v;
  84        volume_envelope->setStep( 0, 0.01, volume );
  85     }
  86
  87     inline slSample *get_sample() { return sample; }
  88     inline slEnvelope *get_pitch_envelope() { return pitch_envelope; }
  89     inline slEnvelope *get_volume_envelope() { return volume_envelope; }
  90 };
  91
  92
  93 typedef struct {
  94         int n;
  95         slSample *sample;
  96 } sample_ref;
  97
  98 typedef map < string, sample_ref * > sample_map;
  99 typedef sample_map::iterator sample_map_iterator;
 100 typedef sample_map::const_iterator const_sample_map_iterator;
 101
 102
 103 typedef map < string, FGSimpleSound * > sound_map;
 104 typedef sound_map::iterator sound_map_iterator;
 105 typedef sound_map::const_iterator const_sound_map_iterator;
 106
 107
 108 class FGSoundMgr : public FGSubsystem
 109 {
 110
 111     slScheduler *audio_sched;
 112     smMixer *audio_mixer;
 113
 114     sound_map sounds;
 115     sample_map samples;
 116
 117     SGTimeStamp last;
 118     double safety;
 119
 120 public:
 121
 122     FGSoundMgr();
 123     ~FGSoundMgr();
 124
 125
 126     /**
 127      * Initialize the sound manager.
 128      */
 129     void init();
 130
 131
 132     /**
 133      * Bind properties for the sound manager.
 134      */
 135     void bind ();
 136
 137
 138     /**
 139      * Unbind properties for the sound manager.
 140      */
 141     void unbind ();
 142
 143
 144     /**
 145      * Run the audio scheduler.
 146      */
 147     void update(int dt);
 148
 149
 150     /**
 151      * Pause all sounds.
 152      */
 153     void pause ();
 154
 155
 156     /**
 157      * Resume all sounds.
 158      */
 159     void resume ();
 160
 161
 162     // is audio working?
 163     inline bool is_working() const { return !audio_sched->notWorking(); }
 164
 165     // add a sound effect, return true if successful
 166     bool add( FGSimpleSound *sound, const string& refname);
 167
 168     // add a sound file, return the sample if successful, else return NULL
 169     FGSimpleSound *add( const string& refname, const string& file = "" );
 170
 171     // remove a sound effect, return true if successful
 172     bool remove( const string& refname );
 173
 174     // return true of the specified sound exists in the sound manager system
 175     bool exists( const string& refname );
 176
 177     // return a pointer to the FGSimpleSound if the specified sound
 178     // exists in the sound manager system, otherwise return NULL
 179     FGSimpleSound *find( const string& refname );
 180
 181     // tell the scheduler to play the indexed sample in a continuous
 182     // loop
 183     bool play_looped( const string& refname );
 184
 185     // tell the scheduler to play the indexed sample once
 186     bool play_once( const string& refname );
 187
 188     // return true of the specified sound is currently being played
 189     bool is_playing( const string& refname );
 190
 191     // immediate stop playing the sound
 192     bool stop( const string& refname );
 193
 194     // return the audio scheduler
 195     inline slScheduler *get_scheduler( ) { return audio_sched; };
 196 };
 197
 198
 199 #endif // _SOUNDMGR_HXX
 200
 201