From 2b9a02d6c4c70c9694dd46e06e874e7f2895b0ea Mon Sep 17 00:00:00 2001
From: Diogo Miranda <diogomsmiranda@gmail.com>
Date: Wed, 2 Oct 2024 17:43:42 +0100
Subject: [PATCH] feat(audio): Add AudioPlugin

---
 engine/CMakeLists.txt                         |  3 ++
 engine/include/cubos/engine/audio/audio.hpp   |  2 +-
 engine/include/cubos/engine/audio/bridge.hpp  |  4 +-
 .../include/cubos/engine/audio/listener.hpp   | 22 ++++++++++
 engine/include/cubos/engine/audio/plugin.hpp  | 40 +++++++++++++++++++
 engine/include/cubos/engine/audio/source.hpp  | 20 ++++++++++
 engine/src/audio/audio.cpp                    |  2 +-
 engine/src/audio/listener.cpp                 | 11 +++++
 engine/src/audio/plugin.cpp                   | 39 ++++++++++++++++++
 engine/src/audio/source.cpp                   |  9 +++++
 10 files changed, 148 insertions(+), 4 deletions(-)
 create mode 100644 engine/include/cubos/engine/audio/listener.hpp
 create mode 100644 engine/include/cubos/engine/audio/plugin.hpp
 create mode 100644 engine/include/cubos/engine/audio/source.hpp
 create mode 100644 engine/src/audio/listener.cpp
 create mode 100644 engine/src/audio/plugin.cpp
 create mode 100644 engine/src/audio/source.cpp

diff --git a/engine/CMakeLists.txt b/engine/CMakeLists.txt
index 14bb380277..ef63e69c80 100644
--- a/engine/CMakeLists.txt
+++ b/engine/CMakeLists.txt
@@ -36,6 +36,9 @@ set(CUBOS_ENGINE_SOURCE
 	"src/utils/free_camera/plugin.cpp"
 	"src/utils/free_camera/controller.cpp"
 
+	"src/audio/plugin.cpp"
+	"src/audio/source.cpp"
+	"src/audio/listener.cpp"
     "src/audio/audio.cpp"
     "src/audio/bridge.cpp"
 
diff --git a/engine/include/cubos/engine/audio/audio.hpp b/engine/include/cubos/engine/audio/audio.hpp
index 62f7c3bda4..b7c6bc568c 100644
--- a/engine/include/cubos/engine/audio/audio.hpp
+++ b/engine/include/cubos/engine/audio/audio.hpp
@@ -20,7 +20,7 @@ namespace cubos::engine
         std::shared_ptr<cubos::core::al::impl::Buffer> mData; // Raw data of the audio
         size_t mLength;                                       // Audio length in seconds TODO: add getter in audio
 
-        explicit Audio(std::shared_ptr<cubos::core::al::MiniaudioContext>, core::memory::Stream& stream);
+        explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);
         Audio(Audio&& other) noexcept;
         ~Audio();
     };
