Merge pull request #10942 from marcelofg55/wasapi_driver_21

Added new WASAPI driver for Windows

drivers/SCsub

@@ -16,6 +16,7 @@ SConscript('alsa/SCsub')
 SConscript('pulseaudio/SCsub')
 if (env["platform"] == "windows"):
     SConscript("rtaudio/SCsub")
+    SConscript("wasapi/SCsub")
 
 # Graphics drivers
 SConscript('gles2/SCsub')

drivers/rtaudio/audio_driver_rtaudio.cpp

@@ -224,6 +224,7 @@ void AudioDriverRtAudio::finish() {
 
 AudioDriverRtAudio::AudioDriverRtAudio() {
 
+	active = false;
 	mutex = NULL;
 	mix_rate = 44100;
 	output_format = OUTPUT_STEREO;

drivers/wasapi/SCsub

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+Import('env')
+
+# Driver source files
+env.add_source_files(env.drivers_sources, "*.cpp")
+
+Export('env')

drivers/wasapi/audio_driver_wasapi.cpp

@@ -0,0 +1,364 @@
+/*************************************************************************/
+/*  audio_driver_wasapi.cpp                                              */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                    http://www.godotengine.org                         */
+/*************************************************************************/
+/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* 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.                */
+/*************************************************************************/
+#ifdef WASAPI_ENABLED
+
+#include "audio_driver_wasapi.h"
+
+#include "globals.h"
+#include "os/os.h"
+
+const CLSID CLSID_MMDeviceEnumerator = __uuidof(MMDeviceEnumerator);
+const IID IID_IMMDeviceEnumerator = __uuidof(IMMDeviceEnumerator);
+const IID IID_IAudioClient = __uuidof(IAudioClient);
+const IID IID_IAudioRenderClient = __uuidof(IAudioRenderClient);
+
+Error AudioDriverWASAPI::init_device() {
+
+	WAVEFORMATEX *pwfex;
+	IMMDeviceEnumerator *enumerator = NULL;
+	IMMDevice *device = NULL;
+
+	CoInitialize(NULL);
+
+	HRESULT hr = CoCreateInstance(CLSID_MMDeviceEnumerator, NULL, CLSCTX_ALL, IID_IMMDeviceEnumerator, (void **)&enumerator);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	hr = enumerator->GetDefaultAudioEndpoint(eRender, eConsole, &device);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	hr = device->Activate(IID_IAudioClient, CLSCTX_ALL, NULL, (void **)&audio_client);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	hr = audio_client->GetMixFormat(&pwfex);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	// Since we're using WASAPI Shared Mode we can't control any of these, we just tag along
+	channels = pwfex->nChannels;
+	mix_rate = pwfex->nSamplesPerSec;
+	format_tag = pwfex->wFormatTag;
+	bits_per_sample = pwfex->wBitsPerSample;
+
+	switch (channels) {
+		case 2: // Stereo
+//		case 6: // Surround 5.1
+//		case 8: // Surround 7.1
+			break;
+
+		default:
+			ERR_PRINT("WASAPI: Unsupported number of channels");
+			ERR_FAIL_V(ERR_CANT_OPEN);
+			break;
+	}
+
+	if (format_tag == WAVE_FORMAT_EXTENSIBLE) {
+		WAVEFORMATEXTENSIBLE *wfex = (WAVEFORMATEXTENSIBLE *)pwfex;
+
+		if (wfex->SubFormat == KSDATAFORMAT_SUBTYPE_PCM) {
+			format_tag = WAVE_FORMAT_PCM;
+		} else if (wfex->SubFormat == KSDATAFORMAT_SUBTYPE_IEEE_FLOAT) {
+			format_tag = WAVE_FORMAT_IEEE_FLOAT;
+		} else {
+			ERR_PRINT("WASAPI: Format not supported");
+			ERR_FAIL_V(ERR_CANT_OPEN);
+		}
+	} else {
+		if (format_tag != WAVE_FORMAT_PCM && format_tag != WAVE_FORMAT_IEEE_FLOAT) {
+			ERR_PRINT("WASAPI: Format not supported");
+			ERR_FAIL_V(ERR_CANT_OPEN);
+		}
+	}
+
+	hr = audio_client->Initialize(AUDCLNT_SHAREMODE_SHARED, AUDCLNT_STREAMFLAGS_EVENTCALLBACK, 0, 0, pwfex, NULL);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	event = CreateEvent(NULL, FALSE, FALSE, NULL);
+	ERR_FAIL_COND_V(event == NULL, ERR_CANT_OPEN);
+
+	hr = audio_client->SetEventHandle(event);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	hr = audio_client->GetService(IID_IAudioRenderClient, (void **)&render_client);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	UINT32 max_frames;
+	hr = audio_client->GetBufferSize(&max_frames);
+	ERR_FAIL_COND_V(hr != S_OK, ERR_CANT_OPEN);
+
+	// Due to WASAPI Shared Mode we have no control of the buffer size
+	buffer_frames = max_frames;
+
+	// Sample rate is independent of channels (ref: https://stackoverflow.com/questions/11048825/audio-sample-frequency-rely-on-channels)
+	buffer_size = buffer_frames * channels;
+	samples_in.resize(buffer_size);
+
+	if (OS::get_singleton()->is_stdout_verbose()) {
+		print_line("audio buffer frames: " + itos(buffer_frames) + " calculated latency: " + itos(buffer_frames * 1000 / mix_rate) + "ms");
+	}
+
+	return OK;
+}
+
+Error AudioDriverWASAPI::finish_device() {
+
+	if (audio_client) {
+		if (active) {
+			audio_client->Stop();
+			active = false;
+		}
+	}
+
+	if (render_client) {
+		render_client->Release();
+		render_client = NULL;
+	}
+
+	if (audio_client) {
+		audio_client->Release();
+		audio_client = NULL;
+	}
+
+	return OK;
+}
+
+Error AudioDriverWASAPI::init() {
+
+	Error err = init_device();
+	ERR_FAIL_COND_V(err != OK, err);
+
+	active = false;
+	exit_thread = false;
+	thread_exited = false;
+
+	mutex = Mutex::create(true);
+	thread = Thread::create(thread_func, this);
+
+	return OK;
+}
+
+Error AudioDriverWASAPI::reopen() {
+	Error err = finish_device();
+	if (err != OK) {
+		ERR_PRINT("WASAPI: finish_device error");
+	} else {
+		err = init_device();
+		if (err != OK) {
+			ERR_PRINT("WASAPI: init_device error");
+		} else {
+			start();
+		}
+	}
+
+	return err;
+}
+
+int AudioDriverWASAPI::get_mix_rate() const {
+
+	return mix_rate;
+}
+
+AudioDriverSW::OutputFormat AudioDriverWASAPI::get_output_format() const {
+
+	return OUTPUT_STEREO;
+}
+
+void AudioDriverWASAPI::thread_func(void *p_udata) {
+
+	AudioDriverWASAPI *ad = (AudioDriverWASAPI *)p_udata;
+
+	while (!ad->exit_thread) {
+		if (ad->active) {
+			ad->lock();
+
+			ad->audio_server_process(ad->buffer_frames, ad->samples_in.ptr());
+
+			ad->unlock();
+		} else {
+			for (unsigned int i = 0; i < ad->buffer_size; i++) {
+				ad->samples_in[i] = 0;
+			}
+		}
+
+		unsigned int left_frames = ad->buffer_frames;
+		unsigned int buffer_idx = 0;
+		while (left_frames > 0) {
+			WaitForSingleObject(ad->event, 1000);
+
+			UINT32 cur_frames;
+			HRESULT hr = ad->audio_client->GetCurrentPadding(&cur_frames);
+			if (hr == S_OK) {
+				// Check how much frames are available on the WASAPI buffer
+				UINT32 avail_frames = ad->buffer_frames - cur_frames;
+				UINT32 write_frames = avail_frames > left_frames ? left_frames : avail_frames;
+
+				BYTE *buffer = NULL;
+				hr = ad->render_client->GetBuffer(write_frames, &buffer);
+				if (hr == S_OK) {
+					// We're using WASAPI Shared Mode so we must convert the buffer
+
+					if (ad->format_tag == WAVE_FORMAT_PCM) {
+						switch (ad->bits_per_sample) {
+							case 8:
+								for (unsigned int i = 0; i < write_frames * ad->channels; i++) {
+									((int8_t *)buffer)[i] = ad->samples_in[buffer_idx++] >> 24;
+								}
+								break;
+
+							case 16:
+								for (unsigned int i = 0; i < write_frames * ad->channels; i++) {
+									((int16_t *)buffer)[i] = ad->samples_in[buffer_idx++] >> 16;
+								}
+								break;
+
+							case 24:
+								for (unsigned int i = 0; i < write_frames * ad->channels; i++) {
+									int32_t sample = ad->samples_in[buffer_idx++];
+									((int8_t *)buffer)[i * 3 + 2] = sample >> 24;
+									((int8_t *)buffer)[i * 3 + 1] = sample >> 16;
+									((int8_t *)buffer)[i * 3 + 0] = sample >> 8;
+								}
+								break;
+
+							case 32:
+								for (unsigned int i = 0; i < write_frames * ad->channels; i++) {
+									((int32_t *)buffer)[i] = ad->samples_in[buffer_idx++];
+								}
+								break;
+						}
+					} else if (ad->format_tag == WAVE_FORMAT_IEEE_FLOAT) {
+						for (unsigned int i = 0; i < write_frames * ad->channels; i++) {
+							((float *)buffer)[i] = (ad->samples_in[buffer_idx++] >> 16) / 32768.f;
+						}
+					} else {
+						ERR_PRINT("WASAPI: Unknown format tag");
+						ad->exit_thread = true;
+					}
+
+					hr = ad->render_client->ReleaseBuffer(write_frames, 0);
+					if (hr != S_OK) {
+						ERR_PRINT("WASAPI: Release buffer error");
+					}
+
+					left_frames -= write_frames;
+				} else if (hr == AUDCLNT_E_DEVICE_INVALIDATED) {
+					// Device is not valid anymore, reopen it
+
+					Error err = ad->reopen();
+					if (err != OK) {
+						ad->exit_thread = true;
+					} else {
+						// We reopened the device and samples_in may have resized, so invalidate the current left_frames
+						left_frames = 0;
+					}
+				} else {
+					ERR_PRINT("WASAPI: Get buffer error");
+					ad->exit_thread = true;
+				}
+			} else if (hr == AUDCLNT_E_DEVICE_INVALIDATED) {
+				// Device is not valid anymore, reopen it
+
+				Error err = ad->reopen();
+				if (err != OK) {
+					ad->exit_thread = true;
+				} else {
+					// We reopened the device and samples_in may have resized, so invalidate the current left_frames
+					left_frames = 0;
+				}
+			} else {
+				ERR_PRINT("WASAPI: GetCurrentPadding error");
+			}
+		}
+	}
+
+	ad->thread_exited = true;
+}
+
+void AudioDriverWASAPI::start() {
+
+	HRESULT hr = audio_client->Start();
+	if (hr != S_OK) {
+		ERR_PRINT("WASAPI: Start failed");
+	} else {
+		active = true;
+	}
+}
+
+void AudioDriverWASAPI::lock() {
+
+	if (mutex)
+		mutex->lock();
+}
+
+void AudioDriverWASAPI::unlock() {
+
+	if (mutex)
+		mutex->unlock();
+}
+
+void AudioDriverWASAPI::finish() {
+
+	if (thread) {
+		exit_thread = true;
+		Thread::wait_to_finish(thread);
+
+		memdelete(thread);
+		thread = NULL;
+	}
+
+	finish_device();
+
+	if (mutex) {
+		memdelete(mutex);
+		mutex = NULL;
+	}
+}
+
+AudioDriverWASAPI::AudioDriverWASAPI() {
+
+	audio_client = NULL;
+	render_client = NULL;
+	mutex = NULL;
+	thread = NULL;
+
+	format_tag = 0;
+	bits_per_sample = 0;
+
+	samples_in.clear();
+
+	buffer_size = 0;
+	channels = 0;
+	mix_rate = 0;
+	buffer_frames = 0;
+
+	thread_exited = false;
+	exit_thread = false;
+	active = false;
+}
+
+#endif

drivers/wasapi/audio_driver_wasapi.h

@@ -0,0 +1,86 @@
+/*************************************************************************/
+/*  audio_driver_wasapi.h                                                */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                    http://www.godotengine.org                         */
+/*************************************************************************/
+/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* 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.                */
+/*************************************************************************/
+#ifndef AUDIO_DRIVER_WASAPI_H
+#define AUDIO_DRIVER_WASAPI_H
+
+#ifdef WASAPI_ENABLED
+
+#include "servers/audio/audio_server_sw.h"
+
+#include <audioclient.h>
+#include <mmdeviceapi.h>
+#include <windows.h>
+
+class AudioDriverWASAPI : public AudioDriverSW {
+
+	HANDLE event;
+	IAudioClient *audio_client;
+	IAudioRenderClient *render_client;
+	Mutex *mutex;
+	Thread *thread;
+
+	WORD format_tag;
+	WORD bits_per_sample;
+
+	Vector<int32_t> samples_in;
+
+	unsigned int buffer_size;
+	unsigned int channels;
+	int mix_rate;
+	int buffer_frames;
+
+	bool thread_exited;
+	mutable bool exit_thread;
+	bool active;
+
+	static void thread_func(void *p_udata);
+
+	Error init_device();
+	Error finish_device();
+	Error reopen();
+
+public:
+	virtual const char *get_name() const {
+		return "WASAPI";
+	}
+
+	virtual Error init();
+	virtual void start();
+	virtual int get_mix_rate() const;
+	virtual OutputFormat get_output_format() const;
+	virtual void lock();
+	virtual void unlock();
+	virtual void finish();
+
+	AudioDriverWASAPI();
+};
+
+#endif // AUDIO_DRIVER_WASAPI_H
+#endif

platform/windows/detect.py

@@ -250,6 +250,7 @@ def configure(env):
         env.Append(CCFLAGS=['/I' + os.getenv("WindowsSdkDir") + "/Include"])
         env.Append(CCFLAGS=['/DWINDOWS_ENABLED'])
         env.Append(CCFLAGS=['/DRTAUDIO_ENABLED'])
+        env.Append(CCFLAGS=['/DWASAPI_ENABLED'])
         env.Append(CCFLAGS=['/DWIN32'])
         env.Append(CCFLAGS=['/DTYPED_METHOD_BIND'])
 
@@ -362,8 +363,9 @@ def configure(env):
 
         env.Append(CCFLAGS=['-DWINDOWS_ENABLED', '-mwindows'])
         env.Append(CPPFLAGS=['-DRTAUDIO_ENABLED'])
+        env.Append(CPPFLAGS=['-DWASAPI_ENABLED'])
         env.Append(CCFLAGS=['-DGLES2_ENABLED'])
-        env.Append(LIBS=['mingw32', 'opengl32', 'dsound', 'ole32', 'd3d9', 'winmm', 'gdi32', 'iphlpapi', 'shlwapi', 'wsock32', 'ws2_32', 'kernel32', 'oleaut32', 'dinput8', 'dxguid'])
+        env.Append(LIBS=['mingw32', 'opengl32', 'dsound', 'ole32', 'd3d9', 'winmm', 'gdi32', 'iphlpapi', 'shlwapi', 'wsock32', 'ws2_32', 'kernel32', 'oleaut32', 'dinput8', 'dxguid', 'ksuser'])
 
         # if (env["bits"]=="32"):
         # env.Append(LIBS=['gcc_s'])

platform/windows/os_windows.cpp

@@ -2330,6 +2330,9 @@ OS_Windows::OS_Windows(HINSTANCE _hInstance) {
 #endif
 	user_proc = NULL;
 
+#ifdef WASAPI_ENABLED
+	AudioDriverManagerSW::add_driver(&driver_wasapi);
+#endif
 #ifdef RTAUDIO_ENABLED
 	AudioDriverManagerSW::add_driver(&driver_rtaudio);
 #endif

platform/windows/os_windows.h

@@ -38,6 +38,7 @@
 #include "servers/visual_server.h"
 
 #include "drivers/rtaudio/audio_driver_rtaudio.h"
+#include "drivers/wasapi/audio_driver_wasapi.h"
 #include "drivers/unix/ip_unix.h"
 #include "servers/audio/audio_server_sw.h"
 #include "servers/audio/sample_manager_sw.h"
@@ -129,6 +130,9 @@ class OS_Windows : public OS {
 	InputDefault *input;
 	joystick_windows *joystick;
 
+#ifdef WASAPI_ENABLED
+	AudioDriverWASAPI driver_wasapi;
+#endif
 #ifdef RTAUDIO_ENABLED
 	AudioDriverRtAudio driver_rtaudio;
 #endif