initial commit, 4.5 stable

drivers/xaudio2/SCsub

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+from misc.utility.scons_hints import *
+
+Import("env")
+
+env.add_source_files(env.drivers_sources, "*.cpp")
+env.Append(CPPDEFINES=["XAUDIO2_ENABLED"])
+env.Append(LINKFLAGS=["xaudio2_8.lib"])

drivers/xaudio2/audio_driver_xaudio2.cpp

@@ -0,0 +1,180 @@
+/**************************************************************************/
+/*  audio_driver_xaudio2.cpp                                              */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#include "audio_driver_xaudio2.h"
+
+#include "core/config/project_settings.h"
+#include "core/os/os.h"
+
+Error AudioDriverXAudio2::init() {
+	active.clear();
+	exit_thread.clear();
+	pcm_open = false;
+	samples_in = nullptr;
+
+	mix_rate = _get_configured_mix_rate();
+
+	// FIXME: speaker_mode seems unused in the Xaudio2 driver so far
+	speaker_mode = SPEAKER_MODE_STEREO;
+	channels = 2;
+
+	int latency = Engine::get_singleton()->get_audio_output_latency();
+	buffer_size = closest_power_of_2(latency * mix_rate / 1000);
+
+	samples_in = memnew_arr(int32_t, size_t(buffer_size) * channels);
+	for (int i = 0; i < AUDIO_BUFFERS; i++) {
+		samples_out[i] = memnew_arr(int16_t, size_t(buffer_size) * channels);
+		xaudio_buffer[i].AudioBytes = buffer_size * channels * sizeof(int16_t);
+		xaudio_buffer[i].pAudioData = (const BYTE *)(samples_out[i]);
+		xaudio_buffer[i].Flags = 0;
+	}
+
+	HRESULT hr;
+	hr = XAudio2Create(&xaudio, 0, XAUDIO2_DEFAULT_PROCESSOR);
+	ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 engine.");
+
+	hr = xaudio->CreateMasteringVoice(&mastering_voice);
+	ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 mastering voice.");
+
+	wave_format.nChannels = channels;
+	wave_format.cbSize = 0;
+	wave_format.nSamplesPerSec = mix_rate;
+	wave_format.wFormatTag = WAVE_FORMAT_PCM;
+	wave_format.wBitsPerSample = 16;
+	wave_format.nBlockAlign = channels * wave_format.wBitsPerSample >> 3;
+	wave_format.nAvgBytesPerSec = mix_rate * wave_format.nBlockAlign;
+
+	hr = xaudio->CreateSourceVoice(&source_voice, &wave_format, 0, XAUDIO2_MAX_FREQ_RATIO, &voice_callback);
+	ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 source voice. Error code: " + itos(hr) + ".");
+
+	thread.start(AudioDriverXAudio2::thread_func, this);
+
+	return OK;
+}
+
+void AudioDriverXAudio2::thread_func(void *p_udata) {
+	AudioDriverXAudio2 *ad = static_cast<AudioDriverXAudio2 *>(p_udata);
+
+	while (!ad->exit_thread.is_set()) {
+		if (!ad->active.is_set()) {
+			for (int i = 0; i < AUDIO_BUFFERS; i++) {
+				ad->xaudio_buffer[i].Flags = XAUDIO2_END_OF_STREAM;
+			}
+
+		} else {
+			ad->lock();
+			ad->start_counting_ticks();
+
+			ad->audio_server_process(ad->buffer_size, ad->samples_in);
+
+			ad->stop_counting_ticks();
+			ad->unlock();
+
+			for (unsigned int i = 0; i < ad->buffer_size * ad->channels; i++) {
+				ad->samples_out[ad->current_buffer][i] = ad->samples_in[i] >> 16;
+			}
+
+			ad->xaudio_buffer[ad->current_buffer].Flags = 0;
+			ad->xaudio_buffer[ad->current_buffer].AudioBytes = ad->buffer_size * ad->channels * sizeof(int16_t);
+			ad->xaudio_buffer[ad->current_buffer].pAudioData = (const BYTE *)(ad->samples_out[ad->current_buffer]);
+			ad->xaudio_buffer[ad->current_buffer].PlayBegin = 0;
+			ad->source_voice->SubmitSourceBuffer(&(ad->xaudio_buffer[ad->current_buffer]));
+
+			ad->current_buffer = (ad->current_buffer + 1) % AUDIO_BUFFERS;
+
+			XAUDIO2_VOICE_STATE state;
+			while (ad->source_voice->GetState(&state), state.BuffersQueued > AUDIO_BUFFERS - 1) {
+				WaitForSingleObject(ad->voice_callback.buffer_end_event, INFINITE);
+			}
+		}
+	}
+}
+
+void AudioDriverXAudio2::start() {
+	active.set();
+	HRESULT hr = source_voice->Start(0);
+	ERR_FAIL_COND_MSG(hr != S_OK, "Error starting XAudio2 driver. Error code: " + itos(hr) + ".");
+}
+
+int AudioDriverXAudio2::get_mix_rate() const {
+	return mix_rate;
+}
+
+AudioDriver::SpeakerMode AudioDriverXAudio2::get_speaker_mode() const {
+	return speaker_mode;
+}
+
+float AudioDriverXAudio2::get_latency() {
+	XAUDIO2_PERFORMANCE_DATA perf_data;
+	xaudio->GetPerformanceData(&perf_data);
+	if (perf_data.CurrentLatencyInSamples) {
+		return (float)(perf_data.CurrentLatencyInSamples / ((float)mix_rate));
+	} else {
+		return 0;
+	}
+}
+
+void AudioDriverXAudio2::lock() {
+	mutex.lock();
+}
+
+void AudioDriverXAudio2::unlock() {
+	mutex.unlock();
+}
+
+void AudioDriverXAudio2::finish() {
+	exit_thread.set();
+	if (thread.is_started()) {
+		thread.wait_to_finish();
+	}
+
+	if (source_voice) {
+		source_voice->Stop(0);
+		source_voice->DestroyVoice();
+	}
+
+	if (samples_in) {
+		memdelete_arr(samples_in);
+	}
+	if (samples_out[0]) {
+		for (int i = 0; i < AUDIO_BUFFERS; i++) {
+			memdelete_arr(samples_out[i]);
+		}
+	}
+
+	mastering_voice->DestroyVoice();
+}
+
+AudioDriverXAudio2::AudioDriverXAudio2() {
+	for (int i = 0; i < AUDIO_BUFFERS; i++) {
+		xaudio_buffer[i] = { 0 };
+		samples_out[i] = 0;
+	}
+}

