Skip to content

Commit

Permalink
feat(audio): Add Audio asset (#230)
Browse files Browse the repository at this point in the history
Co-Authored-By: João Miguel Nogueira <101069446+Dageus@users.noreply.github.com>
  • Loading branch information
diogomsmiranda and Dageus committed Oct 3, 2024
1 parent 6e3d340 commit 6b756fc
Show file tree
Hide file tree
Showing 6 changed files with 132 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial application debugging through Tesseratos (#1303, **@RiscadoA**).
- Print stacktrace with *cpptrace* on calls to CUBOS_FAIL (#1172, **@RiscadoA**).
- Orthographic Camera component (#1182, **@mkuritsu**).
- Audio asset (#230, **@Dageus**, **@diogomsmiranda**).

### Changed

Expand Down
3 changes: 3 additions & 0 deletions engine/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
28 changes: 28 additions & 0 deletions engine/include/cubos/engine/audio/audio.hpp
Original file line number Diff line number Diff line change
@@ -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
35 changes: 35 additions & 0 deletions engine/include/cubos/engine/audio/bridge.hpp
Original file line number Diff line number Diff line change
@@ -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
39 changes: 39 additions & 0 deletions engine/src/audio/audio.cpp
Original file line number Diff line number Diff line change
@@ -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)

Check warning on line 7 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L7

Added line #L7 was not covered by tests
{
return core::reflection::Type::create("cubos::engine::Audio");

Check warning on line 9 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L9

Added line #L9 was not covered by tests
}

cubos::engine::Audio::Audio(const std::shared_ptr<cubos::core::al::AudioContext>& context, core::memory::Stream& stream)

Check warning on line 12 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L12

Added line #L12 was not covered by tests
{
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))

Check warning on line 18 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L14-L18

Added lines #L14 - L18 were not covered by tests
{
CUBOS_ERROR("Couldn't load audio: stream read failed");
buffer = nullptr;
operator delete(contents);
return;

Check warning on line 23 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L20-L23

Added lines #L20 - L23 were not covered by tests
};

buffer = context->createBuffer(contents, (size_t)streamSize);
if (buffer == nullptr)

Check warning on line 27 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L26-L27

Added lines #L26 - L27 were not covered by tests
{
CUBOS_ERROR("Couldn't create audio buffer");

Check warning on line 29 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L29

Added line #L29 was not covered by tests
}
operator delete(contents);

Check warning on line 31 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L31

Added line #L31 was not covered by tests
}

cubos::engine::Audio::~Audio() = default;

Check warning on line 34 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L34

Added line #L34 was not covered by tests

cubos::engine::Audio::Audio(Audio&& other) noexcept
: buffer(std::move(other.buffer))

Check warning on line 37 in engine/src/audio/audio.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/audio.cpp#L36-L37

Added lines #L36 - L37 were not covered by tests
{
}
26 changes: 26 additions & 0 deletions engine/src/audio/bridge.cpp
Original file line number Diff line number Diff line change
@@ -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)

Check warning on line 9 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L9

Added line #L9 was not covered by tests
{
Audio audio{mContext, stream};
if (audio.buffer == nullptr)

Check warning on line 12 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L11-L12

Added lines #L11 - L12 were not covered by tests
{
return false;

Check warning on line 14 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L14

Added line #L14 was not covered by tests
}
assets.store(handle, std::move(audio));
return true;

Check warning on line 17 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L16-L17

Added lines #L16 - L17 were not covered by tests
}
bool AudioBridge::saveToFile(const Assets& assets, const AnyAsset& handle, core::memory::Stream& stream)

Check warning on line 19 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L19

Added line #L19 was not covered by tests
{
(void)assets;
(void)handle;
(void)stream;
CUBOS_ERROR("Saving audios is currently unsupported");
return false;

Check warning on line 25 in engine/src/audio/bridge.cpp

View check run for this annotation

Codecov / codecov/patch

engine/src/audio/bridge.cpp#L24-L25

Added lines #L24 - L25 were not covered by tests
}

0 comments on commit 6b756fc

Please sign in to comment.