Refactor sound (part 2) (#153)

nyanpasu64 · Oct 9, 2019 · 5d5bf47 · 5d5bf47
2 parents d1d961c + c67c1cd
commit 5d5bf47
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 40 deletions.
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/Source/APU/APU.CPP b/Source/APU/APU.CPP
@@ -260,7 +260,7 @@ bool CAPU::SetupSound(int SampleRate, int NrChannels, int Machine)		// // //
 	return true;
 }
 
-void CAPU::AddTime(int32_t Cycles)
+void CAPU::AddCycles(int32_t Cycles)
 {
 	if (Cycles < 0)
 		return;

diff --git a/Source/APU/APU.h b/Source/APU/APU.h
@@ -51,7 +51,7 @@ class CAPU {
 
 	void	Reset();
 	void	Process();
-	void	AddTime(int32_t Cycles);
+	void	AddCycles(int32_t Cycles);
 
 	void	SetExternalSound(uint8_t Chip);
 	void	Write(uint16_t Address, uint8_t Value);		// // //

diff --git a/Source/APU/Mixer.cpp b/Source/APU/Mixer.cpp
@@ -390,8 +390,10 @@ void CMixer::AddValue(int ChanID, int Chip, int Value, int AbsValue, int FrameCy
 	StoreChannelLevel(ChanID, AbsValue);
 	m_iChannels[ChanID] = Value;
 
+	// Unless otherwise notes, Value is already a delta.
 	switch (Chip) {
 		case SNDCHIP_NONE:
+			// Value == AbsValue.
 			switch (ChanID) {
 				case CHANID_SQUARE1:
 				case CHANID_SQUARE2:
@@ -411,6 +413,7 @@ void CMixer::AddValue(int ChanID, int Chip, int Value, int AbsValue, int FrameCy
 			MixFDS(Value, FrameCycles);
 			break;
 		case SNDCHIP_MMC5:
+			// Value == AbsValue.
 			MixMMC5(Delta, FrameCycles);
 			break;
 		case SNDCHIP_VRC6:

diff --git a/Source/ChannelHandler.cpp b/Source/ChannelHandler.cpp
@@ -945,7 +945,7 @@ int CChannelHandler::LimitVolume(int Volume) const		// // //
 
 void CChannelHandler::AddCycles(int count)
 {
-	m_pSoundGen->AddCycles(count);
+	m_pSoundGen->AddCyclesUnlessEndOfFrame(count);
 }
 
 void CChannelHandler::WriteRegister(uint16_t Reg, uint8_t Value)

diff --git a/Source/DirectSound.cpp b/Source/DirectSound.cpp
@@ -371,7 +371,7 @@ buffer_event_t CDSoundChannel::WaitForSyncEvent(DWORD dwTimeout) const
 		case WAIT_OBJECT_0:			// External event
 			return BUFFER_CUSTOM_EVENT;
 		case WAIT_OBJECT_0 + 1:		// DirectSound buffer
-			return (GetWriteBlock() == m_iCurrentWriteBlock) ? BUFFER_OUT_OF_SYNC : BUFFER_IN_SYNC;
+			return (GetWritableBlock() == m_iCurrentWriteBlock) ? BUFFER_OUT_OF_SYNC : BUFFER_IN_SYNC;
 		case WAIT_TIMEOUT:			// Timeout
 			return BUFFER_TIMEOUT;
 	}
@@ -388,7 +388,7 @@ int CDSoundChannel::GetPlayBlock() const
 	return (PlayPos / m_iBlockSize);
 }
 
-int CDSoundChannel::GetWriteBlock() const
+int CDSoundChannel::GetWritableBlock() const
 {
 	// Return the block where the write pos is
 	DWORD PlayPos, WritePos;

diff --git a/Source/DirectSound.h b/Source/DirectSound.h
@@ -60,7 +60,16 @@ class CDSoundChannel
 
 private:
 	int GetPlayBlock() const;
-	int GetWriteBlock() const;
+
+	/*!
+	https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ee418062(v%3Dvs.85)
+	The write cursor is the point in the buffer ahead of which it is safe to write data to the buffer.
+	Data should not be written to the part of the buffer after the play cursor and before the write cursor.
+
+	Data should not be written to the blocks in (?, write cursor's block].
+	Otherwise, you risk writing before the write cursor, which will not be played back properly.
+	*/
+	int GetWritableBlock() const;
 
 	void AdvanceWritePointer();
 

diff --git a/Source/SoundGen.cpp b/Source/SoundGen.cpp
@@ -51,6 +51,7 @@
 #include "MIDI.h"
 #include "ChannelFactory.h"		// // // test
 #include "DetuneTable.h"		// // //
+#include <iostream>
 
 // 1kHz test tone
 //#define AUDIO_TEST
@@ -1394,15 +1395,15 @@ void CSoundGen::ResetAPU()
 	m_pAPU->ClearSample();		// // //
 }
 
-void CSoundGen::AddCycles(int Count)
+void CSoundGen::AddCyclesUnlessEndOfFrame(int Count)
 {
 	// Called from player thread
 	ASSERT(GetCurrentThreadId() == m_nThreadID);
 
 	// Add APU cycles
 	Count = std::min(Count, m_iUpdateCycles - m_iConsumedCycles);
 	m_iConsumedCycles += Count;
-	m_pAPU->AddTime(Count);
+	m_pAPU->AddCycles(Count);
 }
 
 uint8_t CSoundGen::GetReg(int Chip, int Reg) const
@@ -2119,18 +2120,20 @@ void CSoundGen::UpdateAPU()
 		CSingleLock l(&m_csAPULock);		// // //
 		if (l.Lock()) {
 			// Update APU channel registers
-			unsigned int LastChip = SNDCHIP_NONE;		// // // 050B
+			unsigned int PrevChip = SNDCHIP_NONE;		// // // 050B
 			for (int i = 0; i < CHANNELS; ++i) {
 				if (m_pChannels[i] != NULL) {
 					m_pChannels[i]->RefreshChannel();
 					m_pChannels[i]->FinishTick();		// // //
 					unsigned int Chip = m_pTrackerChannels[i]->GetChip();
 					if (m_pDocument->ExpansionEnabled(Chip)) {
-						int Delay = (Chip == LastChip) ? 150 : 250;
-						AddCycles(Delay);
-						LastChip = Chip;
+						int Delay = (Chip == PrevChip) ? 150 : 250;
+
+						AddCyclesUnlessEndOfFrame(Delay);
+						m_pAPU->Process();
+
+						PrevChip = Chip;
 					}
-					m_pAPU->Process();
 				}
 			}
 		#ifdef WRITE_VGM		// // //
@@ -2142,8 +2145,10 @@ void CSoundGen::UpdateAPU()
 			if (m_iConsumedCycles > m_iUpdateCycles) {
 				throw std::runtime_error("overflowed vblank!");
 			}
-			m_pAPU->AddTime(m_iUpdateCycles - m_iConsumedCycles);
+
+			m_pAPU->AddCycles(m_iUpdateCycles - m_iConsumedCycles);
 			m_pAPU->Process();
+
 			l.Unlock();
 		}
 	}

diff --git a/Source/SoundGen.h b/Source/SoundGen.h
@@ -185,7 +185,7 @@ class CSoundGen : public CWinThread, IAudioCallback
 	// Used by channels
 
 	/** Add cycles to model execution time (capped at vblank). */
-	void		AddCycles(int Count);
+	void		AddCyclesUnlessEndOfFrame(int Count);
 
 	// Other
 	uint8_t		GetReg(int Chip, int Reg) const;