1 // soundmgr.hxx -- Sound effect management class
3 // Sound manager initially written by David Findlay
4 // <david_j_findlay@yahoo.com.au> 2001
6 // C++-ified by Curtis Olson, started March 2001.
8 // Copyright (C) 2001 Curtis L. Olson - curt@flightgear.org
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.
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.
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.
34 #include <simgear/compiler.h>
46 // manages everything we need to know for an individual sound sample
50 slEnvelope *pitch_envelope;
51 slEnvelope *volume_envelope;
57 FGSimpleSound( string file );
58 FGSimpleSound( unsigned char *buffer, int len );
61 inline double get_pitch() const { return pitch; }
62 inline void set_pitch( double p ) {
64 pitch_envelope->setStep( 0, 0.01, pitch );
66 inline double get_volume() const { return volume; }
67 inline void set_volume( double v ) {
69 volume_envelope->setStep( 0, 0.01, volume );
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; }
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;
85 slScheduler *audio_sched;
94 // initialize the sound manager
97 // run the audio scheduler
101 inline bool is_working() const { return !audio_sched->not_working(); }
103 // add a sound effect, return true if successful
104 bool add( FGSimpleSound *sound, const string& refname );
106 // remove a sound effect, return true if successful
107 bool remove( const string& refname );
109 // return true of the specified sound exists in the sound manager system
110 bool exists( const string& refname );
112 // return a pointer to the FGSimpleSound if the specified sound
113 // exists in the sound manager system, otherwise return NULL
114 FGSimpleSound *find( const string& refname );
116 // tell the scheduler to play the indexed sample in a continuous
118 bool play_looped( const string& refname );
120 // tell the scheduler to play the indexed sample once
121 bool play_once( const string& refname );
123 // return true of the specified sound is currently being played
124 bool is_playing( const string& refname );
126 // immediate stop playing the sound
127 bool stop( const string& refname );
131 #endif // _SOUNDMGR_HXX