]> git.mxchange.org Git - simgear.git/blobdiff - simgear/sound/soundmgr_openal.cxx
Fix crash in SGSoundMgr::stop(): do not try to erase buffer items one at a time
[simgear.git] / simgear / sound / soundmgr_openal.cxx
index 4ff36eee99597b16640a4432b01278188f1ec7a1..2cba97807b1924f1a38d48df5f250b5d36c02ea0 100644 (file)
@@ -45,6 +45,7 @@
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/math/SGMath.hxx>
 
+extern bool isNaN(float *v);
 
 #define MAX_SOURCES    128
 
@@ -62,10 +63,13 @@ SGSoundMgr::SGSoundMgr() :
     _volume(0.0),
     _device(NULL),
     _context(NULL),
-    _position(SGVec3d::zeros()),
+    _absolute_pos(SGVec3d::zeros()),
+    _offset_pos(SGVec3d::zeros()),
+    _base_pos(SGVec3d::zeros()),
+    _geod_pos(SGGeod::fromCart(SGVec3d::zeros())),
     _velocity(SGVec3d::zeros()),
     _orientation(SGQuatd::zeros()),
-    _devname(NULL)
+    _bad_doppler(false)
 {
 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
     if (_alut_init == 0) {
@@ -92,13 +96,16 @@ SGSoundMgr::~SGSoundMgr() {
 }
 
 // initialize the sound manager
-void SGSoundMgr::init() {
+void SGSoundMgr::init(const char *devname) {
 
     SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
 
-    ALCdevice *device = alcOpenDevice(_devname);
-    if ( testForError(device, "No default audio device available.") ) {
-        return;
+    ALCdevice *device = alcOpenDevice(devname);
+    if ( testForError(device, "Audio device not available, trying default") ) {
+        device = alcOpenDevice(NULL);
+        if (testForError(device, "Default Audio device not available.") ) {
+           return;
+        }
     }
 
     ALCcontext *context = alcCreateContext(device, NULL);
@@ -114,13 +121,15 @@ void SGSoundMgr::init() {
         return;
     }
 
+    if (_context != NULL)
+        SG_LOG(SG_GENERAL, SG_ALERT, "context is already assigned");
     _context = context;
     _working = true;
 
     _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
     _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
 
-    alListenerf( AL_GAIN, 0.2f );
+    alListenerf( AL_GAIN, 0.0f );
     alListenerfv( AL_ORIENTATION, _at_up_vec );
     alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
     alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
@@ -128,11 +137,9 @@ void SGSoundMgr::init() {
     alDopplerFactor(1.0);
     alDopplerVelocity(340.3);   // speed of sound in meters per second.
 
-    if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
-        alDistanceModel(AL_EXPONENT_DISTANCE);
-    } else {
-        alDistanceModel(AL_INVERSE_DISTANCE);
-    }
+    // gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE +
+    //        AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
+    alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
 
     testForALError("listener initialization");
 
@@ -151,55 +158,85 @@ void SGSoundMgr::init() {
         else break;
     }
 
+    string vendor = alGetString(AL_VENDOR);
+    string renderer = alGetString(AL_RENDERER);
+    if ( vendor != "OpenAL Community" ||
+         (renderer != "Software" && renderer != "OpenAL Sample Implementation")
+       )
+    {
+       _bad_doppler = true;
+    }
+
     if (_free_sources.size() == 0) {
         SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
     }
+}
+
+void SGSoundMgr::activate() {
+    if ( _working ) {
+        _active = true;
+        sample_group_map_iterator sample_grp_current = _sample_groups.begin();
+        sample_group_map_iterator sample_grp_end = _sample_groups.end();
+        for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
+            SGSampleGroup *sgrp = sample_grp_current->second;
+            sgrp->activate();
+        }
+    }
+}
 
+// stop the sound manager
+void SGSoundMgr::stop() {
+
+    // first stop all sample groups
     sample_group_map_iterator sample_grp_current = _sample_groups.begin();
     sample_group_map_iterator sample_grp_end = _sample_groups.end();
     for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
         SGSampleGroup *sgrp = sample_grp_current->second;
-        sgrp->activate();
+        sgrp->stop();
     }
-}
 
-// stop the sound manager
-void SGSoundMgr::stop() {
+    // clear all OpenAL sources
+    for (unsigned int i=0; i<_free_sources.size(); i++) {
+        ALuint source = _free_sources[i];
+        alDeleteSources( 1 , &source );
+    }
+    _free_sources.clear();
+
+    // clear any OpenAL buffers before shutting down
+    buffer_map_iterator buffers_current = _buffers.begin();
+    buffer_map_iterator buffers_end = _buffers.end();
+    for ( ; buffers_current != buffers_end; ++buffers_current ) {
+        refUint ref = buffers_current->second;
+        ALuint buffer = ref.id;
+        alDeleteBuffers(1, &buffer);
+    }
+    _buffers.clear();
+
     if (_working) {
         _working = false;
         _active = false;
-
-        // clear any OpenAL buffers before shutting down
-        buffer_map_iterator buffers_current;
-        while(_buffers.size()){
-            buffers_current = _buffers.begin();
-            refUint ref = buffers_current->second;
-            ALuint buffer = ref.id;
-            alDeleteBuffers(1, &buffer);
-            _buffers.erase( buffers_current );
-        }
-
         _context = alcGetCurrentContext();
         _device = alcGetContextsDevice(_context);
         alcDestroyContext(_context);
         alcCloseDevice(_device);
+        _context = NULL;
     }
 }
 
 void SGSoundMgr::suspend() {
-    if (_active) {
+    if (_working) {
         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
         sample_group_map_iterator sample_grp_end = _sample_groups.end();
         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
             SGSampleGroup *sgrp = sample_grp_current->second;
-            sgrp->suspend();
+            sgrp->stop();
         }
         _active = false;
     }
 }
 
 void SGSoundMgr::resume() {
-    if (!_active) {
+    if (_working) {
         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
         sample_group_map_iterator sample_grp_end = _sample_groups.end();
         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
@@ -225,7 +262,7 @@ void SGSoundMgr::unbind ()
 
     // delete free sources
     for (unsigned int i=0; i<_free_sources.size(); i++) {
-        ALuint source = _free_sources.at( i );
+        ALuint source = _free_sources[i];
         alDeleteSources( 1 , &source );
     }
 
@@ -234,8 +271,14 @@ void SGSoundMgr::unbind ()
 }
 
 // run the audio scheduler
-void SGSoundMgr::update_late( double dt ) {
+void SGSoundMgr::update( double dt ) {
     if (_active) {
+        alcSuspendContext(_context);
+
+        if (_changed) {
+            update_pos_and_orientation();
+        }
+
         sample_group_map_iterator sample_grp_current = _sample_groups.begin();
         sample_group_map_iterator sample_grp_end = _sample_groups.end();
         for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
@@ -244,14 +287,32 @@ void SGSoundMgr::update_late( double dt ) {
         }
 
         if (_changed) {
+#if 0
+if (isNaN(_at_up_vec)) printf("NaN in listener orientation\n");
+if (isNaN(toVec3f(_absolute_pos).data())) printf("NaN in listener position\n");
+if (isNaN(_velocity.data())) printf("NaN in listener velocity\n");
+#endif
             alListenerf( AL_GAIN, _volume );
             alListenerfv( AL_ORIENTATION, _at_up_vec );
-            alListenerfv( AL_POSITION, toVec3f(_position).data() );
-            alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
+            // alListenerfv( AL_POSITION, toVec3f(_absolute_pos).data() );
+
+            SGQuatd hlOr = SGQuatd::fromLonLat( _geod_pos );
+            SGVec3d velocity = SGVec3d::zeros();
+            if ( _velocity[0] || _velocity[1] || _velocity[2] ) {
+                velocity = hlOr.backTransform(_velocity*SG_FEET_TO_METER);
+            }
+
+            if ( _bad_doppler ) {
+                velocity *= 100.0f;
+            }
+
+            alListenerfv( AL_VELOCITY, toVec3f(velocity).data() );
             // alDopplerVelocity(340.3);       // TODO: altitude dependent
             testForALError("update");
             _changed = false;
         }
+
+        alcProcessContext(_context);
     }
 }
 
@@ -264,7 +325,7 @@ bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
         return false;
     }
 
-    if (_working) sgrp->activate();
+    if (_active) sgrp->activate();
     _sample_groups[refname] = sgrp;
 
     return true;
@@ -280,7 +341,7 @@ bool SGSoundMgr::remove( const string &refname )
         return false;
     }
 
-    _sample_groups.erase( refname );
+    _sample_groups.erase( sample_grp_it );
 
     return true;
 }
@@ -306,6 +367,7 @@ SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
         // sample group was not found.
         if (create) {
             SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
+            add( sgrp, refname );
             return sgrp;
         }
         else 
@@ -324,32 +386,6 @@ void SGSoundMgr::set_volume( float v )
     _changed = true;
 }
 
-/**
- * set the orientation of the listener (in opengl coordinates)
- *
- * Description: ORIENTATION is a pair of 3-tuples representing the
- * 'at' direction vector and 'up' direction of the Object in
- * Cartesian space. AL expects two vectors that are orthogonal to
- * each other. These vectors are not expected to be normalized. If
- * one or more vectors have zero length, implementation behavior
- * is undefined. If the two vectors are linearly dependent,
- * behavior is undefined.
- */
-void SGSoundMgr::set_orientation( SGQuatd ori )
-{
-    _orientation = ori;
-
-    SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
-    SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
-    _at_up_vec[0] = sgv_at[0];
-    _at_up_vec[1] = sgv_at[1];
-    _at_up_vec[2] = sgv_at[2];
-    _at_up_vec[3] = sgv_up[0];
-    _at_up_vec[4] = sgv_up[1];
-    _at_up_vec[5] = sgv_up[2];
-    _changed = true;
-}
-
 // Get an unused source id
 //
 // The Sound Manager should keep track of the sources in use, the distance
@@ -368,6 +404,8 @@ unsigned int SGSoundMgr::request_source()
        _free_sources.pop_back();
        _sources_in_use.push_back(source);
     }
