Sound interface now abstract

include/Sound.h

@@ -9,8 +9,6 @@
 #ifndef _SOUND_H_
 #define _SOUND_H_
 
-#include <vector>
-
 /*!
  * \brief This is the audio manager for OpenRaider
  */
@@ -23,53 +21,48 @@ public:
     } SoundFlags;
 
     /*!
-     * \brief Constructs an object of Sound
-     */
-    Sound();
-
-    /*!
      * \brief Deconstructs an object of Sound
      */
-    ~Sound();
+    virtual ~Sound();
 
     /*!
      * \brief Initialize sound system
      * \returns 0 on success or < 0 error flags
      */
-    int initialize();
+    virtual int initialize() = 0;
 
-    void setEnabled(bool on);
+    virtual void setEnabled(bool on) = 0;
 
     /*!
      * \brief Set the volume
      * \param vol new source gain
      */
-    void setVolume(float vol);
+    virtual void setVolume(float vol) = 0;
 
     /*!
      * \brief Get number of registered sources
      * \returns number of registered sources
      */
-    int registeredSources();
+    virtual int registeredSources() = 0;
 
     /*!
      * \brief Remove all loaded sounds
      */
-    void clear();
+    virtual void clear() = 0;
 
     /*!
      * \brief Move listener and repositions them
      * \param pos New position for listener
      * \param angle New orientation for listener
      */
-    void listenAt(float pos[3], float angle[3]);
+    virtual void listenAt(float pos[3], float angle[3]) = 0;
 
     /*!
      * \brief Move sound source to position
      * \param source valid source id
      * \param pos new position for source
      */
-    void sourceAt(int source, float pos[3]);
+    virtual void sourceAt(int source, float pos[3]) = 0;
 
     /*!
      * \brief Load wav file from disk
@@ -78,7 +71,7 @@ public:
      * \param flags set options. Use SoundFlags enum bitwise OR-ed
      * \returns 0 for no error or < 0 error flag
      */
-    int addFile(const char *filename, int *source, unsigned int flags);
+    virtual int addFile(const char *filename, int *source, unsigned int flags) = 0;
 
     /*!
      * \brief Load wav file from buffer
@@ -88,27 +81,21 @@ public:
      * \param flags set options. Use SoundFlags enum bitwise OR-ed
      * \returns 0 for no error or < 0 error flag
      */
-    int addWave(unsigned char *wav, unsigned int length, int *source, unsigned int flags);
+    virtual int addWave(unsigned char *wav, unsigned int length, int *source, unsigned int flags) = 0;
 
     /*!
      * \brief Play sound source
      * \param source sound source to play
      */
-    void play(int source);
+    virtual void play(int source) = 0;
 
     /*!
      * \brief Stop playing sound source
      * \param source sound source to stop
      */
-    void stop(int source);
+    virtual void stop(int source) = 0;
 
 private:
-
-    bool mEnabled;
-    bool mInit;                        //!< Guard to ensure ausio system is active
-    float mVolume;                     //!< Listener gain
-    std::vector<unsigned int> mBuffer; //!< Audio buffer id list
-    std::vector<unsigned int> mSource; //!< Audio source id list
 };
 
 #endif

include/SoundAL.h

