Renderer refactor

Raffaello · Nov 1, 2023 · 05fda49 · 05fda49
1 parent 0bd0214
commit 05fda49
Show file tree

Hide file tree

Showing 10 changed files with 153 additions and 26 deletions.
diff --git a/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/audio/Renderer.cpp b/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/audio/Renderer.cpp
@@ -7,14 +7,15 @@ namespace HyperSonicDrivers::audio
     {
     }
 
-    void Renderer::setOutputFile(const std::filesystem::path& path)
+    void Renderer::openOutputFile(const std::filesystem::path& path)
     {
         m_out = std::make_unique<files::WAVFile>(path.string(), audio::mixer::eChannelGroup::Unknown, false);
         m_buf.resize(0);
     }
 
-    void Renderer::releaseOutputFile() noexcept
+    void Renderer::closeOutputFile() noexcept
     {
+        m_out->save_end();
         m_out.reset();
     }
 

diff --git a/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/audio/Renderer.hpp b/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/audio/Renderer.hpp
@@ -18,12 +18,13 @@ namespace HyperSonicDrivers::audio
         explicit Renderer(const size_t buffer_size);
         virtual ~Renderer() = default;
 
-        void setOutputFile(const std::filesystem::path& path);
-        void releaseOutputFile() noexcept;
+        void openOutputFile(const std::filesystem::path& path);
+        void closeOutputFile() noexcept;
 
         void renderBuffer(IAudioStream* stream);
-        inline void renderBuffer(const std::shared_ptr<hardware::opl::OPL>& opl) { renderBuffer(opl->getAudioStream().get()); };
-        inline void renderBuffer(const std::shared_ptr<devices::Opl>& opl) { renderBuffer(opl->getHardware()->getAudioStream().get()); };
+
+        //inline void renderBuffer(const std::shared_ptr<hardware::opl::OPL>& opl) { renderBuffer(opl->getAudioStream().get()); };
+        inline void renderBuffer(const std::shared_ptr<devices::IDevice>& device) { renderBuffer(device->getHardware()->getAudioStream().get()); };
 
     private:
         const size_t m_buf_size;

diff --git a/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/drivers/westwood/ADLDriver.cpp b/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/drivers/westwood/ADLDriver.cpp
@@ -255,7 +255,11 @@ namespace HyperSonicDrivers::drivers::westwood
 
     bool ADLDriver::isPlaying() const noexcept
     {
-        return isChannelPlaying(0) || m_programQueueStart != m_programQueueEnd;
+        bool res = false;
+        for (int i = 0; i <= NUM_CHANNELS; i++)
+            res |= isChannelPlaying(i);
+
+        return res || (m_programQueueStart != m_programQueueEnd);
     }
 
     uint8_t* ADLDriver::getProgram_(const int progId, const files::westwood::ADLFile::PROG_TYPE progType) const