drivers/xaudio2/audio_driver_xaudio2.h

@@ -0,0 +1,109 @@
+/**************************************************************************/
+/*  audio_driver_xaudio2.h                                                */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "core/os/mutex.h"
+#include "core/os/thread.h"
+#include "core/templates/safe_refcount.h"
+#include "servers/audio_server.h"
+
+#include <mmsystem.h>
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#include <wrl/client.h>
+#include <xaudio2.h>
+
+class AudioDriverXAudio2 : public AudioDriver {
+	enum {
+		AUDIO_BUFFERS = 2
+	};
+
+	struct XAudio2DriverVoiceCallback : public IXAudio2VoiceCallback {
+		HANDLE buffer_end_event;
+		XAudio2DriverVoiceCallback() :
+				buffer_end_event(CreateEvent(nullptr, FALSE, FALSE, nullptr)) {}
+		void STDMETHODCALLTYPE OnBufferEnd(void *pBufferContext) {
+			SetEvent(buffer_end_event);
+		}
+
+		//Unused methods are stubs
+		void STDMETHODCALLTYPE OnStreamEnd() {}
+		void STDMETHODCALLTYPE OnVoiceProcessingPassEnd() {}
+		void STDMETHODCALLTYPE OnVoiceProcessingPassStart(UINT32 SamplesRequired) {}
+		void STDMETHODCALLTYPE OnBufferStart(void *pBufferContext) {}
+		void STDMETHODCALLTYPE OnLoopEnd(void *pBufferContext) {}
+		void STDMETHODCALLTYPE OnVoiceError(void *pBufferContext, HRESULT Error) {}
+	};
+
+	Thread thread;
+	Mutex mutex;
+
+	int32_t *samples_in = nullptr;
+	int16_t *samples_out[AUDIO_BUFFERS];
+
+	static void thread_func(void *p_udata);
+	int buffer_size = 0;
+
+	unsigned int mix_rate = 0;
+	SpeakerMode speaker_mode = SpeakerMode::SPEAKER_MODE_STEREO;
+
+	int channels = 0;
+
+	SafeFlag active;
+	SafeFlag exit_thread;
+	bool pcm_open = false;
+
+	WAVEFORMATEX wave_format = { 0 };
+	Microsoft::WRL::ComPtr<IXAudio2> xaudio;
+	int current_buffer = 0;
+	IXAudio2MasteringVoice *mastering_voice = nullptr;
+	XAUDIO2_BUFFER xaudio_buffer[AUDIO_BUFFERS];
+	IXAudio2SourceVoice *source_voice = nullptr;
+	XAudio2DriverVoiceCallback voice_callback;
+
+public:
+	virtual const char *get_name() const override {
+		return "XAudio2";
+	}
+
+	virtual Error init() override;
+	virtual void start() override;
+	virtual int get_mix_rate() const override;
+	virtual SpeakerMode get_speaker_mode() const override;
+	virtual float get_latency() override;
+
+	virtual void lock() override;
+	virtual void unlock() override;
+	virtual void finish() override;
+
+	AudioDriverXAudio2();
+	~AudioDriverXAudio2() {}
+};