@@ -0,0 +1,112 @@
+/*!
+ * \file include/SoundAL.h
+ * \brief This is the OpenAL audio manager Header
+ *
+ * \author Mongoose
+ * \author xythobuz
+ */
+
+#ifndef _SOUND_AL_H_
+#define _SOUND_AL_H_
+
+#include <vector>
+
+#include "Sound.h"
+
+/*!
+ * \brief This is the OpenAL audio manager
+ */
+class SoundAL : public Sound {
+public:
+
+    /*!
+     * \brief Constructs an object of SoundAL
+     */
+    SoundAL();
+
+    /*!
+     * \brief Deconstructs an object of SoundAL
+     */
+    virtual ~SoundAL();
+
+    /*!
+     * \brief Initialize sound system
+     * \returns 0 on success or < 0 error flags
+     */
+    virtual int initialize();
+
+    virtual void setEnabled(bool on);
+
+    /*!
+     * \brief Set the volume
+     * \param vol new source gain
+     */
+    virtual void setVolume(float vol);
+
+    /*!
+     * \brief Get number of registered sources
+     * \returns number of registered sources
+     */
+    virtual int registeredSources();
+
+    /*!
+     * \brief Remove all loaded sounds
+     */
+    virtual void clear();
+
+    /*!
+     * \brief Move listener and repositions them
+     * \param pos New position for listener
+     * \param angle New orientation for listener
+     */
+    virtual void listenAt(float pos[3], float angle[3]);
+
+    /*!
+     * \brief Move sound source to position
+     * \param source valid source id
+     * \param pos new position for source
+     */
+    virtual void sourceAt(int source, float pos[3]);
+
+    /*!
+     * \brief Load wav file from disk
+     * \param filename not NULL!
+     * \param source not NULL! Returns new source ID or -1 on error.
+     * \param flags set options. Use SoundFlags enum bitwise OR-ed
+     * \returns 0 for no error or < 0 error flag
+     */
+    virtual int addFile(const char *filename, int *source, unsigned int flags);
+
+    /*!
+     * \brief Load wav file from buffer
+     * \param wav not NULL! Is a valid waveform buffer!
+     * \param length length of wav buffer
+     * \param source not NULL! Returns new source ID or -1 on error.
+     * \param flags set options. Use SoundFlags enum bitwise OR-ed
+     * \returns 0 for no error or < 0 error flag
+     */
+    virtual int addWave(unsigned char *wav, unsigned int length, int *source, unsigned int flags);
+
+    /*!
+     * \brief Play sound source
+     * \param source sound source to play
+     */
+    virtual void play(int source);
+
+    /*!
+     * \brief Stop playing sound source
+     * \param source sound source to stop
+     */
+    virtual void stop(int source);
+
+private:
+
+    bool mEnabled;
+    bool mInit;                        //!< Guard to ensure ausio system is active
+    float mVolume;                     //!< Listener gain
+    std::vector<unsigned int> mBuffer; //!< Audio buffer id list
+    std::vector<unsigned int> mSource; //!< Audio source id list
+};
+
+#endif
+

src/CMakeLists.txt

@@ -14,12 +14,12 @@ include_directories (SYSTEM ${OPENGL_INCLUDE_DIRS})
 set (LIBS ${LIBS} ${OPENGL_LIBRARIES})
 
 # Add OpenAL Library
-find_package (OpenAL REQUIRED)
+find_package (OpenAL)
 include_directories (SYSTEM ${OPENAL_INCLUDE_DIRS})
 set (LIBS ${LIBS} ${OPENAL_LIBRARIES})
 
 # Add ALUT Library
-find_package (ALUT REQUIRED)
+find_package (ALUT)
 include_directories (SYSTEM ${ALUT_INCLUDE_DIRS})
 set (LIBS ${LIBS} ${ALUT_LIBRARIES})
 
@@ -49,6 +49,14 @@ set (SRCS ${SRCS} "ViewVolume.cpp")
 set (SRCS ${SRCS} "Window.cpp")
 set (SRCS ${SRCS} "World.cpp")
 
+# Select available Sound library
+if (OPENAL_FOUND AND ALUT_FOUND)
+    set (SRCS ${SRCS} "SoundAL.cpp")
+else (OPENAL_FOUND AND ALUT_FOUND)
+    # Currently only OpenAL support
+    message (FATAL_ERROR "OpenAL and ALUT are required!")
+endif (OPENAL_FOUND AND ALUT_FOUND)
+
 # Select available Windowing library
 if (SDL2_FOUND AND SDL2TTF_FOUND)
     set (SRCS ${SRCS} "WindowSDL.cpp")

src/Game.cpp

