1 /*************************************************************************/
2 /* audio_driver_xaudio2.cpp */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* https://godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
10 /* */
11 /* Permission is hereby granted, free of charge, to any person obtaining */
12 /* a copy of this software and associated documentation files (the */
13 /* "Software"), to deal in the Software without restriction, including */
14 /* without limitation the rights to use, copy, modify, merge, publish, */
15 /* distribute, sublicense, and/or sell copies of the Software, and to */
16 /* permit persons to whom the Software is furnished to do so, subject to */
17 /* the following conditions: */
18 /* */
19 /* The above copyright notice and this permission notice shall be */
20 /* included in all copies or substantial portions of the Software. */
21 /* */
22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29 /*************************************************************************/
30
31 #include "audio_driver_xaudio2.h"
32
33 #include "core/os/os.h"
34 #include "core/project_settings.h"
35
get_name() const36 const char *AudioDriverXAudio2::get_name() const {
37 return "XAudio2";
38 }
39
init()40 Error AudioDriverXAudio2::init() {
41
42 active = false;
43 thread_exited = false;
44 exit_thread = false;
45 pcm_open = false;
46 samples_in = NULL;
47
48 mix_rate = GLOBAL_GET("audio/mix_rate");
49 // FIXME: speaker_mode seems unused in the Xaudio2 driver so far
50 speaker_mode = SPEAKER_MODE_STEREO;
51 channels = 2;
52
53 int latency = GLOBAL_GET("audio/output_latency");
54 buffer_size = closest_power_of_2(latency * mix_rate / 1000);
55
56 samples_in = memnew_arr(int32_t, buffer_size * channels);
57 for (int i = 0; i < AUDIO_BUFFERS; i++) {
58 samples_out[i] = memnew_arr(int16_t, buffer_size * channels);
59 xaudio_buffer[i].AudioBytes = buffer_size * channels * sizeof(int16_t);
60 xaudio_buffer[i].pAudioData = (const BYTE *)(samples_out[i]);
61 xaudio_buffer[i].Flags = 0;
62 }
63
64 HRESULT hr;
65 hr = XAudio2Create(&xaudio, 0, XAUDIO2_DEFAULT_PROCESSOR);
66 ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 engine.");
67
68 hr = xaudio->CreateMasteringVoice(&mastering_voice);
69 ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 mastering voice.");
70
71 wave_format.nChannels = channels;
72 wave_format.cbSize = 0;
73 wave_format.nSamplesPerSec = mix_rate;
74 wave_format.wFormatTag = WAVE_FORMAT_PCM;
75 wave_format.wBitsPerSample = 16;
76 wave_format.nBlockAlign = channels * wave_format.wBitsPerSample >> 3;
77 wave_format.nAvgBytesPerSec = mix_rate * wave_format.nBlockAlign;
78
79 hr = xaudio->CreateSourceVoice(&source_voice, &wave_format, 0, XAUDIO2_MAX_FREQ_RATIO, &voice_callback);
80 ERR_FAIL_COND_V_MSG(hr != S_OK, ERR_UNAVAILABLE, "Error creating XAudio2 source voice. Error code: " + itos(hr) + ".");
81
82 mutex = Mutex::create();
83 thread = Thread::create(AudioDriverXAudio2::thread_func, this);
84
85 return OK;
86 }
87
thread_func(void * p_udata)88 void AudioDriverXAudio2::thread_func(void *p_udata) {
89
90 AudioDriverXAudio2 *ad = (AudioDriverXAudio2 *)p_udata;
91
92 while (!ad->exit_thread) {
93
94 if (!ad->active) {
95
96 for (int i = 0; i < AUDIO_BUFFERS; i++) {
97 ad->xaudio_buffer[i].Flags = XAUDIO2_END_OF_STREAM;
98 }
99
100 } else {
101
102 ad->lock();
103
104 ad->audio_server_process(ad->buffer_size, ad->samples_in);
105
106 ad->unlock();
107
108 for (unsigned int i = 0; i < ad->buffer_size * ad->channels; i++) {
109
110 ad->samples_out[ad->current_buffer][i] = ad->samples_in[i] >> 16;
111 }
112
113 ad->xaudio_buffer[ad->current_buffer].Flags = 0;
114 ad->xaudio_buffer[ad->current_buffer].AudioBytes = ad->buffer_size * ad->channels * sizeof(int16_t);
115 ad->xaudio_buffer[ad->current_buffer].pAudioData = (const BYTE *)(ad->samples_out[ad->current_buffer]);
116 ad->xaudio_buffer[ad->current_buffer].PlayBegin = 0;
117 ad->source_voice->SubmitSourceBuffer(&(ad->xaudio_buffer[ad->current_buffer]));
118
119 ad->current_buffer = (ad->current_buffer + 1) % AUDIO_BUFFERS;
120
121 XAUDIO2_VOICE_STATE state;
122 while (ad->source_voice->GetState(&state), state.BuffersQueued > AUDIO_BUFFERS - 1) {
123 WaitForSingleObject(ad->voice_callback.buffer_end_event, INFINITE);
124 }
125 }
126 }
127
128 ad->thread_exited = true;
129 }
130
start()131 void AudioDriverXAudio2::start() {
132
133 active = true;
134 HRESULT hr = source_voice->Start(0);
135 ERR_FAIL_COND_MSG(hr != S_OK, "Error starting XAudio2 driver. Error code: " + itos(hr) + ".");
136 }
137
get_mix_rate() const138 int AudioDriverXAudio2::get_mix_rate() const {
139
140 return mix_rate;
141 }
142
get_speaker_mode() const143 AudioDriver::SpeakerMode AudioDriverXAudio2::get_speaker_mode() const {
144
145 return speaker_mode;
146 }
147
get_latency()148 float AudioDriverXAudio2::get_latency() {
149
150 XAUDIO2_PERFORMANCE_DATA perf_data;
151 xaudio->GetPerformanceData(&perf_data);
152 if (perf_data.CurrentLatencyInSamples) {
153 return (float)(perf_data.CurrentLatencyInSamples / ((float)mix_rate));
154 } else {
155 return 0;
156 }
157 }
158
lock()159 void AudioDriverXAudio2::lock() {
160
161 if (!thread || !mutex)
162 return;
163 mutex->lock();
164 }
unlock()165 void AudioDriverXAudio2::unlock() {
166
167 if (!thread || !mutex)
168 return;
169 mutex->unlock();
170 }
171
finish()172 void AudioDriverXAudio2::finish() {
173
174 if (!thread)
175 return;
176
177 exit_thread = true;
178 Thread::wait_to_finish(thread);
179
180 if (source_voice) {
181 source_voice->Stop(0);
182 source_voice->DestroyVoice();
183 }
184
185 if (samples_in) {
186 memdelete_arr(samples_in);
187 }
188 if (samples_out[0]) {
189 for (int i = 0; i < AUDIO_BUFFERS; i++) {
190 memdelete_arr(samples_out[i]);
191 }
192 }
193
194 mastering_voice->DestroyVoice();
195
196 memdelete(thread);
197 if (mutex)
198 memdelete(mutex);
199 thread = NULL;
200 }
201
AudioDriverXAudio2()202 AudioDriverXAudio2::AudioDriverXAudio2() :
203 thread(NULL),
204 mutex(NULL),
205 current_buffer(0) {
206 wave_format = { 0 };
207 for (int i = 0; i < AUDIO_BUFFERS; i++) {
208 xaudio_buffer[i] = { 0 };
209 samples_out[i] = 0;
210 }
211 }
212
~AudioDriverXAudio2()213 AudioDriverXAudio2::~AudioDriverXAudio2() {
214 }
215