Cocoa Port: Finish refactoring the audio output code. (Related to commit 3b07d28.)

Author: rogerman

desmume/src/frontend/cocoa/ClientAudioOutput.cpp

@@ -20,36 +20,77 @@
 
 #include "ClientEmulationOutput.h"
 
+#include "rthreads.h"
 #include "../../SPU.h"
 
 
+class ClientAudioOutputEngine
+{
+protected:
+	int _engineID;
+	std::string _engineString;
+	int _bufferSizeForSPUInit;
+	bool _isPaused;
+	
+public:
+	ClientAudioOutputEngine();
+	virtual ~ClientAudioOutputEngine();
+	
+	int GetEngineID() const;
+	const char* GetEngineString() const;
+	int GetBufferSizeForSPUInit() const;
+	bool IsPaused() const;
+	
+	virtual void Start();
+	virtual void Stop();
+	virtual void SetMute(bool theState);
+	virtual void SetPause(bool theState);
+	virtual void SetVolume(int volume);
+	
+	virtual size_t GetAvailableSamples() const;
+	virtual void WriteToBuffer(const void *inSamples, size_t numberSampleFrames);
+	virtual void ClearBuffer();
+	
+	virtual void HandleFetchSamples(s16 *sampleBuffer, size_t sampleCount, ESynchMode synchMode, ISynchronizingAudioBuffer *theSynchronizer);
+	virtual size_t HandlePostProcessSamples(s16 *postProcessBuffer, size_t requestedSampleCount, ESynchMode synchMode, ISynchronizingAudioBuffer *theSynchronizer);
+	
+};
+
+class DummyAudioOutputEngine : public ClientAudioOutputEngine
+{
+public:
+	DummyAudioOutputEngine() {};
+};
+
 class ClientAudioOutput : public ClientEmulationOutput
 {
 protected:
+	DummyAudioOutputEngine *_dummyAudioEngine;
+	ClientAudioOutputEngine *_audioEngine;
+	SoundInterface_struct _spuCallbackStruct;
+	
 	float _volume;
-	int _engineID;
 	bool _spuAdvancedLogic;
 	SPUInterpolationMode _interpolationModeID;
 	ESynchMode _syncModeID;
 	ESynchMethod _syncMethodID;
 	bool _isMuted;
-	int _filterID;
 
-	std::string _engineString;
 	std::string _spuInterpolationModeString;
 	std::string _spuSyncMethodString;
 
-	pthread_mutex_t _mutexEngine;
-	pthread_mutex_t _mutexVolume;
-	pthread_mutex_t _mutexSpuAdvancedLogic;
-	pthread_mutex_t _mutexSpuInterpolationMode;
-	pthread_mutex_t _mutexSpuSyncMethod;
+	slock_t *_mutexEngine;
+	slock_t *_mutexVolume;
+	slock_t *_mutexSpuAdvancedLogic;
+	slock_t *_mutexSpuInterpolationMode;
+	slock_t *_mutexSpuSyncMethod;
 
 public:
 	ClientAudioOutput();
 	~ClientAudioOutput();
 
-	void SetEngineByID(int engineID);
+	void SetEngine(ClientAudioOutputEngine *theEngine);
+	ClientAudioOutputEngine* GetEngine();
 	int GetEngineByID();
 
 	void SetVolume(float vol);
@@ -70,12 +111,12 @@ class ClientAudioOutput : public ClientEmulationOutput
 	void SetMute(bool theState);
 	bool IsMuted();
 
-	void SetFilterByID(int filterID);
-	int GetFilterByID();
-	
 	const char* GetEngineString();
 	const char* GetSPUInterpolationModeString();
 	const char* GetSPUSyncMethodString();
+	
+	// ClientEmulationOutput methods
+	virtual void SetIdle(bool theState);
 };
 
 #endif // _CLIENT_AUDIO_OUTPUT_H_

desmume/src/frontend/cocoa/ClientAudioOutput.h

