Skip to content

Latest commit

 

History

History
966 lines (815 loc) · 33.9 KB

SDL_wasapi.c

File metadata and controls

966 lines (815 loc) · 33.9 KB
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/*
Simple DirectMedia Layer
Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#include "../../SDL_internal.h"
#if SDL_AUDIO_DRIVER_WASAPI
#include "../../core/windows/SDL_windows.h"
#include "SDL_audio.h"
#include "SDL_timer.h"
#include "../SDL_audio_c.h"
#include "../SDL_sysaudio.h"
#include "SDL_assert.h"
#include "SDL_log.h"
#define COBJMACROS
#include <mmdeviceapi.h>
#include <audioclient.h>
#include "SDL_wasapi.h"
static const ERole SDL_WASAPI_role = eConsole; /* !!! FIXME: should this be eMultimedia? Should be a hint? */
/* This is global to the WASAPI target, to handle hotplug and default device lookup. */
static IMMDeviceEnumerator *enumerator = NULL;
Mar 30, 2017
Mar 30, 2017
45
46
47
48
/* these increment as default devices change. Opened default devices pick up changes in their threads. */
static SDL_atomic_t default_playback_generation;
static SDL_atomic_t default_capture_generation;
49
50
51
/* This is a list of device id strings we have inflight, so we have consistent pointers to the same device. */
typedef struct DevIdList
{
May 18, 2017
May 18, 2017
52
53
WCHAR *str;
struct DevIdList *next;
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
} DevIdList;
static DevIdList *deviceid_list = NULL;
/* handle to Avrt.dll--Vista and later!--for flagging the callback thread as "Pro Audio" (low latency). */
#ifndef __WINRT__
static HMODULE libavrt = NULL;
#endif
typedef HANDLE (WINAPI *pfnAvSetMmThreadCharacteristicsW)(LPWSTR,LPDWORD);
typedef BOOL (WINAPI *pfnAvRevertMmThreadCharacteristics)(HANDLE);
static pfnAvSetMmThreadCharacteristicsW pAvSetMmThreadCharacteristicsW = NULL;
static pfnAvRevertMmThreadCharacteristics pAvRevertMmThreadCharacteristics = NULL;
/* Some GUIDs we need to know without linking to libraries that aren't available before Vista. */
static const CLSID SDL_CLSID_MMDeviceEnumerator = { 0xbcde0395, 0xe52f, 0x467c, { 0x8e, 0x3d, 0xc4, 0x57, 0x92, 0x91, 0x69, 0x2e } };
static const IID SDL_IID_IMMDeviceEnumerator = { 0xa95664d2, 0x9614, 0x4f35, { 0xa7, 0x46, 0xde, 0x8d, 0xb6, 0x36, 0x17, 0xe6 } };
static const IID SDL_IID_IMMNotificationClient = { 0x7991eec9, 0x7e89, 0x4d85, { 0x83, 0x90, 0x6c, 0x70, 0x3c, 0xec, 0x60, 0xc0 } };
static const IID SDL_IID_IMMEndpoint = { 0x1be09788, 0x6894, 0x4089, { 0x85, 0x86, 0x9a, 0x2a, 0x6c, 0x26, 0x5a, 0xc5 } };
static const IID SDL_IID_IAudioClient = { 0x1cb9ad4c, 0xdbfa, 0x4c32, { 0xb1, 0x78, 0xc2, 0xf5, 0x68, 0xa7, 0x03, 0xb2 } };
static const IID SDL_IID_IAudioRenderClient = { 0xf294acfc, 0x3146, 0x4483, { 0xa7, 0xbf, 0xad, 0xdc, 0xa7, 0xc2, 0x60, 0xe2 } };
static const IID SDL_IID_IAudioCaptureClient = { 0xc8adbd64, 0xe71e, 0x48a0, { 0xa4, 0xde, 0x18, 0x5c, 0x39, 0x5c, 0xd3, 0x17 } };
static const GUID SDL_KSDATAFORMAT_SUBTYPE_PCM = { 0x00000001, 0x0000, 0x0010, { 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 } };
static const GUID SDL_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT = { 0x00000003, 0x0000, 0x0010, { 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 } };
static const PROPERTYKEY SDL_PKEY_Device_FriendlyName = { { 0xa45c254e, 0xdf1c, 0x4efd, { 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, } }, 14 };
/* PropVariantInit() is an inline function/macro in PropIdl.h that calls the C runtime's memset() directly. Use ours instead, to avoid dependency. */
#ifdef PropVariantInit
#undef PropVariantInit
#endif
#define PropVariantInit(p) SDL_zerop(p)
static void AddWASAPIDevice(const SDL_bool iscapture, IMMDevice *device, LPCWSTR devid);
static void RemoveWASAPIDevice(const SDL_bool iscapture, LPCWSTR devid);
/* We need a COM subclass of IMMNotificationClient for hotplug support, which is
easy in C++, but we have to tapdance more to make work in C.
Thanks to this page for coaching on how to make this work:
https://www.codeproject.com/Articles/13601/COM-in-plain-C */
typedef struct SDLMMNotificationClient
{
const IMMNotificationClientVtbl *lpVtbl;
SDL_atomic_t refcount;
} SDLMMNotificationClient;
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_QueryInterface(IMMNotificationClient *this, REFIID iid, void **ppv)
{
if ((WIN_IsEqualIID(iid, &IID_IUnknown)) || (WIN_IsEqualIID(iid, &SDL_IID_IMMNotificationClient)))
{
*ppv = this;
this->lpVtbl->AddRef(this);
return S_OK;
}
*ppv = NULL;
return E_NOINTERFACE;
}
static ULONG STDMETHODCALLTYPE
SDLMMNotificationClient_AddRef(IMMNotificationClient *ithis)
{
May 18, 2017
May 18, 2017
116
SDLMMNotificationClient *this = (SDLMMNotificationClient *) ithis;
117
118
119
120
121
122
123
return (ULONG) (SDL_AtomicIncRef(&this->refcount) + 1);
}
static ULONG STDMETHODCALLTYPE
SDLMMNotificationClient_Release(IMMNotificationClient *ithis)
{
/* this is a static object; we don't ever free it. */
May 18, 2017
May 18, 2017
124
SDLMMNotificationClient *this = (SDLMMNotificationClient *) ithis;
125
126
127
128
129
130
131
132
133
134
135
136
const ULONG retval = SDL_AtomicDecRef(&this->refcount);
if (retval == 0) {
SDL_AtomicSet(&this->refcount, 0); /* uhh... */
return 0;
}
return retval - 1;
}
/* These are the entry points called when WASAPI device endpoints change. */
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_OnDefaultDeviceChanged(IMMNotificationClient *ithis, EDataFlow flow, ERole role, LPCWSTR pwstrDeviceId)
{
May 18, 2017
May 18, 2017
137
138
139
if (role != SDL_WASAPI_role) {
return S_OK; /* ignore it. */
}
Mar 30, 2017
Mar 30, 2017
141
/* Increment the "generation," so opened devices will pick this up in their threads. */
May 18, 2017
May 18, 2017
142
143
switch (flow) {
case eRender:
Mar 30, 2017
Mar 30, 2017
144
145
146
SDL_AtomicAdd(&default_playback_generation, 1);
break;
May 18, 2017
May 18, 2017
147
case eCapture:
Mar 30, 2017
Mar 30, 2017
148
149
150
SDL_AtomicAdd(&default_capture_generation, 1);
break;
May 18, 2017
May 18, 2017
151
case eAll:
Mar 30, 2017
Mar 30, 2017
152
153
154
155
156
157
158
SDL_AtomicAdd(&default_playback_generation, 1);
SDL_AtomicAdd(&default_capture_generation, 1);
break;
default:
SDL_assert(!"uhoh, unexpected OnDefaultDeviceChange flow!");
break;
May 18, 2017
May 18, 2017
159
}
May 18, 2017
May 18, 2017
161
return S_OK;
162
163
164
165
166
}
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_OnDeviceAdded(IMMNotificationClient *ithis, LPCWSTR pwstrDeviceId)
{
May 18, 2017
May 18, 2017
167
168
169
170
171
172
/* we ignore this; devices added here then progress to ACTIVE, if appropriate, in
OnDeviceStateChange, making that a better place to deal with device adds. More
importantly: the first time you plug in a USB audio device, this callback will
fire, but when you unplug it, it isn't removed (it's state changes to NOTPRESENT).
Plugging it back in won't fire this callback again. */
return S_OK;
173
174
175
176
177
}
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_OnDeviceRemoved(IMMNotificationClient *ithis, LPCWSTR pwstrDeviceId)
{
May 18, 2017
May 18, 2017
178
179
/* See notes in OnDeviceAdded handler about why we ignore this. */
return S_OK;
180
181
182
183
184
}
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_OnDeviceStateChanged(IMMNotificationClient *ithis, LPCWSTR pwstrDeviceId, DWORD dwNewState)
{
May 18, 2017
May 18, 2017
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
SDLMMNotificationClient *this = (SDLMMNotificationClient *) ithis;
IMMDevice *device = NULL;
if (SUCCEEDED(IMMDeviceEnumerator_GetDevice(enumerator, pwstrDeviceId, &device))) {
IMMEndpoint *endpoint = NULL;
if (SUCCEEDED(IMMDevice_QueryInterface(device, &SDL_IID_IMMEndpoint, (void **) &endpoint))) {
EDataFlow flow;
if (SUCCEEDED(IMMEndpoint_GetDataFlow(endpoint, &flow))) {
const SDL_bool iscapture = (flow == eCapture);
if (dwNewState == DEVICE_STATE_ACTIVE) {
AddWASAPIDevice(iscapture, device, pwstrDeviceId);
} else {
RemoveWASAPIDevice(iscapture, pwstrDeviceId);
}
}
IMMEndpoint_Release(endpoint);
}
IMMDevice_Release(device);
}
return S_OK;
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
}
static HRESULT STDMETHODCALLTYPE
SDLMMNotificationClient_OnPropertyValueChanged(IMMNotificationClient *this, LPCWSTR pwstrDeviceId, const PROPERTYKEY key)
{
return S_OK; /* we don't care about these. */
}
static const IMMNotificationClientVtbl notification_client_vtbl = {
SDLMMNotificationClient_QueryInterface,
SDLMMNotificationClient_AddRef,
SDLMMNotificationClient_Release,
SDLMMNotificationClient_OnDeviceStateChanged,
SDLMMNotificationClient_OnDeviceAdded,
SDLMMNotificationClient_OnDeviceRemoved,
SDLMMNotificationClient_OnDefaultDeviceChanged,
SDLMMNotificationClient_OnPropertyValueChanged
};
static SDLMMNotificationClient notification_client = { &notification_client_vtbl, 1 };
static SDL_bool
WStrEqual(const WCHAR *a, const WCHAR *b)
{
May 18, 2017
May 18, 2017
230
231
232
233
234
235
236
237
while (*a) {
if (*a != *b) {
return SDL_FALSE;
}
a++;
b++;
}
return *b == 0;
238
239
240
241
242
}
static WCHAR *
WStrDupe(const WCHAR *wstr)
{
May 18, 2017
May 18, 2017
243
244
245
246
247
248
const int len = (lstrlenW(wstr) + 1) * sizeof (WCHAR);
WCHAR *retval = (WCHAR *) SDL_malloc(len);
if (retval) {
SDL_memcpy(retval, wstr, len);
}
return retval;
249
250
251
252
253
}
static void
RemoveWASAPIDevice(const SDL_bool iscapture, LPCWSTR devid)
{
May 18, 2017
May 18, 2017
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
DevIdList *i;
DevIdList *next;
DevIdList *prev = NULL;
for (i = deviceid_list; i; i = next) {
next = i->next;
if (WStrEqual(i->str, devid)) {
if (prev) {
prev->next = next;
} else {
deviceid_list = next;
}
SDL_RemoveAudioDevice(iscapture, i->str);
SDL_free(i->str);
SDL_free(i);
}
prev = i;
}
271
272
273
274
275
}
static void
AddWASAPIDevice(const SDL_bool iscapture, IMMDevice *device, LPCWSTR devid)
{
May 18, 2017
May 18, 2017
276
IPropertyStore *props = NULL;
277
char *utf8dev = NULL;
May 18, 2017
May 18, 2017
278
DevIdList *devidlist;
279
280
PROPVARIANT var;
May 18, 2017
May 18, 2017
281
/* You can have multiple endpoints on a device that are mutually exclusive ("Speakers" vs "Line Out" or whatever).
282
283
284
285
286
287
288
289
In a perfect world, things that are unplugged won't be in this collection. The only gotcha is probably for
phones and tablets, where you might have an internal speaker and a headphone jack and expect both to be
available and switch automatically. (!!! FIXME...?) */
/* PKEY_Device_FriendlyName gives you "Speakers (SoundBlaster Pro)" which drives me nuts. I'd rather it be
"SoundBlaster Pro (Speakers)" but I guess that's developers vs users. Windows uses the FriendlyName in
its own UIs, like Volume Control, etc. */
May 18, 2017
May 18, 2017
290
291
292
293
294
295
/* see if we already have this one. */
for (devidlist = deviceid_list; devidlist; devidlist = devidlist->next) {
if (WStrEqual(devidlist->str, devid)) {
return; /* we already have this. */
}
}
May 18, 2017
May 18, 2017
297
298
299
300
devidlist = (DevIdList *) SDL_malloc(sizeof (*devidlist));
if (!devidlist) {
return; /* oh well. */
}
May 18, 2017
May 18, 2017
302
303
304
305
306
devid = WStrDupe(devid);
if (!devid) {
SDL_free(devidlist);
return; /* oh well. */
}
May 18, 2017
May 18, 2017
308
309
310
devidlist->str = (WCHAR *) devid;
devidlist->next = deviceid_list;
deviceid_list = devidlist;
311
312
if (SUCCEEDED(IMMDevice_OpenPropertyStore(device, STGM_READ, &props))) {
May 18, 2017
May 18, 2017
313
314
315
316
317
318
319
320
321
322
323
PropVariantInit(&var);
if (SUCCEEDED(IPropertyStore_GetValue(props, &SDL_PKEY_Device_FriendlyName, &var))) {
utf8dev = WIN_StringToUTF8(var.pwszVal);
if (utf8dev) {
SDL_AddAudioDevice(iscapture, utf8dev, (void *) devid);
SDL_free(utf8dev);
}
}
PropVariantClear(&var);
IPropertyStore_Release(props);
}
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
}
static void
EnumerateEndpoints(const SDL_bool iscapture)
{
IMMDeviceCollection *collection = NULL;
UINT i, total;
/* Note that WASAPI separates "adapter devices" from "audio endpoint devices"
...one adapter device ("SoundBlaster Pro") might have multiple endpoint devices ("Speakers", "Line-Out"). */
if (FAILED(IMMDeviceEnumerator_EnumAudioEndpoints(enumerator, iscapture ? eCapture : eRender, DEVICE_STATE_ACTIVE, &collection))) {
return;
}
if (FAILED(IMMDeviceCollection_GetCount(collection, &total))) {
IMMDeviceCollection_Release(collection);
return;
}
for (i = 0; i < total; i++) {
IMMDevice *device = NULL;
if (SUCCEEDED(IMMDeviceCollection_Item(collection, i, &device))) {
May 18, 2017
May 18, 2017
347
348
349
350
351
352
353
354
LPWSTR devid = NULL;
if (SUCCEEDED(IMMDevice_GetId(device, &devid))) {
AddWASAPIDevice(iscapture, device, devid);
CoTaskMemFree(devid);
}
IMMDevice_Release(device);
}
}
355
356
357
358
359
360
361
362
363
364
365
366
367
368
IMMDeviceCollection_Release(collection);
}
static void
WASAPI_DetectDevices(void)
{
EnumerateEndpoints(SDL_FALSE); /* playback */
EnumerateEndpoints(SDL_TRUE); /* capture */
/* if this fails, we just won't get hotplug events. Carry on anyhow. */
IMMDeviceEnumerator_RegisterEndpointNotificationCallback(enumerator, (IMMNotificationClient *) &notification_client);
}
Mar 30, 2017
Mar 30, 2017
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
static int
WASAPI_GetPendingBytes(_THIS)
{
UINT32 frames = 0;
/* it's okay to fail here; we'll deal with failures in the audio thread. */
if (FAILED(IAudioClient_GetCurrentPadding(this->hidden->client, &frames))) {
return 0; /* oh well. */
}
return ((int) frames) * this->hidden->framesize;
}
static SDL_INLINE SDL_bool
WasapiFailed(_THIS, const HRESULT err)
{
if (err == S_OK) {
return SDL_FALSE;
}
if (err == AUDCLNT_E_DEVICE_INVALIDATED) {
this->hidden->device_lost = SDL_TRUE;
} else if (SDL_AtomicGet(&this->enabled)) {
May 18, 2017
May 18, 2017
392
393
IAudioClient_Stop(this->hidden->client);
SDL_OpenedAudioDeviceDisconnected(this);
Mar 30, 2017
Mar 30, 2017
394
395
396
397
398
399
SDL_assert(!SDL_AtomicGet(&this->enabled));
}
return SDL_TRUE;
}
Mar 29, 2017
Mar 29, 2017
400
401
402
403
404
405
406
407
408
409
static int PrepWasapiDevice(_THIS, const int iscapture, IMMDevice *device);
static void ReleaseWasapiDevice(_THIS);
static SDL_bool
RecoverWasapiDevice(_THIS)
{
const SDL_AudioSpec oldspec = this->spec;
IMMDevice *device = NULL;
HRESULT ret = S_OK;
Mar 30, 2017
Mar 30, 2017
410
if (this->hidden->default_device_generation) {
Mar 29, 2017
Mar 29, 2017
411
412
const EDataFlow dataflow = this->iscapture ? eCapture : eRender;
ReleaseWasapiDevice(this); /* dump the lost device's handles. */
Mar 30, 2017
Mar 30, 2017
413
this->hidden->default_device_generation = SDL_AtomicGet(this->iscapture ? &default_capture_generation : &default_playback_generation);
Mar 29, 2017
Mar 29, 2017
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
ret = IMMDeviceEnumerator_GetDefaultAudioEndpoint(enumerator, dataflow, SDL_WASAPI_role, &device);
if (FAILED(ret)) {
return SDL_FALSE; /* can't find a new default device! */
}
} else {
device = this->hidden->device;
this->hidden->device = NULL; /* don't release this in ReleaseWasapiDevice(). */
ReleaseWasapiDevice(this); /* dump the lost device's handles. */
}
SDL_assert(device != NULL);
/* this can fail for lots of reasons, but the most likely is we had a
non-default device that was disconnected, so we can't recover. Default
devices try to reinitialize whatever the new default is, so it's more
likely to carry on here, but this handles a non-default device that
simply had its format changed in the Windows Control Panel. */
if (PrepWasapiDevice(this, this->iscapture, device) == -1) {
return SDL_FALSE;
}
/* Since WASAPI requires us to handle all audio conversion, and our
device format might have changed, we might have to add/remove/change
the audio stream that the higher level uses to convert data, so
SDL keeps firing the callback as if nothing happened here. */
if ( (this->callbackspec.channels == this->spec.channels) &&
(this->callbackspec.format == this->spec.format) &&
(this->callbackspec.freq == this->spec.freq) &&
(this->callbackspec.samples == this->spec.samples) ) {
/* no need to buffer/convert in an AudioStream! */
SDL_FreeAudioStream(this->stream);
this->stream = NULL;
} else if ( (oldspec.channels == this->spec.channels) &&
(oldspec.format == this->spec.format) &&
Mar 30, 2017
Mar 30, 2017
449
(oldspec.freq == this->spec.freq) ) {
Mar 29, 2017
Mar 29, 2017
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/* The existing audio stream is okay to keep using. */
} else {
/* replace the audiostream for new format */
SDL_FreeAudioStream(this->stream);
if (this->iscapture) {
this->stream = SDL_NewAudioStream(this->spec.format,
this->spec.channels, this->spec.freq,
this->callbackspec.format,
this->callbackspec.channels,
this->callbackspec.freq);
} else {
this->stream = SDL_NewAudioStream(this->callbackspec.format,
this->callbackspec.channels,
this->callbackspec.freq, this->spec.format,
this->spec.channels, this->spec.freq);
}
if (!this->stream) {
return SDL_FALSE;
}
}
/* make sure our scratch buffer can cover the new device spec. */
if (this->spec.size > this->work_buffer_len) {
Uint8 *ptr = (Uint8 *) SDL_realloc(this->work_buffer, this->spec.size);
if (ptr == NULL) {
SDL_OutOfMemory();
return SDL_FALSE;
}
this->work_buffer = ptr;
this->work_buffer_len = this->spec.size;
}
Mar 30, 2017
Mar 30, 2017
483
484
this->hidden->device_lost = SDL_FALSE;
Mar 29, 2017
Mar 29, 2017
485
486
487
488
return SDL_TRUE; /* okay, carry on with new device details! */
}
static SDL_bool
Mar 30, 2017
Mar 30, 2017
489
RecoverWasapiIfLost(_THIS)
Mar 29, 2017
Mar 29, 2017
490
{
Mar 30, 2017
Mar 30, 2017
491
492
const int generation = this->hidden->default_device_generation;
SDL_bool lost = this->hidden->device_lost;
Mar 29, 2017
Mar 29, 2017
493
Mar 30, 2017
Mar 30, 2017
494
495
496
if (!SDL_AtomicGet(&this->enabled)) {
return SDL_FALSE; /* already failed. */
}
Mar 29, 2017
Mar 29, 2017
497
Mar 30, 2017
Mar 30, 2017
498
499
500
501
502
if (!lost && (generation > 0)) { /* is a default device? */
const int newgen = SDL_AtomicGet(this->iscapture ? &default_capture_generation : &default_playback_generation);
if (generation != newgen) { /* the desired default device was changed, jump over to it. */
lost = SDL_TRUE;
}
Mar 30, 2017
Mar 30, 2017
505
return lost ? RecoverWasapiDevice(this) : SDL_TRUE;
506
507
508
509
510
511
512
}
static Uint8 *
WASAPI_GetDeviceBuf(_THIS)
{
/* get an endpoint buffer from WASAPI. */
BYTE *buffer = NULL;
Mar 29, 2017
Mar 29, 2017
513
Mar 30, 2017
Mar 30, 2017
514
515
516
517
while (RecoverWasapiIfLost(this)) {
if (!WasapiFailed(this, IAudioRenderClient_GetBuffer(this->hidden->render, this->spec.samples, &buffer))) {
return (Uint8 *) buffer;
}
518
519
SDL_assert(buffer == NULL);
}
Mar 30, 2017
Mar 30, 2017
520
521
522
523
524
525
526
return (Uint8 *) buffer;
}
static void
WASAPI_PlayDevice(_THIS)
{
Mar 30, 2017
Mar 30, 2017
527
528
/* WasapiFailed() will mark the device for reacquisition or removal elsewhere. */
WasapiFailed(this, IAudioRenderClient_ReleaseBuffer(this->hidden->render, this->spec.samples, 0));
529
530
531
532
533
}
static void
WASAPI_WaitDevice(_THIS)
{
May 18, 2017
May 18, 2017
534
const UINT32 maxpadding = this->spec.samples;
Mar 30, 2017
Mar 30, 2017
535
while (RecoverWasapiIfLost(this)) {
May 18, 2017
May 18, 2017
536
UINT32 padding = 0;
Mar 29, 2017
Mar 29, 2017
537
Mar 30, 2017
Mar 30, 2017
538
539
if (!WasapiFailed(this, IAudioClient_GetCurrentPadding(this->hidden->client, &padding))) {
if (padding <= maxpadding) {
May 18, 2017
May 18, 2017
540
break;
Mar 30, 2017
Mar 30, 2017
541
}
May 18, 2017
May 18, 2017
542
543
/* Sleep long enough for half the buffer to be free. */
SDL_Delay(((padding - maxpadding) * 1000) / this->spec.freq);
May 18, 2017
May 18, 2017
545
}
546
547
548
549
550
551
552
553
554
555
556
557
558
}
static int
WASAPI_CaptureFromDevice(_THIS, void *buffer, int buflen)
{
SDL_AudioStream *stream = this->hidden->capturestream;
const int avail = SDL_AudioStreamAvailable(stream);
if (avail > 0) {
const int cpy = SDL_min(buflen, avail);
SDL_AudioStreamGet(stream, buffer, cpy);
return cpy;
}
Mar 30, 2017
Mar 30, 2017
559
while (RecoverWasapiIfLost(this)) {
560
561
562
563
564
HRESULT ret;
BYTE *ptr = NULL;
UINT32 frames = 0;
DWORD flags = 0;
Mar 30, 2017
Mar 30, 2017
565
ret = IAudioCaptureClient_GetBuffer(this->hidden->capture, &ptr, &frames, &flags, NULL, NULL);
May 19, 2017
May 19, 2017
566
567
568
if (ret != AUDCLNT_S_BUFFER_EMPTY) {
WasapiFailed(this, ret); /* mark device lost/failed if necessary. */
}
Mar 29, 2017
Mar 29, 2017
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
if ((ret == AUDCLNT_S_BUFFER_EMPTY) || !frames) {
WASAPI_WaitDevice(this);
} else if (ret == S_OK) {
const int total = ((int) frames) * this->hidden->framesize;
const int cpy = SDL_min(buflen, total);
const int leftover = total - cpy;
const SDL_bool silent = (flags & AUDCLNT_BUFFERFLAGS_SILENT) ? SDL_TRUE : SDL_FALSE;
if (silent) {
SDL_memset(buffer, this->spec.silence, cpy);
} else {
SDL_memcpy(buffer, ptr, cpy);
}
if (leftover > 0) {
ptr += cpy;
if (silent) {
SDL_memset(ptr, this->spec.silence, leftover); /* I guess this is safe? */
}
if (SDL_AudioStreamPut(stream, ptr, leftover) == -1) {
return -1; /* uhoh, out of memory, etc. Kill device. :( */
}
}
Mar 30, 2017
Mar 30, 2017
595
596
597
ret = IAudioCaptureClient_ReleaseBuffer(this->hidden->capture, frames);
WasapiFailed(this, ret); /* mark device lost/failed if necessary. */
598
599
600
601
602
603
604
605
606
607
return cpy;
}
}
return -1; /* unrecoverable error. */
}
static void
WASAPI_FlushCapture(_THIS)
{
Mar 30, 2017
Mar 30, 2017
608
if (RecoverWasapiIfLost(this)) {
609
610
611
BYTE *ptr = NULL;
UINT32 frames = 0;
DWORD flags = 0;
Mar 30, 2017
Mar 30, 2017
612
613
/* just read until we stop getting packets, throwing them away. */
May 18, 2017
May 18, 2017
614
while (SDL_TRUE) {
May 18, 2017
May 18, 2017
615
const HRESULT ret = IAudioCaptureClient_GetBuffer(this->hidden->capture, &ptr, &frames, &flags, NULL, NULL);
May 18, 2017
May 18, 2017
616
617
618
619
620
621
if (ret == AUDCLNT_S_BUFFER_EMPTY) {
break; /* no more buffered data; we're done. */
} else if (WasapiFailed(this, ret)) {
break; /* failed for some other reason, abort. */
} else if (WasapiFailed(this, IAudioCaptureClient_ReleaseBuffer(this->hidden->capture, frames))) {
break; /* something broke. */
Mar 30, 2017
Mar 30, 2017
622
}
623
624
625
626
627
628
}
SDL_AudioStreamClear(this->hidden->capturestream);
}
}
static void
Mar 29, 2017
Mar 29, 2017
629
ReleaseWasapiDevice(_THIS)
May 18, 2017
May 18, 2017
631
if (this->hidden->client) {
632
IAudioClient_Stop(this->hidden->client);
Mar 29, 2017
Mar 29, 2017
633
634
this->hidden->client = NULL;
}
635
636
637
if (this->hidden->render) {
IAudioRenderClient_Release(this->hidden->render);
Mar 29, 2017
Mar 29, 2017
638
this->hidden->render = NULL;
Mar 29, 2017
Mar 29, 2017
641
642
643
if (this->hidden->capture) {
IAudioCaptureClient_Release(this->hidden->capture);
this->hidden->client = NULL;
644
645
646
647
}
if (this->hidden->waveformat) {
CoTaskMemFree(this->hidden->waveformat);
Mar 29, 2017
Mar 29, 2017
648
this->hidden->waveformat = NULL;
649
650
651
652
}
if (this->hidden->device) {
IMMDevice_Release(this->hidden->device);
Mar 29, 2017
Mar 29, 2017
653
this->hidden->device = NULL;
654
655
656
657
}
if (this->hidden->capturestream) {
SDL_FreeAudioStream(this->hidden->capturestream);
Mar 29, 2017
Mar 29, 2017
658
this->hidden->capturestream = NULL;
Mar 29, 2017
Mar 29, 2017
660
}
Mar 29, 2017
Mar 29, 2017
662
663
664
665
666
667
668
static void
WASAPI_CloseDevice(_THIS)
{
/* don't touch this->hidden->task in here; it has to be reverted from
our callback thread. We do that in WASAPI_ThreadDeinit().
(likewise for this->hidden->coinitialized). */
ReleaseWasapiDevice(this);
669
670
671
SDL_free(this->hidden);
}
Mar 29, 2017
Mar 29, 2017
672
Mar 29, 2017
Mar 29, 2017
674
PrepWasapiDevice(_THIS, const int iscapture, IMMDevice *device)
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
{
/* !!! FIXME: we could request an exclusive mode stream, which is lower latency;
!!! it will write into the kernel's audio buffer directly instead of
!!! shared memory that a user-mode mixer then writes to the kernel with
!!! everything else. Doing this means any other sound using this device will
!!! stop playing, including the user's MP3 player and system notification
!!! sounds. You'd probably need to release the device when the app isn't in
!!! the foreground, to be a good citizen of the system. It's doable, but it's
!!! more work and causes some annoyances, and I don't know what the latency
!!! wins actually look like. Maybe add a hint to force exclusive mode at
!!! some point. To be sure, defaulting to shared mode is the right thing to
!!! do in any case. */
const AUDCLNT_SHAREMODE sharemode = AUDCLNT_SHAREMODE_SHARED;
UINT32 bufsize = 0; /* this is in sample frames, not samples, not bytes. */
REFERENCE_TIME duration = 0;
IAudioClient *client = NULL;
IAudioRenderClient *render = NULL;
IAudioCaptureClient *capture = NULL;
WAVEFORMATEX *waveformat = NULL;
SDL_AudioFormat test_format = SDL_FirstAudioFormat(this->spec.format);
SDL_AudioFormat wasapi_format = 0;
SDL_bool valid_format = SDL_FALSE;
HRESULT ret = S_OK;
this->hidden->device = device;
ret = IMMDevice_Activate(device, &SDL_IID_IAudioClient, CLSCTX_ALL, NULL, (void **) &client);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't activate audio endpoint", ret);
}
SDL_assert(client != NULL);
this->hidden->client = client;
ret = IAudioClient_GetMixFormat(client, &waveformat);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't determine mix format", ret);
}
SDL_assert(waveformat != NULL);
this->hidden->waveformat = waveformat;
/* WASAPI will not do any conversion on our behalf. Force channels and sample rate. */
this->spec.channels = (Uint8) waveformat->nChannels;
this->spec.freq = waveformat->nSamplesPerSec;
/* Make sure we have a valid format that we can convert to whatever WASAPI wants. */
if ((waveformat->wFormatTag == WAVE_FORMAT_IEEE_FLOAT) && (waveformat->wBitsPerSample == 32)) {
wasapi_format = AUDIO_F32SYS;
} else if ((waveformat->wFormatTag == WAVE_FORMAT_PCM) && (waveformat->wBitsPerSample == 16)) {
wasapi_format = AUDIO_S16SYS;
} else if ((waveformat->wFormatTag == WAVE_FORMAT_PCM) && (waveformat->wBitsPerSample == 32)) {
wasapi_format = AUDIO_S32SYS;
} else if (waveformat->wFormatTag == WAVE_FORMAT_EXTENSIBLE) {
const WAVEFORMATEXTENSIBLE *ext = (const WAVEFORMATEXTENSIBLE *) waveformat;
if ((SDL_memcmp(&ext->SubFormat, &SDL_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT, sizeof (GUID)) == 0) && (waveformat->wBitsPerSample == 32)) {
wasapi_format = AUDIO_F32SYS;
} else if ((SDL_memcmp(&ext->SubFormat, &SDL_KSDATAFORMAT_SUBTYPE_PCM, sizeof (GUID)) == 0) && (waveformat->wBitsPerSample == 16)) {
wasapi_format = AUDIO_S16SYS;
} else if ((SDL_memcmp(&ext->SubFormat, &SDL_KSDATAFORMAT_SUBTYPE_PCM, sizeof (GUID)) == 0) && (waveformat->wBitsPerSample == 32)) {
wasapi_format = AUDIO_S32SYS;
}
}
while ((!valid_format) && (test_format)) {
if (test_format == wasapi_format) {
this->spec.format = test_format;
valid_format = SDL_TRUE;
break;
}
test_format = SDL_NextAudioFormat();
}
if (!valid_format) {
return SDL_SetError("WASAPI: Unsupported audio format");
}
ret = IAudioClient_GetDevicePeriod(client, NULL, &duration);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't determine minimum device period", ret);
}
ret = IAudioClient_Initialize(client, sharemode, 0, duration, sharemode == AUDCLNT_SHAREMODE_SHARED ? 0 : duration, waveformat, NULL);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't initialize audio client", ret);
}
May 18, 2017
May 18, 2017
762
ret = IAudioClient_GetBufferSize(client, &bufsize);
763
764
765
766
767
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't determine buffer size", ret);
}
this->spec.samples = (Uint16) bufsize;
May 18, 2017
May 18, 2017
768
769
770
if (!iscapture) {
this->spec.samples /= 2; /* fill half of the DMA buffer on each run. */
}
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
/* Update the fragment size as size in bytes */
SDL_CalculateAudioSpec(&this->spec);
this->hidden->framesize = (SDL_AUDIO_BITSIZE(this->spec.format) / 8) * this->spec.channels;
if (iscapture) {
this->hidden->capturestream = SDL_NewAudioStream(this->spec.format, this->spec.channels, this->spec.freq, this->spec.format, this->spec.channels, this->spec.freq);
if (!this->hidden->capturestream) {
return -1; /* already set SDL_Error */
}
ret = IAudioClient_GetService(client, &SDL_IID_IAudioCaptureClient, (void**) &capture);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't get capture client service", ret);
}
SDL_assert(capture != NULL);
this->hidden->capture = capture;
ret = IAudioClient_Start(client);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't start capture", ret);
}
WASAPI_FlushCapture(this); /* MSDN says you should flush capture endpoint right after startup. */
} else {
ret = IAudioClient_GetService(client, &SDL_IID_IAudioRenderClient, (void**) &render);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't get render client service", ret);
}
SDL_assert(render != NULL);
this->hidden->render = render;
ret = IAudioClient_Start(client);
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't start playback", ret);
}
}
return 0; /* good to go. */
}
Mar 29, 2017
Mar 29, 2017
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
static int
WASAPI_OpenDevice(_THIS, void *handle, const char *devname, int iscapture)
{
const SDL_bool is_default_device = (handle == NULL);
IMMDevice *device = NULL;
HRESULT ret = S_OK;
/* Initialize all variables that we clean on shutdown */
this->hidden = (struct SDL_PrivateAudioData *)
SDL_malloc((sizeof *this->hidden));
if (this->hidden == NULL) {
return SDL_OutOfMemory();
}
SDL_zerop(this->hidden);
if (is_default_device) {
Mar 30, 2017
Mar 30, 2017
829
830
const EDataFlow dataflow = iscapture ? eCapture : eRender;
this->hidden->default_device_generation = SDL_AtomicGet(iscapture ? &default_capture_generation : &default_playback_generation);
Mar 29, 2017
Mar 29, 2017
831
ret = IMMDeviceEnumerator_GetDefaultAudioEndpoint(enumerator, dataflow, SDL_WASAPI_role, &device);
May 18, 2017
May 18, 2017
832
} else {
Mar 29, 2017
Mar 29, 2017
833
834
835
836
837
838
839
840
841
842
843
ret = IMMDeviceEnumerator_GetDevice(enumerator, (LPCWSTR) handle, &device);
}
if (FAILED(ret)) {
return WIN_SetErrorFromHRESULT("WASAPI can't find requested audio endpoint", ret);
}
SDL_assert(device != NULL);
return PrepWasapiDevice(this, iscapture, device);
}
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
static void
WASAPI_ThreadInit(_THIS)
{
/* this thread uses COM. */
if (SUCCEEDED(WIN_CoInitialize())) { /* can't report errors, hope it worked! */
this->hidden->coinitialized = SDL_TRUE;
}
/* Set this thread to very high "Pro Audio" priority. */
if (pAvSetMmThreadCharacteristicsW) {
DWORD idx = 0;
this->hidden->task = pAvSetMmThreadCharacteristicsW(TEXT("Pro Audio"), &idx);
}
}
static void
WASAPI_ThreadDeinit(_THIS)
{
/* Set this thread to very high "Pro Audio" priority. */
if (this->hidden->task && pAvRevertMmThreadCharacteristics) {
pAvRevertMmThreadCharacteristics(this->hidden->task);
this->hidden->task = NULL;
}
if (this->hidden->coinitialized) {
WIN_CoUninitialize();
}
}
static void
WASAPI_Deinitialize(void)
{
May 18, 2017
May 18, 2017
876
877
DevIdList *devidlist;
DevIdList *next;
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
if (enumerator) {
IMMDeviceEnumerator_UnregisterEndpointNotificationCallback(enumerator, (IMMNotificationClient *) &notification_client);
IMMDeviceEnumerator_Release(enumerator);
enumerator = NULL;
}
#ifndef __WINRT__
if (libavrt) {
FreeLibrary(libavrt);
libavrt = NULL;
}
#endif
pAvSetMmThreadCharacteristicsW = NULL;
pAvRevertMmThreadCharacteristics = NULL;
May 18, 2017
May 18, 2017
895
896
897
898
899
900
for (devidlist = deviceid_list; devidlist; devidlist = next) {
next = devidlist->next;
SDL_free(devidlist->str);
SDL_free(devidlist);
}
deviceid_list = NULL;
901
902
903
904
905
906
907
WIN_CoUninitialize();
}
static int
WASAPI_Init(SDL_AudioDriverImpl * impl)
{
May 18, 2017
May 18, 2017
908
HRESULT ret;
May 18, 2017
May 18, 2017
910
911
/* just skip the discussion with COM here. */
if (!WIN_IsWindowsVistaOrGreater()) {
May 28, 2017
May 28, 2017
912
913
SDL_SetError("WASAPI support requires Windows Vista or later");
return 0;
May 18, 2017
May 18, 2017
914
}
Mar 30, 2017
Mar 30, 2017
916
917
918
SDL_AtomicSet(&default_playback_generation, 1);
SDL_AtomicSet(&default_capture_generation, 1);
May 18, 2017
May 18, 2017
919
if (FAILED(WIN_CoInitialize())) {
920
921
922
923
SDL_SetError("WASAPI: CoInitialize() failed");
return 0;
}
May 18, 2017
May 18, 2017
924
ret = CoCreateInstance(&SDL_CLSID_MMDeviceEnumerator, NULL, CLSCTX_INPROC_SERVER, &SDL_IID_IMMDeviceEnumerator, (LPVOID) &enumerator);
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
if (FAILED(ret)) {
WIN_CoUninitialize();
WIN_SetErrorFromHRESULT("WASAPI CoCreateInstance(MMDeviceEnumerator)", ret);
return 0; /* oh well. */
}
#ifdef __WINRT__
pAvSetMmThreadCharacteristicsW = AvSetMmThreadCharacteristicsW;
pAvRevertMmThreadCharacteristics = AvRevertMmThreadCharacteristics;
#else
libavrt = LoadLibraryW(L"avrt.dll"); /* this library is available in Vista and later. No WinXP, so have to LoadLibrary to use it for now! */
if (libavrt) {
pAvSetMmThreadCharacteristicsW = (pfnAvSetMmThreadCharacteristicsW) GetProcAddress(libavrt, "AvSetMmThreadCharacteristicsW");
pAvRevertMmThreadCharacteristics = (pfnAvRevertMmThreadCharacteristics) GetProcAddress(libavrt, "AvRevertMmThreadCharacteristics");
}
#endif
/* Set the function pointers */
impl->DetectDevices = WASAPI_DetectDevices;
impl->ThreadInit = WASAPI_ThreadInit;
impl->ThreadDeinit = WASAPI_ThreadDeinit;
impl->OpenDevice = WASAPI_OpenDevice;
impl->PlayDevice = WASAPI_PlayDevice;
impl->WaitDevice = WASAPI_WaitDevice;
impl->GetPendingBytes = WASAPI_GetPendingBytes;
impl->GetDeviceBuf = WASAPI_GetDeviceBuf;
impl->CaptureFromDevice = WASAPI_CaptureFromDevice;
impl->FlushCapture = WASAPI_FlushCapture;
impl->CloseDevice = WASAPI_CloseDevice;
impl->Deinitialize = WASAPI_Deinitialize;
impl->HasCaptureSupport = 1;
return 1; /* this audio target is available. */
}
AudioBootStrap WASAPI_bootstrap = {
"wasapi", "WASAPI", WASAPI_Init, 0
};
#endif /* SDL_AUDIO_DRIVER_WASAPI */
/* vi: set ts=4 sw=4 expandtab: */