diff --git a/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/hardware/IHardware.hpp b/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/hardware/IHardware.hpp
@@ -10,7 +10,7 @@
 
 namespace HyperSonicDrivers::audio
 {
-    //class IRenderer;
+    class Renderer;
 
     namespace streams
     {
@@ -27,6 +27,7 @@ namespace HyperSonicDrivers::hardware
     class IHardware
     {
         friend audio::streams::EmulatedStream;
+        friend audio::Renderer;
 
     public:
         explicit IHardware(const std::shared_ptr<audio::IMixer>& mixer);

diff --git a/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/hardware/opl/OPL.hpp b/sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/hardware/opl/OPL.hpp
@@ -6,11 +6,6 @@
 #include <HyperSonicDrivers/hardware/opl/OplType.hpp>
 #include <HyperSonicDrivers/audio/IMixer.hpp>
 
-namespace HyperSonicDrivers::audio
-{
-    class Renderer;
-}
-
 namespace HyperSonicDrivers::hardware::opl
 {
     constexpr uint8_t opl2_num_channels = 9;
@@ -22,8 +17,6 @@ namespace HyperSonicDrivers::hardware::opl
      */
     class OPL : public IHardware
     {
-        friend audio::Renderer;
-
     public:
         explicit OPL(const std::shared_ptr<audio::IMixer>& mixer, const OplType type);
         ~OPL() override = default;

diff --git a/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/CMakeLists.txt b/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/CMakeLists.txt
@@ -266,6 +266,7 @@ macro_test(
     LINKS_PRIVATE hyper-sonic-drivers-static
     FIXTURES
         "../fixtures/test_renderer_adlib_mame2.wav"
+        "../fixtures/test_renderer_sbpro2_dosbox.wav"
         "../fixtures/DUNE0.ADL"
 )
 

diff --git a/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/audio/TestRenderer.cpp b/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/audio/TestRenderer.cpp
@@ -1,19 +1,101 @@
 #include <gtest/gtest.h>
 #include <HyperSonicDrivers/audio/Renderer.hpp>
 #include <HyperSonicDrivers/devices/Adlib.hpp>
+#include <HyperSonicDrivers/devices/SbPro2.hpp>
 #include <HyperSonicDrivers/drivers/westwood/ADLDriver.hpp>
 #include <HyperSonicDrivers/audio/mixer/ChannelGroup.hpp>
 #include <HyperSonicDrivers/hardware/opl/OplEmulator.hpp>
 #include <HyperSonicDrivers/audio/stubs/StubMixer.hpp>
 #include <filesystem>
+#include <string>
 
 namespace HyperSonicDrivers::audio
 {
     using audio::mixer::eChannelGroup;
-    using devices::Adlib;
     using hardware::opl::OplEmulator;
+    using devices::eDeviceName;
 
-    TEST(Renderer, adlib_mame2)
+    class RendererTest : public ::testing::TestWithParam<std::tuple<std::string, const int, const devices::eDeviceName, const OplEmulator>>
+    {
+    public:
+        const std::string test_name = std::get<0>(GetParam());
+        const int freq = std::get<1>(GetParam());
+        const eDeviceName device_name = std::get<2>(GetParam());
+        const OplEmulator opl_emu = std::get<3>(GetParam());
+
+        std::shared_ptr<devices::Opl> opl;
+        std::shared_ptr<IMixer> mixer;
+
+        RendererTest()
+        {
+            mixer = std::make_shared<stubs::StubMixer>();
+            switch (device_name)
+            {
+                using enum devices::eDeviceName;
+            case Adlib:
+                opl = devices::make_device<devices::Adlib, devices::Opl>(mixer, opl_emu);
+                break;
+            case SbPro2:
+                opl = devices::make_device<devices::SbPro2, devices::Opl>(mixer, opl_emu);
+                break;
+            default:
+                throw std::invalid_argument("");
+            }
+        }
+    };
+
+    TEST_P(RendererTest, render_wav)
+    {
+        const std::string exp_renderer = "../fixtures/test_renderer_" + test_name + ".wav";
+        const std::string rfile = "../fixtures/test_renderer_" + test_name + "_out.wav";
+
+        if (std::filesystem::exists(rfile))
+            std::filesystem::remove(rfile);
+
+        ASSERT_FALSE(std::filesystem::exists(rfile));
+
+        {
+            audio::Renderer r(freq);
+            r.openOutputFile(rfile);
+
+            auto drv1 = drivers::westwood::ADLDriver(opl, eChannelGroup::Music);
+            auto af = std::make_shared<files::westwood::ADLFile>("../fixtures/DUNE0.ADL");
+            drv1.setADLFile(af);
+
+            drv1.play(4);
+            while (drv1.isPlaying())
+                r.renderBuffer(opl);
+
+            r.closeOutputFile();
+        }
+
+        files::WAVFile w(rfile);
+        auto sound = w.getSound();
+        files::WAVFile wexp(exp_renderer);
+        auto exp_sound = wexp.getSound();
+
+        ASSERT_EQ(sound->dataSize, exp_sound->dataSize);
+        ASSERT_EQ(sound->freq, exp_sound->freq);
+        ASSERT_EQ(sound->stereo, exp_sound->stereo);
+        EXPECT_EQ(sound->freq, freq);
+        EXPECT_EQ(sound->stereo, opl->getHardware()->isStereo());
+        for (uint32_t i = 0; i < sound->dataSize; i++)
+        {
+            EXPECT_EQ(sound->data[i], exp_sound->data[i]);
+        }
+    }
+    INSTANTIATE_TEST_SUITE_P(
+        Renderer,
+        RendererTest,
+        ::testing::Values(
+            std::make_tuple<>("adlib_mame2", 44100, eDeviceName::Adlib, OplEmulator::MAME),
+            std::make_tuple<>("sbpro2_dosbox", 44100, eDeviceName::SbPro2, OplEmulator::DOS_BOX)
+        )
+    );
+
+
+    // These 2 disabled test are generating a shorter wav file. WHY?
+    TEST(DISABLED_Renderer, adlib_mame2)
     {
         constexpr const char* exp_renderer = "../fixtures/test_renderer_adlib_mame2.wav";
         constexpr const char* rfile = "test_renderer_adlib_mame2_out.wav";
@@ -24,7 +106,7 @@ namespace HyperSonicDrivers::audio
         ASSERT_FALSE(std::filesystem::exists(rfile));
 
         audio::Renderer r(1024);
-        r.setOutputFile(rfile);
+        r.openOutputFile(rfile);
 
         auto mixer = std::make_shared<stubs::StubMixer>();
 
@@ -33,12 +115,53 @@ namespace HyperSonicDrivers::audio
         auto af = std::make_shared<files::westwood::ADLFile>("../fixtures/DUNE0.ADL");
         drv1.setADLFile(af);
 
-        auto eo = adlib->getOpl();
         drv1.play(4);
         while (drv1.isPlaying())
-            r.renderBuffer(eo);
+            r.renderBuffer(adlib);
+
+        r.closeOutputFile();
+
+        files::WAVFile w(rfile);
+        auto sound = w.getSound();
+        files::WAVFile wexp(exp_renderer);
+        auto exp_sound = wexp.getSound();
+
+        ASSERT_EQ(sound->dataSize, exp_sound->dataSize);
+        ASSERT_EQ(sound->freq, exp_sound->freq);
+        ASSERT_EQ(sound->stereo, exp_sound->stereo);
+        EXPECT_EQ(sound->freq, 44100);
+        EXPECT_FALSE(sound->stereo);
+        for (uint32_t i = 0; i < sound->dataSize; i++)
+        {
+            EXPECT_EQ(sound->data[i], exp_sound->data[i]);
+        }
+    }
+
+    TEST(DISABLED_Renderer, sbpro2_dosbox)
+    {
+        constexpr const char* exp_renderer = "../fixtures/test_renderer_sbpro2_dosbox.wav";
+        constexpr const char* rfile = "test_renderer_sbpro2_dosbox_out.wav";
+
+        if (std::filesystem::exists(rfile))
+            std::filesystem::remove(rfile);
+
+        ASSERT_FALSE(std::filesystem::exists(rfile));
+
+        audio::Renderer r(1024);
+        r.openOutputFile(rfile);
+
+        auto mixer = std::make_shared<stubs::StubMixer>();
+
+        auto sbpro2 = devices::make_device<devices::SbPro2, devices::Opl>(mixer, OplEmulator::DOS_BOX);
+        auto drv1 = drivers::westwood::ADLDriver(sbpro2, eChannelGroup::Music);
+        auto af = std::make_shared<files::westwood::ADLFile>("../fixtures/DUNE0.ADL");
+        drv1.setADLFile(af);
+
+        drv1.play(4);
+        while (drv1.isPlaying())
+            r.renderBuffer(sbpro2);
 
-        r.releaseOutputFile();
+        r.closeOutputFile();
 
         files::WAVFile w(rfile);
         auto sound = w.getSound();
@@ -48,13 +171,15 @@ namespace HyperSonicDrivers::audio
         ASSERT_EQ(sound->dataSize, exp_sound->dataSize);
         ASSERT_EQ(sound->freq, exp_sound->freq);
         ASSERT_EQ(sound->stereo, exp_sound->stereo);
+        EXPECT_EQ(sound->freq, 44100);
+        EXPECT_TRUE(sound->stereo);
         for (uint32_t i = 0; i < sound->dataSize; i++)
         {
             EXPECT_EQ(sound->data[i], exp_sound->data[i]);
         }
     }
 
-    TEST(Renderer, adlib_mame2_device)
+    /*TEST(DISABLED_Renderer, adlib_mame2_device)
     {
         constexpr const char* exp_renderer = "../fixtures/test_renderer_adlib_mame2.wav";
         constexpr const char* rfile = "test_renderer_adlib_mame2_out.wav";
@@ -65,7 +190,7 @@ namespace HyperSonicDrivers::audio
         ASSERT_FALSE(std::filesystem::exists(rfile));
 
         audio::Renderer r(1024);
-        r.setOutputFile(rfile);
+        r.openOutputFile(rfile);
 
         auto mixer = std::make_shared<stubs::StubMixer>();
 
@@ -78,7 +203,7 @@ namespace HyperSonicDrivers::audio
         while (drv1.isPlaying())
             r.renderBuffer(adlib);
 
-        r.releaseOutputFile();
+        r.closeOutputFile();
 
         files::WAVFile w(rfile);
         auto sound = w.getSound();
@@ -92,7 +217,7 @@ namespace HyperSonicDrivers::audio
         {
             EXPECT_EQ(sound->data[i], exp_sound->data[i]);
         }
-    }
+    }*/
 }
 
 int main(int argc, char** argv)

diff --git a/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/audio/stubs/StubMixer.hpp b/sdl2-hyper-sonic-drivers/test/HyperSonicDrivers/audio/stubs/StubMixer.hpp
@@ -13,7 +13,8 @@ namespace HyperSonicDrivers::audio::stubs
     public:
         int rate = 44100;
 
-        StubMixer() : IMixer(32, 44100, 1024/*, const uint8_t bitsDepth*/) {};
+        StubMixer() : IMixer(32, 44100, 1024) {};
+        StubMixer(const int freq) : IMixer(32, freq, 1024) {};
 
         bool init() override { return true; };
 

diff --git a/sdl2-hyper-sonic-drivers/test/fixtures/test_renderer_adlib_mame2.wav b/sdl2-hyper-sonic-drivers/test/fixtures/test_renderer_adlib_mame2.wav
diff --git a/sdl2-hyper-sonic-drivers/test/fixtures/test_renderer_sbpro2_dosbox.wav b/sdl2-hyper-sonic-drivers/test/fixtures/test_renderer_sbpro2_dosbox.wav