Replace AudioPlayerFactory with AudioOutput

Author: adazem009

src/audio/CMakeLists.txt

@@ -16,9 +16,9 @@ endif()
 target_sources(scratchcpp-audio
   PUBLIC
     iaudioplayer.h
-    iaudioplayerfactory.h
-    audioplayerfactory.cpp
-    audioplayerfactory.h
+    iaudiooutput.h
+    audiooutput.cpp
+    audiooutput.h
 )
 
 if (LIBSCRATCHCPP_AUDIO_SUPPORT)

src/audio/audioplayerfactory.cpp src/audio/audiooutput.cppsrc/audio/audioplayerfactory.cpp renamed to src/audio/audiooutput.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-#include "audioplayerfactory.h"
+#include "audiooutput.h"
 
 #ifdef LIBSCRATCHCPP_AUDIO_SUPPORT
 #include "internal/audioplayer.h"
@@ -10,18 +10,18 @@
 
 using namespace libscratchcpp;
 
-std::shared_ptr<AudioPlayerFactory> AudioPlayerFactory::m_instance = std::make_shared<AudioPlayerFactory>();
+std::shared_ptr<IAudioOutput> AudioOutput::m_instance = std::make_shared<AudioOutput>();
 
-AudioPlayerFactory::AudioPlayerFactory()
+AudioOutput::AudioOutput()
 {
 }
 
-std::shared_ptr<AudioPlayerFactory> AudioPlayerFactory::instance()
+std::shared_ptr<IAudioOutput> AudioOutput::instance()
 {
     return m_instance;
 }
 
-std::shared_ptr<IAudioPlayer> AudioPlayerFactory::create() const
+std::shared_ptr<IAudioPlayer> AudioOutput::createAudioPlayer() const
 {
 #ifdef LIBSCRATCHCPP_AUDIO_SUPPORT
     return std::make_shared<AudioPlayer>();

src/audio/audiooutput.h

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "iaudiooutput.h"
+
+namespace libscratchcpp
+{
+
+class AudioOutput : public IAudioOutput
+{
+    public:
+        AudioOutput();
+
+        static std::shared_ptr<IAudioOutput> instance();
+
+        std::shared_ptr<IAudioPlayer> createAudioPlayer() const override;
+
+    private:
+        static std::shared_ptr<IAudioOutput> m_instance;
+};
+
+} // namespace libscratchcpp

src/audio/audioplayerfactory.h

@@ -9,12 +9,12 @@ namespace libscratchcpp
 
 class IAudioPlayer;
 
-class IAudioPlayerFactory
+class IAudioOutput
 {
     public:
-        virtual ~IAudioPlayerFactory() { }
+        virtual ~IAudioOutput() { }
 
-        virtual std::shared_ptr<IAudioPlayer> create() const = 0;
+        virtual std::shared_ptr<IAudioPlayer> createAudioPlayer() const = 0;
 };
 
 } // namespace libscratchcpp

src/audio/iaudioplayerfactory.h src/audio/iaudiooutput.hsrc/audio/iaudioplayerfactory.h renamed to src/audio/iaudiooutput.h

@@ -4,7 +4,6 @@
 #include <iostream>
 
 #include "sound_p.h"
-#include "audio/audioplayerfactory.h"
 
 using namespace libscratchcpp;
 

src/scratch/sound.cpp

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "sound_p.h"
-#include "audio/audioplayerfactory.h"
+#include "audio/audiooutput.h"
 
 using namespace libscratchcpp;
 
-IAudioPlayerFactory *SoundPrivate::playerFactory = nullptr;
+IAudioOutput *SoundPrivate::audioOutput = nullptr;
 
 SoundPrivate::SoundPrivate()
 {
-    // NOTE: playerFactory must be initialized in the constructor to avoid static initialization order fiasco
-    if (!playerFactory)
-        playerFactory = AudioPlayerFactory::instance().get();
+    // NOTE: audioOutput must be initialized in the constructor to avoid static initialization order fiasco
+    if (!audioOutput)
+        audioOutput = AudioOutput::instance().get();
 
-    player = playerFactory->create();
+    player = audioOutput->createAudioPlayer();
 }

src/scratch/sound_p.cpp

@@ -4,7 +4,7 @@
 
 #include <string>
 
-#include "audio/iaudioplayerfactory.h"
+#include "audio/iaudiooutput.h"
 #include "audio/iaudioplayer.h"
 
 namespace libscratchcpp
@@ -17,7 +17,7 @@ struct SoundPrivate
 
         int rate = 0;
         int sampleCount = 0;
-        static IAudioPlayerFactory *playerFactory;
+        static IAudioOutput *audioOutput;
         std::shared_ptr<IAudioPlayer> player = nullptr;
 };
 

src/scratch/sound_p.h

@@ -1,6 +1,6 @@
 #include <scratchcpp/sound.h>
 #include <scratch/sound_p.h>
-#include <audioplayerfactorymock.h>
+#include <audiooutputmock.h>
 #include <audioplayermock.h>
 
 #include "../common.h"
@@ -15,13 +15,13 @@ class SoundTest : public testing::Test
         void SetUp() override
         {
             m_player = std::make_shared<AudioPlayerMock>();
-            SoundPrivate::playerFactory = &m_playerFactory;
-            EXPECT_CALL(m_playerFactory, create()).WillOnce(Return(m_player));
+            SoundPrivate::audioOutput = &m_playerFactory;
+            EXPECT_CALL(m_playerFactory, createAudioPlayer()).WillOnce(Return(m_player));
         }
 
-        void TearDown() override { SoundPrivate::playerFactory = nullptr; }
+        void TearDown() override { SoundPrivate::audioOutput = nullptr; }
 
-        AudioPlayerFactoryMock m_playerFactory;
+        AudioOutputMock m_playerFactory;
         std::shared_ptr<AudioPlayerMock> m_player;
 };
 
@@ -98,5 +98,5 @@ TEST_F(SoundTest, IsPlaying)
     EXPECT_CALL(*m_player, isPlaying()).WillOnce(Return(false));
     ASSERT_FALSE(sound.isPlaying());
 
-    SoundPrivate::playerFactory = nullptr;
+    SoundPrivate::audioOutput = nullptr;
 }

test/assets/sound_test.cpp

@@ -1,15 +1,15 @@
 if (LIBSCRATCHCPP_AUDIO_SUPPORT)
-    # audioplayerfactory_test
+    # audiooutput_test
     add_executable(
-      audioplayerfactory_test
-      audioplayerfactory_test.cpp
+      audiooutput_test
+      audiooutput_test.cpp
     )
 
     target_link_libraries(
-      audioplayerfactory_test
+      audiooutput_test
       GTest::gtest_main
       scratchcpp
     )
 
-    gtest_discover_tests(audioplayerfactory_test)
+    gtest_discover_tests(audiooutput_test)
 endif()