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 - http://www.flightgear.org/~curt
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.
28 * Provides a sound manager class to keep track of
29 * multiple sounds and manage playing them with different effects and
33 #ifndef _SG_SOUNDMGR_OPENAL_HXX
34 #define _SG_SOUNDMGR_OPENAL_HXX 1
37 # error This library requires C++
40 #include <simgear/compiler.h>
45 #if defined( __APPLE__ )
46 # include <OpenAL/al.h>
47 # include <OpenAL/alc.h>
53 #include "sample_openal.hxx"
59 typedef map < string, SGSoundSample * > sample_map;
60 typedef sample_map::iterator sample_map_iterator;
61 typedef sample_map::const_iterator const_sample_map_iterator;
65 * Manage a collection of SGSoundSample instances
73 // Position of the listener.
74 ALfloat listener_pos[3];
76 // Velocity of the listener.
77 ALfloat listener_vel[3];
79 // Orientation of the listener. (first 3 elements are "at", second
81 ALfloat listener_ori[6];
95 * (re) initialize the sound manager.
101 * Bind properties for the sound manager.
107 * Unbind properties for the sound manager.
113 * Run the audio scheduler.
115 void update(double dt);
133 inline bool is_working() const { return working; }
136 * reinitialize the sound manager
138 inline void reinit() { init(); }
141 * add a sound effect, return true if successful
143 bool add( SGSoundSample *sound, const string& refname);
146 * remove a sound effect, return true if successful
148 bool remove( const string& refname );
151 * return true of the specified sound exists in the sound manager system
153 bool exists( const string& refname );
156 * return a pointer to the SGSoundSample if the specified sound
157 * exists in the sound manager system, otherwise return NULL
159 SGSoundSample *find( const string& refname );
162 * tell the scheduler to play the indexed sample in a continuous
165 bool play_looped( const string& refname );
168 * tell the scheduler to play the indexed sample once
170 bool play_once( const string& refname );
173 * return true of the specified sound is currently being played
175 bool is_playing( const string& refname );
178 * immediate stop playing the sound
180 bool stop( const string& refname );
183 * set overall volume for the application.
184 * @param vol 1.0 is default, must be greater than 0
186 inline void set_volume( const ALfloat vol ) {
188 alListenerf( AL_GAIN, vol );
193 * set the position of the listener (in opengl coordinates)
195 inline void set_listener_pos( ALfloat *pos ) {
196 listener_pos[0] = pos[0];
197 listener_pos[1] = pos[1];
198 listener_pos[2] = pos[2];
199 alListenerfv( AL_POSITION, listener_pos );
203 * set the velocity of the listener (in opengl coordinates)
205 inline void set_listener_vel( ALfloat *vel ) {
206 listener_vel[0] = vel[0];
207 listener_vel[1] = vel[1];
208 listener_vel[2] = vel[2];
209 alListenerfv( AL_VELOCITY, listener_vel );
213 * set the orientation of the listener (in opengl coordinates)
215 * Description: ORIENTATION is a pair of 3-tuples representing the
216 * 'at' direction vector and 'up' direction of the Object in
217 * Cartesian space. AL expects two vectors that are orthogonal to
218 * each other. These vectors are not expected to be normalized. If
219 * one or more vectors have zero length, implementation behavior
220 * is undefined. If the two vectors are linearly dependent,
221 * behavior is undefined.
223 inline void set_listener_orientation( ALfloat *ori ) {
224 listener_ori[0] = ori[0];
225 listener_ori[1] = ori[1];
226 listener_ori[2] = ori[2];
227 listener_ori[3] = ori[3];
228 listener_ori[4] = ori[4];
229 listener_ori[5] = ori[5];
230 alListenerfv( AL_ORIENTATION, listener_ori );
234 * set the positions of all managaged sound sources
236 void set_source_pos_all( ALfloat *pos );
239 * set the velocities of all managaged sound sources
241 void set_source_vel_all( ALfloat *pos );
245 #endif // _SG_SOUNDMGR_OPENAL_HXX