feat(audio): Add Audio asset (#230)

Co-Authored-By: João Miguel Nogueira <[email protected]>

CHANGELOG.md

@@ -18,20 +18,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Deadzone for input axis (#844, **@kuukitenshi**).
 - Generic Camera component to hold projection matrix (#1331, **@mkuritsu**).
 - Initial application debugging through Tesseratos (#1303, **@RiscadoA**).
-- Print stacktrace with *cpptrace* on calls to CUBOS_FAIL (#1172, **@RiscadoA**).
+- Print stacktrace with _cpptrace_ on calls to CUBOS_FAIL (#1172, **@RiscadoA**).
 - Orthographic Camera component (#1182, **@mkuritsu**).
 - Importer plugin (#1299, **@Scarface1809**).
 - Handle body rotation on penetration solving (#1272, **&fallenatlas**).
 - Cascaded shadow maps (#1187, **@tomas7770**).
 - Global telemetry level (for tracing/logging) (#1265, **@roby2014**).
 - Spans for tracing and profiling (#1265, **@roby2014**).
+- Audio asset (#230, **@Dageus**, **@diogomsmiranda**).
 
 ### Changed
 
 - Moved Glad and stb-image libs to another repositories, cubos-glad and cubos-stb, respectively (#1323, **@kuukitenshi**).
 - Moved most tools from Tesseratos to the engine (#1322, **@RiscadoA**).
 - Replaced OpenAL audio device with Miniaudio backend (#1005, **@Dageus**, **@diogomsmiranda**)
+
 ### Fixed
+
 - Spot light angle mismatch between light and shadows (#1310, **@tomas7770**).
 - Spot shadows cause light range cutoff (#1312, **@tomas7770**).
 - Precision error in split screen size calculations (**@mkuritsu**).

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/audio.cpp"
+ "src/audio/bridge.cpp"
+
  "src/assets/plugin.cpp"
  "src/assets/assets.cpp"
  "src/assets/bridge.cpp"

engine/include/cubos/engine/audio/audio.hpp

@@ -0,0 +1,28 @@
+/// @file
+/// @brief Class @ref cubos::engine::Audio.
+/// @ingroup audio-plugin
+#pragma once
+
+#include <cubos/core/al/miniaudio_context.hpp>
+#include <cubos/core/memory/stream.hpp>
+#include <cubos/core/reflection/reflect.hpp>
+
+#include <cubos/engine/assets/asset.hpp>
+
+namespace cubos::engine
+{
+ /// @brief Asset containing raw Audio data.
+ ///
+ /// @ingroup audio-plugin
+ struct CUBOS_ENGINE_API Audio
+ {
+ CUBOS_REFLECT;
+
+ /// @brief Audio buffer.
+ cubos::core::al::Buffer buffer;
+
+ explicit Audio(const std::shared_ptr<cubos::core::al::AudioContext>& context, core::memory::Stream& stream);
+ Audio(Audio&& other) noexcept;
+ ~Audio();
+ };
+} // namespace cubos::engine

engine/include/cubos/engine/audio/bridge.hpp

@@ -0,0 +1,35 @@
+/// @file
+/// @brief Class @ref cubos::engine::AudioBridge.
+/// @ingroup audio-plugin
+
+#pragma once
+
+#include <utility>
+
+#include <cubos/engine/assets/bridges/file.hpp>
+#include <cubos/engine/audio/audio.hpp>
+
+namespace cubos::engine
+{
+ /// @brief Bridge which loads and saves @ref Sound assets.
+ ///
+ /// Uses the format specified in @ref Audio::loadFrom and @ref Audio::writeTo
+ ///
+ /// @ingroup audio-plugin
+ class AudioBridge : public FileBridge
+ {
+ public:
+ std::shared_ptr<cubos::core::al::AudioContext> mContext;
+
+ /// @brief Constructs a bridge.
+ AudioBridge(std::shared_ptr<cubos::core::al::AudioContext> context)
+ : FileBridge(core::reflection::reflect<Audio>())
+ , mContext(std::move(context))
+ {
+ }
+
+ protected:
+ bool loadFromFile(Assets& assets, const AnyAsset& handle, core::memory::Stream& stream) override;
+ bool saveToFile(const Assets& assets, const AnyAsset& handle, core::memory::Stream& stream) override;
+ };
+} // namespace cubos::engine

engine/src/audio/audio.cpp

@@ -0,0 +1,39 @@
+#include <cubos/core/log.hpp>
+#include <cubos/core/reflection/external/cstring.hpp>
+#include <cubos/core/reflection/type.hpp>
+
+#include <cubos/engine/audio/audio.hpp>
+
+CUBOS_REFLECT_IMPL(cubos::engine::Audio)
+{
+ return core::reflection::Type::create("cubos::engine::Audio");
+}
+
+cubos::engine::Audio::Audio(const 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();
+ void* contents = operator new(sizeof(char) * streamSize);
+ stream.seek(0, cubos::core::memory::SeekOrigin::Begin);
+ if (!stream.readExact((char*)contents, streamSize))
+ {
+ CUBOS_ERROR("Couldn't load audio: stream read failed");
+ buffer = nullptr;
+ operator delete(contents);
+ return;
+ };
+
+ buffer = context->createBuffer(contents, (size_t)streamSize);
+ if (buffer == nullptr)
+ {
+ CUBOS_ERROR("Couldn't create audio buffer");
+ }
+ operator delete(contents);
+}
+
+cubos::engine::Audio::~Audio() = default;
+
+cubos::engine::Audio::Audio(Audio&& other) noexcept
+ : buffer(std::move(other.buffer))
+{
+}

engine/src/audio/bridge.cpp

@@ -0,0 +1,26 @@
+#include <cubos/core/log.hpp>
+
+#include <cubos/engine/assets/assets.hpp>
+#include <cubos/engine/audio/audio.hpp>
+#include <cubos/engine/audio/bridge.hpp>
+
+using namespace cubos::engine;
+
+bool AudioBridge::loadFromFile(Assets& assets, const AnyAsset& handle, core::memory::Stream& stream)
+{
+ Audio audio{mContext, stream};
+ if (audio.buffer == nullptr)
+ {
+ return false;
+ }
+ assets.store(handle, std::move(audio));
+ return true;
+}
+bool AudioBridge::saveToFile(const Assets& assets, const AnyAsset& handle, core::memory::Stream& stream)
+{
+ (void)assets;
+ (void)handle;
+ (void)stream;
+ CUBOS_ERROR("Saving audios is currently unsupported");
+ return false;
+}