1004 Add Audio support to the engine #1321

diogomsmiranda · 2024-09-24T11:24:49Z

Description

Include a summary of the changes here.

Checklist

Self-review changes.
Evaluate impact on the documentation.
Ensure test coverage.
Write new samples.
Add entry to the changelog's unreleased section.

github-actions · 2024-09-24T11:25:49Z

PR Preview Action v1.4.8
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/preview/pr-1321/
on branch `gh-pages` at 2024-10-22 21:40 UTC

codecov · 2024-09-24T11:43:32Z

Codecov Report

Attention: Patch coverage is 0% with 205 lines in your changes missing coverage. Please review.

Project coverage is 42.19%. Comparing base (7205c59) to head (9c844c0).

Files with missing lines	Patch %	Lines
core/src/al/miniaudio_context.cpp	0.00%	137 Missing ⚠️
engine/src/audio/audio.cpp	0.00%	20 Missing ⚠️
engine/src/audio/plugin.cpp	0.00%	18 Missing ⚠️
core/include/cubos/core/al/audio_context.hpp	0.00%	10 Missing ⚠️
engine/src/audio/bridge.cpp	0.00%	9 Missing ⚠️
engine/src/audio/listener.cpp	0.00%	4 Missing ⚠️
engine/include/cubos/engine/audio/bridge.hpp	0.00%	3 Missing ⚠️
core/src/al/audio_context.cpp	0.00%	2 Missing ⚠️
engine/src/audio/source.cpp	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1321      +/-   ##
==========================================
- Coverage   42.45%   42.19%   -0.26%     
==========================================
  Files         410      416       +6     
  Lines       29260    29442     +182     
==========================================
+ Hits        12421    12422       +1     
- Misses      16839    17020     +181

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/1)

core/src/al/miniaudio_device.cpp

RiscadoA

Thanks for working on this! Reviewed the audio device part

core/include/cubos/core/al/miniaudio_device.hpp

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

core/src/al/miniaudio_device.cpp

core/include/cubos/core/al/audio_context.hpp

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

engine/src/audio/audio.cpp

engine/src/audio/plugin.cpp

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

engine/src/audio/plugin.cpp

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/2)

github-actions · 2024-10-03T15:55:51Z

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

+        CUBOS_REFLECT;
+
+    private:
+        cubos::core::al::Source source;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member source

Suggested change

cubos::core::al::Source source;

cubos::core::al::Source mSource;

github-actions · 2024-10-03T15:55:51Z

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

+        bool active = false; //< Is the listener active?
+
+    private:
+        cubos::core::al::Listener listener;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member listener

Suggested change

cubos::core::al::Listener listener;

cubos::core::al::Listener mListener;

github-actions · 2024-10-03T15:55:51Z

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

+
+#include <cubos/engine/assets/bridges/file.hpp>
+#include <cubos/engine/audio/audio.hpp>
+


⚠️ modernize-pass-by-value ⚠️
pass by value and use std::move

Suggested change

#include <utility>

github-actions · 2024-10-03T15:55:51Z

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

+        /// @brief Constructs a bridge.
+        AudioBridge(std::shared_ptr<cubos::core::al::AudioContext> context)
+            : FileBridge(core::reflection::reflect<Audio>())
+            , mContext(context)


⚠️ modernize-pass-by-value ⚠️
pass by value and use std::move

Suggested change

, mContext(context)

, mContext(std::move(context))

github-actions · 2024-10-03T15:55:51Z

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

+
+#include <cubos/engine/assets/bridges/file.hpp>
+#include <cubos/engine/audio/audio.hpp>
+


⚠️ performance-unnecessary-value-param ⚠️
parameter context is passed by value and only copied once; consider moving it to avoid unnecessary copies

Suggested change

#include <utility>

github-actions · 2024-10-03T15:55:52Z

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

+        /// @brief Constructs a bridge.
+        AudioBridge(std::shared_ptr<cubos::core::al::AudioContext> context)
+            : FileBridge(core::reflection::reflect<Audio>())
+            , mContext(context)


⚠️ performance-unnecessary-value-param ⚠️
parameter context is passed by value and only copied once; consider moving it to avoid unnecessary copies

