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., 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/alut.h>
54 #include <simgear/compiler.h>
55 #include <simgear/structure/subsystem_mgr.hxx>
56 #include <simgear/math/SGMathFwd.hxx>
58 #include "sample_group.hxx"
59 #include "sample_openal.hxx"
64 typedef map < string, SGSharedPtr<SGSampleGroup> > sample_group_map;
65 typedef sample_group_map::iterator sample_group_map_iterator;
66 typedef sample_group_map::const_iterator const_sample_group_map_iterator;
70 * Manage a collection of SGSampleGroup instances
72 class SGSoundMgr : public SGSubsystem
82 void update(double dt);
88 inline void reinit() { stop(); init(); }
93 inline bool is_working() const { return _working; }
96 * add a sample group, return true if successful
98 bool add( SGSampleGroup *sgrp, const string& refname );
101 * remove a sample group, return true if successful
103 bool remove( const string& refname );
106 * return true of the specified sound exists in the sound manager system
108 bool exists( const string& refname );
111 * return a pointer to the SGSampleGroup if the specified sound
112 * exists in the sound manager system, otherwise return NULL
114 SGSampleGroup *find( const string& refname, bool create = false );
117 * set the position of the listener (in opengl coordinates)
119 inline void set_position( SGVec3d pos ) {
124 inline double *get_position() {
125 return _listener_pos.data();
129 * set the velocity of the listener (in opengl coordinates)
131 inline void set_velocity( SGVec3f vel ) {
137 * set the orientation of the listener (in opengl coordinates)
139 void set_orientation( SGQuatd ori );
142 NO_SOURCE = (unsigned int)-1,
143 NO_BUFFER = (unsigned int)-1
146 void set_volume( float v );
147 inline float get_volume() { return _volume; }
150 * get a new OpenAL source id
151 * returns NO_SOURCE is no source is available
153 unsigned int request_source();
156 * give back an OpenAL source id for further use.
158 void release_source( unsigned int source );
160 bool load(string &samplepath, void **data, int *format, unsigned int*size,
165 static int _alut_init;
172 ALCcontext *_context;
174 // Position of the listener.
175 SGVec3d _listener_pos;
177 // Velocity of the listener.
178 SGVec3f _listener_vel;
180 // Orientation of the listener.
181 // first 3 elements are "at" vector, second 3 are "up" vector
182 ALfloat _listener_ori[6];
184 sample_group_map _sample_groups;
186 vector<ALuint> _free_sources;
187 vector<ALuint> _sources_in_use;
191 bool testForALError(string s);
192 bool testForALCError(string s);
193 bool testForALUTError(string s);
194 bool testForError(void *p, string s);
195 void update_sample_config( SGSampleGroup *sound );
199 #endif // _SG_SOUNDMGR_OPENAL_HXX