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