From ffcac1bc3b6b71b092ff1c341f97d941ee272720 Mon Sep 17 00:00:00 2001
From: Jonathan Li <jonathan.li@hotmail.co.uk>
Date: Fri, 14 Apr 2017 12:41:08 +0100
Subject: [PATCH] spu2-x:xaudio2: Comment stuff to investigate

---
 plugins/spu2-x/src/Windows/SndOut_XAudio2.inl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/plugins/spu2-x/src/Windows/SndOut_XAudio2.inl b/plugins/spu2-x/src/Windows/SndOut_XAudio2.inl
index b91ee550e4..0f235fb615 100644
--- a/plugins/spu2-x/src/Windows/SndOut_XAudio2.inl
+++ b/plugins/spu2-x/src/Windows/SndOut_XAudio2.inl
@@ -174,12 +174,18 @@ private:
         virtual ~StreamingVoice()
         {
             IXAudio2SourceVoice *killMe = pSourceVoice;
+            // XXX: Potentially leads to a race condition that causes a nullptr
+            // dereference when SubmitSourceBuffer is called in OnBufferEnd?
             pSourceVoice = nullptr;
             if (killMe != nullptr) {
                 killMe->FlushSourceBuffers();
                 killMe->DestroyVoice();
             }
 
+            // XXX: Not sure we even need a critical section - DestroyVoice is
+            // blocking, and the documentation states no callbacks are called
+            // or audio data is read after it returns, so it's safe to free up
+            // resources.
             EnterCriticalSection(&cs);
             m_buffer = nullptr;
             LeaveCriticalSection(&cs);
@@ -221,6 +227,8 @@ private:
             EnterCriticalSection(&cs);
 
             // All of these checks are necessary because XAudio2 is wonky shizat.
+            // XXX: The pSourceVoice nullptr check seems a bit self-inflicted
+            // due to the destructor logic.
             if (pSourceVoice == nullptr || context == nullptr) {
                 LeaveCriticalSection(&cs);
                 return;