simgear/sound/soundmgr_openal.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 - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23 //
  24 // $Id$
  25
  26 /**
  27  * \file soundmgr.hxx
  28  * Provides a sound manager class to keep track of
  29  * multiple sounds and manage playing them with different effects and
  30  * timings.
  31  */
  32
  33 #ifndef _SG_SOUNDMGR_OPENAL_HXX
  34 #define _SG_SOUNDMGR_OPENAL_HXX 1
  35
  36 #ifndef __cplusplus
  37 # error This library requires C++
  38 #endif
  39
  40 #include <string>
  41 #include <vector>
  42 #include <map>
  43
  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>
  49 #else
  50 # include <AL/al.h>
  51 # include <AL/alut.h>
  52 #endif
  53
  54 #include <simgear/compiler.h>
  55 #include <simgear/structure/subsystem_mgr.hxx>
  56 #include <simgear/math/SGMathFwd.hxx>
  57
  58 #include "sample_group.hxx"
  59 #include "sample_openal.hxx"
  60
  61 using std::map;
  62 using std::string;
  63
  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;
  67
  68
  69 /**
  70  * Manage a collection of SGSampleGroup instances
  71  */
  72 class SGSoundMgr : public SGSubsystem
  73 {
  74 public:
  75
  76     SGSoundMgr();
  77     ~SGSoundMgr();
  78
  79     void init();
  80     void bind();
  81     void unbind();
  82     void update(double dt);
  83     void update_late(double dt);
  84
  85     void suspend();
  86     void resume();
  87     void stop();
  88
  89     inline void reinit() { stop(); init(); }
  90
  91     /**
  92      * is audio working?
  93      */
  94     inline bool is_working() const { return _working; }
  95
  96     /**
  97      * add a sample group, return true if successful
  98      */
  99     bool add( SGSampleGroup *sgrp, const string& refname );
 100
 101     /**
 102      * remove a sample group, return true if successful
 103      */
 104     bool remove( const string& refname );
 105
 106     /**
 107      * return true of the specified sound exists in the sound manager system
 108      */
 109     bool exists( const string& refname );
 110
 111     /**
 112      * return a pointer to the SGSampleGroup if the specified sound
 113      * exists in the sound manager system, otherwise return NULL
 114      */
 115     SGSampleGroup *find( const string& refname, bool create = false );
 116
 117     /**
 118      * set the position of the listener (in opengl coordinates)
 119      */
 120     inline void set_position( SGVec3d pos ) {
 121         _listener_pos = pos;
 122         _changed = true;
 123     }
 124
 125     inline double *get_position() {
 126        return _listener_pos.data();
 127     }
 128
 129     /**
 130      * set the velocity of the listener (in opengl coordinates)
 131      */
 132     inline void set_velocity( SGVec3f vel ) {
 133         _listener_vel = vel;
 134         _changed = true;
 135     }
 136
 137     /**
 138      * set the orientation of the listener (in opengl coordinates)
 139      */
 140     void set_orientation( SGQuatd ori );
 141
 142     enum {
 143         NO_SOURCE = (unsigned int)-1,
 144         NO_BUFFER = (unsigned int)-1
 145     };
 146
 147     void set_volume( float v );
 148     inline float get_volume() { return _volume; }
 149
 150     /**
 151      * get a new OpenAL source id
 152      * returns NO_SOURCE is no source is available
 153      */
 154     unsigned int request_source();
 155
 156     /**
 157      * give back an OpenAL source id for further use.
 158      */
 159     void release_source( unsigned int source );
 160
 161     static bool load(string &samplepath, void **data, int *format,
 162                                          unsigned int*size, int *freq );
 163
 164
 165 private:
 166     static int _alut_init;
 167
 168     bool _working;
 169     bool _changed;
 170     float _volume;
 171
 172     ALCdevice *_device;
 173     ALCcontext *_context;
 174
 175     // Position of the listener.
 176     SGVec3d _listener_pos;
 177
 178     // Velocity of the listener.
 179     SGVec3f _listener_vel;
 180
 181     // Orientation of the listener.
 182     // first 3 elements are "at" vector, second 3 are "up" vector
 183     ALfloat _listener_ori[6];
 184
 185     sample_group_map _sample_groups;
 186
 187     vector<ALuint> _free_sources;
 188     vector<ALuint> _sources_in_use;
 189
 190     char *_devname;
 191
 192     bool testForALError(string s);
 193     bool testForALCError(string s);
 194     bool testForALUTError(string s);
 195     bool testForError(void *p, string s);
 196     void update_sample_config( SGSampleGroup *sound );
 197 };
 198
 199
 200 #endif // _SG_SOUNDMGR_OPENAL_HXX
 201
 202