simgear/sound/soundmgr_openal.cxx

   1 // soundmgr.cxx -- 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 Foundation,
  22 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23 //
  24 // $Id$
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include <simgear_config.h>
  28 #endif
  29
  30 #if defined( __APPLE__ )
  31 # include <OpenAL/alut.h>
  32 #else
  33 # include <AL/alut.h>
  34 #endif
  35
  36 #include <iostream>
  37
  38 #include "soundmgr_openal.hxx"
  39
  40 #include <simgear/structure/exception.hxx>
  41 #include <simgear/debug/logstream.hxx>
  42 #include <simgear/misc/sg_path.hxx>
  43 #include <simgear/math/SGMath.hxx>
  44
  45
  46 #define MAX_SOURCES     128
  47
  48 //
  49 // Sound Manager
  50 //
  51
  52 int SGSoundMgr::_alut_init = 0;
  53
  54 // constructor
  55 SGSoundMgr::SGSoundMgr() :
  56     _working(false),
  57     _changed(true),
  58     _volume(0.5),
  59     _device(NULL),
  60     _context(NULL),
  61     _listener_pos(SGVec3d::zeros().data()),
  62     _listener_vel(SGVec3f::zeros().data()),
  63     _devname(NULL)
  64 {
  65 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
  66     if (_alut_init == 0) {
  67         if ( !alutInitWithoutContext(NULL, NULL) ) {
  68             testForALUTError("alut initialization");
  69             return;
  70         }
  71         _alut_init++;
  72     }
  73     _alut_init++;
  74 #endif
  75 }
  76
  77 // destructor
  78
  79 SGSoundMgr::~SGSoundMgr() {
  80     stop();
  81 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
  82     _alut_init--;
  83     if (_alut_init == 0) {
  84         alutExit ();
  85     }
  86 #endif
  87 }
  88
  89 // initialize the sound manager
  90 void SGSoundMgr::init() {
  91
  92     SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
  93
  94     ALCdevice *device = alcOpenDevice(_devname);
  95     if ( testForError(device, "No default audio device available.") ) {
  96         return;
  97     }
  98
  99     ALCcontext *context = alcCreateContext(device, NULL);
 100     if ( testForError(context, "Unable to create a valid context.") ) {
 101         return;
 102     }
 103
 104     if ( !alcMakeContextCurrent(context) ) {
 105         testForALCError("context initialization");
 106         return;
 107     }
 108
 109     _context = context;
 110     _working = true;
 111
 112     _listener_ori[0] = 0.0; _listener_ori[1] = 0.0; _listener_ori[2] = -1.0;
 113     _listener_ori[3] = 0.0; _listener_ori[4] = 1.0; _listener_ori[5] = 0.0;
 114
 115     alListenerf( AL_GAIN, 0.2f );
 116     alListenerfv( AL_POSITION, toVec3f(_listener_pos).data() );
 117     alListenerfv( AL_ORIENTATION, _listener_ori );
 118     alListenerfv( AL_VELOCITY, _listener_vel.data() );
 119
 120     alDopplerFactor(1.0);
 121     alDopplerVelocity(340.3);   // speed of sound in meters per second.
 122
 123     if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
 124         alDistanceModel(AL_EXPONENT_DISTANCE);
 125     } else {
 126         alDistanceModel(AL_INVERSE_DISTANCE);
 127     }
 128
 129     testForALError("listener initialization");
 130
 131     alGetError(); // clear any undetetced error, just to be sure
 132
 133     // get a free source one at a time
 134     // if an error is returned no more (hardware) sources are available
 135     for (unsigned int i=0; i<MAX_SOURCES; i++) {
 136         ALuint source;
 137         ALenum error;
 138
 139         alGetError();
 140         alGenSources(1, &source);
 141         error = alGetError();
 142         if ( error == AL_NO_ERROR ) {
 143             _free_sources.push_back( source );
 144         }
 145         else break;
 146     }
 147 }
 148
 149 // suspend the sound manager
 150 void SGSoundMgr::stop() {
 151     if (_working) {
 152         _working = false;
 153
 154         _context = alcGetCurrentContext();
 155         _device = alcGetContextsDevice(_context);
 156         alcMakeContextCurrent(NULL);
 157         alcDestroyContext(_context);
 158         alcCloseDevice(_device);
 159     }
 160 }
 161
 162 void SGSoundMgr::suspend() {
 163     if (_working) {
 164         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 165         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 166         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 167             SGSampleGroup *sgrp = sample_grp_current->second;
 168             sgrp->suspend();
 169         }
 170     }
 171 }
 172
 173
 174 void SGSoundMgr::bind ()
 175 {
 176     _free_sources.clear();
 177     _free_sources.reserve( MAX_SOURCES );
 178     _sources_in_use.clear();
 179     _sources_in_use.reserve( MAX_SOURCES );
 180 }
 181
 182
 183 void SGSoundMgr::unbind ()
 184 {
 185     _sample_groups.clear();
 186
 187     // delete free sources
 188     for (unsigned int i=0; i<_free_sources.size(); i++) {
 189         ALuint source = _free_sources.at( i );
 190         alDeleteSources( 1 , &source );
 191     }
 192
 193     _free_sources.clear();
 194     _sources_in_use.clear();
 195 }
 196
 197
 198 // run the audio scheduler
 199 void SGSoundMgr::update( double dt ) {
 200     if (_working) {
 201         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 202         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 203         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 204             SGSampleGroup *sgrp = sample_grp_current->second;
 205             sgrp->update(dt);
 206         }
 207
 208         if (_changed) {
 209             alListenerf( AL_GAIN, _volume );
 210             alListenerfv( AL_VELOCITY, _listener_vel.data() );
 211             alListenerfv( AL_ORIENTATION, _listener_ori );
 212             alListenerfv( AL_POSITION, toVec3f(_listener_pos).data() );
 213             // alDopplerVelocity(340.3);        // TODO: altitude dependent
 214             testForALError("update");
 215             _changed = false;
 216         }
 217     }
 218 }
 219
 220
 221 void
 222 SGSoundMgr::resume ()
 223 {
 224     if (_working) {
 225         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 226         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 227         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 228             SGSampleGroup *sgrp = sample_grp_current->second;
 229             sgrp->resume();
 230         }
 231     }
 232 }
 233
 234
 235 // add a sampel group, return true if successful
 236 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
 237 {
 238     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 239     if ( sample_grp_it != _sample_groups.end() ) {
 240         // sample group already exists
 241         return false;
 242     }
 243
 244     _sample_groups[refname] = sgrp;
 245
 246     return true;
 247 }
 248
 249
 250 // remove a sound effect, return true if successful
 251 bool SGSoundMgr::remove( const string &refname )
 252 {
 253     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 254     if ( sample_grp_it == _sample_groups.end() ) {
 255         // sample group was not found.
 256         return false;
 257     }
 258
 259     _sample_groups.erase( refname );
 260
 261     return true;
 262 }
 263
 264
 265 // return true of the specified sound exists in the sound manager system
 266 bool SGSoundMgr::exists( const string &refname ) {
 267     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 268     if ( sample_grp_it == _sample_groups.end() ) {
 269         // sample group was not found.
 270         return false;
 271     }
 272
 273     return true;
 274 }
 275
 276
 277 // return a pointer to the SGSampleGroup if the specified sound exists
 278 // in the sound manager system, otherwise return NULL
 279 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
 280     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 281     if ( sample_grp_it == _sample_groups.end() ) {
 282         // sample group was not found.
 283         if (create) {
 284             SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
 285             return sgrp;
 286         }
 287         else
 288             return NULL;
 289     }
 290
 291     return sample_grp_it->second;
 292 }
 293
 294
 295 void SGSoundMgr::set_volume( float v )
 296 {
 297     _volume = v;
 298     if (_volume > 1.0) _volume = 1.0;
 299     if (_volume < 0.0) _volume = 0.0;
 300     _changed = true;
 301 }
 302
 303 // Get an unused source id
 304 //
 305 // The Sound Manager should keep track of the sources in use, the distance
 306 // of these sources to the listener and the volume (also based on audio cone
 307 // and hence orientation) of the sources.
 308 //
 309 // The Sound Manager is (and should be) the only one knowing about source
 310 // management. Sources further away should be suspendped to free resources for
 311 // newly added sounds close by.
 312 unsigned int SGSoundMgr::request_source()
 313 {
 314     unsigned int source = NO_SOURCE;
 315
 316     if (_free_sources.size() > 0) {
 317        source = _free_sources.back();
 318        _free_sources.pop_back();
 319
 320        _sources_in_use.push_back(source);
 321     }
 322
 323     return source;
 324 }
 325
 326 // Free up a source id for further use
 327 void SGSoundMgr::release_source( unsigned int source )
 328 {
 329     for (unsigned int i = 0; i<_sources_in_use.size(); i++) {
 330         if ( _sources_in_use[i] == source ) {
 331             ALint result;
 332
 333             alGetSourcei( source, AL_SOURCE_STATE, &result );
 334             if ( result == AL_PLAYING ) {
 335                 alSourceStop( source );
 336             }
 337             testForALError("free_source");
 338
 339             _free_sources.push_back(source);
 340             _sources_in_use.erase(_sources_in_use.begin()+i,
 341                                   _sources_in_use.begin()+i+1);
 342             break;
 343         }
 344     }
 345 }
 346
 347 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
 348                                           unsigned int *sz, int *frq )
 349 {
 350     ALenum format = (ALenum)*fmt;
 351     ALsizei size = (ALsizei)*sz;
 352     ALsizei freq = (ALsizei)*frq;
 353     ALvoid *data;
 354
 355 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
 356     ALfloat freqf;
 357     data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
 358     freq = (ALsizei)freqf;
 359     if (data == NULL) {
 360         int error = alutGetError();
 361         string msg = "Failed to load wav file: ";
 362         msg.append(alutGetErrorString(error));
 363         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
 364         return false;
 365     }
 366
 367 #else
 368     ALbyte *fname = (ALbyte *)samplepath.c_str();
 369 # if defined (__APPLE__)
 370     alutLoadWAVFile( fname, &format, &data, &size, &freq );
 371 # else
 372     ALboolean loop;
 373     alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
 374 # endif
 375     ALenum error =  alutGetError();
 376     if ( error != ALUT_ERROR_NO_ERROR ) {
 377         string msg = "Failed to load wav file: ";
 378         msg.append(alutGetErrorString(error));
 379         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
 380         return false;
 381     }
 382 #endif
 383
 384     *dbuf = (void *)data;
 385     *fmt = (int)format;
 386     *sz = (unsigned int)size;
 387     *frq = (int)freq;
 388
 389     return true;
 390 }
 391
 392
 393 /**
 394  * set the orientation of the listener (in opengl coordinates)
 395  *
 396  * Description: ORIENTATION is a pair of 3-tuples representing the
 397  * 'at' direction vector and 'up' direction of the Object in
 398  * Cartesian space. AL expects two vectors that are orthogonal to
 399  * each other. These vectors are not expected to be normalized. If
 400  * one or more vectors have zero length, implementation behavior
 401  * is undefined. If the two vectors are linearly dependent,
 402  * behavior is undefined.
 403  */
 404 void SGSoundMgr::set_orientation( SGQuatd ori )
 405 {
 406     SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
 407     SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
 408     for (int i=0; i<3; i++) {
 409        _listener_ori[i] = sgv_at[i];
 410        _listener_ori[i+3] = sgv_up[i];
 411     }
 412     _changed = true;
 413 }
 414
 415
 416 bool SGSoundMgr::testForError(void *p, string s)
 417 {
 418    if (p == NULL) {
 419       SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
 420       return true;
 421    }
 422    return false;
 423 }
 424
 425
 426 bool SGSoundMgr::testForALError(string s)
 427 {
 428     ALenum error = alGetError();
 429     if (error != AL_NO_ERROR)  {
 430        SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
 431                                       << alGetString(error) << " at " << s);
 432        return true;
 433     }
 434     return false;
 435 }
 436
 437 bool SGSoundMgr::testForALCError(string s)
 438 {
 439     ALCenum error;
 440     error = alcGetError(_device);
 441     if (error != ALC_NO_ERROR) {
 442         SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
 443                                        << alcGetString(_device, error) << " at "
 444                                        << s);
 445         return true;
 446     }
 447     return false;
 448 }
 449
 450 bool SGSoundMgr::testForALUTError(string s)
 451 {
 452     ALenum error;
 453     error =  alutGetError ();
 454     if (error != ALUT_ERROR_NO_ERROR) {
 455         SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
 456                                        << alutGetErrorString(error) << " at "
 457                                        << s);
 458         return true;
 459     }
 460     return false;
 461 }