Merge pull request #175 from jhasse/sdl2-backend

Add SDL2 backend for playback, fix #173

5 files changed, 266 insertions, 1 deletions

diff --git a/Alc/ALc.c b/Alc/ALc.c
index 0cde449e..c72a1833 100644
--- a/Alc/ALc.c
+++ b/Alc/ALc.c
@@ -100,6 +100,9 @@ static struct BackendInfo BackendList[] = {
 #ifdef HAVE_OPENSL
     { "opensl", ALCopenslBackendFactory_getFactory },
 #endif
+#ifdef HAVE_SDL2
+    { "sdl2", ALCsdl2BackendFactory_getFactory },
+#endif
 
     { "null", ALCnullBackendFactory_getFactory },
 #ifdef HAVE_WAVE
diff --git a/Alc/backends/base.h b/Alc/backends/base.h
index 177f6869..b05523b2 100644
--- a/Alc/backends/base.h
+++ b/Alc/backends/base.h
@@ -147,6 +147,7 @@ ALCbackendFactory *ALCportBackendFactory_getFactory(void);
 ALCbackendFactory *ALCopenslBackendFactory_getFactory(void);
 ALCbackendFactory *ALCnullBackendFactory_getFactory(void);
 ALCbackendFactory *ALCwaveBackendFactory_getFactory(void);
+ALCbackendFactory *ALCsdl2BackendFactory_getFactory(void);
 ALCbackendFactory *ALCloopbackFactory_getFactory(void);
 
 
diff --git a/Alc/backends/sdl2.c b/Alc/backends/sdl2.c
new file mode 100644
index 00000000..9bd42cdf
--- /dev/null
+++ b/Alc/backends/sdl2.c
@@ -0,0 +1,238 @@
+/**
+ * OpenAL cross platform audio library
+ * Copyright (C) 2018 by authors.
+ * This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Library General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ *  License along with this library; if not, write to the
+ *  Free Software Foundation, Inc.,
+ *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * Or go to http://www.gnu.org/copyleft/lgpl.html
+ */
+
+#include "config.h"
+
+#include <stdlib.h>
+#include <SDL2/SDL.h>
+
+#include "alMain.h"
+#include "alu.h"
+#include "threads.h"
+#include "compat.h"
+
+#include "backends/base.h"
+
+
+typedef struct ALCsdl2Backend {
+    DERIVE_FROM_TYPE(ALCbackend);
+
+    SDL_AudioDeviceID deviceID;
+    ALCboolean quit;
+    ALuint Frequency;
+    enum DevFmtChannels FmtChans;
+    enum DevFmtType     FmtType;
+} ALCsdl2Backend;
+
+static void ALCsdl2Backend_Construct(ALCsdl2Backend *self, ALCdevice *device);
+static DECLARE_FORWARD(ALCsdl2Backend, ALCbackend, void, Destruct)
+static ALCenum ALCsdl2Backend_open(ALCsdl2Backend *self, const ALCchar *name);
+static ALCboolean ALCsdl2Backend_reset(ALCsdl2Backend *self);
+static ALCboolean ALCsdl2Backend_start(ALCsdl2Backend *self);
+static void ALCsdl2Backend_stop(ALCsdl2Backend *self);
+static DECLARE_FORWARD2(ALCsdl2Backend, ALCbackend, ALCenum, captureSamples, void*, ALCuint)
+static DECLARE_FORWARD(ALCsdl2Backend, ALCbackend, ALCuint, availableSamples)
+static DECLARE_FORWARD(ALCsdl2Backend, ALCbackend, ClockLatency, getClockLatency)
+static DECLARE_FORWARD(ALCsdl2Backend, ALCbackend, void, lock)
+static DECLARE_FORWARD(ALCsdl2Backend, ALCbackend, void, unlock)
+DECLARE_DEFAULT_ALLOCATORS(ALCsdl2Backend)
+
+DEFINE_ALCBACKEND_VTABLE(ALCsdl2Backend);
+
+static const ALCchar defaultDeviceName[] = "Default device";
+
+static void ALCsdl2Backend_Construct(ALCsdl2Backend *self, ALCdevice *device)
+{
+    ALCbackend_Construct(STATIC_CAST(ALCbackend, self), device);
+    SET_VTABLE2(ALCsdl2Backend, ALCbackend, self);
+
+    self->quit = ALC_FALSE;
+    self->Frequency = device->Frequency;
+    self->FmtChans = device->FmtChans;
+    self->FmtType = device->FmtType;
+    if(SDL_WasInit(0) == 0) // Is SDL2 initialized at all?
+    {
+        SDL_Init(SDL_INIT_AUDIO);
+        self->quit = ALC_TRUE;
+    }
+    else if(!SDL_WasInit(SDL_INIT_AUDIO))
+        SDL_InitSubSystem(SDL_INIT_AUDIO);
+}
+
+
+static void ALCsdl2Backend_audioCallback(void *ptr, Uint8* stream, int len)
+{
+    ALCsdl2Backend *self = (ALCsdl2Backend*)ptr;
+    ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
+    ALsizei frameSize = FrameSizeFromDevFmt(
+        device->FmtChans, device->FmtType, device->AmbiOrder
+    );
+    assert(len % frameSize == 0);
+    ALCsdl2Backend_lock(self);
+    aluMixData(device, stream, len / frameSize);
+    ALCsdl2Backend_unlock(self);
+}
+
+static ALCenum ALCsdl2Backend_open(ALCsdl2Backend *self, const ALCchar *name)
+{
+    ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
+    SDL_AudioSpec want, have;
+    SDL_zero(want);
+    want.freq = device->Frequency;
+    want.format = AUDIO_F32;
+    want.channels = (device->FmtChans == DevFmtMono) ? 1 : 2;
+    want.samples = device->UpdateSize;
+    want.callback = ALCsdl2Backend_audioCallback;
+    want.userdata = self;
+
+    if (name && strcmp(name, defaultDeviceName) == 0)
+        name = NULL; // Passing NULL to SDL_OpenAudioDevice is special and will NOT select the first
+                     // device in the list.
+    self->deviceID = SDL_OpenAudioDevice(name, 0, &want, &have, SDL_AUDIO_ALLOW_ANY_CHANGE);
+    if(self->deviceID == 0)
+    {
+        ERR("Could not open device\n");
+        return ALC_INVALID_VALUE;
+    }
+    if(want.freq != have.freq)
+    {
+        TRACE("Frequency changed by SDL2\n");
+        device->Frequency = have.freq;
+    }
+    if(have.channels == 1)
+        device->FmtChans = DevFmtMono;
+    else if(have.channels == 2)
+        device->FmtChans = DevFmtStereo;
+    else
+    {
+        ERR("Invalid number of channels\n");
+        return ALC_INVALID_VALUE;
+    }
+    switch(have.format)
+    {
+        case AUDIO_U8:     device->FmtType = DevFmtUByte;  break;
+        case AUDIO_S8:     device->FmtType = DevFmtByte;   break;
+        case AUDIO_U16SYS: device->FmtType = DevFmtUShort; break;
+        case AUDIO_S16SYS: device->FmtType = DevFmtShort;  break;
+        case AUDIO_S32SYS: device->FmtType = DevFmtInt;    break;
+        case AUDIO_F32SYS: device->FmtType = DevFmtFloat;  break;
+        default:
+            ERR("Unsupported format\n");
+            return ALC_INVALID_VALUE;
+    }
+    self->Frequency = device->Frequency;
+    self->FmtChans = device->FmtChans;
+    self->FmtType = device->FmtType;
+    if(!name)
+        name = defaultDeviceName;
+    alstr_copy_cstr(&STATIC_CAST(ALCbackend, self)->mDevice->DeviceName, name);
+
+    return ALC_NO_ERROR;
+}
+
+static ALCboolean ALCsdl2Backend_reset(ALCsdl2Backend *self)
+{
+    ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
+    device->Frequency = self->Frequency;
+    device->FmtChans = self->FmtChans;
+    device->FmtType = self->FmtType;
+    SetDefaultWFXChannelOrder(device);
+    return ALC_TRUE;
+}
+
+static ALCboolean ALCsdl2Backend_start(ALCsdl2Backend *self)
+{
+    SDL_PauseAudioDevice(self->deviceID, 0);
+    return ALC_TRUE;
+}
+
+static void ALCsdl2Backend_stop(ALCsdl2Backend *self)
+{
+    SDL_PauseAudioDevice(self->deviceID, 1);
+    if(self->quit)
+        SDL_Quit();
+}
+
+
+typedef struct ALCsdl2BackendFactory {
+    DERIVE_FROM_TYPE(ALCbackendFactory);
+} ALCsdl2BackendFactory;
+#define ALCsdl2BACKENDFACTORY_INITIALIZER { { GET_VTABLE2(ALCsdl2BackendFactory, ALCbackendFactory) } }
+
+ALCbackendFactory *ALCsdl2BackendFactory_getFactory(void);
+
+static ALCboolean ALCsdl2BackendFactory_init(ALCsdl2BackendFactory *self);
+static DECLARE_FORWARD(ALCsdl2BackendFactory, ALCbackendFactory, void, deinit)
+static ALCboolean ALCsdl2BackendFactory_querySupport(ALCsdl2BackendFactory *self, ALCbackend_Type type);
+static void ALCsdl2BackendFactory_probe(ALCsdl2BackendFactory *self, enum DevProbe type);
+static ALCbackend* ALCsdl2BackendFactory_createBackend(ALCsdl2BackendFactory *self, ALCdevice *device, ALCbackend_Type type);
+DEFINE_ALCBACKENDFACTORY_VTABLE(ALCsdl2BackendFactory);
+
+
+ALCbackendFactory *ALCsdl2BackendFactory_getFactory(void)
+{
+    static ALCsdl2BackendFactory factory = ALCsdl2BACKENDFACTORY_INITIALIZER;
+    return STATIC_CAST(ALCbackendFactory, &factory);
+}
+
+
+static ALCboolean ALCsdl2BackendFactory_init(ALCsdl2BackendFactory* UNUSED(self))
+{
+    return ALC_TRUE;
+}
+
+static ALCboolean ALCsdl2BackendFactory_querySupport(ALCsdl2BackendFactory* UNUSED(self), ALCbackend_Type type)
+{
+    if(type == ALCbackend_Playback)
+        return ALC_TRUE;
+    return ALC_FALSE;
+}
+
+static void ALCsdl2BackendFactory_probe(ALCsdl2BackendFactory* UNUSED(self), enum DevProbe type)
+{
+    if(type != ALL_DEVICE_PROBE)
+        return;
+    ALCboolean quit = ALC_FALSE;
+    if(SDL_WasInit(0) == 0) // Is SDL2 initialized at all?
+    {
+        SDL_Init(SDL_INIT_AUDIO);
+        quit = ALC_TRUE;
+    }
+    else if(!SDL_WasInit(SDL_INIT_AUDIO))
+        SDL_InitSubSystem(SDL_INIT_AUDIO);
+    AppendAllDevicesList(defaultDeviceName);
+    for(int i = 0; i < SDL_GetNumAudioDevices(0); ++i)
+        AppendAllDevicesList(SDL_GetAudioDeviceName(i, 0));
+    if(quit)
+        SDL_Quit();
+}
+
+static ALCbackend* ALCsdl2BackendFactory_createBackend(ALCsdl2BackendFactory* UNUSED(self), ALCdevice *device, ALCbackend_Type type)
+{
+    if(type == ALCbackend_Playback)
+    {
+        ALCsdl2Backend *backend;
+        NEW_OBJ(backend, ALCsdl2Backend)(device);
+        if(!backend) return NULL;
+        return STATIC_CAST(ALCbackend, backend);
+    }
+
+    return NULL;
+}
diff --git a/CMakeLists.txt b/CMakeLists.txt
index bd531128..0c6196f1 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -759,6 +759,7 @@ SET(HAVE_PULSEAUDIO 0)
 SET(HAVE_COREAUDIO  0)
 SET(HAVE_OPENSL     0)
 SET(HAVE_WAVE       0)
+SET(HAVE_SDL2       0)
 
 # Check for SSE support
 OPTION(ALSOFT_REQUIRE_SSE "Require SSE support" OFF)
@@ -1123,6 +1124,23 @@ IF(ALSOFT_REQUIRE_OPENSL AND NOT HAVE_OPENSL)
     MESSAGE(FATAL_ERROR "Failed to enabled required OpenSL backend")
 ENDIF()
 
+# Check for SDL2 backend
+OPTION(ALSOFT_REQUIRE_SDL2 "Require SDL2 backend" OFF)
+FIND_PACKAGE(SDL2)
+IF(SDL2_FOUND)
+    # Off by default, since it adds a runtime dependency
+    OPTION(ALSOFT_BACKEND_SDL2 "Enable SDL2 backend" OFF)
+    IF(ALSOFT_BACKEND_SDL2)
+        SET(HAVE_SDL2 1)
+        SET(ALC_OBJS  ${ALC_OBJS} Alc/backends/sdl2.c)
+        SET(BACKENDS  "${BACKENDS} SDL2,")
+        SET(EXTRA_LIBS ${SDL2_LIBRARY} ${EXTRA_LIBS})
+    ENDIF()
+ENDIF()
+IF(ALSOFT_REQUIRE_SDL2 AND NOT SDL2_FOUND)
+    MESSAGE(FATAL_ERROR "Failed to enabled required SDL2 backend")
+ENDIF()
+
 # Optionally enable the Wave Writer backend
 OPTION(ALSOFT_BACKEND_WAVE "Enable Wave Writer backend" ON)
 IF(ALSOFT_BACKEND_WAVE)
@@ -1206,7 +1224,9 @@ IF(ALSOFT_UTILS AND NOT ALSOFT_NO_CONFIG_UTIL)
     add_subdirectory(utils/alsoft-config)
 ENDIF()
 IF(ALSOFT_EXAMPLES)
-    FIND_PACKAGE(SDL2)
+    IF(NOT SDL2_FOUND)
+        FIND_PACKAGE(SDL2)
+    ENDIF()
     IF(SDL2_FOUND)
         FIND_PACKAGE(SDL_sound)
         FIND_PACKAGE(FFmpeg COMPONENTS AVFORMAT AVCODEC AVUTIL SWSCALE SWRESAMPLE)
diff --git a/config.h.in b/config.h.in
index 2abeedfd..345e8408 100644
--- a/config.h.in
+++ b/config.h.in
@@ -77,6 +77,9 @@
 /* Define if we have the Wave Writer backend */
 #cmakedefine HAVE_WAVE
 
+/* Define if we have the SDL2 backend */
+#cmakedefine HAVE_SDL2
+
 /* Define if we have the stat function */
 #cmakedefine HAVE_STAT