SoundStream / Music Fixes

 * Fixed SoundStreamAL buffer re-use
 * Abstracted private SoundStreamAL functions
 * Added music to music_list.h
 * Moved AL_ERROR_CHECK to /thirdparty/OpenAL.h
 * Added AL_ERROR_SILENCE

Author: BrentDaMage

platforms/openal/SoundStreamAL.cpp

@@ -1,12 +1,13 @@
 #include "SoundStreamAL.hpp"
 #include <assert.h>
+#include "common/Logger.hpp"
 
 SoundStreamAL::SoundStreamAL()
 {
     _decoder = nullptr;
     _info = stb_vorbis_info();
-    alGenSources(1, &_source);
-    alGenBuffers(2, _buffers);
+    _createSource();
+    _createBuffers();
     _tempPcmBufferSize = 4096 * 8;
     _tempPcmBuffer = new int16_t[_tempPcmBufferSize];
     _alFormat = AL_NONE;
@@ -20,9 +21,9 @@ SoundStreamAL::SoundStreamAL()
 
 SoundStreamAL::~SoundStreamAL()
 {
-    alDeleteSources(1, &_source);
-    alDeleteBuffers(2, _buffers);
-    close();
+    _deleteSource();
+    _deleteBuffers();
+    _deleteDecoder();
     delete[] _tempPcmBuffer;
 }
 
@@ -41,18 +42,67 @@ bool SoundStreamAL::_stream(uint32_t buffer)
     if (size == 0) return false;
 
     alBufferData(buffer, _alFormat, _tempPcmBuffer, size * sizeof(int16_t), _info.sample_rate);
+    AL_ERROR_CHECK();
     _totalSamplesLeft -= size;
 
     return true;
 }
 
+void SoundStreamAL::_deleteSource()
+{
+    alDeleteSources(1, &_source);
+    AL_ERROR_CHECK();
+}
+
+void SoundStreamAL::_createSource()
+{
+    alGenSources(1, &_source);
+}
+
+void SoundStreamAL::_resetSource()
+{
+    alSourceStop(_source);
+    AL_ERROR_CHECK();
+    alSourceRewind(_source);
+    AL_ERROR_CHECK();
+    // Detach all of the buffers from the source
+    alSourcei(_source, AL_BUFFER, 0);
+    AL_ERROR_CHECK();
+}
+
+void SoundStreamAL::_deleteBuffers()
+{
+    alDeleteBuffers(2, _buffers);
+    AL_ERROR_CHECK();
+}
+
+void SoundStreamAL::_createBuffers()
+{
+    alGenBuffers(2, _buffers);
+}
+
+void SoundStreamAL::_resetBuffers()
+{
+    _deleteBuffers();
+    _createBuffers();
+}
+
+void SoundStreamAL::_deleteDecoder()
+{
+    if (_decoder != nullptr)
+        stb_vorbis_close(_decoder);
+    _decoder = nullptr;
+}
+
 bool SoundStreamAL::open(const std::string& fileName)
 {
     if (isStreaming())
     {
         close();
     }
 
+    _isPaused = false;
+
     _decoder = stb_vorbis_open_filename(fileName.c_str(), NULL, NULL);
     if (!_decoder) return false;
     // Get file info
@@ -63,7 +113,9 @@ bool SoundStreamAL::open(const std::string& fileName)
     if (!_stream(_buffers[0])) return false;
     if (!_stream(_buffers[1])) return false;
     alSourceQueueBuffers(_source, 2, _buffers);
+    AL_ERROR_CHECK();
     alSourcePlay(_source);
+    AL_ERROR_CHECK();
 
     _totalSamplesLeft = stb_vorbis_stream_length_in_samples(_decoder) * _info.channels;
     _isStreaming = true;
@@ -73,11 +125,9 @@ bool SoundStreamAL::open(const std::string& fileName)
 
 void SoundStreamAL::close()
 {
-    alSourceStop(_source);
-    alSourceRewind(_source);
-    if (_decoder != nullptr)
-        stb_vorbis_close(_decoder);
-    _decoder = nullptr;
+    _resetSource();
+    //_resetBuffers();
+    _deleteDecoder();
     _alFormat = AL_NONE;
     _totalSamplesLeft = 0;
     _isStreaming = false;
@@ -90,12 +140,14 @@ void SoundStreamAL::update()
     int32_t processed = 0;
 
     alGetSourcei(_source, AL_BUFFERS_PROCESSED, &processed);
+    AL_ERROR_CHECK();
 
     while (processed--)
     {
         uint32_t buffer = 0;
 
         alSourceUnqueueBuffers(_source, 1, &buffer);
+        AL_ERROR_CHECK();
 
         if (!_stream(buffer))
         {
@@ -115,11 +167,12 @@ void SoundStreamAL::update()
             }
         }
         alSourceQueueBuffers(_source, 1, &buffer);
+        AL_ERROR_CHECK();
     }
 }
 
 void SoundStreamAL::setVolume(float vol)
 {
     alSourcef(_source, AL_GAIN, vol);
-    assert(alGetError() == AL_NO_ERROR);
+    AL_ERROR_CHECK();
 }

