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 Foundation,
22 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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++
44 #if defined(__APPLE__)
45 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
46 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
47 # include <OpenAL/al.h>
48 # include <OpenAL/alc.h>
49 # include <OpenAL/alut.h>
60 #include <simgear/compiler.h>
61 #include <simgear/structure/subsystem_mgr.hxx>
62 #include <simgear/math/SGMathFwd.hxx>
64 #include "sample_group.hxx"
65 #include "sample_openal.hxx"
73 refUint() { refctr = 0; id = (ALuint)-1; };
74 refUint(ALuint i) { refctr = 1; id = i; };
78 typedef std::map < string, refUint > buffer_map;
79 typedef buffer_map::iterator buffer_map_iterator;
80 typedef buffer_map::const_iterator const_buffer_map_iterator;
82 typedef std::map < string, SGSharedPtr<SGSampleGroup> > sample_group_map;
83 typedef sample_group_map::iterator sample_group_map_iterator;
84 typedef sample_group_map::const_iterator const_sample_group_map_iterator;
87 * Manage a collection of SGSampleGroup instances
89 class SGSoundMgr : public SGSubsystem
99 void update(double dt);
100 void update_late(double dt);
106 inline void reinit() { stop(); init(); }
111 inline bool is_working() const { return _working; }
114 * add a sample group, return true if successful
116 bool add( SGSampleGroup *sgrp, const string& refname );
119 * remove a sample group, return true if successful
121 bool remove( const string& refname );
124 * return true of the specified sound exists in the sound manager system
126 bool exists( const string& refname );
129 * return a pointer to the SGSampleGroup if the specified sound
130 * exists in the sound manager system, otherwise return NULL
132 SGSampleGroup *find( const string& refname, bool create = false );
135 * set the position of the listener (in opengl coordinates)
137 void set_position( SGVec3d pos ) {
138 if (_position != pos) {
144 inline double *get_position() { return _position.data(); }
145 inline SGVec3d get_position_vec() { return _position; };
148 * set the velocity of the listener (in opengl coordinates)
150 void set_velocity( SGVec3f vel ) {
151 if (_velocity != vel) {
157 inline SGVec3f get_velocity() { return _velocity; }
160 * set the orientation of the listener (in opengl coordinates)
162 void set_orientation( SGQuatd ori );
164 inline SGVec3f get_direction() {
165 return SGVec3f(_orientation[0], _orientation[1], _orientation[2]);
169 NO_SOURCE = (unsigned int)-1,
170 NO_BUFFER = (unsigned int)-1
173 void set_volume( float v );
174 inline float get_volume() { return _volume; }
177 * get a new OpenAL source id
178 * returns NO_SOURCE if no source is available
180 unsigned int request_source();
183 * give back an OpenAL source id for further use.
185 void release_source( unsigned int source );
188 * get a new OpenAL buffer id
189 * returns NO_BUFFER if loading of the buffer failed.
191 unsigned int request_buffer(SGSoundSample *sample);
194 * give back an OpenAL source id for further use.
196 void release_buffer( SGSoundSample *sample );
201 * returns true if the position has changed
203 inline bool has_changed() { return _changed; }
205 static bool load(string &samplepath, void **data, int *format,
206 unsigned int*size, int *freq );
211 static int _alut_init;
218 ALCcontext *_context;
220 // Position of the listener.
223 // Velocity of the listener.
226 // Orientation of the listener.
227 // first 3 elements are "at" vector, second 3 are "up" vector
228 ALfloat _orientation[6];
230 sample_group_map _sample_groups;
233 vector<ALuint> _free_sources;
234 vector<ALuint> _sources_in_use;
238 bool testForALError(string s);
239 bool testForALCError(string s);
240 bool testForALUTError(string s);
241 bool testForError(void *p, string s);
242 void update_sample_config( SGSampleGroup *sound );
246 #endif // _SG_SOUNDMGR_OPENAL_HXX