Target: Add API for sound effects

Author: adazem009

include/scratchcpp/target.h

@@ -7,6 +7,7 @@
 #include "global.h"
 #include "spimpl.h"
 #include "rect.h"
+#include "sound.h"
 
 namespace libscratchcpp
 {
@@ -88,6 +89,8 @@ class LIBSCRATCHCPP_EXPORT Target
         double volume() const;
         void setVolume(double newVolume);
 
+        virtual void setSoundEffect(Sound::Effect effect, double value);
+
         virtual Rect boundingRect() const;
         virtual Rect fastBoundingRect() const;
 

src/scratch/target.cpp

@@ -359,6 +359,9 @@ int Target::addSound(std::shared_ptr<Sound> sound)
     if (sound) {
         sound->setTarget(this);
         sound->setVolume(impl->volume);
+
+        for (const auto &[effect, value] : impl->soundEffects)
+            sound->setEffect(effect, value);
     }
 
     impl->sounds.push_back(sound);
@@ -419,6 +422,17 @@ void Target::setVolume(double newVolume)
     }
 }
 
+/*! Sets the value of the given sound effect. */
+void Target::setSoundEffect(Sound::Effect effect, double value)
+{
+    impl->soundEffects[effect] = value;
+
+    for (auto sound : impl->sounds) {
+        if (sound)
+            sound->setEffect(effect, value);
+    }
+}
+
 /*! Returns the bounding rectangle of the sprite. */
 Rect Target::boundingRect() const
 {

src/scratch/target_p.h

@@ -36,6 +36,7 @@ struct TargetPrivate
         std::vector<std::shared_ptr<Sound>> sounds;
         int layerOrder = 0;
         double volume = 100;
+        std::unordered_map<Sound::Effect, double> soundEffects;
         std::unordered_map<IGraphicsEffect *, double> graphicsEffects;
         Target::BubbleType bubbleType = Target::BubbleType::Say;
         std::string bubbleText;

test/mocks/targetmock.h

@@ -17,6 +17,8 @@ class TargetMock : public Target
 
         MOCK_METHOD(void, setLayerOrder, (int), (override));
 
+        MOCK_METHOD(void, setSoundEffect, (Sound::Effect, double), (override));
+
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
 

test/scratch_classes/target_test.cpp

@@ -13,6 +13,7 @@
 #include <graphicseffectmock.h>
 #include <audiooutputmock.h>
 #include <audioplayermock.h>
+#include <soundmock.h>
 
 #include "../common.h"
 
@@ -511,6 +512,38 @@ TEST(TargetTest, Volume)
     SoundPrivate::audioOutput = nullptr;
 }
 
+TEST(TargetTest, SetSoundEffect)
+{
+    Target target;
+
+    auto s1 = std::make_shared<SoundMock>();
+    auto s2 = std::make_shared<SoundMock>();
+    auto s3 = std::make_shared<SoundMock>();
+
+    EXPECT_CALL(*s1, setVolume);
+    EXPECT_CALL(*s2, setVolume);
+    EXPECT_CALL(*s3, setVolume);
+    target.addSound(s1);
+    target.addSound(s2);
+    target.addSound(s3);
+
+    EXPECT_CALL(*s1, setEffect(Sound::Effect::Pitch, 12.5));
+    EXPECT_CALL(*s2, setEffect(Sound::Effect::Pitch, 12.5));
+    EXPECT_CALL(*s3, setEffect(Sound::Effect::Pitch, 12.5));
+    target.setSoundEffect(Sound::Effect::Pitch, 12.5);
+
+    EXPECT_CALL(*s1, setEffect(Sound::Effect::Pan, -56.7));
+    EXPECT_CALL(*s2, setEffect(Sound::Effect::Pan, -56.7));
+    EXPECT_CALL(*s3, setEffect(Sound::Effect::Pan, -56.7));
+    target.setSoundEffect(Sound::Effect::Pan, -56.7);
+
+    auto s4 = std::make_shared<SoundMock>();
+    EXPECT_CALL(*s4, setVolume);
+    EXPECT_CALL(*s4, setEffect(Sound::Effect::Pitch, 12.5));
+    EXPECT_CALL(*s4, setEffect(Sound::Effect::Pan, -56.7));
+    target.addSound(s4);
+}
+
 TEST(TargetTest, CurrentCostumeWidth)
 {
     Target target;