]> git.mxchange.org Git - simgear.git/blobdiff - simgear/sound/soundmgr_openal.cxx
Merge branch 'next' of git://gitorious.org/fg/simgear into next
[simgear.git] / simgear / sound / soundmgr_openal.cxx
index ebd3a4b42c1f51b690b98fe03503d72644d01c95..97a1f05c4ff6e9c42606b9911f1a424b7721e0aa 100644 (file)
 #endif
 
 #if defined( __APPLE__ )
-# include <OpenAL/alut.h>
+# include <ALUT/alut.h>
 #else
 # include <AL/alut.h>
 #endif
 
 #include <iostream>
 #include <algorithm>
+#include <cstring>
 
 #include "soundmgr_openal.hxx"
 
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/math/SGMath.hxx>
 
+using std::string;
+using std::vector;
+
 extern bool isNaN(float *v);
 
 #define MAX_SOURCES    128
 
+
+#ifndef ALC_ALL_DEVICES_SPECIFIER
+# define ALC_ALL_DEVICES_SPECIFIER     0x1013
+#endif
+
 //
 // Sound Manager
 //
@@ -69,7 +78,9 @@ SGSoundMgr::SGSoundMgr() :
     _geod_pos(SGGeod::fromCart(SGVec3d::zeros())),
     _velocity(SGVec3d::zeros()),
     _orientation(SGQuatd::zeros()),
-    _devname(NULL)
+    _bad_doppler(false),
+    _renderer("unknown"),
+    _vendor("unknown")
 {
 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
     if (_alut_init == 0) {
@@ -79,6 +90,8 @@ SGSoundMgr::SGSoundMgr() :
         }
     }
     _alut_init++;
+#else
+  //#error ALUT 1.1 required, ALUT 1.0 is no longer supported, please upgrade
 #endif
 }
 
@@ -96,16 +109,21 @@ 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;
+        }
     }
 
+    _device = device;
     ALCcontext *context = alcCreateContext(device, NULL);
+    testForALCError("context creation.");
     if ( testForError(context, "Unable to create a valid context.") ) {
         alcCloseDevice (device);
         return;
@@ -155,6 +173,16 @@ void SGSoundMgr::init() {
         else break;
     }
 
+    _vendor = (const char *)alGetString(AL_VENDOR);
+    _renderer = (const char *)alGetString(AL_RENDERER);
+
+    if (_vendor == "Creative Labs Inc.") {
+       _bad_doppler = true;
+
+    } else if (_vendor == "OpenAL Community" && _renderer == "OpenAL Soft") {
+       _bad_doppler = true;
+    }
+
     if (_free_sources.size() == 0) {
         SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
     }
@@ -174,24 +202,43 @@ void SGSoundMgr::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->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 = _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();
-
         _context = alcGetCurrentContext();
         _device = alcGetContextsDevice(_context);
         alcDestroyContext(_context);
         alcCloseDevice(_device);
+        _context = NULL;
+
+        _renderer = "unknown";
+        _vendor = "unknown";
     }
 }
 
@@ -201,7 +248,7 @@ void SGSoundMgr::suspend() {
         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;
     }
@@ -245,6 +292,8 @@ void SGSoundMgr::unbind ()
 // run the audio scheduler
 void SGSoundMgr::update( double dt ) {
     if (_active) {
+        alcSuspendContext(_context);
+
         if (_changed) {
             update_pos_and_orientation();
         }
@@ -271,11 +320,18 @@ if (isNaN(_velocity.data())) printf("NaN in listener velocity\n");
             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);
     }
 }
 
@@ -383,11 +439,12 @@ void SGSoundMgr::release_source( unsigned int source )
         ALint result;
 
         alGetSourcei( source, AL_SOURCE_STATE, &result );
-        if ( result == AL_PLAYING )
+        if ( result == AL_PLAYING ) {
             alSourceStop( source );
-        testForALError("release source");
+        }
 
-        alSourcei( source, AL_BUFFER, 0 );
+        alSourcei( source, AL_BUFFER, 0 );     // detach the associated buffer
+        testForALError("release_source");
         _free_sources.push_back( source );
         _sources_in_use.erase( it );
     }
