From 9b751899eb98a6eb1c0338126f0e84af089e41a2 Mon Sep 17 00:00:00 2001
From: Chris Thrasher <chrisjthrasher@gmail.com>
Date: Sun, 26 Nov 2023 16:43:22 -0700
Subject: [PATCH] Add tests for `sf::InputSoundFile`

---
 test/Audio/InputSoundFile.test.cpp | 297 ++++++++++++++++++++++++++++-
 1 file changed, 293 insertions(+), 4 deletions(-)

diff --git a/test/Audio/InputSoundFile.test.cpp b/test/Audio/InputSoundFile.test.cpp
index e6e3e1e3c..c6e73da2f 100644
--- a/test/Audio/InputSoundFile.test.cpp
+++ b/test/Audio/InputSoundFile.test.cpp
@@ -1,8 +1,297 @@
 #include <SFML/Audio/InputSoundFile.hpp>
 
+// Other 1st party headers
+#include <SFML/System/FileInputStream.hpp>
+#include <SFML/System/Time.hpp>
+
+#include <catch2/catch_test_macros.hpp>
+
+#include <SystemUtil.hpp>
+#include <array>
+#include <fstream>
 #include <type_traits>
 
-static_assert(!std::is_copy_constructible_v<sf::InputSoundFile>);
-static_assert(!std::is_copy_assignable_v<sf::InputSoundFile>);
-static_assert(std::is_nothrow_move_constructible_v<sf::InputSoundFile>);
-static_assert(std::is_nothrow_move_assignable_v<sf::InputSoundFile>);
+TEST_CASE("[Audio] sf::InputSoundFile")
+{
+    SECTION("Type traits")
+    {
+        STATIC_CHECK(!std::is_copy_constructible_v<sf::InputSoundFile>);
+        STATIC_CHECK(!std::is_copy_assignable_v<sf::InputSoundFile>);
+        STATIC_CHECK(std::is_nothrow_move_constructible_v<sf::InputSoundFile>);
+        STATIC_CHECK(std::is_nothrow_move_assignable_v<sf::InputSoundFile>);
+    }
+
+    SECTION("Construction")
+    {
+        const sf::InputSoundFile inputSoundFile;
+        CHECK(inputSoundFile.getSampleCount() == 0);
+        CHECK(inputSoundFile.getChannelCount() == 0);
+        CHECK(inputSoundFile.getSampleRate() == 0);
+        CHECK(inputSoundFile.getDuration() == sf::Time::Zero);
+        CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+        CHECK(inputSoundFile.getSampleOffset() == 0);
+    }
+
+    SECTION("openFromFile()")
+    {
+        sf::InputSoundFile inputSoundFile;
+
+        SECTION("Invalid file")
+        {
+            CHECK(!inputSoundFile.openFromFile("does/not/exist.wav"));
+        }
+
+        SECTION("Valid file")
+        {
+            SECTION("flac")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+                CHECK(inputSoundFile.getSampleCount() == 87'798);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(1'990'884));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("mp3")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/ding.mp3"));
+                CHECK(inputSoundFile.getSampleCount() == 87'798);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(1'990'884));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("ogg")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/doodle_pop.ogg"));
+                CHECK(inputSoundFile.getSampleCount() == 2'116'992);
+                CHECK(inputSoundFile.getChannelCount() == 2);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(24'002'176));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("wav")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/killdeer.wav"));
+                CHECK(inputSoundFile.getSampleCount() == 112'941);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 22'050);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(5'122'040));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+        }
+    }
+
+    SECTION("openFromMemory()")
+    {
+        sf::InputSoundFile inputSoundFile;
+        const auto         memory = []()
+        {
+            std::ifstream file("Audio/killdeer.wav", std::ios::binary | std::ios::ate);
+            REQUIRE(file);
+            const auto size = file.tellg();
+            file.seekg(0, std::ios::beg);
+            std::vector<char> buffer(static_cast<std::size_t>(size));
+            REQUIRE(file.read(buffer.data(), size));
+            return buffer;
+        }();
+
+        REQUIRE(inputSoundFile.openFromMemory(memory.data(), memory.size()));
+        CHECK(inputSoundFile.getSampleCount() == 112'941);
+        CHECK(inputSoundFile.getChannelCount() == 1);
+        CHECK(inputSoundFile.getSampleRate() == 22'050);
+        CHECK(inputSoundFile.getDuration() == sf::microseconds(5'122'040));
+        CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+        CHECK(inputSoundFile.getSampleOffset() == 0);
+    }
+
+    SECTION("openFromStream()")
+    {
+        sf::InputSoundFile  inputSoundFile;
+        sf::FileInputStream stream;
+
+        SECTION("Invalid stream")
+        {
+            CHECK(!inputSoundFile.openFromStream(stream));
+        }
+
+        SECTION("Valid stream")
+        {
+            SECTION("flac")
+            {
+                REQUIRE(stream.open("Audio/ding.flac"));
+                REQUIRE(inputSoundFile.openFromStream(stream));
+                CHECK(inputSoundFile.getSampleCount() == 87'798);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(1'990'884));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("mp3")
+            {
+                REQUIRE(stream.open("Audio/ding.mp3"));
+                REQUIRE(inputSoundFile.openFromStream(stream));
+                CHECK(inputSoundFile.getSampleCount() == 87'798);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(1'990'884));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("ogg")
+            {
+                REQUIRE(stream.open("Audio/doodle_pop.ogg"));
+                REQUIRE(inputSoundFile.openFromStream(stream));
+                CHECK(inputSoundFile.getSampleCount() == 2'116'992);
+                CHECK(inputSoundFile.getChannelCount() == 2);
+                CHECK(inputSoundFile.getSampleRate() == 44'100);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(24'002'176));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+
+            SECTION("wav")
+            {
+                REQUIRE(stream.open("Audio/killdeer.wav"));
+                REQUIRE(inputSoundFile.openFromStream(stream));
+                CHECK(inputSoundFile.getSampleCount() == 112'941);
+                CHECK(inputSoundFile.getChannelCount() == 1);
+                CHECK(inputSoundFile.getSampleRate() == 22'050);
+                CHECK(inputSoundFile.getDuration() == sf::microseconds(5'122'040));
+                CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+                CHECK(inputSoundFile.getSampleOffset() == 0);
+            }
+        }
+    }
+
+    SECTION("seek(std::uint64_t)")
+    {
+        sf::InputSoundFile inputSoundFile;
+
+        SECTION("flac")
+        {
+            REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+            inputSoundFile.seek(1'000);
+            CHECK(inputSoundFile.getTimeOffset() == sf::microseconds(22'675));
+            CHECK(inputSoundFile.getSampleOffset() == 1'000);
+        }
+
+        SECTION("mp3")
+        {
+            REQUIRE(inputSoundFile.openFromFile("Audio/ding.mp3"));
+            inputSoundFile.seek(1'000);
+            CHECK(inputSoundFile.getTimeOffset() == sf::microseconds(22'675));
+            CHECK(inputSoundFile.getSampleOffset() == 1'000);
+        }
+
+        SECTION("ogg")
+        {
+            REQUIRE(inputSoundFile.openFromFile("Audio/doodle_pop.ogg"));
+            inputSoundFile.seek(1'000);
+            CHECK(inputSoundFile.getTimeOffset() == sf::microseconds(11'337));
+            CHECK(inputSoundFile.getSampleOffset() == 1'000);
+        }
+
+        SECTION("wav")
+        {
+            REQUIRE(inputSoundFile.openFromFile("Audio/killdeer.wav"));
+            inputSoundFile.seek(1'000);
+            CHECK(inputSoundFile.getTimeOffset() == sf::microseconds(45'351));
+            CHECK(inputSoundFile.getSampleOffset() == 1'000);
+        }
+    }
+
+    SECTION("seek(Time)")
+    {
+        sf::InputSoundFile inputSoundFile;
+        REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+        inputSoundFile.seek(sf::milliseconds(100));
+        CHECK(inputSoundFile.getSampleCount() == 87'798);
+        CHECK(inputSoundFile.getChannelCount() == 1);
+        CHECK(inputSoundFile.getSampleRate() == 44'100);
+        CHECK(inputSoundFile.getDuration() == sf::microseconds(1'990'884));
+        CHECK(inputSoundFile.getTimeOffset() == sf::milliseconds(100));
+        CHECK(inputSoundFile.getSampleOffset() == 4'410);
+    }
+
+    SECTION("read()")
+    {
+        sf::InputSoundFile          inputSoundFile;
+        std::array<std::int16_t, 4> samples{};
+
+        SECTION("Unloaded file")
+        {
+            CHECK(inputSoundFile.read(samples.data(), samples.size()) == 0);
+        }
+
+        REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+
+        SECTION("Null address")
+        {
+            CHECK(inputSoundFile.read(nullptr, 10) == 0);
+        }
+
+        SECTION("Zero count")
+        {
+            CHECK(inputSoundFile.read(samples.data(), 0) == 0);
+        }
+
+        SECTION("Successful read")
+        {
+            SECTION("flac")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{0, 1, -1, 4});
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{1, 4, 9, 6});
+            }
+
+            SECTION("mp3")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/ding.mp3"));
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{0, -2, 0, 2});
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{1, 4, 6, 8});
+            }
+
+            SECTION("ogg")
+            {
+                REQUIRE(inputSoundFile.openFromFile("Audio/doodle_pop.ogg"));
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{-827, -985, -1168, -1319});
+                CHECK(inputSoundFile.read(samples.data(), samples.size()) == 4);
+                CHECK(samples == std::array<std::int16_t, 4>{-1738, -1883, -2358, -2497});
+            }
+
+            SECTION("wav")
+            {
+                // Cannot be tested since reading from a .wav file triggers UB
+            }
+        }
+    }
+
+    SECTION("close()")
+    {
+        sf::InputSoundFile inputSoundFile;
+        REQUIRE(inputSoundFile.openFromFile("Audio/ding.flac"));
+        inputSoundFile.close();
+        CHECK(inputSoundFile.getSampleCount() == 0);
+        CHECK(inputSoundFile.getChannelCount() == 0);
+        CHECK(inputSoundFile.getSampleRate() == 0);
+        CHECK(inputSoundFile.getDuration() == sf::Time::Zero);
+        CHECK(inputSoundFile.getTimeOffset() == sf::Time::Zero);
+        CHECK(inputSoundFile.getSampleOffset() == 0);
+    }
+}