Suggested change

, mContext(context)

, mContext(std::move(context))

github-actions · 2024-10-03T15:55:52Z

core/src/al/miniaudio_context.cpp

+    {
+    }


⚠️ modernize-use-equals-default ⚠️
use = default to define a trivial destructor

Suggested change

{

}

= default;

github-actions · 2024-10-03T15:55:52Z

core/src/al/miniaudio_context.cpp

+public:
+    MiniaudioDevice(ma_context& context, const std::string& deviceName, ma_uint32 listenerCount)
+        : mContext(context)
+        , mListeners()


⚠️ readability-redundant-member-init ⚠️
initializer for member mListeners is redundant

Suggested change

, mListeners()

,

github-actions · 2024-10-03T15:55:52Z

core/src/al/miniaudio_context.cpp

+
+    for (ma_uint32 i = 0; i < playbackDeviceCount; i++)
+    {
+        if (pPlaybackDeviceInfos[i].isDefault)


⚠️ readability-implicit-bool-conversion ⚠️
implicit conversion ma_bool32 (aka unsigned int) -> bool

Suggested change

if (pPlaybackDeviceInfos[i].isDefault)

if (pPlaybackDeviceInfos[i].isDefault != 0u)

github-actions · 2024-10-03T15:55:52Z

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

+        /// @brief Audio buffer.
+        cubos::core::al::Buffer buffer;
+
+        explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);

explicit Audio(std::shared_ptr<cubos::core::al::AudioContext> /*context*/, core::memory::Stream& stream);

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (2/2)

github-actions · 2024-10-03T15:56:04Z

engine/src/audio/audio.cpp

+    return core::reflection::Type::create("cubos::engine::Audio");
+}
+
+cubos::engine::Audio::Audio(std::shared_ptr<cubos::core::al::AudioContext> context, core::memory::Stream& stream)


⚠️ performance-unnecessary-value-param ⚠️
the parameter context is copied for each invocation but only used as a const reference; consider making it a const reference

Suggested change

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

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

github-actions · 2024-10-03T15:56:04Z

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

+        /// @brief Audio buffer.
+        cubos::core::al::Buffer buffer;
+
+        explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);


⚠️ performance-unnecessary-value-param ⚠️
the parameter context is copied for each invocation but only used as a const reference; consider making it a const reference

Suggested change

explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);

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

github-actions · 2024-10-03T15:56:04Z

engine/src/audio/audio.cpp

+    operator delete(contents);
+}
+
+cubos::engine::Audio::~Audio()


⚠️ modernize-use-equals-default ⚠️
use = default to define a trivial destructor

github-actions · 2024-10-03T15:56:04Z

engine/src/audio/audio.cpp

+}
+
+cubos::engine::Audio::Audio(Audio&& other) noexcept
+    : buffer(other.buffer)


⚠️ performance-move-constructor-init ⚠️
move constructor initializes class member by calling a copy constructor

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

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/1)

github-actions · 2024-10-22T21:40:32Z

engine/src/audio/bridge.cpp

@@ -0,0 +1,26 @@
+#include <cubos/core/log.hpp>


⚠️ clang-diagnostic-error ⚠️
cubos/core/log.hpp file not found

github-actions · 2024-10-22T21:40:32Z

engine/src/audio/bridge.cpp

+    if (audio.buffer == nullptr)
+    {
+        return false;
+    }
+    assets.store(handle, std::move(audio));
+    return true;


⚠️ readability-simplify-boolean-expr ⚠️
redundant boolean literal in conditional return statement

Suggested change

if (audio.buffer == nullptr)

{

return false;

}

assets.store(handle, std::move(audio));

return true;

return static_cast<bool>(audio.buffer != nullptr);

github-actions · 2024-10-22T21:40:32Z

core/src/al/miniaudio_context.cpp

@@ -1,7 +1,7 @@
 #define MINIAUDIO_IMPLEMENTATION
 #include <cubos/core/al/miniaudio_context.hpp>
+#include <cubos/core/log.hpp>


⚠️ clang-diagnostic-error ⚠️
cubos/core/log.hpp file not found