@@ -400,6 +457,7 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
     if ( !sample->is_valid_buffer() ) {
         // sample was not yet loaded or removed again
         string sample_name = sample->get_sample_name();
+        void *sample_data = NULL;
 
         // see if the sample name is already cached
         buffer_map_iterator buffer_it = _buffers.find( sample_name );
@@ -412,15 +470,24 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
 
         // sample name was not found in the buffer cache.
         if ( sample->is_file() ) {
-            size_t size;
             int freq, format;
-            void *data;
+            size_t size;
 
-            load(sample_name, &data, &format, &size, &freq);
-            sample->set_data( &data );
+            try {
+              bool res = load(sample_name, &sample_data, &format, &size, &freq);
+              if (res == false) return NO_BUFFER;
+            } catch (sg_exception& e) {
+              SG_LOG(SG_GENERAL, SG_ALERT,
+                     "failed to load sound buffer:" << e.getFormattedMessage());
+              return NO_BUFFER;
+            }
+            
             sample->set_frequency( freq );
             sample->set_format( format );
             sample->set_size( size );
+
+        } else {
+            sample_data = sample->get_data();
         }
 
         // create an OpenAL buffer handle
@@ -428,46 +495,45 @@ unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
         if ( !testForALError("generate buffer") ) {
             // Copy data to the internal OpenAL buffer
 
-            const ALvoid *data = sample->get_data();
             ALenum format = sample->get_format();
             ALsizei size = sample->get_size();
             ALsizei freq = sample->get_frequency();
-            alBufferData( buffer, format, data, size, freq );
-
-            // 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();
+            alBufferData( buffer, format, sample_data, size, freq );
 
             if ( !testForALError("buffer add data") ) {
                 sample->set_buffer(buffer);
                 _buffers[sample_name] = refUint(buffer);
             }
         }
+
+        if ( sample->is_file() ) free(sample_data);
     }
     else {
         buffer = sample->get_buffer();
-}
+    }
 
     return buffer;
 }
 
 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
-        return;
-    }
+    if ( !sample->is_queue() )
+    {
+        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
+            return;
+        }
 
-    sample->no_valid_buffer();
-    buffer_it->second.refctr--;
-    if (buffer_it->second.refctr == 0) {
-        ALuint buffer = buffer_it->second.id;
-        alDeleteBuffers(1, &buffer);
-        _buffers.erase( buffer_it );
-        testForALError("release buffer");
+        sample->no_valid_buffer();
+        buffer_it->second.refctr--;
+        if (buffer_it->second.refctr == 0) {
+            ALuint buffer = buffer_it->second.id;
+            alDeleteBuffers(1, &buffer);
+            _buffers.erase( buffer_it );
+            testForALError("release buffer");
+        }
     }
 }
 
@@ -492,10 +558,7 @@ void SGSoundMgr::update_pos_and_orientation() {
     _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 );
+    _absolute_pos = _base_pos;
 }
 
 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
@@ -510,12 +573,15 @@ bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
 
 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
     ALfloat freqf;
+    // ignore previous errors to prevent the system from halting on silly errors
+    alGetError();
+    alcGetError(_device);
     data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
     freq = (ALsizei)freqf;
-    if (data == NULL) {
-        int error = alutGetError();
+    int error = alutGetError();
+    if (data == NULL || error != ALUT_ERROR_NO_ERROR) {
         string msg = "Failed to load wav file: ";
-        msg.append(alutGetErrorString(error));
+         msg.append(alutGetErrorString(error));
         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
         return false;
     }
@@ -531,12 +597,27 @@ 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(alGetString(error));
+        const ALchar *errorString = alGetString(error);
+        if (errorString) {
+            msg.append(errorString);
+        } else {
+            // alGetString returns NULL when an unexpected or OS specific error
+            // occurs: e.g. -43 on Mac when file is not found.
+            // In this case, alGetString() sets 'Invalid Enum' error, so
+            // showing with the original error number is helpful.
+            stringstream ss;
+            ss << alGetString(alGetError()) << "(" << error << ")";
+            msg.append(ss.str());
+        }
         throw sg_io_exception(msg.c_str(), sg_location(samplepath));
         return false;
     }
 #endif
 
+    if (format == AL_FORMAT_STEREO8 || format == AL_FORMAT_STEREO16) {
+        throw sg_io_exception("Warning: STEREO files are not supported for 3D audio effects: " + samplepath);
+    }
+
     *dbuf = (void *)data;
     *fmt = (int)format;
     *sz = (size_t)size;
@@ -545,6 +626,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)
 {