Replace OpenAL by PortAudio

.gitmodules

@@ -4,9 +4,6 @@
 [submodule "core/lib/glm"]
 	path = core/lib/glm
 	url = https://github.com/g-truc/glm.git
-[submodule "core/lib/openal-soft"]
-	path = core/lib/openal-soft
-	url = https://github.com/kcat/openal-soft
 [submodule "core/lib/stduuid"]
 	path = core/lib/stduuid
 	url = https://github.com/mariusbancila/stduuid.git
@@ -28,3 +25,6 @@
 [submodule "engine/lib/implot"]
 	path = engine/lib/implot
 	url = https://github.com/epezent/implot.git
+[submodule "core/lib/portaudio"]
+	path = core/lib/portaudio
+	url = https://github.com/PortAudio/portaudio.git

core/CMakeLists.txt

@@ -8,7 +8,12 @@ if(WITH_GLFW)
 	option(GLFW_USE_SUBMODULE "Compile GLFW from source?" ON)
 endif()
 
-option(WITH_OPENAL "With OpenAL?" ON)
+option(WITH_PORTAUDIO "With PortAudio?" ON)
+
+if(WITH_PORTAUDIO)
+	option(PORTAUDIO_USE_SUBMODULE "Compile PortAudio from source?" ON)
+endif()
+
 option(GLM_USE_SUBMODULE "Compile GLM from source?" ON)
 
 set(CUBOS_CORE_ECS_MAX_COMPONENTS "63" CACHE STRING "The maximum number of components registered in an ECS world.")
