Sound: Add owner property

Author: adazem009

include/scratchcpp/sound.h

@@ -9,6 +9,7 @@
 namespace libscratchcpp
 {
 
+class Thread;
 class SoundPrivate;
 
 /*! \brief The Sound class represents a Scratch sound. */
@@ -34,13 +35,15 @@ class LIBSCRATCHCPP_EXPORT Sound : public Asset
         virtual void setVolume(double volume);
         virtual void setEffect(Effect effect, double value);
 
-        virtual void start();
+        virtual void start(Thread *owner = nullptr);
         virtual void stop();
 
         virtual bool isPlaying() const;
 
         std::shared_ptr<Sound> clone() const;
 
+        Thread *owner() const;
+
     protected:
         void processData(unsigned int size, void *data) override;
         virtual bool isClone() const override;

src/scratch/sound.cpp

@@ -66,10 +66,11 @@ void Sound::setEffect(Effect effect, double value)
 }
 
 /*! Starts the playback of the sound. */
-void Sound::start()
+void Sound::start(Thread *owner)
 {
     // Stop sounds in clones (#538)
     stopCloneSounds();
+    impl->owner = owner;
     impl->player->start();
 }
 
@@ -78,6 +79,7 @@ void Sound::stop()
 {
     // Stop sounds in clones (#538)
     stopCloneSounds();
+    impl->owner = nullptr;
     impl->player->stop();
 }
 
@@ -107,6 +109,11 @@ std::shared_ptr<Sound> Sound::clone() const
     return sound;
 }
 
+Thread *Sound::owner() const
+{
+    return impl->owner;
+}
+
 void Sound::processData(unsigned int size, void *data)
 {
     if (impl->player->isLoaded())

src/scratch/sound_p.h

@@ -11,6 +11,7 @@ namespace libscratchcpp
 {
 
 class Sound;
+class Thread;
 
 struct SoundPrivate
 {
@@ -22,6 +23,7 @@ struct SoundPrivate
         static IAudioOutput *audioOutput;
         std::shared_ptr<IAudioPlayer> player = nullptr;
         const Sound *cloneRoot = nullptr;
+        Thread *owner = nullptr;
 };
 
 } // namespace libscratchcpp

test/assets/sound_test.cpp

@@ -1,5 +1,6 @@
 #include <scratchcpp/sound.h>
 #include <scratchcpp/sprite.h>
+#include <scratchcpp/thread.h>
 #include <scratch/sound_p.h>
 #include <audiooutputmock.h>
 #include <audioplayermock.h>
@@ -128,6 +129,16 @@ TEST_F(SoundTest, Start)
     sound.start();
 }
 
+TEST_F(SoundTest, StartWithOwner)
+{
+    Sound sound("sound1", "a", "wav");
+    Thread thread(nullptr, nullptr, nullptr);
+
+    EXPECT_CALL(*m_player, start());
+    sound.start(&thread);
+    ASSERT_EQ(sound.owner(), &thread);
+}
+
 TEST_F(SoundTest, Stop)
 {
     Sound sound("sound1", "a", "wav");
@@ -136,6 +147,20 @@ TEST_F(SoundTest, Stop)
     sound.stop();
 }
 
+TEST_F(SoundTest, StartAndStopWithOwner)
+{
+    Sound sound("sound1", "a", "wav");
+    Thread thread(nullptr, nullptr, nullptr);
+
+    EXPECT_CALL(*m_player, start());
+    sound.start(&thread);
+    ASSERT_EQ(sound.owner(), &thread);
+
+    EXPECT_CALL(*m_player, stop());
+    sound.stop();
+    ASSERT_EQ(sound.owner(), nullptr);
+}
+
 TEST_F(SoundTest, IsPlaying)
 {
     Sound sound("sound1", "a", "wav");

test/mocks/soundmock.h

@@ -16,7 +16,7 @@ class SoundMock : public Sound
         MOCK_METHOD(void, setVolume, (double), (override));
         MOCK_METHOD(void, setEffect, (Sound::Effect, double), (override));
 
-        MOCK_METHOD(void, start, (), (override));
+        MOCK_METHOD(void, start, (Thread *), (override));
         MOCK_METHOD(void, stop, (), (override));
         MOCK_METHOD(bool, isPlaying, (), (const, override));
 };