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 // Modified for the new SoundSystem by Erik Hofman, October 2009
   8 //
   9 // Copyright (C) 2001  Curtis L. Olson - http://www.flightgear.org/~curt
  10 // Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
  11 //
  12 // This program is free software; you can redistribute it and/or
  13 // modify it under the terms of the GNU General Public License as
  14 // published by the Free Software Foundation; either version 2 of the
  15 // License, or (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful, but
  18 // WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 // General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License
  23 // along with this program; if not, write to the Free Software Foundation,
  24 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  25 //
  26 // $Id$
  27
  28 /**
  29  * \file soundmgr.hxx
  30  * Provides a sound manager class to keep track of
  31  * multiple sounds and manage playing them with different effects and
  32  * timings.
  33  */
  34
  35 #ifndef _SG_SOUNDMGR_OPENAL_HXX
  36 #define _SG_SOUNDMGR_OPENAL_HXX 1
  37
  38 #ifndef __cplusplus
  39 # error This library requires C++
  40 #endif
  41
  42 #include <string>
  43 #include <vector>
  44 #include <map>
  45
  46 #if defined(__APPLE__)
  47 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
  48 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
  49 # include <OpenAL/al.h>
  50 # include <OpenAL/alc.h>
  51 # include <OpenAL/alut.h>
  52 #elif defined(_WIN32)
  53 # include <al.h>
  54 # include <alc.h>
  55 # include <AL/alut.h>
  56 #else
  57 # include <AL/al.h>
  58 # include <AL/alc.h>
  59 # include <AL/alut.h>
  60 #endif
  61
  62 #include <simgear/compiler.h>
  63 #include <simgear/structure/subsystem_mgr.hxx>
  64 #include <simgear/math/SGMathFwd.hxx>
  65
  66 #include "sample_group.hxx"
  67 #include "sample_openal.hxx"
  68
  69 using std::string;
  70
  71 struct refUint {
  72     unsigned int refctr;
  73     ALuint id;
  74
  75     refUint() { refctr = 0; id = (ALuint)-1; };
  76     refUint(ALuint i) { refctr = 1; id = i; };
  77     ~refUint() {};
  78 };
  79
  80 typedef std::map < string, refUint > buffer_map;
  81 typedef buffer_map::iterator buffer_map_iterator;
  82 typedef buffer_map::const_iterator  const_buffer_map_iterator;
  83
  84 typedef std::map < string, SGSharedPtr<SGSampleGroup> > sample_group_map;
  85 typedef sample_group_map::iterator sample_group_map_iterator;
  86 typedef sample_group_map::const_iterator const_sample_group_map_iterator;
  87
  88 /**
  89  * Manage a collection of SGSampleGroup instances
  90  */
  91 class SGSoundMgr : public SGSubsystem
  92 {
  93 public:
  94
  95     SGSoundMgr();
  96     ~SGSoundMgr();
  97
  98     void init();
  99     void bind();
 100     void unbind();
 101     void update(double dt) {};
 102     void update_late(double dt);
 103
 104     void suspend();
 105     void resume();
 106     void stop();
 107
 108     inline void reinit() { stop(); init(); }
 109
 110     /**
 111      * Test is the sound manager is in a working condition.
 112      * @return true is the sound manager is working
 113      */
 114     inline bool is_working() const { return _working; }
 115
 116     /**
 117      * Register a sample group to the sound manager.
 118      * @para sgrp Pointer to a sample group to add
 119      * @param refname Reference name of the sample group
 120      * @return true if successful, false otherwise
 121      */
 122     bool add( SGSampleGroup *sgrp, const string& refname );
 123
 124     /**
 125      * Remove a sample group from the sound manager.
 126      * @param refname Reference name of the sample group to remove
 127      * @return true if successful, false otherwise
 128      */
 129     bool remove( const string& refname );
 130
 131     /**
 132      * Test if a specified sample group is registered at the sound manager
 133      * @param refname Reference name of the sample group test for
 134      * @return true if the specified sample group exists
 135      */
 136     bool exists( const string& refname );
 137
 138     /**
 139      * Find a specified sample group in the sound manager
 140      * @param refname Reference name of the sample group to find
 141      * @return A pointer to the SGSampleGroup
 142      */
 143     SGSampleGroup *find( const string& refname, bool create = false );
 144
 145     /**
 146      * Set the position of the sound manager.
 147      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 148      * @param pos OpenAL listener position
 149      */
 150     void set_position( const SGVec3d& pos ) {
 151         _position = -pos;
 152         _changed = true;
 153     }
 154
 155     /**
 156      * Get the position of the sound manager.
 157      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
 158      * @return OpenAL listener position
 159      */
 160     SGVec3f get_position() { return toVec3f(_position); }
 161
 162     /**
 163      * Set the velocity vector of the sound manager
 164      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 165      * @param vel Velocity vector of the OpenAL listener
 166      */
 167     void set_velocity( SGVec3d& dir ) {
 168         _velocity = dir;
 169         _changed = true;
 170     }
 171
 172     /**
 173      * Get the velocity vector of the sound manager
 174      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 175      * @return Velocity vector of the OpenAL listener
 176      */
 177     inline SGVec3f get_velocity() { return toVec3f(_velocity); }
 178
 179     /**
 180      * Set the orientation of the sound manager
 181      * @param ori Quaternation containing the orientation information
 182      */
 183     void set_orientation( SGQuatd ori );
 184
 185     /**
 186      * Get the orientation of the sound manager
 187      * @return Quaternation containing the orientation information
 188      */
 189     inline const SGQuatd& get_orientation() { return _orientation; }
 190
 191     /**
 192      * Get the direction vector of the sound manager
 193      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 194      * @return Look-at direction of the OpenAL listener
 195      */
 196     SGVec3f get_direction() {
 197         return SGVec3f(_at_up_vec[0], _at_up_vec[1], _at_up_vec[2]);
 198     }
 199
 200     enum {
 201         NO_SOURCE = (unsigned int)-1,
 202         NO_BUFFER = (unsigned int)-1
 203     };
 204
 205     /**
 206      * Set the master volume.
 207      * @param vol Volume (must be between 0.0 and 1.0)
 208      */
 209     void set_volume( float vol );
 210
 211     /**
 212      * Get the master volume.
 213      * @return Volume (must be between 0.0 and 1.0)
 214      */
 215     inline float get_volume() { return _volume; }
 216
 217     /**
 218      * Get a free OpenAL source-id
 219      * @return NO_SOURCE if no source is available
 220      */
 221     unsigned int request_source();
 222
 223     /**
 224      * Free an OpenAL source-id for future use
 225      * @param source OpenAL source-id to free
 226      */
 227     void release_source( unsigned int source );
 228
 229     /**
 230      * Get a free OpenAL buffer-id
 231      * The buffer-id will be asigned to the sample by calling this function.
 232      * @param sample Pointer to an audio sample to assign the buffer-id to
 233      * @return NO_BUFFER if loading of the buffer failed.
 234      */
 235     unsigned int request_buffer(SGSoundSample *sample);
 236
 237     /**
 238      * Free an OpenAL buffer-id for this sample
 239      * @param sample Pointer to an audio sample for which to free the buffer
 240      */
 241     void release_buffer( SGSoundSample *sample );
 242
 243     /**
 244      * Test if the position of the sound manager has changed.
 245      * The value will be set to false upon the next call to update_late()
 246      * @return true if the position has changed
 247      */
 248     inline bool has_changed() { return _changed; }
 249
 250     /**
 251      * Load a sample file and return it's configuration and data.
 252      * @param samplepath Path to the file to load
 253      * @param data Pointer to a variable that points to the allocated data
 254      * @param format Pointer to a vairable that gets the OpenAL format
 255      * @param size Pointer to a vairable that gets the sample size in bytes
 256      * @param freq Pointer to a vairable that gets the sample frequency in Herz
 257      * @return true if succesful, false on error
 258      */
 259     bool load(string &samplepath, void **data, int *format,
 260                                          size_t *size, int *freq );
 261
 262 private:
 263     static int _alut_init;
 264
 265     bool _working;
 266     bool _changed;
 267     float _volume;
 268
 269     ALCdevice *_device;
 270     ALCcontext *_context;
 271
 272     // Position of the listener.
 273     SGVec3d _position;
 274
 275     // Velocity of the listener.
 276     SGVec3d _velocity;
 277
 278     // Orientation of the listener.
 279     // first 3 elements are "at" vector, second 3 are "up" vector
 280     SGQuatd _orientation;
 281     ALfloat _at_up_vec[6];
 282
 283     sample_group_map _sample_groups;
 284     buffer_map _buffers;
 285
 286     vector<ALuint> _free_sources;
 287     vector<ALuint> _sources_in_use;
 288
 289     char *_devname;
 290
 291     bool testForALError(string s);
 292     bool testForALCError(string s);
 293     bool testForALUTError(string s);
 294     bool testForError(void *p, string s);
 295
 296     void update_sample_config( SGSampleGroup *sound );
 297 };
 298
 299
 300 #endif // _SG_SOUNDMGR_OPENAL_HXX
 301
 302