Add stopSounds method to IEngine

Author: adazem009

include/scratchcpp/iengine.h

@@ -81,6 +81,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Automatically called from clones that are being deleted. */
         virtual void deinitClone(std::shared_ptr<Sprite> clone) = 0;
 
+        /*! Stops all currently playing sounds. */
+        virtual void stopSounds() = 0;
+
         /*! Steps all currently running threads. Use this to implement a custom event loop. */
         virtual void step() = 0;
 

src/engine/internal/engine.cpp

@@ -16,6 +16,7 @@
 #include <scratchcpp/comment.h>
 #include <scratchcpp/costume.h>
 #include <scratchcpp/keyevent.h>
+#include <scratchcpp/sound.h>
 #include <cassert>
 #include <iostream>
 
@@ -189,6 +190,7 @@ void Engine::stop()
 {
     // https://github.com/scratchfoundation/scratch-vm/blob/f1aa92fad79af17d9dd1c41eeeadca099339a9f1/src/engine/runtime.js#L2057-L2081
     deleteClones();
+    stopSounds();
 
     if (m_activeThread) {
         stopThread(m_activeThread.get());
@@ -276,6 +278,19 @@ void Engine::deinitClone(std::shared_ptr<Sprite> clone)
     m_executableTargets.erase(std::remove(m_executableTargets.begin(), m_executableTargets.end(), clone.get()), m_executableTargets.end());
 }
 
+void Engine::stopSounds()
+{
+    // TODO: Loop through clones
+    for (auto target : m_targets) {
+        const auto &sounds = target->sounds();
+
+        for (auto sound : sounds) {
+            if (sound->isPlaying())
+                sound->stop();
+        }
+    }
+}
+
 void Engine::step()
 {
     // https://github.com/scratchfoundation/scratch-vm/blob/f1aa92fad79af17d9dd1c41eeeadca099339a9f1/src/engine/runtime.js#L2087C6-L2155

src/engine/internal/engine.h

@@ -41,6 +41,7 @@ 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;
 
         void step() override;
         void run() override;

test/engine/engine_test.cpp

@@ -6,8 +6,11 @@
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/keyevent.h>
+#include <scratch/sound_p.h>
 #include <timermock.h>
 #include <clockmock.h>
+#include <audioplayerfactorymock.h>
+#include <audioplayermock.h>
 #include <thread>
 
 #include "../common.h"
@@ -70,6 +73,35 @@ TEST(EngineTest, IsRunning)
     ASSERT_FALSE(engine.isRunning());
 }
 
+TEST(EngineTest, StopSounds)
+{
+    AudioPlayerFactoryMock factory;
+    auto player1 = std::make_shared<AudioPlayerMock>();
+    auto player2 = std::make_shared<AudioPlayerMock>();
+    auto player3 = std::make_shared<AudioPlayerMock>();
+    SoundPrivate::playerFactory = &factory;
+    EXPECT_CALL(factory, create()).WillOnce(Return(player1)).WillOnce(Return(player2)).WillOnce(Return(player3));
+    EXPECT_CALL(*player1, load).WillOnce(Return(true));
+    EXPECT_CALL(*player2, load).WillOnce(Return(true));
+    EXPECT_CALL(*player3, load).WillOnce(Return(true));
+    EXPECT_CALL(*player1, setVolume).Times(2);
+    EXPECT_CALL(*player2, setVolume).Times(2);
+    EXPECT_CALL(*player3, setVolume).Times(2);
+    Project p("sounds.sb3");
+    ASSERT_TRUE(p.load());
+
+    auto engine = p.engine();
+
+    EXPECT_CALL(*player1, isPlaying()).WillOnce(Return(false));
+    EXPECT_CALL(*player2, isPlaying()).WillOnce(Return(true));
+    EXPECT_CALL(*player3, isPlaying()).WillOnce(Return(true));
+    EXPECT_CALL(*player2, stop());
+    EXPECT_CALL(*player3, stop());
+    engine->stopSounds();
+
+    SoundPrivate::playerFactory = nullptr;
+}
+
 TEST(EngineTest, Step)
 {
     Project p("step.sb3");

test/mocks/enginemock.h

@@ -24,6 +24,7 @@ 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(void, step, (), (override));
         MOCK_METHOD(void, run, (), (override));