@@ -1,5 +1,5 @@
 /*
-	Copyright (C) 2017-2022 DeSmuME team
+	Copyright (C) 2017-2025 DeSmuME team
  
 	This file is free software: you can redistribute it and/or modify
 	it under the terms of the GNU General Public License as published by
@@ -28,6 +28,7 @@
 
 #include "ClientAVCaptureObject.h"
 #include "ClientExecutionControl.h"
+#include "cocoa_globals.h"
 
 // Need to include assert.h this way so that GDB stub will work
 // with an optimized build.

desmume/src/frontend/cocoa/ClientExecutionControl.cpp

@@ -1,5 +1,5 @@
 /*
-	Copyright (C) 2017-2021 DeSmuME team
+	Copyright (C) 2017-2025 DeSmuME team
  
 	This file is free software: you can redistribute it and/or modify
 	it under the terms of the GNU General Public License as published by
@@ -37,7 +37,6 @@
 #define SPEED_SCALAR_DOUBLE							2.0			// Speed scalar for double execution speed.
 #define SPEED_SCALAR_MIN							0.005		// Lower limit for the speed multiplier.
 
-#define DS_FRAMES_PER_SECOND						59.8261		// Number of DS frames per second.
 #define DS_SECONDS_PER_FRAME						(1.0 / DS_FRAMES_PER_SECOND) // The length of time in seconds that, ideally, a frame should be processed within.
 
 #define FRAME_SKIP_AGGRESSIVENESS					1.0			// Must be a value between 0.0 (inclusive) and positive infinity.

desmume/src/frontend/cocoa/ClientExecutionControl.h

@@ -189,6 +189,8 @@
 
 #define WINDOW_STATUS_BAR_HEIGHT					24		// Height of an emulation window status bar in pixels.
 
+#define DS_FRAMES_PER_SECOND						59.8261 // Number of DS frames per second.
+
 //#define SPU_SAMPLE_RATE								(44100.0 * DS_FRAMES_PER_SECOND / 60.0)	// Samples per second
 #define SPU_SAMPLE_RATE								44100.0	// Samples per second
 #define SPU_SAMPLE_RESOLUTION						16		// Bits per sample; must be a multiple of 8

desmume/src/frontend/cocoa/DeSmuME (Latest).xcodeproj/project.pbxproj

@@ -1,5 +1,5 @@
 /*
-	Copyright (C) 2012-2022 DeSmuME team
+	Copyright (C) 2012-2025 DeSmuME team
 
 	This file is free software: you can redistribute it and/or modify
 	it under the terms of the GNU General Public License as published by
@@ -16,6 +16,7 @@
  */
 
 #include "coreaudiosound.h"
+#include "MacCoreAudioOutputEngine.h"
 
 #include <CoreAudio/CoreAudio.h>
 #include "ClientInputHandler.h"
