Feature: Add XAudio2 driver

3 files changed, 307 insertions, 1 deletions

diff --git a/src/sound/win32_s.h b/src/sound/win32_s.h
index 77906c88a..c6c8e8d14 100644
--- a/src/sound/win32_s.h
+++ b/src/sound/win32_s.h
@@ -26,7 +26,7 @@ public:
 /** Factory for the sound driver for Windows. */
 class FSoundDriver_Win32 : public DriverFactoryBase {
 public:
-	FSoundDriver_Win32() : DriverFactoryBase(Driver::DT_SOUND, 10, "win32", "Win32 WaveOut Sound Driver") {}
+	FSoundDriver_Win32() : DriverFactoryBase(Driver::DT_SOUND, 9, "win32", "Win32 WaveOut Sound Driver") {}
 	/* virtual */ Driver *CreateInstance() const { return new SoundDriver_Win32(); }
 };
 
diff --git a/src/sound/xaudio2_s.cpp b/src/sound/xaudio2_s.cpp
new file mode 100644
index 000000000..60311ced2
--- /dev/null
+++ b/src/sound/xaudio2_s.cpp
@@ -0,0 +1,273 @@
+/* $Id$ */
+
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+ * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file xaudio2_s.cpp XAudio2 sound driver. */
+
+#ifdef WITH_XAUDIO2
+
+#include "../stdafx.h"
+#include "../openttd.h"
+#include "../driver.h"
+#include "../mixer.h"
+#include "../debug.h"
+#include "../core/alloc_func.hpp"
+#include "../core/bitmath_func.hpp"
+#include "../core/math_func.hpp"
+
+// Windows 8 SDK required for XAudio2
+#undef NTDDI_VERSION
+#undef _WIN32_WINNT
+
+#define NTDDI_VERSION    NTDDI_WIN8
+#define _WIN32_WINNT     _WIN32_WINNT_WIN8
+
+#include "xaudio2_s.h"
+
+#include <windows.h>
+#include <mmsystem.h>
+#include <wrl\client.h>
+#include <xaudio2.h>
+
+using Microsoft::WRL::ComPtr;
+
+#include "../os/windows/win32.h"
+#include "../safeguards.h"
+
+// Definition of the "XAudio2Create" call used to initialise XAudio2
+typedef HRESULT(__stdcall *API_XAudio2Create)(_Outptr_ IXAudio2** ppXAudio2, UINT32 Flags, XAUDIO2_PROCESSOR XAudio2Processor);
+
+static FSoundDriver_XAudio2 iFSoundDriver_XAudio2;
+
+/**
+* Implementation of the IXAudio2VoiceCallback interface.
+* Provides buffered audio to XAudio2 from the OpenTTD mixer.
+*/
+class StreamingVoiceContext : public IXAudio2VoiceCallback
+{
+private:
+	int bufferLength;
+	char *buffer;
+
+public:
+	IXAudio2SourceVoice* SourceVoice;
+
+	StreamingVoiceContext(int bufferLength)
+	{
+		this->bufferLength = bufferLength;
+		this->buffer = MallocT<char>(bufferLength);
+	}
+
+	virtual ~StreamingVoiceContext()
+	{
+		free(this->buffer);
+	}
+
+	HRESULT SubmitBuffer()
+	{
+		// Ensure we do have a valid voice
+		if (this->SourceVoice == nullptr)
+		{
+			return E_FAIL;
+		}
+
+		MxMixSamples(this->buffer, this->bufferLength / 4);
+
+		XAUDIO2_BUFFER buf = { 0 };
+		buf.AudioBytes = this->bufferLength;
+		buf.pAudioData = (const BYTE *) this->buffer;
+
+		return SourceVoice->SubmitSourceBuffer(&buf);
+	}
+
+	STDMETHOD_(void, OnVoiceProcessingPassStart)(UINT32) override
+	{
+	}
+
+	STDMETHOD_(void, OnVoiceProcessingPassEnd)() override
+	{
+	}
+
+	STDMETHOD_(void, OnStreamEnd)() override
+	{
+	}
+
+	STDMETHOD_(void, OnBufferStart)(void*) override
+	{
+	}
+
+	STDMETHOD_(void, OnBufferEnd)(void*) override
+	{
+		SubmitBuffer();
+	}
+
+	STDMETHOD_(void, OnLoopEnd)(void*) override
+	{
+	}
+
+	STDMETHOD_(void, OnVoiceError)(void*, HRESULT) override
+	{
+	}
+};
+
+static HMODULE _xaudio_dll_handle;
+static IXAudio2SourceVoice* _source_voice = nullptr;
+static IXAudio2MasteringVoice* _mastering_voice = nullptr;
+static ComPtr<IXAudio2> _xaudio2;
+static StreamingVoiceContext* _voice_context = nullptr;
+
+/**
+* Initialises the XAudio2 driver.
+*
+* @param parm Driver parameters.
+* @return An error message if unsuccessful, or NULL otherwise.
+*
+*/
+const char *SoundDriver_XAudio2::Start(const char * const *parm)
+{
+	HRESULT hr = CoInitializeEx(nullptr, COINIT_MULTITHREADED);
+
+	if (FAILED(hr))
+	{
+		DEBUG(driver, 0, "xaudio2_s: CoInitializeEx failed (%08x)", hr);
+		return "Failed to initialise COM";
+	}
+
+	_xaudio_dll_handle = LoadLibraryA(XAUDIO2_DLL_A);
+
+	if (_xaudio_dll_handle == NULL)
+	{
+		CoUninitialize();
+
+		DEBUG(driver, 0, "xaudio2_s: Unable to load " XAUDIO2_DLL_A);
+		return "Failed to load XAudio2 DLL";
+	}
+
+	API_XAudio2Create xAudio2Create = (API_XAudio2Create) GetProcAddress(_xaudio_dll_handle, "XAudio2Create");
+
+	if (xAudio2Create == NULL)
+	{
+		FreeLibrary(_xaudio_dll_handle);
+		CoUninitialize();
+
+		DEBUG(driver, 0, "xaudio2_s: Unable to find XAudio2Create function in DLL");
+		return "Failed to load XAudio2 DLL";
+	}
+
+	// Create the XAudio engine
+	UINT32 flags = 0;
+	hr = xAudio2Create(_xaudio2.GetAddressOf(), flags, XAUDIO2_DEFAULT_PROCESSOR);
+
+	if (FAILED(hr))
+	{
+		FreeLibrary(_xaudio_dll_handle);
+		CoUninitialize();
+
+		DEBUG(driver, 0, "xaudio2_s: XAudio2Create failed (%08x)", hr);
+		return "Failed to inititialise the XAudio2 engine";
+	}
+
+	// Create a mastering voice
+	hr = _xaudio2->CreateMasteringVoice(&_mastering_voice);
+
+	if (FAILED(hr))
+	{
+		_xaudio2.Reset();
+		FreeLibrary(_xaudio_dll_handle);
+		CoUninitialize();
+
+		DEBUG(driver, 0, "xaudio2_s: CreateMasteringVoice failed (%08x)", hr);
+		return "Failed to create a mastering voice";
+	}
+
+	// Create a source voice to stream our audio
+	WAVEFORMATEX wfex;
+
+	wfex.wFormatTag = WAVE_FORMAT_PCM;
+	wfex.nChannels = 2;
+	wfex.wBitsPerSample = 16;
+	wfex.nSamplesPerSec = GetDriverParamInt(parm, "hz", 44100);
+	wfex.nBlockAlign = (wfex.nChannels * wfex.wBitsPerSample) / 8;
+	wfex.nAvgBytesPerSec = wfex.nSamplesPerSec * wfex.nBlockAlign;
+
+	// Limit buffer size to prevent overflows
+	int bufsize = GetDriverParamInt(parm, "bufsize", 8192);
+	bufsize = min(bufsize, UINT16_MAX);
+
+	_voice_context = new StreamingVoiceContext(bufsize * 4);
+
+	if (_voice_context == nullptr)
+	{
+		_mastering_voice->DestroyVoice();
+		_xaudio2.Reset();
+		FreeLibrary(_xaudio_dll_handle);
+		CoUninitialize();
+
+		return "Failed to create streaming voice context";
+	}
+
+	hr = _xaudio2->CreateSourceVoice(&_source_voice, &wfex, 0, 1.0f, _voice_context);
+
+	if (FAILED(hr))
+	{
+		_mastering_voice->DestroyVoice();
+		_xaudio2.Reset();
+		FreeLibrary(_xaudio_dll_handle);
+		CoUninitialize();
+
+		DEBUG(driver, 0, "xaudio2_s: CreateSourceVoice failed (%08x)", hr);
+		return "Failed to create a source voice";
+	}
+
+	_voice_context->SourceVoice = _source_voice;
+	hr = _source_voice->Start(0, 0);
+
+	if (FAILED(hr))
+	{
+		DEBUG(driver, 0, "xaudio2_s: _source_voice->Start failed (%08x)", hr);
+
+		Stop();
+		return "Failed to start the source voice";
+	}
+
+	MxInitialize(wfex.nSamplesPerSec);
+
+	// Submit the first buffer
+	hr = _voice_context->SubmitBuffer();
+
+	if (FAILED(hr))
+	{
+		DEBUG(driver, 0, "xaudio2_s: _voice_context->SubmitBuffer failed (%08x)", hr);
+
+		Stop();
+		return "Failed to submit the first audio buffer";
+	}
+
+	return NULL;
+}
+
+/**
+* Terminates the XAudio2 driver.
+*/
+void SoundDriver_XAudio2::Stop()
+{
+	// Clean up XAudio2
+	_source_voice->DestroyVoice();
+
+	delete _voice_context;
+	_voice_context = nullptr;
+
+	_mastering_voice->DestroyVoice();
+
+	_xaudio2.Reset();
+
+	FreeLibrary(_xaudio_dll_handle);
+	CoUninitialize();
+}
+
+#endif
diff --git a/src/sound/xaudio2_s.h b/src/sound/xaudio2_s.h
new file mode 100644
index 000000000..2385f49ee
--- /dev/null
+++ b/src/sound/xaudio2_s.h
@@ -0,0 +1,33 @@
+/* $Id$ */
+
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+ * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file xaudio2_s.h Base for XAudio2 sound handling. */
+
+#ifndef SOUND_XAUDIO2_H
+#define SOUND_XAUDIO2_H
+
+#include "sound_driver.hpp"
+
+/** Implementation of the XAudio2 sound driver. */
+class SoundDriver_XAudio2 : public SoundDriver {
+public:
+	/* virtual */ const char *Start(const char * const *param);
+
+	/* virtual */ void Stop();
+	/* virtual */ const char *GetName() const { return "xaudio2"; }
+};
+
+/** Factory for the XAudio2 sound driver. */
+class FSoundDriver_XAudio2 : public DriverFactoryBase {
+public:
+	FSoundDriver_XAudio2() : DriverFactoryBase(Driver::DT_SOUND, 10, "xaudio2", "XAudio2 Sound Driver") {}
+	/* virtual */ Driver *CreateInstance() const { return new SoundDriver_XAudio2(); }
+};
+
+#endif /* SOUND_XAUDIO2_H */