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