@@ -903,206 +904,6 @@ void CoreAudioInputDefaultHardwareGainChangedCallback(float normalizedGain, void
 
 #pragma mark -
 
-CoreAudioOutput::CoreAudioOutput(size_t bufferSamples, size_t sampleSize)
-{
-	OSStatus error = noErr;
-	
-	_unfairlockAU = apple_unfairlock_create();
-	
-	_buffer = new RingBuffer(bufferSamples, sampleSize);
-	_volume = 1.0f;
-	
-	// Create a new audio unit
-#if !defined(FORCE_AUDIOCOMPONENT_10_5) && defined(MAC_OS_X_VERSION_10_6) && (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6)
-	if (IsOSXVersionSupported(10, 6, 0))
-	{
-		AudioComponentDescription audioDesc;
-		audioDesc.componentType = kAudioUnitType_Output;
-		audioDesc.componentSubType = kAudioUnitSubType_DefaultOutput;
-		audioDesc.componentManufacturer = kAudioUnitManufacturer_Apple;
-		audioDesc.componentFlags = 0;
-		audioDesc.componentFlagsMask = 0;
-		
-		CreateAudioUnitInstance(&_au, &audioDesc);
-	}
-	else
-#endif
-	{
-		ComponentDescription audioDesc;
-		audioDesc.componentType = kAudioUnitType_Output;
-		audioDesc.componentSubType = kAudioUnitSubType_DefaultOutput;
-		audioDesc.componentManufacturer = kAudioUnitManufacturer_Apple;
-		audioDesc.componentFlags = 0;
-		audioDesc.componentFlagsMask = 0;
-		
-		CreateAudioUnitInstance(&_au, &audioDesc);
-	}
-	
-	// Set the render callback
-	AURenderCallbackStruct callback;
-	callback.inputProc = &CoreAudioOutputRenderCallback;
-	callback.inputProcRefCon = _buffer;
-	
-	error = AudioUnitSetProperty(_au,
-								 kAudioUnitProperty_SetRenderCallback,
-								 kAudioUnitScope_Input,
-								 0,
-								 &callback,
-								 sizeof(callback) );
-	
-	if(error != noErr)
-	{
-		return;
-	}
-	
-	// Set up the audio unit for audio streaming
-	AudioStreamBasicDescription outputFormat;
-	outputFormat.mSampleRate = SPU_SAMPLE_RATE;
-	outputFormat.mFormatID = kAudioFormatLinearPCM;
-	outputFormat.mFormatFlags = kAudioFormatFlagIsSignedInteger | kAudioFormatFlagsNativeEndian | kLinearPCMFormatFlagIsPacked;
-	outputFormat.mBytesPerPacket = SPU_SAMPLE_SIZE;
-	outputFormat.mFramesPerPacket = 1;
-	outputFormat.mBytesPerFrame = SPU_SAMPLE_SIZE;
-	outputFormat.mChannelsPerFrame = SPU_NUMBER_CHANNELS;
-	outputFormat.mBitsPerChannel = SPU_SAMPLE_RESOLUTION;
-	
-	error = AudioUnitSetProperty(_au,
-								 kAudioUnitProperty_StreamFormat,
-								 kAudioUnitScope_Input,
-								 0,
-								 &outputFormat,
-								 sizeof(outputFormat) );
-	
-	if(error != noErr)
-	{
-		return;
-	}
-	
-	// Initialize our new audio unit
-	error = AudioUnitInitialize(_au);
-	if(error != noErr)
-	{
-		return;
-	}
-}
-
-CoreAudioOutput::~CoreAudioOutput()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	DestroyAudioUnitInstance(&this->_au);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-	
-	delete this->_buffer;
-	this->_buffer = NULL;
-	
-	apple_unfairlock_destroy(this->_unfairlockAU);
-}
-
-void CoreAudioOutput::start()
-{
-	this->clearBuffer();
-	
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioUnitReset(this->_au, kAudioUnitScope_Global, 0);
-	AudioOutputUnitStart(this->_au);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-void CoreAudioOutput::pause()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioOutputUnitStop(this->_au);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-void CoreAudioOutput::unpause()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioOutputUnitStart(this->_au);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-void CoreAudioOutput::stop()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioOutputUnitStop(this->_au);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-	
-	this->clearBuffer();
-}
-
-void CoreAudioOutput::writeToBuffer(const void *buffer, size_t numberSampleFrames)
-{
-	size_t availableSampleFrames = this->_buffer->getAvailableElements();
-	if (availableSampleFrames < numberSampleFrames)
-	{
-		this->_buffer->drop(numberSampleFrames - availableSampleFrames);
-	}
-	
-	this->_buffer->write(buffer, numberSampleFrames);
-}
-
-void CoreAudioOutput::clearBuffer()
-{
-	this->_buffer->clear();
-}
-
-void CoreAudioOutput::mute()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioUnitSetParameter(this->_au, kHALOutputParam_Volume, kAudioUnitScope_Global, 0, 0.0f, 0);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-void CoreAudioOutput::unmute()
-{
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioUnitSetParameter(this->_au, kHALOutputParam_Volume, kAudioUnitScope_Global, 0, this->_volume, 0);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-size_t CoreAudioOutput::getAvailableSamples() const
-{
-	return this->_buffer->getAvailableElements();
-}
-
-float CoreAudioOutput::getVolume() const
-{
-	return this->_volume;
-}
-
-void CoreAudioOutput::setVolume(float vol)
-{
-	this->_volume = vol;
-	
-	apple_unfairlock_lock(this->_unfairlockAU);
-	AudioUnitSetParameter(this->_au, kHALOutputParam_Volume, kAudioUnitScope_Global, 0, vol, 0);
-	apple_unfairlock_unlock(this->_unfairlockAU);
-}
-
-OSStatus CoreAudioOutputRenderCallback(void *inRefCon,
-									   AudioUnitRenderActionFlags *ioActionFlags,
-									   const AudioTimeStamp *inTimeStamp,
-									   UInt32 inBusNumber,
-									   UInt32 inNumberFrames,
-									   AudioBufferList *ioData)
-{
-	RingBuffer *__restrict__ audioBuffer = (RingBuffer *)inRefCon;
-	UInt8 *__restrict__ playbackBuffer = (UInt8 *)ioData->mBuffers[0].mData;
-	const size_t framesRead = audioBuffer->read(playbackBuffer, inNumberFrames);
-	
-	// Pad any remaining samples.
-	if (framesRead < inNumberFrames)
-	{
-		const size_t frameSize = audioBuffer->getElementSize();
-		memset(playbackBuffer + (framesRead * frameSize), 0, (inNumberFrames - framesRead) * frameSize);
-	}
-	
-	return noErr;
-}
-
-#pragma mark -
-
 bool CreateAudioUnitInstance(AudioUnit *au, ComponentDescription *auDescription)
 {
 	bool result = false;