+    else
+       SG_LOG( SG_GENERAL, SG_INFO, "No more free sources available\n");
 
     return source;
 }
@@ -386,8 +424,9 @@ void SGSoundMgr::release_source( unsigned int source )
             alSourceStop( source );
         testForALError("release source");
 
-        _free_sources.push_back(source);
-        _sources_in_use.erase(it, it+1);
+        alSourcei( source, AL_BUFFER, 0 );
+        _free_sources.push_back( source );
+        _sources_in_use.erase( it );
     }
 }
 
@@ -415,7 +454,7 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
             void *data;
 
             load(sample_name, &data, &format, &size, &freq);
-            sample->set_data( (unsigned char *)data );
+            sample->set_data( &data );
             sample->set_frequency( freq );
             sample->set_format( format );
             sample->set_size( size );
@@ -435,7 +474,7 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
             // If this sample was read from a file we have all the information
             // needed to read it again. For data buffers provided by the
             // program we don't; so don't delete it's data.
-            if (sample->is_file()) sample->free_data();
+            if ( sample->is_file() ) sample->free_data();
 
             if ( !testForALError("buffer add data") ) {
                 sample->set_buffer(buffer);
@@ -443,8 +482,9 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
             }
         }
     }
-    else
+    else {
         buffer = sample->get_buffer();
+}
 
     return buffer;
 }