github-actions · 2024-10-22T21:40:32Z

engine/src/audio/audio.cpp

@@ -0,0 +1,43 @@
+#include <cubos/core/log.hpp>


⚠️ clang-diagnostic-error ⚠️
cubos/core/log.hpp file not found

diogomsmiranda linked an issue Sep 24, 2024 that may be closed by this pull request

Add audio support to the engine #1004

Closed

4 tasks

diogomsmiranda assigned diogomsmiranda and Dageus Sep 24, 2024

github-actions bot added A-Engine B-Audio C-Tracking-Issue labels Sep 24, 2024

This comment was marked as outdated.

Sign in to view

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch from 8ee607d to 362bfac Compare September 24, 2024 11:30

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch 3 times, most recently from e72f419 to 9a7bb18 Compare September 24, 2024 12:17

github-actions bot reviewed Sep 24, 2024

View reviewed changes

core/src/al/miniaudio_device.cpp Outdated Show resolved Hide resolved

core/src/al/miniaudio_device.cpp Outdated Show resolved Hide resolved

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch 5 times, most recently from 31b51bd to a7bae01 Compare September 29, 2024 21:28

RiscadoA requested changes Sep 30, 2024

View reviewed changes

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch 2 times, most recently from b480460 to 52949f6 Compare October 2, 2024 14:13

RiscadoA requested changes Oct 2, 2024

View reviewed changes

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch from 2b9a02d to d30fa15 Compare October 2, 2024 18:38

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch from d30fa15 to 9c844c0 Compare October 3, 2024 15:54

github-actions bot reviewed Oct 3, 2024

View reviewed changes

diogomsmiranda and others added 6 commits October 22, 2024 22:38

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

f685309

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

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

02d6ab0

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

chore(audio): refactor code in audio scope

b251491

feat(audio): Add AudioContext and MiniaudioContext

20a2545

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

feat(audio): Add AudioListener and MiniaudioListener

124311b

feat(audio): add AudioPlugin

813e49e

diogomsmiranda force-pushed the 1004-add-audio-support-to-the-engine branch from 9c844c0 to 813e49e Compare October 22, 2024 21:39

github-actions bot reviewed Oct 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1004 Add Audio support to the engine #1321

1004 Add Audio support to the engine #1321

diogomsmiranda commented Sep 24, 2024

github-actions bot commented Sep 24, 2024 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Sep 24, 2024 •

edited

Loading

github-actions bot left a comment

RiscadoA left a comment

github-actions bot left a comment

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot left a comment

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot left a comment

github-actions bot Oct 22, 2024

github-actions bot Oct 22, 2024

github-actions bot Oct 22, 2024

github-actions bot Oct 22, 2024

	cubos::core::al::Source source;
	cubos::core::al::Source mSource;

	cubos::core::al::Listener listener;
	cubos::core::al::Listener mListener;


		#include <cubos/engine/assets/bridges/file.hpp>
		#include <cubos/engine/audio/audio.hpp>

	if (pPlaybackDeviceInfos[i].isDefault)
	if (pPlaybackDeviceInfos[i].isDefault != 0u)

	explicit Audio(std::shared_ptr<cubos::core::al::AudioContext>, core::memory::Stream& stream);
	explicit Audio(std::shared_ptr<cubos::core::al::AudioContext> /context/, core::memory::Stream& stream);

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

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

1004 Add Audio support to the engine #1321

Are you sure you want to change the base?

1004 Add Audio support to the engine #1321

Conversation

diogomsmiranda commented Sep 24, 2024

Description

Checklist

github-actions bot commented Sep 24, 2024 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Sep 24, 2024 • edited Loading

Codecov Report

github-actions bot left a comment

Choose a reason for hiding this comment

RiscadoA left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 22, 2024

Choose a reason for hiding this comment

github-actions bot Oct 22, 2024

Choose a reason for hiding this comment

github-actions bot Oct 22, 2024

Choose a reason for hiding this comment

github-actions bot Oct 22, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 24, 2024 •

edited

Loading

codecov bot commented Sep 24, 2024 •

edited

Loading