Audaspace: add support for CoreAudio on macOS

This adds CoreAudio as audio backend on macOS.
CoreAudio is the standard audio API on macOS.

Ref T86590

4 files changed, 526 insertions, 0 deletions

diff --git a/extern/audaspace/plugins/coreaudio/CoreAudioDevice.cpp b/extern/audaspace/plugins/coreaudio/CoreAudioDevice.cpp
new file mode 100644
index 00000000000..113ceccad60
--- /dev/null
+++ b/extern/audaspace/plugins/coreaudio/CoreAudioDevice.cpp
@@ -0,0 +1,235 @@
+/*******************************************************************************
+ * Copyright 2009-2021 Jörg Müller
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+#include "CoreAudioDevice.h"
+#include "devices/DeviceManager.h"
+#include "devices/IDeviceFactory.h"
+#include "Exception.h"
+#include "IReader.h"
+
+AUD_NAMESPACE_BEGIN
+
+OSStatus CoreAudioDevice::CoreAudio_mix(void* data, AudioUnitRenderActionFlags* flags, const AudioTimeStamp* time_stamp, UInt32 bus_number, UInt32 number_frames, AudioBufferList* buffer_list)
+{
+	CoreAudioDevice* device = (CoreAudioDevice*)data;
+
+	for(int i = 0; i < buffer_list->mNumberBuffers; i++)
+	{
+		auto& buffer = buffer_list->mBuffers[i];
+
+		device->mix((data_t*)buffer.mData, buffer.mDataByteSize / AUD_DEVICE_SAMPLE_SIZE(device->m_specs));
+	}
+
+	return noErr;
+}
+
+void CoreAudioDevice::playing(bool playing)
+{
+	if(m_playback != playing)
+	{
+		if(playing)
+			AudioOutputUnitStart(m_audio_unit);
+		else
+			AudioOutputUnitStop(m_audio_unit);
+	}
+
+	m_playback = playing;
+}
+
+CoreAudioDevice::CoreAudioDevice(DeviceSpecs specs, int buffersize) :
+m_playback(false),
+m_audio_unit(nullptr)
+{
+	AudioComponentDescription component_description = {};
+
+	component_description.componentType = kAudioUnitType_Output;
+	component_description.componentSubType = kAudioUnitSubType_DefaultOutput;
+	component_description.componentManufacturer = kAudioUnitManufacturer_Apple;
+
+	AudioComponent component = AudioComponentFindNext(nullptr, &component_description);
+
+	if(!component)
+		AUD_THROW(DeviceException, "The audio device couldn't be opened with CoreAudio.");
+
+	OSStatus status = AudioComponentInstanceNew(component, &m_audio_unit);
+
+	if(status != noErr)
+		AUD_THROW(DeviceException, "The audio device couldn't be opened with CoreAudio.");
+
+	AudioStreamBasicDescription stream_basic_description = {};
+
+	if(specs.channels == CHANNELS_INVALID)
+		specs.channels = CHANNELS_STEREO;
+	if(specs.format == FORMAT_INVALID)
+		specs.format = FORMAT_FLOAT32;
+	if(specs.rate == RATE_INVALID)
+		specs.rate = RATE_48000;
+
+	switch(specs.format)
+	{
+	case FORMAT_U8:
+		stream_basic_description.mFormatFlags = 0;
+		stream_basic_description.mBitsPerChannel = 8;
+		break;
+	case FORMAT_S16:
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsSignedInteger;
+		stream_basic_description.mBitsPerChannel = 16;
+		break;
+	case FORMAT_S24:
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsSignedInteger;
+		stream_basic_description.mBitsPerChannel = 24;
+		break;
+	case FORMAT_S32:
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsSignedInteger;
+		stream_basic_description.mBitsPerChannel = 32;
+		break;
+	case FORMAT_FLOAT32:
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsFloat;
+		stream_basic_description.mBitsPerChannel = 32;
+		break;
+	case FORMAT_FLOAT64:
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsFloat;
+		stream_basic_description.mBitsPerChannel = 64;
+		break;
+	default:
+		specs.format = FORMAT_FLOAT32;
+		stream_basic_description.mFormatFlags = kLinearPCMFormatFlagIsFloat;
+		stream_basic_description.mBitsPerChannel = 32;
+		break;
+	}
+
+	stream_basic_description.mSampleRate = specs.rate;
+	stream_basic_description.mFormatID = kAudioFormatLinearPCM;
+	stream_basic_description.mFormatFlags |= kAudioFormatFlagsNativeEndian | kLinearPCMFormatFlagIsPacked;
+	stream_basic_description.mBytesPerPacket = stream_basic_description.mBytesPerFrame = AUD_DEVICE_SAMPLE_SIZE(specs);
+	stream_basic_description.mFramesPerPacket = 1;
+	stream_basic_description.mChannelsPerFrame = specs.channels;
+
+	status = AudioUnitSetProperty(m_audio_unit, kAudioUnitProperty_StreamFormat, kAudioUnitScope_Input, 0, &stream_basic_description, sizeof(stream_basic_description));
+
+	if(status != noErr)
+	{
+		AudioComponentInstanceDispose(m_audio_unit);
+		AUD_THROW(DeviceException, "The audio device couldn't be opened with CoreAudio.");
+	}
+
+	m_specs = specs;
+
+	AURenderCallbackStruct render_callback_struct;
+	render_callback_struct.inputProc = CoreAudioDevice::CoreAudio_mix;
+	render_callback_struct.inputProcRefCon = this;
+
+	status = AudioUnitSetProperty(m_audio_unit, kAudioUnitProperty_SetRenderCallback, kAudioUnitScope_Input, 0, &render_callback_struct, sizeof(render_callback_struct));
+
+	if(status != noErr)
+	{
+		AudioComponentInstanceDispose(m_audio_unit);
+		AUD_THROW(DeviceException, "The audio device couldn't be opened with CoreAudio.");
+	}
+
+	status = AudioUnitInitialize(m_audio_unit);
+
+	if(status != noErr)
+	{
+		AudioComponentInstanceDispose(m_audio_unit);
+		AUD_THROW(DeviceException, "The audio device couldn't be opened with CoreAudio.");
+	}
+
+	try
+	{
+		m_synchronizer = std::unique_ptr<CoreAudioSynchronizer>(new CoreAudioSynchronizer(m_audio_unit));
+	}
+	catch(Exception&)
+	{
+		AudioComponentInstanceDispose(m_audio_unit);
+		throw;
+	}
+
+	create();
+}
+
+CoreAudioDevice::~CoreAudioDevice()
+{
+	AudioOutputUnitStop(m_audio_unit);
+	AudioUnitUninitialize(m_audio_unit);
+	AudioComponentInstanceDispose(m_audio_unit);
+
+	destroy();
+}
+
+ISynchronizer* CoreAudioDevice::getSynchronizer()
+{
+	return m_synchronizer.get();
+}
+
+class CoreAudioDeviceFactory : public IDeviceFactory
+{
+private:
+	DeviceSpecs m_specs;
+	int m_buffersize;
+
+public:
+	CoreAudioDeviceFactory() :
+	m_buffersize(AUD_DEFAULT_BUFFER_SIZE)
+	{
+		m_specs.format = FORMAT_FLOAT32;
+		m_specs.channels = CHANNELS_STEREO;
+		m_specs.rate = RATE_48000;
+	}
+
+	virtual std::shared_ptr<IDevice> openDevice()
+	{
+		return std::shared_ptr<IDevice>(new CoreAudioDevice(m_specs, m_buffersize));
+	}
+
+	virtual int getPriority()
+	{
+		return 1 << 15;
+	}
+
+	virtual void setSpecs(DeviceSpecs specs)
+	{
+		m_specs = specs;
+	}
+
+	virtual void setBufferSize(int buffersize)
+	{
+		m_buffersize = buffersize;
+	}
+
+	virtual void setName(std::string name)
+	{
+	}
+};
+
+void CoreAudioDevice::registerPlugin()
+{
+	DeviceManager::registerDevice("CoreAudio", std::shared_ptr<IDeviceFactory>(new CoreAudioDeviceFactory));
+}
+
+#ifdef COREAUDIO_PLUGIN
+extern "C" AUD_PLUGIN_API void registerPlugin()
+{
+	CoreAudioDevice::registerPlugin();
+}
+
+extern "C" AUD_PLUGIN_API const char* getName()
+{
+	return "CoreAudio";
+}
+#endif
+
+AUD_NAMESPACE_END
diff --git a/extern/audaspace/plugins/coreaudio/CoreAudioDevice.h b/extern/audaspace/plugins/coreaudio/CoreAudioDevice.h
new file mode 100644
index 00000000000..3770228db6f
--- /dev/null
+++ b/extern/audaspace/plugins/coreaudio/CoreAudioDevice.h
@@ -0,0 +1,100 @@
+/*******************************************************************************
+ * Copyright 2009-2021 Jörg Müller
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+#pragma once
+
+#ifdef COREAUDIO_PLUGIN
+#define AUD_BUILD_PLUGIN
+#endif
+
+/**
+ * @file CoreAudioDevice.h
+ * @ingroup plugin
+ * The CoreAudioDevice class.
+ */
+
+#include "CoreAudioSynchronizer.h"
+#include "devices/SoftwareDevice.h"
+
+#include <memory>
+
+#include <AudioUnit/AudioUnit.h>
+
+AUD_NAMESPACE_BEGIN
+
+/**
+ * This device plays back through CoreAudio, the Apple audio API.
+ */
+class AUD_PLUGIN_API CoreAudioDevice : public SoftwareDevice
+{
+private:
+	/**
+	 * Whether there is currently playback.
+	 */
+	bool m_playback;
+
+	/**
+	 * The CoreAudio AudioUnit.
+	 */
+	AudioUnit m_audio_unit;
+
+	/**
+	 * The Synchronizer.
+	 */
+	std::unique_ptr<CoreAudioSynchronizer> m_synchronizer;
+
+	/**
+	 * Mixes the next bytes into the buffer.
+	 * \param data The CoreAudio device.
+	 * \param flags Unused flags.
+	 * \param time_stamp Unused time stamp.
+	 * \param bus_number Unused bus number.
+	 * \param number_frames Unused number of frames.
+	 * \param buffer_list The list of buffers to be filled.
+	 */
+	AUD_LOCAL static OSStatus CoreAudio_mix(void* data, AudioUnitRenderActionFlags* flags, const AudioTimeStamp* time_stamp, UInt32 bus_number, UInt32 number_frames, AudioBufferList* buffer_list);
+
+	// delete copy constructor and operator=
+	CoreAudioDevice(const CoreAudioDevice&) = delete;
+	CoreAudioDevice& operator=(const CoreAudioDevice&) = delete;
+
+protected:
+	virtual void playing(bool playing);
+
+public:
+	/**
+	 * Opens the CoreAudio audio device for playback.
+	 * \param specs The wanted audio specification.
+	 * \param buffersize The size of the internal buffer.
+	 * \note The specification really used for opening the device may differ.
+	 * \exception Exception Thrown if the audio device cannot be opened.
+	 */
+	CoreAudioDevice(DeviceSpecs specs, int buffersize = AUD_DEFAULT_BUFFER_SIZE);
+
+	/**
+	 * Closes the CoreAudio audio device.
+	 */
+	virtual ~CoreAudioDevice();
+
+	virtual ISynchronizer* getSynchronizer();
+
+	/**
+	 * Registers this plugin.
+	 */
+	static void registerPlugin();
+};
+
+AUD_NAMESPACE_END
diff --git a/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.cpp b/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.cpp
new file mode 100644
index 00000000000..fcfa7fde9be
--- /dev/null
+++ b/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.cpp
@@ -0,0 +1,127 @@
+/*******************************************************************************
+ * Copyright 2009-2016 Jörg Müller
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+#include "CoreAudioSynchronizer.h"
+
+#include "CoreAudioDevice.h"
+#include "Exception.h"
+
+AUD_NAMESPACE_BEGIN
+
+CoreAudioSynchronizer::CoreAudioSynchronizer(AudioUnit& audio_unit) :
+	m_clock_ref(nullptr),
+	m_playing(false)
+{
+	OSStatus status = CAClockNew(0, &m_clock_ref);
+
+	if(status != noErr)
+		AUD_THROW(DeviceException, "Could not create a CoreAudio clock.");
+
+	CAClockTimebase timebase = kCAClockTimebase_AudioOutputUnit;
+
+	status = CAClockSetProperty(m_clock_ref, kCAClockProperty_InternalTimebase, sizeof(timebase), &timebase);
+
+	if(status != noErr)
+	{
+		CAClockDispose(m_clock_ref);
+		AUD_THROW(DeviceException, "Could not create a CoreAudio clock.");
+	}
+
+	status = CAClockSetProperty(m_clock_ref, kCAClockProperty_TimebaseSource, sizeof(audio_unit), &audio_unit);
+
+	if(status != noErr)
+	{
+		CAClockDispose(m_clock_ref);
+		AUD_THROW(DeviceException, "Could not create a CoreAudio clock.");
+	}
+
+	CAClockSyncMode sync_mode = kCAClockSyncMode_Internal;
+
+	status = CAClockSetProperty(m_clock_ref, kCAClockProperty_SyncMode, sizeof(sync_mode), &sync_mode);
+
+	if(status != noErr)
+	{
+		CAClockDispose(m_clock_ref);
+		AUD_THROW(DeviceException, "Could not create a CoreAudio clock.");
+	}
+}
+
+CoreAudioSynchronizer::~CoreAudioSynchronizer()
+{
+	CAClockDispose(m_clock_ref);
+}
+
+void CoreAudioSynchronizer::seek(std::shared_ptr<IHandle> handle, double time)
+{
+	if(m_playing)
+		CAClockStop(m_clock_ref);
+
+	CAClockTime clock_time;
+	clock_time.format = kCAClockTimeFormat_Seconds;
+	clock_time.time.seconds = time;
+	CAClockSetCurrentTime(m_clock_ref, &clock_time);
+
+	handle->seek(time);
+
+	if(m_playing)
+		CAClockStart(m_clock_ref);
+}
+
+double CoreAudioSynchronizer::getPosition(std::shared_ptr<IHandle> handle)
+{
+	CAClockTime clock_time;
+
+	OSStatus status;
+
+	if(m_playing)
+		status = CAClockGetCurrentTime(m_clock_ref, kCAClockTimeFormat_Seconds, &clock_time);
+	else
+		status = CAClockGetStartTime(m_clock_ref, kCAClockTimeFormat_Seconds, &clock_time);
+
+	if(status != noErr)
+		return 0;
+
+	return clock_time.time.seconds;
+}
+
+void CoreAudioSynchronizer::play()
+{
+	if(m_playing)
+		return;
+
+	m_playing = true;
+	CAClockStart(m_clock_ref);
+}
+
+void CoreAudioSynchronizer::stop()
+{
+	if(!m_playing)
+		return;
+
+	m_playing = false;
+	CAClockStop(m_clock_ref);
+}
+
+void CoreAudioSynchronizer::setSyncCallback(ISynchronizer::syncFunction function, void* data)
+{
+}
+
+int CoreAudioSynchronizer::isPlaying()
+{
+	return m_playing;
+}
+
+AUD_NAMESPACE_END
diff --git a/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.h b/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.h
new file mode 100644
index 00000000000..4f9d9b28ea5
--- /dev/null
+++ b/extern/audaspace/plugins/coreaudio/CoreAudioSynchronizer.h
@@ -0,0 +1,64 @@
+/*******************************************************************************
+ * Copyright 2009-2016 Jörg Müller
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+#pragma once
+
+#ifdef COREAUDIO_PLUGIN
+#define AUD_BUILD_PLUGIN
+#endif
+
+/**
+ * @file CoreAudioSynchronizer.h
+ * @ingroup plugin
+ * The CoreAudioSynchronizer class.
+ */
+
+#include "devices/ISynchronizer.h"
+
+#include <AudioUnit/AudioUnit.h>
+#include <AudioToolbox/CoreAudioClock.h>
+
+AUD_NAMESPACE_BEGIN
+
+/**
+ * This class is a Synchronizer implementation using a CoreAudio clock.
+ */
+class AUD_PLUGIN_API CoreAudioSynchronizer : public ISynchronizer
+{
+private:
+    /// The CoreAudio clock referene.
+    CAClockRef m_clock_ref;
+
+	/// Whether the clock is currently playing.
+	bool m_playing;
+
+public:
+	/**
+	 * Creates a new CoreAudioSynchronizer.
+	 * @param device The device that should be synchronized.
+	 */
+    CoreAudioSynchronizer(AudioUnit& audio_unit);
+    virtual ~CoreAudioSynchronizer();
+
+	virtual void seek(std::shared_ptr<IHandle> handle, double time);
+	virtual double getPosition(std::shared_ptr<IHandle> handle);
+	virtual void play();
+	virtual void stop();
+	virtual void setSyncCallback(syncFunction function, void* data);
+	virtual int isPlaying();
+};
+
+AUD_NAMESPACE_END