Sound: Implement pan effect

Author: adazem009

include/scratchcpp/sound.h

@@ -18,7 +18,8 @@ class LIBSCRATCHCPP_EXPORT Sound : public Asset
     public:
         enum class Effect
         {
-            Pitch
+            Pitch,
+            Pan
         };
 
         Sound(const std::string &name, const std::string &id, const std::string &format);

src/scratch/sound.cpp

@@ -12,7 +12,8 @@
 using namespace libscratchcpp;
 
 static std::unordered_map<Sound::Effect, std::pair<double, double>> EFFECT_RANGE = {
-    { Sound::Effect::Pitch, { -360, 360 } } // -3 to 3 octaves
+    { Sound::Effect::Pitch, { -360, 360 } }, // -3 to 3 octaves
+    { Sound::Effect::Pan, { -100, 100 } }    // // 100% left to 100% right
 };
 
 /*! Constructs Sound. */
@@ -63,11 +64,16 @@ void Sound::setEffect(Effect effect, double value)
     value = std::clamp(value, it->second.first, it->second.second);
 
     switch (effect) {
-        case Effect::Pitch:
+        case Effect::Pitch: {
             // Convert from linear
             const double root = std::pow(2, 1 / 12.0);
             impl->player->setPitch(std::pow(root, value / 10));
             break;
+        }
+
+        case Effect::Pan:
+            impl->player->setPan(value / 100);
+            break;
     }
 }
 
@@ -115,6 +121,7 @@ std::shared_ptr<Sound> Sound::clone() const
     sound->impl->cloneRoot = root;
     sound->impl->player->setVolume(impl->player->volume());
     sound->impl->player->setPitch(impl->player->pitch());
+    sound->impl->player->setPan(impl->player->pan());
 
     if (root->impl->player->isLoaded()) {
         sound->impl->player->loadCopy(root->impl->player.get());

test/assets/sound_test.cpp

@@ -104,6 +104,28 @@ TEST_F(SoundTest, SetEffect)
 
     EXPECT_CALL(*m_player, setPitch(8));
     sound.setEffect(Sound::Effect::Pitch, 400);
+
+    // Pan
+    EXPECT_CALL(*m_player, setPan(-1));
+    sound.setEffect(Sound::Effect::Pan, -150);
+
+    EXPECT_CALL(*m_player, setPan(-1));
+    sound.setEffect(Sound::Effect::Pan, -100);
+
+    EXPECT_CALL(*m_player, setPan(-0.5));
+    sound.setEffect(Sound::Effect::Pan, -50);
+
+    EXPECT_CALL(*m_player, setPan(0));
+    sound.setEffect(Sound::Effect::Pan, 0);
+
+    EXPECT_CALL(*m_player, setPan(0.5));
+    sound.setEffect(Sound::Effect::Pan, 50);
+
+    EXPECT_CALL(*m_player, setPan(1));
+    sound.setEffect(Sound::Effect::Pan, 100);
+
+    EXPECT_CALL(*m_player, setPan(1));
+    sound.setEffect(Sound::Effect::Pan, 150);
 }
 
 TEST_F(SoundTest, Start)
@@ -166,6 +188,8 @@ TEST_F(SoundTest, Clone)
     EXPECT_CALL(*clonePlayer, setVolume(0.45));
     EXPECT_CALL(*m_player, pitch()).WillOnce(Return(1.25));
     EXPECT_CALL(*clonePlayer, setPitch(1.25));
+    EXPECT_CALL(*m_player, pan()).WillOnce(Return(-0.75));
+    EXPECT_CALL(*clonePlayer, setPan(-0.75));
     EXPECT_CALL(*clonePlayer, isLoaded()).WillOnce(Return(true));
     auto clone = sound->clone();
     ASSERT_TRUE(clone);
@@ -183,6 +207,8 @@ TEST_F(SoundTest, Clone)
     EXPECT_CALL(*cloneClonePlayer, setVolume(0.62));
     EXPECT_CALL(*clonePlayer, pitch()).WillOnce(Return(0.5));
     EXPECT_CALL(*cloneClonePlayer, setPitch(0.5));
+    EXPECT_CALL(*clonePlayer, pan()).WillOnce(Return(0.25));
+    EXPECT_CALL(*cloneClonePlayer, setPan(0.25));
     EXPECT_CALL(*cloneClonePlayer, isLoaded()).WillOnce(Return(true));
     auto cloneClone = clone->clone();
     ASSERT_TRUE(cloneClone);
@@ -195,6 +221,8 @@ TEST_F(SoundTest, Clone)
     EXPECT_CALL(*anotherClonePlayer, setVolume(0.62));
     EXPECT_CALL(*clonePlayer, pitch()).WillOnce(Return(2));
     EXPECT_CALL(*anotherClonePlayer, setPitch(2));
+    EXPECT_CALL(*clonePlayer, pan()).WillOnce(Return(1));
+    EXPECT_CALL(*anotherClonePlayer, setPan(1));
     EXPECT_CALL(*anotherClonePlayer, isLoaded()).Times(0);
     auto anotherClone = clone->clone();
     ASSERT_TRUE(anotherClone);