From 4fac032ff647f5b9b5c5f318ee3119f72664bd7e Mon Sep 17 00:00:00 2001
From: Connor McLaughlin <stenzek@gmail.com>
Date: Sat, 7 Aug 2021 13:21:53 +1000
Subject: [PATCH] SPU: Add a macro to enable per-voice dumping

---
 src/core/spu.cpp | 59 +++++++++++++++++++++++++++++++++++++++++++++---
 src/core/spu.h   |  8 +++++++
 2 files changed, 64 insertions(+), 3 deletions(-)

diff --git a/src/core/spu.cpp b/src/core/spu.cpp
index a9b1c3fee..72a99f57d 100644
--- a/src/core/spu.cpp
+++ b/src/core/spu.cpp
@@ -1,6 +1,7 @@
 #include "spu.h"
 #include "cdrom.h"
 #include "common/audio_stream.h"
+#include "common/file_system.h"
 #include "common/log.h"
 #include "common/state_wrapper.h"
 #include "common/wav_writer.h"
@@ -1021,9 +1022,7 @@ void SPU::GeneratePendingSamples()
 
 bool SPU::StartDumpingAudio(const char* filename)
 {
-  if (m_dump_writer)
-    m_dump_writer.reset();
-
+  m_dump_writer.reset();
   m_dump_writer = std::make_unique<Common::WAVWriter>();
   if (!m_dump_writer->Open(filename, SAMPLE_RATE, 2))
   {
@@ -1032,6 +1031,27 @@ bool SPU::StartDumpingAudio(const char* filename)
     return false;
   }
 
+#ifdef SPU_DUMP_ALL_VOICES
+  for (size_t i = 0; i < m_voice_dump_writers.size(); i++)
+  {
+    m_voice_dump_writers[i].reset();
+    m_voice_dump_writers[i] = std::make_unique<Common::WAVWriter>();
+
+    TinyString new_suffix;
+    if (i == NUM_VOICES)
+      new_suffix.Assign("reverb.wav");
+    else
+      new_suffix.Format("voice%u.wav", i);
+
+    std::string voice_filename(FileSystem::ReplaceExtension(filename, new_suffix));
+    if (!m_voice_dump_writers[i]->Open(voice_filename.c_str(), SAMPLE_RATE, 2))
+    {
+      Log_ErrorPrintf("Failed to open voice dump filename '%s'", voice_filename.c_str());
+      m_voice_dump_writers[i].reset();
+    }
+  }
+#endif
+
   return true;
 }
 
@@ -1041,6 +1061,12 @@ bool SPU::StopDumpingAudio()
     return false;
 
   m_dump_writer.reset();
+
+#ifdef SPU_DUMP_ALL_VOICES
+  for (size_t i = 0; i < m_voice_dump_writers.size(); i++)
+    m_voice_dump_writers[i].reset();
+#endif
+
   return true;
 }
 
@@ -1417,6 +1443,15 @@ ALWAYS_INLINE_RELEASE std::tuple<s32, s32> SPU::SampleVoice(u32 voice_index)
   if (!voice.IsOn() && !m_SPUCNT.irq9_enable)
   {
     voice.last_volume = 0;
+
+#ifdef SPU_DUMP_ALL_VOICES
+    if (m_voice_dump_writers[voice_index])
+    {
+      const s16 dump_samples[2] = {0, 0};
+      m_voice_dump_writers[voice_index]->WriteFrames(dump_samples, 1);
+    }
+#endif
+
     return {};
   }
 
@@ -1503,6 +1538,15 @@ ALWAYS_INLINE_RELEASE std::tuple<s32, s32> SPU::SampleVoice(u32 voice_index)
   const s32 right = ApplyVolume(volume, voice.right_volume.current_level);
   voice.left_volume.Tick();
   voice.right_volume.Tick();
+
+#ifdef SPU_DUMP_ALL_VOICES
+  if (m_voice_dump_writers[voice_index])
+  {
+    const s16 dump_samples[2] = {static_cast<s16>(Clamp16(left)), static_cast<s16>(Clamp16(right))};
+    m_voice_dump_writers[voice_index]->WriteFrames(dump_samples, 1);
+  }
+#endif
+
   return std::make_tuple(left, right);
 }
 
@@ -1712,6 +1756,15 @@ void SPU::ProcessReverb(s16 left_in, s16 right_in, s32* left_out, s32* right_out
 
   s_last_reverb_output[0] = *left_out = ApplyVolume(out[0], m_reverb_registers.vLOUT);
   s_last_reverb_output[1] = *right_out = ApplyVolume(out[1], m_reverb_registers.vROUT);
+
+#ifdef SPU_DUMP_ALL_VOICES
+  if (m_voice_dump_writers[NUM_VOICES])
+  {
+    const s16 dump_samples[2] = {static_cast<s16>(Clamp16(s_last_reverb_output[0])),
+                                 static_cast<s16>(Clamp16(s_last_reverb_output[1]))};
+    m_voice_dump_writers[NUM_VOICES]->WriteFrames(dump_samples, 1);
+  }
+#endif
 }
 
 void SPU::Execute(TickCount ticks)
diff --git a/src/core/spu.h b/src/core/spu.h
index 670f3c69d..65be67f3c 100644
--- a/src/core/spu.h
+++ b/src/core/spu.h
@@ -6,6 +6,9 @@
 #include <array>
 #include <memory>
 
+// Enable to dump all voices of the SPU audio individually.
+// #define SPU_DUMP_ALL_VOICES 1
+
 class StateWrapper;
 
 namespace Common {
@@ -424,6 +427,11 @@ private:
   InlineFIFOQueue<u16, FIFO_SIZE_IN_HALFWORDS> m_transfer_fifo;
 
   std::array<u8, RAM_SIZE> m_ram{};
+
+#ifdef SPU_DUMP_ALL_VOICES
+  // +1 for reverb output
+  std::array<std::unique_ptr<Common::WAVWriter>, NUM_VOICES + 1> m_voice_dump_writers;
+#endif
 };
 
 extern SPU g_spu;
\ No newline at end of file