diff --git a/engine/include/cubos/engine/audio/bridge.hpp b/engine/include/cubos/engine/audio/bridge.hpp
index fb196361a1..6fd5209668 100644
--- a/engine/include/cubos/engine/audio/bridge.hpp
+++ b/engine/include/cubos/engine/audio/bridge.hpp
@@ -17,10 +17,10 @@ namespace cubos::engine
     class AudioBridge : public FileBridge
     {
     public:
-        std::shared_ptr<cubos::core::al::MiniaudioContext> mContext;
+        std::shared_ptr<cubos::core::al::AudioContext> mContext;
 
         /// @brief Constructs a bridge.
-        AudioBridge(std::shared_ptr<cubos::core::al::MiniaudioContext> context)
+        AudioBridge(std::shared_ptr<cubos::core::al::AudioContext> context)
             : FileBridge(core::reflection::reflect<Audio>())
             , mContext(context)
         {
diff --git a/engine/include/cubos/engine/audio/listener.hpp b/engine/include/cubos/engine/audio/listener.hpp
new file mode 100644
index 0000000000..35c21445f0
--- /dev/null
+++ b/engine/include/cubos/engine/audio/listener.hpp
@@ -0,0 +1,22 @@
+/// @file
+/// @brief Component @ref cubos::engine::AudioListener.
+/// @ingroup audio-plugin
+
+#pragma once
+
+#include <cubos/core/reflection/reflect.hpp>
+
+#include <cubos/engine/api.hpp>
+
+namespace cubos::engine
+{
+    /// @brief Component which adds an AudioListener to the entitiy
+    /// @ingroup audio-plugin
+
+    struct CUBOS_ENGINE_API AudioListener
+    {
+        CUBOS_REFLECT;
+
+        bool active; // is the listener active (assigned to an entity)
+    };
+} // namespace cubos::engine
\ No newline at end of file
diff --git a/engine/include/cubos/engine/audio/plugin.hpp b/engine/include/cubos/engine/audio/plugin.hpp
new file mode 100644
index 0000000000..0a03c933fe
--- /dev/null
+++ b/engine/include/cubos/engine/audio/plugin.hpp
@@ -0,0 +1,40 @@
+/// @dir
+/// @brief @ref audio-plugin plugin directory.
+
+/// @file
+/// @brief Plugin entry point.
+/// @ingroup audio-plugin
+
+#pragma once
+
+#include <cubos/engine/audio/audio.hpp>
+#include <cubos/engine/audio/listener.hpp>
+#include <cubos/engine/audio/source.hpp>
+#include <cubos/engine/prelude.hpp>
+
+namespace cubos::engine
+{
+    /// @defgroup audio-plugin Audio
+    /// @ingroup engine
+    /// @brief Adds audio management to @b Cubos
+    ///
+    /// ## Settings
+    /// - `audio.listenerCount` - number of listeners per audio device (default: `4`).
+    ///
+    /// ## Dependencies
+    /// - @ref settings-plugin
+
+    /// @brief Initializes the audio manager (after @ref settingsTag).
+    CUBOS_ENGINE_API extern Tag audioInitTag;
+
+    /// @brief Systems which add bridges to the audio manager should be tagged with this.
+    CUBOS_ENGINE_API extern Tag audioBridgeTag;
+
+    /// @brief Startup systems which load audios should be tagged with this.
+    CUBOS_ENGINE_API extern Tag audioTag;
+
+    /// @brief Plugin entry function.
+    /// @param cubos @b Cubos main class.
+    /// @ingroup assets-plugin
+    CUBOS_ENGINE_API void audioPlugin(Cubos& cubos);
+} // namespace cubos::engine
diff --git a/engine/include/cubos/engine/audio/source.hpp b/engine/include/cubos/engine/audio/source.hpp
new file mode 100644
index 0000000000..d48b6ec3b1
--- /dev/null
+++ b/engine/include/cubos/engine/audio/source.hpp
@@ -0,0 +1,20 @@
+/// @file
+/// @brief Component @ref cubos::engine::AudioSource.
+/// @ingroup audio-plugin
+
+#pragma once
+
+#include <cubos/core/reflection/reflect.hpp>
+
+#include <cubos/engine/api.hpp>
+
+namespace cubos::engine
+{
+    /// @brief Component which adds an AudioSource to the entitiy
+    /// @ingroup audio-plugin
+
+    struct CUBOS_ENGINE_API AudioSource
+    {
+        CUBOS_REFLECT;
+    };
+} // namespace cubos::engine
\ No newline at end of file
diff --git a/engine/src/audio/audio.cpp b/engine/src/audio/audio.cpp
index 8629f72629..284473bad0 100644
--- a/engine/src/audio/audio.cpp
+++ b/engine/src/audio/audio.cpp
@@ -9,7 +9,7 @@ CUBOS_REFLECT_IMPL(cubos::engine::Audio)
     return core::reflection::Type::create("cubos::engine::Audio");
 }
 
-cubos::engine::Audio::Audio(std::shared_ptr<cubos::core::al::MiniaudioContext> context, core::memory::Stream& stream)
+cubos::engine::Audio::Audio(std::shared_ptr<cubos::core::al::AudioContext> context, core::memory::Stream& stream)
 {
     stream.seek(0, cubos::core::memory::SeekOrigin::End);
     size_t streamSize = stream.tell();
diff --git a/engine/src/audio/listener.cpp b/engine/src/audio/listener.cpp
new file mode 100644
index 0000000000..85ff21bc7e
--- /dev/null
+++ b/engine/src/audio/listener.cpp
@@ -0,0 +1,11 @@
+#include <cubos/core/ecs/reflection.hpp>
+#include <cubos/core/reflection/external/primitives.hpp>
+
+#include <cubos/engine/audio/listener.hpp>
+
+CUBOS_REFLECT_IMPL(cubos::engine::AudioListener)
+{
+    return core::ecs::TypeBuilder<AudioListener>("cubos::engine::AudioListener")
+        .withField("active", &AudioListener::active)
+        .build();
+}
\ No newline at end of file
diff --git a/engine/src/audio/plugin.cpp b/engine/src/audio/plugin.cpp
new file mode 100644
index 0000000000..5658c29322
--- /dev/null
+++ b/engine/src/audio/plugin.cpp
@@ -0,0 +1,39 @@
+#include <cubos/core/al/audio_context.hpp>
+
+#include <cubos/engine/assets/plugin.hpp>
+#include <cubos/engine/audio/bridge.hpp>
+#include <cubos/engine/audio/plugin.hpp>
+#include <cubos/engine/settings/plugin.hpp>
+
+CUBOS_DEFINE_TAG(cubos::engine::audioInitTag);
+CUBOS_DEFINE_TAG(cubos::engine::audioBridgeTag);
+CUBOS_DEFINE_TAG(cubos::engine::audioTag);
+
+using cubos::core::al::AudioContext;
+
+void cubos::engine::audioPlugin(Cubos& cubos)
+{
+    cubos.depends(settingsPlugin);
+
+    cubos.component<AudioSource>();
+    cubos.component<AudioListener>();
+
+    cubos.startupTag(audioTag);
+    cubos.startupTag(audioInitTag).after(settingsTag);
+    cubos.startupTag(audioBridgeTag).after(audioInitTag).before(audioTag);
+
+    cubos.startupSystem("initalize Audio plugin").tagged(audioInitTag).call([](Assets& assets, Settings& settings) {
+        auto audioContext = AudioContext::create();
+
+        unsigned int listenerCount = static_cast<unsigned int>(
+            settings.getInteger("audio.listener.count", static_cast<int>(MA_ENGINE_MAX_LISTENERS)));
+
+        auto audioDevice = audioContext->createDevice("MiniAudioDevice", listenerCount);
+
+        auto bridge = std::make_shared<AudioBridge>(audioContext);
+        assets.registerBridge(".wav", bridge);
+        assets.registerBridge(".mp3", bridge);
+        assets.registerBridge(".flac", bridge);
+        assets.registerBridge(".ogg", bridge);
+    });
+}
\ No newline at end of file
diff --git a/engine/src/audio/source.cpp b/engine/src/audio/source.cpp
new file mode 100644
index 0000000000..2a8b788d24
--- /dev/null
+++ b/engine/src/audio/source.cpp
@@ -0,0 +1,9 @@
+#include <cubos/core/ecs/reflection.hpp>
+#include <cubos/core/reflection/external/primitives.hpp>
+
+#include <cubos/engine/audio/source.hpp>
+
+CUBOS_REFLECT_IMPL(cubos::engine::AudioSource)
+{
+    return core::ecs::TypeBuilder<AudioSource>("cubos::engine::AudioSource").build();
+}
\ No newline at end of file