@@ -377,7 +377,7 @@ void Game::processPakSounds()
     {
         mTombRaider.getSoundSample(i, &riffSz, &riff);
 
-        getSound().addWave(riff, riffSz, &id, getSound().SoundFlagsNone);
+        getSound().addWave(riff, riffSz, &id, Sound::SoundFlagsNone);
 
         //if (((i + 1) == TR_SOUND_F_PISTOL) && (id > 0))
         //{

src/Sound.cpp

@@ -2,271 +2,11 @@
  * \file src/Sound.cpp
  * \brief This is the audio manager Implementation
  *
- * \author Mongoose
  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenAL/al.h>
-#else
-#include <AL/al.h>
-#include <fcntl.h>
-#include <unistd.h>
-#endif
-
-#include <AL/alut.h>
-
-#include <cstdio>
-#include <cstdlib>
-#include <assert.h>
-
-#include "math/math.h"
 #include "Sound.h"
 
-Sound::Sound() {
-    mEnabled = false;
-    mInit = false;
-    mVolume = 1.0f;
-}
-
 Sound::~Sound() {
-    if (mInit)
-        alutExit();
-}
-
-int Sound::initialize() {
-    assert(mInit == false);
-
-    if (!mEnabled)
-        return 0;
-
-#ifndef __APPLE__
-    int fd = open("/dev/dsp", O_RDWR);
-    if (fd < 0) {
-        printf("Could not initialize Sound (/dev/dsp)\n");
-        return -1;
-    }
-    close(fd);
-#endif
-
-    ALCdevice *Device = alcOpenDevice("OSS");
-    ALCcontext *Context = alcCreateContext(Device, NULL);
-    alcMakeContextCurrent(Context);
-
-    if (alutInitWithoutContext(NULL, NULL) == AL_FALSE) {
-        printf("ALUT-Error: %s\n", alutGetErrorString(alutGetError()));
-        return -2;
-    }
-
-    mInit = true;
-
-    return 0;
-}
-
-void Sound::setEnabled(bool on) {
-    mEnabled = on;
-}
-
-void Sound::setVolume(float vol) {
-    assert(mSource.size() == mBuffer.size());
-
-    if (mEnabled) {
-        if ((mSource.size() > 0) && (!equalEpsilon(mVolume, vol))) {
-            // Apply new volume to old sources if needed
-            for (size_t i = 0; i < mSource.size(); i++)
-                alSourcef(mSource[i], AL_GAIN, vol);
-        }
-    }
-
-    mVolume = vol;
-}
-
-int Sound::registeredSources() {
-    assert(mSource.size() == mBuffer.size());
-
-    if ((!mEnabled) || (!mInit))
-        return 0;
-
-    return mSource.size();
-}
-
-void Sound::clear() {
-    assert(mSource.size() == mBuffer.size());
-
-    if ((!mEnabled) || (!mInit))
-        return;
-
-    for (size_t i = 0; i < mSource.size(); i++) {
-        alDeleteSources(1, &mSource[i]);
-        alDeleteBuffers(1, &mBuffer[i]);
-    }
-
-    mSource.clear();
-    mBuffer.clear();
-}
-
-void Sound::listenAt(float pos[3], float angle[3]) {
-    assert(mSource.size() == mBuffer.size());
-    assert(pos != NULL);
-    assert(angle != NULL);
-
-    if ((!mEnabled) || (!mInit))
-        return;
-
-    alListenerfv(AL_POSITION, pos);
-    alListenerfv(AL_ORIENTATION, angle);
-}
-
-void Sound::sourceAt(int source, float pos[3]) {
-    assert(mSource.size() == mBuffer.size());
-    assert(source >= 0);
-    assert(source < (int)mSource.size());
-    assert(pos != NULL);
-
-    if ((!mEnabled) || (!mInit))
-        return;
-
-    alSourcefv(mSource[source], AL_POSITION, pos);
-}
-
-//! \fixme Seperate sourcing and buffering, Mongoose 2002.01.04
-int Sound::addFile(const char *filename, int *source, unsigned int flags) {
-    ALsizei size;
-    ALfloat freq;
-    ALenum format;
-    ALvoid *data;
-    int id;
-
-    assert(mSource.size() == mBuffer.size());
-    assert(filename != NULL);
-    assert(filename[0] != '\0');
-    assert(source != NULL);
-
-    if ((!mEnabled) || (!mInit)) {
-        *source = 0;
-        return 0;
-    }
-
-    *source = -1;
-    id = mSource.size();
-    
-    mSource.push_back(0);
-    mBuffer.push_back(0);
-
-    alGetError();
-    alGenBuffers(1, &mBuffer[id]);
-    if (alGetError() != AL_NO_ERROR) {
-        printf("Could not load wav file (alGenBuffers)\n");
-        return -1;
-    }
-
-    alGetError();
-    alGenSources(1, &mSource[id]);
-    if (alGetError() != AL_NO_ERROR) {
-        printf("Could not load wav file (alGenSources)\n");
-        return -2;
-    }
-
-    data = alutLoadMemoryFromFile(filename, &format, &size, &freq);
-    if (alutGetError() != ALUT_ERROR_NO_ERROR) {
-        printf("Could not load %s\n", filename);
-        return -3;
-    }
-
-    alBufferData(mBuffer[id], format, data, size, static_cast<ALsizei>(freq));
-    alSourcei(mSource[id], AL_BUFFER, mBuffer[id]);
-
-    if (flags & SoundFlagsLoop) {
-        alSourcei(mSource[id], AL_LOOPING, 1);
-    }
-
-    alSourcef(mSource[id], AL_GAIN, mVolume);
-
-    *source = id;
-
-    return 0;
-}
-
-int Sound::addWave(unsigned char *wav, unsigned int length, int *source, unsigned int flags) {
-    ALsizei size;
-    ALfloat freq;
-    ALenum format;
-    ALvoid *data;
-    int error = 0;
-    int id;
-
-    assert(mSource.size() == mBuffer.size());
-    assert(wav != NULL);
-    assert(source != NULL);
-
-    if ((!mEnabled) || (!mInit)) {
-        *source = 0;
-        return 0;
-    }
-
-    *source = -1;
-    id = mSource.size();
-    
-    mSource.push_back(0);
-    mBuffer.push_back(0);
-
-    data = wav;
-
-    alGetError();
-    alGenBuffers(1, &mBuffer[id]);
-    if (alGetError() != AL_NO_ERROR) {
-        printf("Could not load wav (alGenBuffers)\n");
-        return -1;
-    }
-
-    alGetError();
-    alGenSources(1, &mSource[id]);
-    if (alGetError() != AL_NO_ERROR) {
-        printf("Could not load wav (alGenSources)\n");
-        return -2;
-    }
-
-    data = alutLoadMemoryFromFileImage(wav, length, &format, &size, &freq);
-    if (((error = alutGetError()) != ALUT_ERROR_NO_ERROR) || (data == NULL)) {
-        printf("Could not load wav buffer (%s)\n", alutGetErrorString(error));
-        return -3;
-    }
-
-    alBufferData(mBuffer[id], format, data, size, static_cast<ALsizei>(freq));
-    alSourcei(mSource[id], AL_BUFFER, mBuffer[id]);
-
-    if (flags & SoundFlagsLoop) {
-        alSourcei(mSource[id], AL_LOOPING, 1);
-    }
-
-    alSourcef(mSource[id], AL_GAIN, mVolume);
-
-    *source = id;
-
-    //! \fixme Should free alut buffer?
-
-    return 0;
-}
-
-void Sound::play(int source) {
-    assert(mSource.size() == mBuffer.size());
-    assert(source >= 0);
-    assert(source < (int)mSource.size());
-
-    if ((!mEnabled) || (!mInit))
-        return;
-
-    alSourcePlay(mSource[source]);
-}
-
-void Sound::stop(int source) {
-    assert(mSource.size() == mBuffer.size());
-    assert(source >= 0);
-    assert(source < (int)mSource.size());
-
-    if ((!mEnabled) || (!mInit))
-        return;
-
-    alSourceStop(mSource[source]);
 }
 

src/SoundAL.cpp

@@ -0,0 +1,272 @@
+/*!
+ * \file src/SoundAL.cpp
+ * \brief This is the OpenAL audio manager Implementation
+ *
+ * \author Mongoose
+ * \author xythobuz
+ */
+
+#ifdef __APPLE__
+#include <OpenAL/al.h>
+#else
+#include <AL/al.h>
+#include <fcntl.h>
+#include <unistd.h>
+#endif
+
+#include <AL/alut.h>
+
+#include <cstdio>
+#include <cstdlib>
+#include <assert.h>
+
+#include "math/math.h"
+#include "SoundAL.h"
+
+SoundAL::SoundAL() {
+    mEnabled = false;
+    mInit = false;
+    mVolume = 1.0f;
+}
+
+SoundAL::~SoundAL() {
+    if (mInit)
+        alutExit();
+}
+
+int SoundAL::initialize() {
+    assert(mInit == false);
+
+    if (!mEnabled)
+        return 0;
+
+#ifndef __APPLE__
+    int fd = open("/dev/dsp", O_RDWR);
+    if (fd < 0) {
+        printf("Could not initialize OpenAL (/dev/dsp)\n");
+        return -1;
+    }
+    close(fd);
+#endif
+
+    ALCdevice *Device = alcOpenDevice("OSS");
+    ALCcontext *Context = alcCreateContext(Device, NULL);
+    alcMakeContextCurrent(Context);
+
+    if (alutInitWithoutContext(NULL, NULL) == AL_FALSE) {
+        printf("ALUT-Error: %s\n", alutGetErrorString(alutGetError()));
+        return -2;
+    }
+
+    mInit = true;
+
+    return 0;
+}
+
+void SoundAL::setEnabled(bool on) {
+    mEnabled = on;
+}
+
+void SoundAL::setVolume(float vol) {
+    assert(mSource.size() == mBuffer.size());
+
+    if (mEnabled) {
+        if ((mSource.size() > 0) && (!equalEpsilon(mVolume, vol))) {
+            // Apply new volume to old sources if needed
+            for (size_t i = 0; i < mSource.size(); i++)
+                alSourcef(mSource[i], AL_GAIN, vol);
+        }
+    }
+
+    mVolume = vol;
+}
+
+int SoundAL::registeredSources() {
+    assert(mSource.size() == mBuffer.size());
+
+    if ((!mEnabled) || (!mInit))
+        return 0;
+
+    return mSource.size();
+}
+
+void SoundAL::clear() {
+    assert(mSource.size() == mBuffer.size());
+
+    if ((!mEnabled) || (!mInit))
+        return;
+
+    for (size_t i = 0; i < mSource.size(); i++) {
+        alDeleteSources(1, &mSource[i]);
+        alDeleteBuffers(1, &mBuffer[i]);
+    }
+
+    mSource.clear();
+    mBuffer.clear();
+}
+
+void SoundAL::listenAt(float pos[3], float angle[3]) {
+    assert(mSource.size() == mBuffer.size());
+    assert(pos != NULL);
+    assert(angle != NULL);
+
+    if ((!mEnabled) || (!mInit))
+        return;
+
+    alListenerfv(AL_POSITION, pos);
+    alListenerfv(AL_ORIENTATION, angle);
+}
+
+void SoundAL::sourceAt(int source, float pos[3]) {
+    assert(mSource.size() == mBuffer.size());
+    assert(source >= 0);
+    assert(source < (int)mSource.size());
+    assert(pos != NULL);
+
+    if ((!mEnabled) || (!mInit))
+        return;
+
+    alSourcefv(mSource[source], AL_POSITION, pos);
+}
+
+//! \fixme Seperate sourcing and buffering, Mongoose 2002.01.04
+int SoundAL::addFile(const char *filename, int *source, unsigned int flags) {
+    ALsizei size;
+    ALfloat freq;
+    ALenum format;
+    ALvoid *data;
+    int id;
+
+    assert(mSource.size() == mBuffer.size());
+    assert(filename != NULL);
+    assert(filename[0] != '\0');
+    assert(source != NULL);
+
+    if ((!mEnabled) || (!mInit)) {
+        *source = 0;
+        return 0;
+    }
+
+    *source = -1;
+    id = mSource.size();
+
+    mSource.push_back(0);
+    mBuffer.push_back(0);
+
+    alGetError();
+    alGenBuffers(1, &mBuffer[id]);
+    if (alGetError() != AL_NO_ERROR) {
+        printf("Could not load wav file (alGenBuffers)\n");
+        return -1;
+    }
+
+    alGetError();
+    alGenSources(1, &mSource[id]);
+    if (alGetError() != AL_NO_ERROR) {
+        printf("Could not load wav file (alGenSources)\n");
+        return -2;
+    }
+
+    data = alutLoadMemoryFromFile(filename, &format, &size, &freq);
+    if (alutGetError() != ALUT_ERROR_NO_ERROR) {
+        printf("Could not load %s\n", filename);
+        return -3;
+    }
+
+    alBufferData(mBuffer[id], format, data, size, static_cast<ALsizei>(freq));
+    alSourcei(mSource[id], AL_BUFFER, mBuffer[id]);
+
+    if (flags & SoundFlagsLoop) {
+        alSourcei(mSource[id], AL_LOOPING, 1);
+    }
+
+    alSourcef(mSource[id], AL_GAIN, mVolume);
+
+    *source = id;
+
+    return 0;
+}
+
+int SoundAL::addWave(unsigned char *wav, unsigned int length, int *source, unsigned int flags) {
+    ALsizei size;
+    ALfloat freq;
+    ALenum format;
+    ALvoid *data;
+    int error = 0;
+    int id;
+
+    assert(mSource.size() == mBuffer.size());
+    assert(wav != NULL);
+    assert(source != NULL);
+
+    if ((!mEnabled) || (!mInit)) {
+        *source = 0;
+        return 0;
+    }
+
+    *source = -1;
+    id = mSource.size();
+
+    mSource.push_back(0);
+    mBuffer.push_back(0);
+
+    data = wav;
+
+    alGetError();
+    alGenBuffers(1, &mBuffer[id]);
+    if (alGetError() != AL_NO_ERROR) {
+        printf("Could not load wav (alGenBuffers)\n");
+        return -1;
+    }
+
+    alGetError();
+    alGenSources(1, &mSource[id]);
+    if (alGetError() != AL_NO_ERROR) {
+        printf("Could not load wav (alGenSources)\n");
+        return -2;
+    }
+
+    data = alutLoadMemoryFromFileImage(wav, length, &format, &size, &freq);
+    if (((error = alutGetError()) != ALUT_ERROR_NO_ERROR) || (data == NULL)) {
+        printf("Could not load wav buffer (%s)\n", alutGetErrorString(error));
+        return -3;
+    }
+
+    alBufferData(mBuffer[id], format, data, size, static_cast<ALsizei>(freq));
+    alSourcei(mSource[id], AL_BUFFER, mBuffer[id]);
+
+    if (flags & SoundFlagsLoop) {
+        alSourcei(mSource[id], AL_LOOPING, 1);
+    }
+
+    alSourcef(mSource[id], AL_GAIN, mVolume);
+
+    *source = id;
+
+    //! \fixme Should free alut buffer?
+
+    return 0;
+}
+
+void SoundAL::play(int source) {
+    assert(mSource.size() == mBuffer.size());
+    assert(source >= 0);
+    assert(source < (int)mSource.size());
+
+    if ((!mEnabled) || (!mInit))
+        return;
+
+    alSourcePlay(mSource[source]);
+}
+
+void SoundAL::stop(int source) {
+    assert(mSource.size() == mBuffer.size());
+    assert(source >= 0);
+    assert(source < (int)mSource.size());
+
+    if ((!mEnabled) || (!mInit))
+        return;
+
+    alSourceStop(mSource[source]);
+}
+

src/main.cpp

@@ -13,6 +13,8 @@
 #include "config.h"
 #include "main.h"
 #include "utils/time.h"
+
+#include "SoundAL.h"
 #include "WindowSDL.h"
 
 Camera *gCamera = NULL;
@@ -134,7 +136,7 @@ int main(int argc, char *argv[]) {
     atexit(cleanupHandler);
     gOpenRaider = new OpenRaider();
     gWindow = new WindowSDL();
-    gSound = new Sound();
+    gSound = new SoundAL();
     gWorld = new World();
     gCamera = new Camera();
     gConsole = new Console();