platforms/openal/SoundStreamAL.hpp

@@ -33,6 +33,16 @@ class SoundStreamAL : public SoundStream
 private:
     bool _stream(uint32_t buffer);
 
+    void _deleteSource();
+    void _createSource();
+    void _resetSource();
+
+    void _deleteBuffers();
+    void _createBuffers();
+    void _resetBuffers();
+
+    void _deleteDecoder();
+
 public:
     bool isStreaming() const override { return _isStreaming; }
     bool isPaused() const override { return _isPaused; }

platforms/openal/SoundSystemAL.cpp

@@ -23,18 +23,6 @@ SoundSystemAL::~SoundSystemAL()
     stopEngine();
 }
 
-// Error Checking
-#define AL_ERROR_CHECK() AL_ERROR_CHECK_MANUAL(alGetError())
-#define AL_ERROR_CHECK_MANUAL(val) \
-	{ \
-		ALenum __err = val; \
-		if (__err != AL_NO_ERROR) \
-		{ \
-			LOG_E("(%s:%i) OpenAL Error: %s", __FILE__, __LINE__, alGetString(__err)); \
-			assert(!"An OpenAL error occurred!"); \
-		} \
-	}
-
 bool SoundSystemAL::_hasMaxSources() const
 {
 	return _sources.size() + _sources_idle.size() >= SOUND_MAX_SOURCES;

source/client/sound/music_list.h

@@ -3,4 +3,10 @@ MUSIC(calm, 2)
 MUSIC(calm, 3)
 MUSIC(piano, 1)
 MUSIC(piano, 2)
-MUSIC(piano, 3)
+MUSIC(piano, 3)
+MUSIC(hal, 1)
+MUSIC(hal, 2)
+MUSIC(hal, 3)
+MUSIC(hal, 4)
+MUSIC(nuance, 1)
+MUSIC(nuance, 2)

thirdparty/OpenAL.h

@@ -8,4 +8,17 @@
 #else
 #include <AL/al.h>
 #include <AL/alc.h>
-#endif
+#endif
+
+// Error Checking
+#define AL_ERROR_CHECK() AL_ERROR_CHECK_MANUAL(alGetError())
+#define AL_ERROR_CHECK_MANUAL(val) \
+	{ \
+		ALenum __err = val; \
+		if (__err != AL_NO_ERROR) \
+		{ \
+			LOG_E("(%s:%i) OpenAL Error: %s", __FILE__, __LINE__, alGetString(__err)); \
+			assert(!"An OpenAL error occurred!"); \
+		} \
+	}
+#define AL_ERROR_SILENCE() { while ( alGetError() ); }