@@ -452,7 +492,6 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
 void SGSoundMgr::release_buffer(SGSoundSample *sample)
 {
     string sample_name = sample->get_sample_name();
-
     buffer_map_iterator buffer_it = _buffers.find( sample_name );
     if ( buffer_it == _buffers.end() ) {
         // buffer was not found
@@ -463,15 +502,44 @@ void SGSoundMgr::release_buffer(SGSoundSample *sample)
     buffer_it->second.refctr--;
     if (buffer_it->second.refctr == 0) {
         ALuint buffer = buffer_it->second.id;
-        _buffers.erase( buffer_it );
         alDeleteBuffers(1, &buffer);
+        _buffers.erase( buffer_it );
         testForALError("release buffer");
     }
 }
 
+void SGSoundMgr::update_pos_and_orientation() {
+    /**
+     * Description: ORIENTATION is a pair of 3-tuples representing the
+     * 'at' direction vector and 'up' direction of the Object in
+     * Cartesian space. AL expects two vectors that are orthogonal to
+     * each other. These vectors are not expected to be normalized. If
+     * one or more vectors have zero length, implementation behavior
+     * is undefined. If the two vectors are linearly dependent,
+     * behavior is undefined.
+     *
+     * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
+     */
+    SGVec3d sgv_at = _orientation.backTransform(-SGVec3d::e3());
+    SGVec3d sgv_up = _orientation.backTransform(SGVec3d::e2());
+    _at_up_vec[0] = sgv_at[0];
+    _at_up_vec[1] = sgv_at[1];
+    _at_up_vec[2] = sgv_at[2];
+    _at_up_vec[3] = sgv_up[0];
+    _at_up_vec[4] = sgv_up[1];
+    _at_up_vec[5] = sgv_up[2];
+
+    // static const SGQuatd q(-0.5, -0.5, 0.5, 0.5);
+    // SGQuatd hlOr = SGQuatd::fromLonLat(SGGeod::fromCart(_base_pos));
+    // SGQuatd ec2body = hlOr*_orientation;
+    _absolute_pos = _base_pos; // + ec2body.backTransform( _offset_pos );
+}
+
 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
                                           size_t *sz, int *frq )
 {
+    if ( !_working ) return false;
+
     ALenum format;
     ALsizei size;
     ALsizei freq;
@@ -500,7 +568,7 @@ bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
     ALenum error =  alGetError();
     if ( error != AL_NO_ERROR ) {
         string msg = "Failed to load wav file: ";
-        msg.append(alutGetErrorString(error));
+        msg.append(alGetString(error));
         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
         return false;
     }
@@ -514,6 +582,32 @@ bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
     return true;
 }
 
+vector<const char*> SGSoundMgr::get_available_devices()
+{
+    vector<const char*> devices;
+    const ALCchar *s;
+
+    if (alcIsExtensionPresent(NULL, "ALC_enumerate_all_EXT") == AL_TRUE) {
+        s = alcGetString(NULL, ALC_ALL_DEVICES_SPECIFIER);
+    } else {
+        s = alcGetString(NULL, ALC_DEVICE_SPECIFIER);
+    }
+
+    if (s) {
+        ALCchar *nptr, *ptr = (ALCchar *)s;
+
+        nptr = ptr;
+        while (*(nptr += strlen(ptr)+1) != 0)
+        {
+            devices.push_back(ptr);
+            ptr = nptr;
+        }
+        devices.push_back(ptr);
+    }
+
+    return devices;
+}
+
 
 bool SGSoundMgr::testForError(void *p, string s)
 {