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 // 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 #ifdef HAVE_CONFIG_H
  29 #  include <simgear_config.h>
  30 #endif
  31
  32 #if defined( __APPLE__ )
  33 # include <OpenAL/alut.h>
  34 #else
  35 # include <AL/alut.h>
  36 #endif
  37
  38 #include <iostream>
  39 #include <algorithm>
  40
  41 #include "soundmgr_openal.hxx"
  42
  43 #include <simgear/structure/exception.hxx>
  44 #include <simgear/debug/logstream.hxx>
  45 #include <simgear/misc/sg_path.hxx>
  46 #include <simgear/math/SGMath.hxx>
  47
  48
  49 #define MAX_SOURCES     128
  50
  51 //
  52 // Sound Manager
  53 //
  54
  55 int SGSoundMgr::_alut_init = 0;
  56
  57 // constructor
  58 SGSoundMgr::SGSoundMgr() :
  59     _working(false),
  60     _active(false),
  61     _changed(true),
  62     _volume(0.0),
  63     _device(NULL),
  64     _context(NULL),
  65     _position(SGVec3d::zeros()),
  66     _velocity(SGVec3d::zeros()),
  67     _orientation(SGQuatd::zeros()),
  68     _devname(NULL)
  69 {
  70 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
  71     if (_alut_init == 0) {
  72         if ( !alutInitWithoutContext(NULL, NULL) ) {
  73             testForALUTError("alut initialization");
  74             return;
  75         }
  76     }
  77     _alut_init++;
  78 #endif
  79 }
  80
  81 // destructor
  82
  83 SGSoundMgr::~SGSoundMgr() {
  84
  85     stop();
  86 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
  87     _alut_init--;
  88     if (_alut_init == 0) {
  89         alutExit ();
  90     }
  91 #endif
  92 }
  93
  94 // initialize the sound manager
  95 void SGSoundMgr::init() {
  96
  97     SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
  98
  99     ALCdevice *device = alcOpenDevice(_devname);
 100     if ( testForError(device, "No default audio device available.") ) {
 101         return;
 102     }
 103
 104     ALCcontext *context = alcCreateContext(device, NULL);
 105     if ( testForError(context, "Unable to create a valid context.") ) {
 106         alcCloseDevice (device);
 107         return;
 108     }
 109
 110     if ( !alcMakeContextCurrent(context) ) {
 111         testForALCError("context initialization");
 112         alcDestroyContext (context);
 113         alcCloseDevice (device);
 114         return;
 115     }
 116
 117     if (_context != NULL)
 118         SG_LOG(SG_GENERAL, SG_ALERT, "context is already assigned");
 119     _context = context;
 120     _working = true;
 121
 122     _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
 123     _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
 124
 125     alListenerf( AL_GAIN, 0.0f );
 126     alListenerfv( AL_ORIENTATION, _at_up_vec );
 127     alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
 128     alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
 129
 130     alDopplerFactor(1.0);
 131     alDopplerVelocity(340.3);   // speed of sound in meters per second.
 132
 133     if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
 134         alDistanceModel(AL_EXPONENT_DISTANCE);
 135     } else {
 136         alDistanceModel(AL_INVERSE_DISTANCE);
 137     }
 138
 139     testForALError("listener initialization");
 140
 141     // get a free source one at a time
 142     // if an error is returned no more (hardware) sources are available
 143     for (unsigned int i=0; i<MAX_SOURCES; i++) {
 144         ALuint source;
 145         ALenum error;
 146
 147         alGetError();
 148         alGenSources(1, &source);
 149         error = alGetError();
 150         if ( error == AL_NO_ERROR ) {
 151             _free_sources.push_back( source );
 152         }
 153         else break;
 154     }
 155
 156     if (_free_sources.size() == 0) {
 157         SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
 158     }
 159 }
 160
 161 void SGSoundMgr::activate() {
 162     if ( _working ) {
 163         _active = true;
 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->activate();
 169         }
 170     }
 171 }
 172
 173 // stop the sound manager
 174 void SGSoundMgr::stop() {
 175     if (_working) {
 176         _working = false;
 177         _active = false;
 178
 179         // clear any OpenAL buffers before shutting down
 180         buffer_map_iterator buffers_current = _buffers.begin();
 181         buffer_map_iterator buffers_end = _buffers.end();
 182         for ( ; buffers_current != buffers_end; ++buffers_current ) {
 183             refUint ref = buffers_current->second;
 184             ALuint buffer = ref.id;
 185             alDeleteBuffers(1, &buffer);
 186         }
 187         _buffers.clear();
 188
 189         _context = alcGetCurrentContext();
 190         _device = alcGetContextsDevice(_context);
 191         alcDestroyContext(_context);
 192         alcCloseDevice(_device);
 193     }
 194 }
 195
 196 void SGSoundMgr::suspend() {
 197     if (_working) {
 198         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 199         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 200         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 201             SGSampleGroup *sgrp = sample_grp_current->second;
 202             sgrp->suspend();
 203         }
 204         _active = false;
 205     }
 206 }
 207
 208 void SGSoundMgr::resume() {
 209     if (_working) {
 210         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 211         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 212         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 213             SGSampleGroup *sgrp = sample_grp_current->second;
 214             sgrp->resume();
 215         }
 216         _active = true;
 217     }
 218 }
 219
 220 void SGSoundMgr::bind ()
 221 {
 222     _free_sources.clear();
 223     _free_sources.reserve( MAX_SOURCES );
 224     _sources_in_use.clear();
 225     _sources_in_use.reserve( MAX_SOURCES );
 226 }
 227
 228
 229 void SGSoundMgr::unbind ()
 230 {
 231     _sample_groups.clear();
 232
 233     // delete free sources
 234     for (unsigned int i=0; i<_free_sources.size(); i++) {
 235         ALuint source = _free_sources[i];
 236         alDeleteSources( 1 , &source );
 237     }
 238
 239     _free_sources.clear();
 240     _sources_in_use.clear();
 241 }
 242
 243 // run the audio scheduler
 244 void SGSoundMgr::update_late( double dt ) {
 245     if (_active) {
 246         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
 247         sample_group_map_iterator sample_grp_end = _sample_groups.end();
 248         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
 249             SGSampleGroup *sgrp = sample_grp_current->second;
 250             sgrp->update(dt);
 251         }
 252
 253         if (_changed) {
 254             alListenerf( AL_GAIN, _volume );
 255 #if 0
 256             alListenerfv( AL_ORIENTATION, _at_up_vec );
 257 #endif
 258 double *pos = _position.data();
 259 if (isnan(pos[0]) || isnan(pos[1]) || isnan(pos[2])) printf("NaN detected in listener position\n");
 260             alListenerfv( AL_POSITION, toVec3f(_position).data() );
 261
 262 double *vel = _velocity.data();
 263 if (isnan(vel[0]) || isnan(vel[1]) || isnan(vel[2])) printf("NaN detected in listener velocity\n");
 264             alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
 265             // alDopplerVelocity(340.3);        // TODO: altitude dependent
 266             testForALError("update");
 267             _changed = false;
 268         }
 269     }
 270 }
 271
 272 // add a sample group, return true if successful
 273 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
 274 {
 275     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 276     if ( sample_grp_it != _sample_groups.end() ) {
 277         // sample group already exists
 278         return false;
 279     }
 280
 281     if (_active) sgrp->activate();
 282     _sample_groups[refname] = sgrp;
 283
 284     return true;
 285 }
 286
 287
 288 // remove a sound effect, return true if successful
 289 bool SGSoundMgr::remove( const string &refname )
 290 {
 291     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 292     if ( sample_grp_it == _sample_groups.end() ) {
 293         // sample group was not found.
 294         return false;
 295     }
 296
 297     _sample_groups.erase( sample_grp_it );
 298
 299     return true;
 300 }
 301
 302
 303 // return true of the specified sound exists in the sound manager system
 304 bool SGSoundMgr::exists( const string &refname ) {
 305     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 306     if ( sample_grp_it == _sample_groups.end() ) {
 307         // sample group was not found.
 308         return false;
 309     }
 310
 311     return true;
 312 }
 313
 314
 315 // return a pointer to the SGSampleGroup if the specified sound exists
 316 // in the sound manager system, otherwise return NULL
 317 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
 318     sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
 319     if ( sample_grp_it == _sample_groups.end() ) {
 320         // sample group was not found.
 321         if (create) {
 322             SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
 323             return sgrp;
 324         }
 325         else
 326             return NULL;
 327     }
 328
 329     return sample_grp_it->second;
 330 }
 331
 332
 333 void SGSoundMgr::set_volume( float v )
 334 {
 335     _volume = v;
 336     if (_volume > 1.0) _volume = 1.0;
 337     if (_volume < 0.0) _volume = 0.0;
 338     _changed = true;
 339 }
 340
 341 /**
 342  * set the orientation of the listener (in opengl coordinates)
 343  *
 344  * Description: ORIENTATION is a pair of 3-tuples representing the
 345  * 'at' direction vector and 'up' direction of the Object in
 346  * Cartesian space. AL expects two vectors that are orthogonal to
 347  * each other. These vectors are not expected to be normalized. If
 348  * one or more vectors have zero length, implementation behavior
 349  * is undefined. If the two vectors are linearly dependent,
 350  * behavior is undefined.
 351  */
 352 void SGSoundMgr::set_orientation( SGQuatd ori )
 353 {
 354     _orientation = ori;
 355
 356     SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
 357     SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
 358     _at_up_vec[0] = sgv_at[0];
 359     _at_up_vec[1] = sgv_at[1];
 360     _at_up_vec[2] = sgv_at[2];
 361     _at_up_vec[3] = sgv_up[0];
 362     _at_up_vec[4] = sgv_up[1];
 363     _at_up_vec[5] = sgv_up[2];
 364     _changed = true;
 365 }
 366
 367 // Get an unused source id
 368 //
 369 // The Sound Manager should keep track of the sources in use, the distance
 370 // of these sources to the listener and the volume (also based on audio cone
 371 // and hence orientation) of the sources.
 372 //
 373 // The Sound Manager is (and should be) the only one knowing about source
 374 // management. Sources further away should be suspendped to free resources for
 375 // newly added sounds close by.
 376 unsigned int SGSoundMgr::request_source()
 377 {
 378     unsigned int source = NO_SOURCE;
 379
 380     if (_free_sources.size() > 0) {
 381        source = _free_sources.back();
 382        _free_sources.pop_back();
 383        _sources_in_use.push_back(source);
 384     }
 385     else
 386        SG_LOG( SG_GENERAL, SG_INFO, "No more free sources available\n");
 387
 388     return source;
 389 }
 390
 391 // Free up a source id for further use
 392 void SGSoundMgr::release_source( unsigned int source )
 393 {
 394     vector<ALuint>::iterator it;
 395
 396     it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
 397     if ( it != _sources_in_use.end() ) {
 398         ALint result;
 399
 400         alGetSourcei( source, AL_SOURCE_STATE, &result );
 401         if ( result == AL_PLAYING )
 402             alSourceStop( source );
 403         testForALError("release source");
 404
 405         alSourcei( source, AL_BUFFER, 0 );
 406         _free_sources.push_back( source );
 407         _sources_in_use.erase( it );
 408     }
 409 }
 410
 411 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
 412 {
 413     ALuint buffer = NO_BUFFER;
 414
 415     if ( !sample->is_valid_buffer() ) {
 416         // sample was not yet loaded or removed again
 417         string sample_name = sample->get_sample_name();
 418
 419         // see if the sample name is already cached
 420         buffer_map_iterator buffer_it = _buffers.find( sample_name );
 421         if ( buffer_it != _buffers.end() ) {
 422             buffer_it->second.refctr++;
 423             buffer = buffer_it->second.id;
 424             sample->set_buffer( buffer );
 425             return buffer;
 426         }
 427
 428         // sample name was not found in the buffer cache.
 429         if ( sample->is_file() ) {
 430             size_t size;
 431             int freq, format;
 432             void *data;
 433
 434             load(sample_name, &data, &format, &size, &freq);
 435             sample->set_data( &data );
 436             sample->set_frequency( freq );
 437             sample->set_format( format );
 438             sample->set_size( size );
 439         }
 440
 441         // create an OpenAL buffer handle
 442         alGenBuffers(1, &buffer);
 443         if ( !testForALError("generate buffer") ) {
 444             // Copy data to the internal OpenAL buffer
 445
 446             const ALvoid *data = sample->get_data();
 447             ALenum format = sample->get_format();
 448             ALsizei size = sample->get_size();
 449             ALsizei freq = sample->get_frequency();
 450             alBufferData( buffer, format, data, size, freq );
 451
 452             // If this sample was read from a file we have all the information
 453             // needed to read it again. For data buffers provided by the
 454             // program we don't; so don't delete it's data.
 455             if ( sample->is_file() ) sample->free_data();
 456
 457             if ( !testForALError("buffer add data") ) {
 458                 sample->set_buffer(buffer);
 459                 _buffers[sample_name] = refUint(buffer);
 460             }
 461         }
 462     }
 463     else {
 464         buffer = sample->get_buffer();
 465 }
 466
 467     return buffer;
 468 }
 469
 470 void SGSoundMgr::release_buffer(SGSoundSample *sample)
 471 {
 472     string sample_name = sample->get_sample_name();
 473     buffer_map_iterator buffer_it = _buffers.find( sample_name );
 474     if ( buffer_it == _buffers.end() ) {
 475         // buffer was not found
 476         return;
 477     }
 478
 479     sample->no_valid_buffer();
 480     buffer_it->second.refctr--;
 481     if (buffer_it->second.refctr == 0) {
 482         ALuint buffer = buffer_it->second.id;
 483         alDeleteBuffers(1, &buffer);
 484         _buffers.erase( buffer_it );
 485         testForALError("release buffer");
 486     }
 487 }
 488
 489 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
 490                                           size_t *sz, int *frq )
 491 {
 492     if ( !_working ) return false;
 493
 494     ALenum format;
 495     ALsizei size;
 496     ALsizei freq;
 497     ALvoid *data;
 498
 499 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
 500     ALfloat freqf;
 501     data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
 502     freq = (ALsizei)freqf;
 503     if (data == NULL) {
 504         int error = alutGetError();
 505         string msg = "Failed to load wav file: ";
 506         msg.append(alutGetErrorString(error));
 507         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
 508         return false;
 509     }
 510
 511 #else
 512     ALbyte *fname = (ALbyte *)samplepath.c_str();
 513 # if defined (__APPLE__)
 514     alutLoadWAVFile( fname, &format, &data, &size, &freq );
 515 # else
 516     ALboolean loop;
 517     alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
 518 # endif
 519     ALenum error =  alGetError();
 520     if ( error != AL_NO_ERROR ) {
 521         string msg = "Failed to load wav file: ";
 522         msg.append(alGetString(error));
 523         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
 524         return false;
 525     }
 526 #endif
 527
 528     *dbuf = (void *)data;
 529     *fmt = (int)format;
 530     *sz = (size_t)size;
 531     *frq = (int)freq;
 532
 533     return true;
 534 }
 535
 536
 537 bool SGSoundMgr::testForError(void *p, string s)
 538 {
 539    if (p == NULL) {
 540       SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
 541       return true;
 542    }
 543    return false;
 544 }
 545
 546
 547 bool SGSoundMgr::testForALError(string s)
 548 {
 549     ALenum error = alGetError();
 550     if (error != AL_NO_ERROR)  {
 551        SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
 552                                       << alGetString(error) << " at " << s);
 553        return true;
 554     }
 555     return false;
 556 }
 557
 558 bool SGSoundMgr::testForALCError(string s)
 559 {
 560     ALCenum error;
 561     error = alcGetError(_device);
 562     if (error != ALC_NO_ERROR) {
 563         SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
 564                                        << alcGetString(_device, error) << " at "
 565                                        << s);
 566         return true;
 567     }
 568     return false;
 569 }
 570
 571 bool SGSoundMgr::testForALUTError(string s)
 572 {
 573 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
 574     ALenum error;
 575     error =  alutGetError ();
 576     if (error != ALUT_ERROR_NO_ERROR) {
 577         SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
 578                                        << alutGetErrorString(error) << " at "
 579                                        << s);
 580         return true;
 581     }
 582 #endif
 583     return false;
 584 }