Add global volume API

Author: adazem009

include/scratchcpp/iengine.h

@@ -87,6 +87,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Stops all currently playing sounds. */
         virtual void stopSounds() = 0;
 
+        /*! Returns the global volume of all sounds (in %). */
+        virtual double globalVolume() const = 0;
+
+        /*! Sets the global volume of all sounds (in %). */
+        virtual void setGlobalVolume(double volume) = 0;
+
         /*! Updates the values of stage monitors. */
         virtual void updateMonitors() = 0;
 

src/engine/internal/engine.cpp

@@ -26,6 +26,7 @@
 #include "blocksectioncontainer.h"
 #include "timer.h"
 #include "clock.h"
+#include "audio/iaudioengine.h"
 #include "blocks/standardblocks.h"
 #include "blocks/variableblocks.h"
 #include "blocks/listblocks.h"
@@ -46,7 +47,8 @@ const std::unordered_map<Engine::HatType, bool> Engine::m_hatEdgeActivated = {
 Engine::Engine() :
     m_defaultTimer(std::make_unique<Timer>()),
     m_timer(m_defaultTimer.get()),
-    m_clock(Clock::instance().get())
+    m_clock(Clock::instance().get()),
+    m_audioEngine(IAudioEngine::instance())
 {
 }
 
@@ -469,6 +471,16 @@ void Engine::stopSounds()
     }
 }
 
+double Engine::globalVolume() const
+{
+    return m_audioEngine->volume() * 100;
+}
+
+void Engine::setGlobalVolume(double volume)
+{
+    m_audioEngine->setVolume(volume / 100);
+}
+
 void Engine::updateMonitors()
 {
     // Execute the "script" of each visible monitor

src/engine/internal/engine.h

@@ -19,6 +19,7 @@ namespace libscratchcpp
 
 class Entity;
 class IClock;
+class IAudioEngine;
 
 class Engine : public IEngine
 {
@@ -41,7 +42,10 @@ class Engine : public IEngine
         void stopTarget(Target *target, VirtualMachine *exceptScript) override;
         void initClone(std::shared_ptr<Sprite> clone) override;
         void deinitClone(std::shared_ptr<Sprite> clone) override;
+
         void stopSounds() override;
+        virtual double globalVolume() const override;
+        virtual void setGlobalVolume(double volume) override;
 
         void updateMonitors() override;
         void step() override;
@@ -163,6 +167,7 @@ class Engine : public IEngine
         void setUserAgent(const std::string &agent) override;
 
         IClock *m_clock = nullptr;
+        IAudioEngine *m_audioEngine = nullptr;
 
     private:
         enum class HatType

test/engine/engine_test.cpp

@@ -14,6 +14,7 @@
 #include <scratch/sound_p.h>
 #include <timermock.h>
 #include <clockmock.h>
+#include <audioenginemock.h>
 #include <audioinputmock.h>
 #include <audiooutputmock.h>
 #include <audioplayermock.h>
@@ -318,6 +319,24 @@ TEST(EngineTest, StopSounds)
     SoundPrivate::audioOutput = nullptr;
 }
 
+TEST(EngineTest, GlobalVolume)
+{
+    Engine engine;
+    ASSERT_EQ(engine.globalVolume(), 100);
+
+    engine.setGlobalVolume(58.3);
+    ASSERT_EQ(engine.globalVolume(), 58.3);
+
+    AudioEngineMock audioEngine;
+    engine.m_audioEngine = &audioEngine;
+
+    EXPECT_CALL(audioEngine, volume()).WillOnce(Return(0.275));
+    ASSERT_EQ(engine.globalVolume(), 27.5);
+
+    EXPECT_CALL(audioEngine, setVolume(0.9236));
+    engine.setGlobalVolume(92.36);
+}
+
 TEST(EngineTest, Step)
 {
     Project p("step.sb3");

test/mocks/enginemock.h

@@ -24,7 +24,10 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, stopTarget, (Target *, VirtualMachine *), (override));
         MOCK_METHOD(void, initClone, (std::shared_ptr<Sprite>), (override));
         MOCK_METHOD(void, deinitClone, (std::shared_ptr<Sprite>), (override));
+
         MOCK_METHOD(void, stopSounds, (), (override));
+        MOCK_METHOD(double, globalVolume, (), (const, override));
+        MOCK_METHOD(void, setGlobalVolume, (double), (override));
 
         MOCK_METHOD(void, updateMonitors, (), (override));
         MOCK_METHOD(void, step, (), (override));