feat(audio): replace OpenAL audio device for Miniaudio backend (#1005)

.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

core/CMakeLists.txt

@@ -8,7 +8,6 @@ if(WITH_GLFW)
  option(GLFW_USE_SUBMODULE "Compile GLFW from source?" ON)
 endif()
 
-option(WITH_OPENAL "With OpenAL?" OFF)
 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.")
@@ -85,8 +84,8 @@ set(CUBOS_CORE_SOURCE
  "src/gl/util.cpp"
 
  "src/al/audio_device.cpp"
- "src/al/oal_audio_device.cpp"
- "src/al/oal_audio_device.hpp"
+ "src/al/miniaudio_device.cpp"
+ "src/al/miniaudio_device.hpp"
 
  "src/ecs/entity/entity.cpp"
  "src/ecs/entity/hash.cpp"
@@ -191,16 +190,6 @@ 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)
-endif()
-
 if(GLM_USE_SUBMODULE)
  add_subdirectory(lib/glm SYSTEM)
 else()

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

@@ -9,6 +9,7 @@
 #include <vector>
 
 #include <glm/glm.hpp>
+#include <miniaudio.h>
 
 #include <cubos/core/api.hpp>
 
@@ -32,15 +33,6 @@ namespace cubos::core::al
  /// @ingroup core-al
  using Source = std::shared_ptr<impl::Source>;
 
- /// @brief Possible audio formats.
- enum class Format
- {
- Mono8,
- Mono16,
- Stereo8,
- Stereo16,
- };
-
  /// @brief Audio device interface used to wrap low-level audio rendering APIs.
  class CUBOS_CORE_API AudioDevice
  {
@@ -51,36 +43,40 @@ namespace cubos::core::al
  /// @brief Forbid copy construction.
  AudioDevice(const AudioDevice&) = delete;
 
- /// @brief Creates an audio device from a given device @p specifier.
+ /// @brief Creates an audio device.
  /// @see enumerateDevices()
- /// @param specifier Device specifier (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();
 
  /// @brief Enumerates the available devices.
  /// @param[out] devices Vector to fill with the available devices.
  static void enumerateDevices(std::vector<std::string>& devices);
 
  /// @brief Creates a new audio buffer
+ /// @param filePath File path to create buffer from.
  /// @return Handle of the new buffer.
- virtual Buffer createBuffer() = 0;
+ virtual Buffer createBuffer(const void* data, size_t dataSize) = 0;
 
  /// @brief Creates a new audio source.
  /// @return Handle of the new source.
  virtual Source createSource() = 0;
 
  /// @brief Sets the position of the listener.
  /// @param position Position.
- virtual void setListenerPosition(const glm::vec3& position) = 0;
+ /// @param listenerIndex Index of the listener
+ virtual void setListenerPosition(const glm::vec3& position, unsigned int listenerIndex = 0) = 0;
 
  /// @brief Sets the orientation of the listener.
  /// @param forward Forward direction of the listener.
  /// @param up Up direction of the listener.
- virtual void setListenerOrientation(const glm::vec3& forward, const glm::vec3& up) = 0;
+ /// @param listenerIndex Index of the listener
+ virtual void setListenerOrientation(const glm::vec3& forward, const glm::vec3& up,
+ unsigned int listenerIndex = 0) = 0;
 
  /// @brief Sets the velocity of the listener. Used to implement the doppler effect.
  /// @param velocity Velocity of the listener.
- virtual void setListenerVelocity(const glm::vec3& velocity) = 0;
+ /// @param listenerIndex Index of the listener
+ virtual void setListenerVelocity(const glm::vec3& velocity, unsigned int listenerIndex = 0) = 0;
  };
 
  /// @brief Namespace to store the abstract types implemented by the audio device implementations.
@@ -92,13 +88,6 @@ namespace cubos::core::al
  public:
  virtual ~Buffer() = default;
 
- /// @brief Fills the buffer with data.
- /// @param format Audio format of the data.
- /// @param size Size of the buffer in bytes.
- /// @param data Buffer data.
- /// @param frequency Audio frequency.
- virtual void fill(Format format, std::size_t size, const void* data, std::size_t frequency) = 0;
-
  protected:
  Buffer() = default;
  };
@@ -141,26 +130,22 @@ namespace cubos::core::al
 
  /// @brief Sets the maximum distance at which the source is audible.
  /// @param maxDistance Maximum distance.
- virtual void setDistance(float maxDistance) = 0;
+ virtual void setMaxDistance(float maxDistance) = 0;
 
- /// @brief Sets the cone angle of the source, in degrees. By default, 360.
- /// @param coneAngle Angle, in degrees.
- virtual void setConeAngle(float coneAngle) = 0;
+ /// @brief Sets the minimum distance at which the source starts to attenuate.
+ /// @param minDistance Minimum distance.
+ virtual void setMinDistance(float minDistance) = 0;
 
- /// @brief Sets the cone gain of the source.
- /// @todo Find out what this is.
+ /// @brief Sets the cone angle, in degrees. While also setting the outerGain.
+ /// @param innerAngle Outer angle, in degrees.
+ /// @param outerAngle Inner angle, in degrees.
  /// @param coneGain Gain.
- virtual void setConeGain(float coneGain) = 0;
+ virtual void setCone(float innerAngle, float outerAngle, float outerGain) = 0;
 
  /// @brief Sets the cone direction of the source.
  /// @param direction Direction.
  virtual void setConeDirection(const glm::vec3& direction) = 0;
 
- /// @brief Sets the distance under which the volume for the source would normally drop
- /// by half.
- /// @param referenceDistance Distance.
- virtual void setReferenceDistance(float referenceDistance) = 0;
-
  /// @brief Plays the source.
  virtual void play() = 0;
 

core/src/al/audio_device.cpp

@@ -1,13 +1,13 @@
-#include "oal_audio_device.hpp"
+#include "miniaudio_device.hpp"
 
 using namespace cubos::core::al;
 
-std::shared_ptr<AudioDevice> AudioDevice::create(const std::string& specifier)
+std::shared_ptr<AudioDevice> AudioDevice::create()
 {
- return std::make_shared<OALAudioDevice>(specifier);
+ return std::make_shared<MiniaudioDevice>();
 }
 
 void AudioDevice::enumerateDevices(std::vector<std::string>& devices)
 {
- OALAudioDevice::enumerateDevices(devices);
+ MiniaudioDevice::enumerateDevices(devices);
 }