@@ -83,7 +88,9 @@ set(CUBOS_CORE_SOURCE
 
 	"src/al/audio_device.cpp"
 	"src/al/oal_audio_device.cpp"
-	"src/al/oal_audio_device.hpp"
+	"src/al/oal_audio_device.cpp"
+	"src/al/port_audio_device.cpp"
+	"src/al/port_audio_device.hpp"
 
 	"src/ecs/entity/entity.cpp"
 	"src/ecs/entity/hash.cpp"
@@ -162,14 +169,15 @@ if(WITH_GLFW)
 	target_compile_definitions(cubos-core PRIVATE WITH_GLFW)
 endif()
 
-if(WITH_OPENAL)
-	set(ALSOFT_UTILS OFF CACHE BOOL "" FORCE)
-	set(ALSOFT_NO_CONFIG_UTIL OFF CACHE BOOL "" FORCE)
-	set(ALSOFT_EXAMPLES OFF CACHE BOOL "" FORCE)
-	add_subdirectory(lib/openal-soft)
-	target_include_directories(cubos-core PRIVATE lib/openal-soft/include)
-	target_link_libraries(cubos-core PRIVATE OpenAL)
-	target_compile_definitions(cubos-core PRIVATE WITH_OPENAL)
+if(WITH_PORTAUDIO)
+	if(PORTAUDIO_USE_SUBMODULE)
+		add_subdirectory(lib/portaudio EXCLUDE_FROM_ALL)
+	else()
+		find_package(portaudio REQUIRED)
+	endif()
+
+	target_link_libraries(cubos-core PRIVATE PortAudio)
+	target_compile_definitions(cubos-core PRIVATE WITH_PORTAUDIO)
 endif()
 
 if(GLM_USE_SUBMODULE)

core/include/cubos/core/al/audio_device.hpp

@@ -10,8 +10,18 @@
 
 #include <glm/glm.hpp>
 
+#include <cubos/core/memory/function.hpp>
+
 namespace cubos::core::al
 {
+    struct DeviceInfo
+    {
+        const char* name;
+        int maxInputChannels;
+        int maxOutputChannels;
+        double defaultSampleRate;
+    };
+
     namespace impl
     {
         class Buffer;
@@ -43,21 +53,46 @@ namespace cubos::core::al
     class AudioDevice
     {
     public:
+        /// Type alias for a user output callback function.
+        using PortAudioOutputCallbackFn = core::memory::Function<int(void* output, unsigned long frameCount,
+                                                                     unsigned long statusFlags, void* userData)>;
+
         AudioDevice() = default;
         virtual ~AudioDevice() = default;
 
         /// @brief Forbid copy construction.
         AudioDevice(const AudioDevice&) = delete;
 
-        /// @brief Creates an audio device from a given device @p specifier.
-        /// @see enumerateDevices()
-        /// @param specifier Device specifier (empty for default).
+        /// @brief Creates the stream.
+        /// @param callback Supplied function that is responsible for processing and filling input and output buffers.
+        /// @return Whether the stream was successfully created.
+        virtual bool init(PortAudioOutputCallbackFn callback) = 0;
+
+        /// @brief Starts the stream.
+        virtual void start() = 0;
+
+        /// @brief Stops the stream.
+        virtual void stop() = 0;
+
+        /// @brief Creates an audio device from a given device id @p deviceIndex.
+        /// @param deviceIndex Device specifier id (empty for default).
         /// @return Audio device, or nullptr on failure.
-        static std::shared_ptr<AudioDevice> create(const std::string& specifier = "");
+        static std::shared_ptr<AudioDevice> create(int deviceIndex = -1);
+
+        /// @brief Retrieve the number of available devices. The number of available devices may be zero.
+        /// @return Number of available devices.
+        static int deviceCount();
 
         /// @brief Enumerates the available devices.
         /// @param[out] devices Vector to fill with the available devices.
-        static void enumerateDevices(std::vector<std::string>& devices);
+        /// @param debug If true, will print the devices using CUBOS_DEBUG.
+        static void enumerateDevices(std::vector<DeviceInfo>& devices, bool debug = false);
+
+        /// @brief Retrieve the device information by its index.
+        static DeviceInfo deviceInfo(int deviceIndex);
+
+        /// @brief Prints device information by its index.
+        static void printDeviceInformation(int deviceIndex);
 
         /// @brief Creates a new audio buffer
         /// @return Handle of the new buffer.

core/samples/CMakeLists.txt

@@ -47,3 +47,4 @@ make_sample(DIR "ecs/relations")
 make_sample(DIR "gl/compute")
 make_sample(DIR "gl/debug_renderer")
 make_sample(DIR "gl/quad")
+make_sample(DIR "al")

core/samples/al/main.cpp

@@ -0,0 +1,28 @@
+#include <iostream>
+
+#include <stdio.h>
+
+#include <cubos/core/al/audio_device.hpp>
+
+int main()
+{
+    auto audio = cubos::core::al::AudioDevice::create();
+
+    std::vector<cubos::core::al::DeviceInfo> devices;
+    audio->enumerateDevices(devices, true);
+
+    audio->init([](void* outputBuffer, unsigned long framesPerBuffer, unsigned long, void*) -> int {
+        float* out = static_cast<float*>(outputBuffer);
+        for (unsigned int i = 0; i < framesPerBuffer; i++)
+        {
+            *out++ = 0.5f * static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));
+        }
+        return 0;
+    });
+    audio->start();
+
+    std::cout << "press enter to stop the sound";
+    std::cin.get();
+
+    audio->stop();
+}

core/src/al/audio_device.cpp

@@ -1,13 +1,28 @@
-#include "oal_audio_device.hpp"
+#include "port_audio_device.hpp"
 
 using namespace cubos::core::al;
 
-std::shared_ptr<AudioDevice> AudioDevice::create(const std::string& specifier)
+std::shared_ptr<AudioDevice> AudioDevice::create(int deviceIndex)
 {
-    return std::make_shared<OALAudioDevice>(specifier);
+    return std::make_shared<PortAudioDevice>(deviceIndex);
 }
 
-void AudioDevice::enumerateDevices(std::vector<std::string>& devices)
+int AudioDevice::deviceCount()
 {
-    OALAudioDevice::enumerateDevices(devices);
+    return PortAudioDevice::deviceCount();
 }
+
+void AudioDevice::enumerateDevices(std::vector<DeviceInfo>& devices, bool debug)
+{
+    PortAudioDevice::enumerateDevices(devices, debug);
+}
+
+DeviceInfo AudioDevice::deviceInfo(int deviceIndex)
+{
+    return PortAudioDevice::deviceInfo(deviceIndex);
+}
+
+void AudioDevice::printDeviceInformation(int deviceIndex)
+{
+    return PortAudioDevice::printDeviceInformation(deviceIndex);
+}