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(OPENALSDK)
  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      * Set the sound manager to a  working condition.
 118      */
 119     inline void activate() { _active = true; }
 120
 121     /**
 122      * Test is the sound manager is in an active and working condition.
 123      * @return true is the sound manager is active
 124      */
 125     inline bool is_active() const { return (_working && _active); }
 126
 127     /**
 128      * Register a sample group to the sound manager.
 129      * @para sgrp Pointer to a sample group to add
 130      * @param refname Reference name of the sample group
 131      * @return true if successful, false otherwise
 132      */
 133     bool add( SGSampleGroup *sgrp, const string& refname );
 134
 135     /**
 136      * Remove a sample group from the sound manager.
 137      * @param refname Reference name of the sample group to remove
 138      * @return true if successful, false otherwise
 139      */
 140     bool remove( const string& refname );
 141
 142     /**
 143      * Test if a specified sample group is registered at the sound manager
 144      * @param refname Reference name of the sample group test for
 145      * @return true if the specified sample group exists
 146      */
 147     bool exists( const string& refname );
 148
 149     /**
 150      * Find a specified sample group in the sound manager
 151      * @param refname Reference name of the sample group to find
 152      * @return A pointer to the SGSampleGroup
 153      */
 154     SGSampleGroup *find( const string& refname, bool create = false );
 155
 156     /**
 157      * Set the position of the sound manager.
 158      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 159      * @param pos OpenAL listener position
 160      */
 161     void set_position( const SGVec3d& pos ) {
 162         _position = -pos;
 163         _changed = true;
 164     }
 165
 166     /**
 167      * Get the position of the sound manager.
 168      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
 169      * @return OpenAL listener position
 170      */
 171     SGVec3f get_position() { return toVec3f(_position); }
 172
 173     /**
 174      * Set the velocity vector of the sound manager
 175      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 176      * @param vel Velocity vector of the OpenAL listener
 177      */
 178     void set_velocity( SGVec3d& dir ) {
 179         _velocity = dir;
 180         _changed = true;
 181     }
 182
 183     /**
 184      * Get the velocity vector of the sound manager
 185      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 186      * @return Velocity vector of the OpenAL listener
 187      */
 188     inline SGVec3f get_velocity() { return toVec3f(_velocity); }
 189
 190     /**
 191      * Set the orientation of the sound manager
 192      * @param ori Quaternation containing the orientation information
 193      */
 194     void set_orientation( SGQuatd ori );
 195
 196     /**
 197      * Get the orientation of the sound manager
 198      * @return Quaternation containing the orientation information
 199      */
 200     inline const SGQuatd& get_orientation() { return _orientation; }
 201
 202     /**
 203      * Get the direction vector of the sound manager
 204      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 205      * @return Look-at direction of the OpenAL listener
 206      */
 207     SGVec3f get_direction() {
 208         return SGVec3f(_at_up_vec[0], _at_up_vec[1], _at_up_vec[2]);
 209     }
 210
 211     enum {
 212         NO_SOURCE = (unsigned int)-1,
 213         NO_BUFFER = (unsigned int)-1
 214     };
 215
 216     /**
 217      * Set the master volume.
 218      * @param vol Volume (must be between 0.0 and 1.0)
 219      */
 220     void set_volume( float vol );
 221
 222     /**
 223      * Get the master volume.
 224      * @return Volume (must be between 0.0 and 1.0)
 225      */
 226     inline float get_volume() { return _volume; }
 227
 228     /**
 229      * Get a free OpenAL source-id
 230      * @return NO_SOURCE if no source is available
 231      */
 232     unsigned int request_source();
 233
 234     /**
 235      * Free an OpenAL source-id for future use
 236      * @param source OpenAL source-id to free
 237      */
 238     void release_source( unsigned int source );
 239
 240     /**
 241      * Get a free OpenAL buffer-id
 242      * The buffer-id will be asigned to the sample by calling this function.
 243      * @param sample Pointer to an audio sample to assign the buffer-id to
 244      * @return NO_BUFFER if loading of the buffer failed.
 245      */
 246     unsigned int request_buffer(SGSoundSample *sample);
 247
 248     /**
 249      * Free an OpenAL buffer-id for this sample
 250      * @param sample Pointer to an audio sample for which to free the buffer
 251      */
 252     void release_buffer( SGSoundSample *sample );
 253
 254     /**
 255      * Test if the position of the sound manager has changed.
 256      * The value will be set to false upon the next call to update_late()
 257      * @return true if the position has changed
 258      */
 259     inline bool has_changed() { return _changed; }
 260
 261     /**
 262      * Load a sample file and return it's configuration and data.
 263      * @param samplepath Path to the file to load
 264      * @param data Pointer to a variable that points to the allocated data
 265      * @param format Pointer to a vairable that gets the OpenAL format
 266      * @param size Pointer to a vairable that gets the sample size in bytes
 267      * @param freq Pointer to a vairable that gets the sample frequency in Herz
 268      * @return true if succesful, false on error
 269      */
 270     bool load(string &samplepath, void **data, int *format,
 271                                          size_t *size, int *freq );
 272
 273 private:
 274     static int _alut_init;
 275
 276     bool _working;
 277     bool _active;
 278     bool _changed;
 279     float _volume;
 280
 281     ALCdevice *_device;
 282     ALCcontext *_context;
 283
 284     // Position of the listener.
 285     SGVec3d _position;
 286
 287     // Velocity of the listener.
 288     SGVec3d _velocity;
 289
 290     // Orientation of the listener.
 291     // first 3 elements are "at" vector, second 3 are "up" vector
 292     SGQuatd _orientation;
 293     ALfloat _at_up_vec[6];
 294
 295     sample_group_map _sample_groups;
 296     buffer_map _buffers;
 297
 298     vector<ALuint> _free_sources;
 299     vector<ALuint> _sources_in_use;
 300
 301     char *_devname;
 302
 303     bool testForALError(string s);
 304     bool testForALCError(string s);
 305     bool testForALUTError(string s);
 306     bool testForError(void *p, string s);
 307
 308     void update_sample_config( SGSampleGroup *sound );
 309 };
 310
 311
 312 #endif // _SG_SOUNDMGR_OPENAL_HXX
 313
 314