forked from videolan/vlc
/
mmdevice.c
1221 lines (1030 loc) · 34.8 KB
/
mmdevice.c
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
45
46
47
48
49
50
51
52
53
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
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
449
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
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
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
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
762
763
764
765
766
767
768
769
770
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
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
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
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*****************************************************************************
* mmdevice.c : Windows Multimedia Device API audio output plugin for VLC
*****************************************************************************
* Copyright (C) 2012-2014 Rémi Denis-Courmont
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#if !defined(_WIN32_WINNT) || _WIN32_WINNT < 0x600
# undef _WIN32_WINNT
# define _WIN32_WINNT 0x600
#endif
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#define INITGUID
#define COBJMACROS
#define CONST_VTABLE
#include <stdlib.h>
#include <math.h>
#include <assert.h>
#include <audiopolicy.h>
#include <mmdeviceapi.h>
#include <endpointvolume.h>
DEFINE_PROPERTYKEY(PKEY_Device_FriendlyName, 0xa45c254e, 0xdf1c, 0x4efd,
0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 14);
#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_aout.h>
#include <vlc_charset.h>
#include <vlc_modules.h>
#include "audio_output/mmdevice.h"
DEFINE_GUID (GUID_VLC_AUD_OUT, 0x4533f59d, 0x59ee, 0x00c6,
0xad, 0xb2, 0xc6, 0x8b, 0x50, 0x1a, 0x66, 0x55);
static int TryEnterMTA(vlc_object_t *obj)
{
HRESULT hr = CoInitializeEx(NULL, COINIT_MULTITHREADED);
if (unlikely(FAILED(hr)))
{
msg_Err (obj, "cannot initialize COM (error 0x%lx)", hr);
return -1;
}
return 0;
}
#define TryEnterMTA(o) TryEnterMTA(VLC_OBJECT(o))
static void EnterMTA(void)
{
HRESULT hr = CoInitializeEx(NULL, COINIT_MULTITHREADED);
if (unlikely(FAILED(hr)))
abort();
}
static void LeaveMTA(void)
{
CoUninitialize();
}
static wchar_t default_device[1] = L"";
struct aout_sys_t
{
aout_stream_t *stream; /**< Underlying audio output stream */
module_t *module;
audio_output_t *aout;
IMMDeviceEnumerator *it; /**< Device enumerator, NULL when exiting */
IMMDevice *dev; /**< Selected output device, NULL if none */
struct IMMNotificationClient device_events;
struct IAudioSessionEvents session_events;
struct IAudioVolumeDuckNotification duck;
LONG refs;
unsigned ducks;
float gain; /**< Current software gain volume */
wchar_t *device; /**< Requested device identifier, NULL if none */
float volume; /**< Requested volume, negative if none */
signed char mute; /**< Requested mute, negative if none */
CRITICAL_SECTION lock;
CONDITION_VARIABLE work;
CONDITION_VARIABLE ready;
vlc_thread_t thread; /**< Thread for audio session control */
};
/* NOTE: The Core Audio API documentation totally fails to specify the thread
* safety (or lack thereof) of the interfaces. This code takes the most
* restrictive assumption: no thread safety. The background thread (MMThread)
* only runs at specified times, namely between the device_ready and
* device_changed events (effectively a thread synchronization barrier, but
* only Windows 8 natively provides such a primitive).
*
* The audio output owner (i.e. the audio output core) is responsible for
* serializing callbacks. This code only needs to be concerned with
* synchronization between the set of audio output callbacks, MMThread()
* and (trivially) the device and session notifications. */
static int DeviceSelect(audio_output_t *, const char *);
static int vlc_FromHR(audio_output_t *aout, HRESULT hr)
{
/* Select the default device (and restart) on unplug */
if (unlikely(hr == AUDCLNT_E_DEVICE_INVALIDATED))
DeviceSelect(aout, NULL);
return SUCCEEDED(hr) ? 0 : -1;
}
/*** VLC audio output callbacks ***/
static int TimeGet(audio_output_t *aout, mtime_t *restrict delay)
{
aout_sys_t *sys = aout->sys;
HRESULT hr;
EnterMTA();
hr = aout_stream_TimeGet(sys->stream, delay);
LeaveMTA();
return SUCCEEDED(hr) ? 0 : -1;
}
static void Play(audio_output_t *aout, block_t *block)
{
aout_sys_t *sys = aout->sys;
HRESULT hr;
EnterMTA();
hr = aout_stream_Play(sys->stream, block);
LeaveMTA();
vlc_FromHR(aout, hr);
}
static void Pause(audio_output_t *aout, bool paused, mtime_t date)
{
aout_sys_t *sys = aout->sys;
HRESULT hr;
EnterMTA();
hr = aout_stream_Pause(sys->stream, paused);
LeaveMTA();
vlc_FromHR(aout, hr);
(void) date;
}
static void Flush(audio_output_t *aout, bool wait)
{
aout_sys_t *sys = aout->sys;
HRESULT hr;
EnterMTA();
hr = aout_stream_Flush(sys->stream, wait);
LeaveMTA();
vlc_FromHR(aout, hr);
}
static int VolumeSet(audio_output_t *aout, float vol)
{
aout_sys_t *sys = aout->sys;
float gain = 1.f;
vol = vol * vol * vol; /* ISimpleAudioVolume is tapered linearly. */
if (vol > 1.f)
{
gain = vol;
vol = 1.f;
}
aout_GainRequest(aout, gain);
EnterCriticalSection(&sys->lock);
sys->gain = gain;
sys->volume = vol;
WakeConditionVariable(&sys->work);
LeaveCriticalSection(&sys->lock);
return 0;
}
static int MuteSet(audio_output_t *aout, bool mute)
{
aout_sys_t *sys = aout->sys;
EnterCriticalSection(&sys->lock);
sys->mute = mute;
WakeConditionVariable(&sys->work);
LeaveCriticalSection(&sys->lock);
return 0;
}
/*** Audio session events ***/
static inline aout_sys_t *vlc_AudioSessionEvents_sys(IAudioSessionEvents *this)
{
return (void *)(((char *)this) - offsetof(aout_sys_t, session_events));
}
static STDMETHODIMP
vlc_AudioSessionEvents_QueryInterface(IAudioSessionEvents *this, REFIID riid,
void **ppv)
{
if (IsEqualIID(riid, &IID_IUnknown)
|| IsEqualIID(riid, &IID_IAudioSessionEvents))
{
*ppv = this;
IUnknown_AddRef(this);
return S_OK;
}
else
{
*ppv = NULL;
return E_NOINTERFACE;
}
}
static STDMETHODIMP_(ULONG)
vlc_AudioSessionEvents_AddRef(IAudioSessionEvents *this)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
return InterlockedIncrement(&sys->refs);
}
static STDMETHODIMP_(ULONG)
vlc_AudioSessionEvents_Release(IAudioSessionEvents *this)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
return InterlockedDecrement(&sys->refs);
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnDisplayNameChanged(IAudioSessionEvents *this,
LPCWSTR wname, LPCGUID ctx)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "display name changed: %ls", wname);
(void) ctx;
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnIconPathChanged(IAudioSessionEvents *this,
LPCWSTR wpath, LPCGUID ctx)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "icon path changed: %ls", wpath);
(void) ctx;
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnSimpleVolumeChanged(IAudioSessionEvents *this,
float vol, BOOL mute,
LPCGUID ctx)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "simple volume changed: %f, muting %sabled", vol,
mute ? "en" : "dis");
EnterCriticalSection(&sys->lock);
WakeConditionVariable(&sys->work); /* implicit state: vol & mute */
LeaveCriticalSection(&sys->lock);
(void) ctx;
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnChannelVolumeChanged(IAudioSessionEvents *this,
DWORD count, float *vols,
DWORD changed, LPCGUID ctx)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
if (changed != (DWORD)-1)
msg_Dbg(aout, "channel volume %lu of %lu changed: %f", changed, count,
vols[changed]);
else
msg_Dbg(aout, "%lu channels volume changed", count);
(void) ctx;
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnGroupingParamChanged(IAudioSessionEvents *this,
LPCGUID param, LPCGUID ctx)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "grouping parameter changed");
(void) param;
(void) ctx;
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnStateChanged(IAudioSessionEvents *this,
AudioSessionState state)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "state changed: %d", state);
return S_OK;
}
static STDMETHODIMP
vlc_AudioSessionEvents_OnSessionDisconnected(IAudioSessionEvents *this,
AudioSessionDisconnectReason reason)
{
aout_sys_t *sys = vlc_AudioSessionEvents_sys(this);
audio_output_t *aout = sys->aout;
switch (reason)
{
case DisconnectReasonDeviceRemoval:
msg_Warn(aout, "session disconnected: %s", "device removed");
break;
case DisconnectReasonServerShutdown:
msg_Err(aout, "session disconnected: %s", "service stopped");
return S_OK;
case DisconnectReasonFormatChanged:
msg_Warn(aout, "session disconnected: %s", "format changed");
break;
case DisconnectReasonSessionLogoff:
msg_Err(aout, "session disconnected: %s", "user logged off");
return S_OK;
case DisconnectReasonSessionDisconnected:
msg_Err(aout, "session disconnected: %s", "session disconnected");
return S_OK;
case DisconnectReasonExclusiveModeOverride:
msg_Err(aout, "session disconnected: %s", "stream overriden");
return S_OK;
default:
msg_Warn(aout, "session disconnected: unknown reason %d", reason);
return S_OK;
}
/* NOTE: audio decoder thread should get invalidated device and restart */
return S_OK;
}
static const struct IAudioSessionEventsVtbl vlc_AudioSessionEvents =
{
vlc_AudioSessionEvents_QueryInterface,
vlc_AudioSessionEvents_AddRef,
vlc_AudioSessionEvents_Release,
vlc_AudioSessionEvents_OnDisplayNameChanged,
vlc_AudioSessionEvents_OnIconPathChanged,
vlc_AudioSessionEvents_OnSimpleVolumeChanged,
vlc_AudioSessionEvents_OnChannelVolumeChanged,
vlc_AudioSessionEvents_OnGroupingParamChanged,
vlc_AudioSessionEvents_OnStateChanged,
vlc_AudioSessionEvents_OnSessionDisconnected,
};
static inline aout_sys_t *vlc_AudioVolumeDuckNotification_sys(IAudioVolumeDuckNotification *this)
{
return (void *)(((char *)this) - offsetof(aout_sys_t, duck));
}
static STDMETHODIMP
vlc_AudioVolumeDuckNotification_QueryInterface(
IAudioVolumeDuckNotification *this, REFIID riid, void **ppv)
{
if (IsEqualIID(riid, &IID_IUnknown)
|| IsEqualIID(riid, &IID_IAudioVolumeDuckNotification))
{
*ppv = this;
IUnknown_AddRef(this);
return S_OK;
}
else
{
*ppv = NULL;
return E_NOINTERFACE;
}
}
static STDMETHODIMP_(ULONG)
vlc_AudioVolumeDuckNotification_AddRef(IAudioVolumeDuckNotification *this)
{
aout_sys_t *sys = vlc_AudioVolumeDuckNotification_sys(this);
return InterlockedIncrement(&sys->refs);
}
static STDMETHODIMP_(ULONG)
vlc_AudioVolumeDuckNotification_Release(IAudioVolumeDuckNotification *this)
{
aout_sys_t *sys = vlc_AudioVolumeDuckNotification_sys(this);
return InterlockedDecrement(&sys->refs);
}
static STDMETHODIMP
vlc_AudioVolumeDuckNotification_OnVolumeDuckNotification(
IAudioVolumeDuckNotification *this, LPCWSTR sid, UINT32 count)
{
aout_sys_t *sys = vlc_AudioVolumeDuckNotification_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "volume ducked by %ls of %u sessions", sid, count);
sys->ducks++;
aout_PolicyReport(aout, true);
return S_OK;
}
static STDMETHODIMP
vlc_AudioVolumeDuckNotification_OnVolumeUnduckNotification(
IAudioVolumeDuckNotification *this, LPCWSTR sid)
{
aout_sys_t *sys = vlc_AudioVolumeDuckNotification_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "volume unducked by %ls", sid);
sys->ducks--;
aout_PolicyReport(aout, sys->ducks != 0);
return S_OK;
}
static const struct IAudioVolumeDuckNotificationVtbl vlc_AudioVolumeDuckNotification =
{
vlc_AudioVolumeDuckNotification_QueryInterface,
vlc_AudioVolumeDuckNotification_AddRef,
vlc_AudioVolumeDuckNotification_Release,
vlc_AudioVolumeDuckNotification_OnVolumeDuckNotification,
vlc_AudioVolumeDuckNotification_OnVolumeUnduckNotification,
};
/*** Audio devices ***/
/** Gets the user-readable device name */
static char *DeviceName(IMMDevice *dev)
{
IPropertyStore *props;
char *name = NULL;
PROPVARIANT v;
HRESULT hr;
hr = IMMDevice_OpenPropertyStore(dev, STGM_READ, &props);
if (FAILED(hr))
return NULL;
PropVariantInit(&v);
hr = IPropertyStore_GetValue(props, &PKEY_Device_FriendlyName, &v);
if (SUCCEEDED(hr))
{
name = FromWide(v.pwszVal);
PropVariantClear(&v);
}
IPropertyStore_Release(props);
return name;
}
/** Checks that a device is an output device */
static bool DeviceIsRender(IMMDevice *dev)
{
void *pv;
if (FAILED(IMMDevice_QueryInterface(dev, &IID_IMMEndpoint, &pv)))
return false;
IMMEndpoint *ep = pv;
EDataFlow flow;
HRESULT hr = IMMEndpoint_GetDataFlow(ep, &flow);
IMMEndpoint_Release(ep);
if (FAILED(hr) || flow != eRender)
return false;
DWORD pdwState;
hr = IMMDevice_GetState(dev, &pdwState);
return !FAILED(hr) && pdwState == DEVICE_STATE_ACTIVE;
}
static HRESULT DeviceUpdated(audio_output_t *aout, LPCWSTR wid)
{
aout_sys_t *sys = aout->sys;
HRESULT hr;
IMMDevice *dev;
hr = IMMDeviceEnumerator_GetDevice(sys->it, wid, &dev);
if (FAILED(hr))
return hr;
if (!DeviceIsRender(dev))
{
IMMDevice_Release(dev);
return S_OK;
}
char *id = FromWide(wid);
if (unlikely(id == NULL))
{
IMMDevice_Release(dev);
return E_OUTOFMEMORY;
}
char *name = DeviceName(dev);
IMMDevice_Release(dev);
aout_HotplugReport(aout, id, (name != NULL) ? name : id);
free(name);
free(id);
return S_OK;
}
static inline aout_sys_t *vlc_MMNotificationClient_sys(IMMNotificationClient *this)
{
return (void *)(((char *)this) - offsetof(aout_sys_t, device_events));
}
static STDMETHODIMP
vlc_MMNotificationClient_QueryInterface(IMMNotificationClient *this,
REFIID riid, void **ppv)
{
if (IsEqualIID(riid, &IID_IUnknown)
|| IsEqualIID(riid, &IID_IMMNotificationClient))
{
*ppv = this;
IUnknown_AddRef(this);
return S_OK;
}
else
{
*ppv = NULL;
return E_NOINTERFACE;
}
}
static STDMETHODIMP_(ULONG)
vlc_MMNotificationClient_AddRef(IMMNotificationClient *this)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
return InterlockedIncrement(&sys->refs);
}
static STDMETHODIMP_(ULONG)
vlc_MMNotificationClient_Release(IMMNotificationClient *this)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
return InterlockedDecrement(&sys->refs);
}
static STDMETHODIMP
vlc_MMNotificationClient_OnDefaultDeviceChange(IMMNotificationClient *this,
EDataFlow flow, ERole role,
LPCWSTR wid)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
audio_output_t *aout = sys->aout;
if (flow != eRender)
return S_OK;
if (role != eConsole)
return S_OK;
msg_Dbg(aout, "default device changed: %ls", wid); /* TODO? migrate */
return S_OK;
}
static STDMETHODIMP
vlc_MMNotificationClient_OnDeviceAdded(IMMNotificationClient *this,
LPCWSTR wid)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
audio_output_t *aout = sys->aout;
msg_Dbg(aout, "device %ls added", wid);
return DeviceUpdated(aout, wid);
}
static STDMETHODIMP
vlc_MMNotificationClient_OnDeviceRemoved(IMMNotificationClient *this,
LPCWSTR wid)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
audio_output_t *aout = sys->aout;
char *id = FromWide(wid);
msg_Dbg(aout, "device %ls removed", wid);
if (unlikely(id == NULL))
return E_OUTOFMEMORY;
aout_HotplugReport(aout, id, NULL);
free(id);
return S_OK;
}
static STDMETHODIMP
vlc_MMNotificationClient_OnDeviceStateChanged(IMMNotificationClient *this,
LPCWSTR wid, DWORD state)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
audio_output_t *aout = sys->aout;
switch (state) {
case DEVICE_STATE_UNPLUGGED:
msg_Dbg(aout, "device %ls state changed: unplugged", wid);
break;
case DEVICE_STATE_ACTIVE:
msg_Dbg(aout, "device %ls state changed: active", wid);
return DeviceUpdated(aout, wid);
case DEVICE_STATE_DISABLED:
msg_Dbg(aout, "device %ls state changed: disabled", wid);
break;
case DEVICE_STATE_NOTPRESENT:
msg_Dbg(aout, "device %ls state changed: not present", wid);
break;
default:
msg_Dbg(aout, "device %ls state changed: unknown: %08lx", wid, state);
return E_FAIL;
}
/* Unplugged, disabled or notpresent */
char *id = FromWide(wid);
if (unlikely(id == NULL))
return E_OUTOFMEMORY;
aout_HotplugReport(aout, id, NULL);
free(id);
return S_OK;
}
static STDMETHODIMP
vlc_MMNotificationClient_OnPropertyValueChanged(IMMNotificationClient *this,
LPCWSTR wid,
const PROPERTYKEY key)
{
aout_sys_t *sys = vlc_MMNotificationClient_sys(this);
audio_output_t *aout = sys->aout;
if (key.pid == PKEY_Device_FriendlyName.pid)
{
msg_Dbg(aout, "device %ls name changed", wid);
return DeviceUpdated(aout, wid);
}
return S_OK;
}
static const struct IMMNotificationClientVtbl vlc_MMNotificationClient =
{
vlc_MMNotificationClient_QueryInterface,
vlc_MMNotificationClient_AddRef,
vlc_MMNotificationClient_Release,
vlc_MMNotificationClient_OnDeviceStateChanged,
vlc_MMNotificationClient_OnDeviceAdded,
vlc_MMNotificationClient_OnDeviceRemoved,
vlc_MMNotificationClient_OnDefaultDeviceChange,
vlc_MMNotificationClient_OnPropertyValueChanged,
};
static int DevicesEnum(audio_output_t *aout, IMMDeviceEnumerator *it)
{
HRESULT hr;
IMMDeviceCollection *devs;
hr = IMMDeviceEnumerator_EnumAudioEndpoints(it, eRender,
DEVICE_STATE_ACTIVE, &devs);
if (FAILED(hr))
{
msg_Warn(aout, "cannot enumerate audio endpoints (error 0x%lx)", hr);
return -1;
}
UINT count;
hr = IMMDeviceCollection_GetCount(devs, &count);
if (FAILED(hr))
{
msg_Warn(aout, "cannot count audio endpoints (error 0x%lx)", hr);
count = 0;
}
unsigned n = 0;
for (UINT i = 0; i < count; i++)
{
IMMDevice *dev;
char *id, *name;
hr = IMMDeviceCollection_Item(devs, i, &dev);
if (FAILED(hr) || !DeviceIsRender(dev))
continue;
/* Unique device ID */
LPWSTR devid;
hr = IMMDevice_GetId(dev, &devid);
if (FAILED(hr))
{
IMMDevice_Release(dev);
continue;
}
id = FromWide(devid);
CoTaskMemFree(devid);
name = DeviceName(dev);
IMMDevice_Release(dev);
aout_HotplugReport(aout, id, (name != NULL) ? name : id);
free(name);
free(id);
n++;
}
IMMDeviceCollection_Release(devs);
return n;
}
static int DeviceSelect(audio_output_t *aout, const char *id)
{
aout_sys_t *sys = aout->sys;
wchar_t *device;
if (id != NULL)
{
device = ToWide(id);
if (unlikely(device == NULL))
return -1;
}
else
device = default_device;
EnterCriticalSection(&sys->lock);
assert(sys->device == NULL);
sys->device = device;
WakeConditionVariable(&sys->work);
while (sys->device != NULL)
SleepConditionVariableCS(&sys->ready, &sys->lock, INFINITE);
LeaveCriticalSection(&sys->lock);
if (sys->stream != NULL && sys->dev != NULL)
/* Request restart of stream with the new device */
aout_RestartRequest(aout, AOUT_RESTART_OUTPUT);
return (sys->dev != NULL) ? 0 : -1;
}
/*** Initialization / deinitialization **/
static wchar_t *var_InheritWide(vlc_object_t *obj, const char *name)
{
char *v8 = var_InheritString(obj, name);
if (v8 == NULL)
return NULL;
wchar_t *v16 = ToWide(v8);
free(v8);
return v16;
}
#define var_InheritWide(o,n) var_InheritWide(VLC_OBJECT(o),n)
/** MMDevice audio output thread.
* This thread takes cares of the audio session control. Inconveniently enough,
* the audio session control interface must:
* - be created and destroyed from the same thread, and
* - survive across VLC audio output calls.
* The only way to reconcile both requirements is a custom thread.
* The thread also ensure that the COM Multi-Thread Apartment is continuously
* referenced so that MMDevice objects are not destroyed early.
* Furthermore, VolumeSet() and MuteSet() may be called from a thread with a
* COM STA, so that it cannot access the COM MTA for audio controls.
*/
static HRESULT MMSession(audio_output_t *aout, IMMDeviceEnumerator *it)
{
aout_sys_t *sys = aout->sys;
IAudioSessionManager *manager;
IAudioSessionControl *control;
ISimpleAudioVolume *volume;
IAudioEndpointVolume *endpoint;
void *pv;
HRESULT hr;
assert(sys->device != NULL);
assert(sys->dev == NULL);
if (sys->device != default_device) /* Device selected explicitly */
{
msg_Dbg(aout, "using selected device %ls", sys->device);
hr = IMMDeviceEnumerator_GetDevice(it, sys->device, &sys->dev);
if (FAILED(hr))
msg_Err(aout, "cannot get selected device %ls (error 0x%lx)",
sys->device, hr);
free(sys->device);
}
else
hr = AUDCLNT_E_DEVICE_INVALIDATED;
while (hr == AUDCLNT_E_DEVICE_INVALIDATED)
{ /* Default device selected by policy and with stream routing.
* "Do not use eMultimedia" says MSDN. */
msg_Dbg(aout, "using default device");
hr = IMMDeviceEnumerator_GetDefaultAudioEndpoint(it, eRender,
eConsole, &sys->dev);
if (FAILED(hr))
msg_Err(aout, "cannot get default device (error 0x%lx)", hr);
}
sys->device = NULL;
WakeConditionVariable(&sys->ready);
if (SUCCEEDED(hr))
{ /* Report actual device */
LPWSTR wdevid;
hr = IMMDevice_GetId(sys->dev, &wdevid);
if (SUCCEEDED(hr))
{
char *id = FromWide(wdevid);
CoTaskMemFree(wdevid);
if (likely(id != NULL))
{
aout_DeviceReport(aout, id);
free(id);
}
}
}
else
{
msg_Err(aout, "cannot get device identifier (error 0x%lx)", hr);
return hr;
}
/* Create session manager (for controls even w/o active audio client) */
hr = IMMDevice_Activate(sys->dev, &IID_IAudioSessionManager,
CLSCTX_ALL, NULL, &pv);
manager = pv;
if (SUCCEEDED(hr))
{
LPCGUID guid = &GUID_VLC_AUD_OUT;
/* Register session control */
hr = IAudioSessionManager_GetAudioSessionControl(manager, guid, 0,
&control);
if (SUCCEEDED(hr))
{
wchar_t *ua = var_InheritWide(aout, "user-agent");
IAudioSessionControl_SetDisplayName(control, ua, NULL);
free(ua);
IAudioSessionControl_RegisterAudioSessionNotification(control,
&sys->session_events);
}
else
msg_Err(aout, "cannot get session control (error 0x%lx)", hr);
hr = IAudioSessionManager_GetSimpleAudioVolume(manager, guid, FALSE,
&volume);
if (FAILED(hr))
msg_Err(aout, "cannot get simple volume (error 0x%lx)", hr);
/* Try to get version 2 (Windows 7) of the manager & control */
wchar_t *siid = NULL;
hr = IAudioSessionManager_QueryInterface(manager,
&IID_IAudioSessionControl2, &pv);
if (SUCCEEDED(hr))
{
IAudioSessionControl2 *c2 = pv;
IAudioSessionControl2_SetDuckingPreference(c2, FALSE);
hr = IAudioSessionControl2_GetSessionInstanceIdentifier(c2, &siid);
if (FAILED(hr))
siid = NULL;
IAudioSessionControl2_Release(c2);
}
else
msg_Dbg(aout, "version 2 session control unavailable");
hr = IAudioSessionManager_QueryInterface(manager,
&IID_IAudioSessionManager2, &pv);
if (SUCCEEDED(hr))
{
IAudioSessionManager2 *m2 = pv;
IAudioSessionManager2_RegisterDuckNotification(m2, siid,
&sys->duck);
IAudioSessionManager2_Release(m2);
}
else
msg_Dbg(aout, "version 2 session management unavailable");
CoTaskMemFree(siid);
}
else
{
msg_Err(aout, "cannot activate session manager (error 0x%lx)", hr);
control = NULL;
volume = NULL;
}
hr = IMMDevice_Activate(sys->dev, &IID_IAudioEndpointVolume,
CLSCTX_ALL, NULL, &pv);
endpoint = pv;
if (SUCCEEDED(hr))
{
float min, max, inc;
hr = IAudioEndpointVolume_GetVolumeRange(endpoint, &min, &max, &inc);
if (SUCCEEDED(hr))
msg_Dbg(aout, "volume from %+f dB to %+f dB with %f dB increments",
min, max, inc);
else
msg_Err(aout, "cannot get volume range (error 0x%lx)", hr);
}
else
msg_Err(aout, "cannot activate endpoint volume (error %lx)", hr);
/* Main loop (adjust volume as long as device is unchanged) */
while (sys->device == NULL)
{
if (volume != NULL)
{
float level;
hr = ISimpleAudioVolume_GetMasterVolume(volume, &level);
if (SUCCEEDED(hr))
aout_VolumeReport(aout, cbrtf(level * sys->gain));
else
msg_Err(aout, "cannot get master volume (error 0x%lx)", hr);
level = sys->volume;
if (level >= 0.f)
{
hr = ISimpleAudioVolume_SetMasterVolume(volume, level, NULL);
if (FAILED(hr))
msg_Err(aout, "cannot set master volume (error 0x%lx)",
hr);
}
sys->volume = -1.f;
BOOL mute;
hr = ISimpleAudioVolume_GetMute(volume, &mute);
if (SUCCEEDED(hr))
aout_MuteReport(aout, mute != FALSE);
else
msg_Err(aout, "cannot get mute (error 0x%lx)", hr);
if (sys->mute >= 0)
{
mute = sys->mute ? TRUE : FALSE;
hr = ISimpleAudioVolume_SetMute(volume, mute, NULL);
if (FAILED(hr))
msg_Err(aout, "cannot set mute (error 0x%lx)", hr);
}
sys->mute = -1;
}
SleepConditionVariableCS(&sys->work, &sys->lock, INFINITE);
}
LeaveCriticalSection(&sys->lock);
if (endpoint != NULL)
IAudioEndpointVolume_Release(endpoint);
if (manager != NULL)
{ /* Deregister callbacks *without* the lock */
hr = IAudioSessionManager_QueryInterface(manager,
&IID_IAudioSessionManager2, &pv);
if (SUCCEEDED(hr))
{
IAudioSessionManager2 *m2 = pv;
IAudioSessionManager2_UnregisterDuckNotification(m2, &sys->duck);
IAudioSessionManager2_Release(m2);
}
if (volume != NULL)
ISimpleAudioVolume_Release(volume);
if (control != NULL)
{
IAudioSessionControl_UnregisterAudioSessionNotification(control,
&sys->session_events);