DrvHostAudioWasApi.cpp@ 89487

Last change on this file since 89487 was 89487, checked in by vboxsync, 3 years ago
Audio: Changed PDMIHOSTAUDIO::pfnStreamCreate to take a pointer to a const pCfgReq parameter. bugref:9890
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 124.4 KB

Line
1	/* $Id: DrvHostAudioWasApi.cpp 89487 2021-06-03 20:16:17Z vboxsync $ */
2	/** @file
3	* Host audio driver - Windows Audio Session API.
4	*/
5
6	/*
7	* Copyright (C) 2021 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DRV_HOST_AUDIO
23	/#define INITGUID - defined in VBoxhostAudioDSound.cpp already /
24	#include <VBox/log.h>
25	#include <iprt/win/windows.h>
26	#include <Mmdeviceapi.h>
27	#include <iprt/win/audioclient.h>
28	#include <functiondiscoverykeys_devpkey.h>
29	#include <AudioSessionTypes.h>
30	#ifndef AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY
31	# define AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY UINT32_C(0x08000000)
32	#endif
33	#ifndef AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM
34	# define AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM UINT32_C(0x80000000)
35	#endif
36
37	#include <VBox/vmm/pdmaudioinline.h>
38	#include <VBox/vmm/pdmaudiohostenuminline.h>
39
40	#include <iprt/rand.h>
41	#include <iprt/semaphore.h>
42	#include <iprt/utf16.h>
43	#include <iprt/uuid.h>
44
45	#include <new> /* std::bad_alloc */
46
47	#include "VBoxDD.h"
48
49
50	/*********************************************************************************************************************************
51	* Defined Constants And Macros *
52	*********************************************************************************************************************************/
53	/** Max GetCurrentPadding value we accept (to make sure it's safe to convert to bytes). */
54	#define VBOX_WASAPI_MAX_PADDING UINT32_C(0x007fffff)
55
56	/** Maximum number of cached device configs in each direction.
57	* The number 4 was picked at random. */
58	#define VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES 4
59
60	#if 0
61	/** @name WM_DRVHOSTAUDIOWAS_XXX - Worker thread messages.
62	* @{ */
63	#define WM_DRVHOSTAUDIOWAS_PURGE_CACHE (WM_APP + 3)
64	/** @} */
65	#endif
66
67
68	/** @name DRVHOSTAUDIOWAS_DO_XXX - Worker thread operations.
69	* @{ */
70	#define DRVHOSTAUDIOWAS_DO_PURGE_CACHE ((uintptr_t)0x49f37300 + 1)
71	#define DRVHOSTAUDIOWAS_DO_PRUNE_CACHE ((uintptr_t)0x49f37300 + 2)
72	#define DRVHOSTAUDIOWAS_DO_STREAM_DEV_SWITCH ((uintptr_t)0x49f37300 + 3)
73	/** @} */
74
75
76	/*********************************************************************************************************************************
77	* Structures and Typedefs *
78	*********************************************************************************************************************************/
79	class DrvHostAudioWasMmNotifyClient;
80
81	/** Pointer to the cache entry for a host audio device (+dir). */
82	typedef struct DRVHOSTAUDIOWASCACHEDEV *PDRVHOSTAUDIOWASCACHEDEV;
83
84	/**
85	* Cached pre-initialized audio client for a device.
86	*
87	* The activation and initialization of an IAudioClient has been observed to be
88	* very very slow (> 100 ms) and not suitable to be done on an EMT. So, we'll
89	* pre-initialize the device clients at construction time and when the default
90	* device changes to try avoid this problem.
91	*
92	* A client is returned to the cache after we're done with it, provided it still
93	* works fine.
94	*/
95	typedef struct DRVHOSTAUDIOWASCACHEDEVCFG
96	{
97	/** Entry in DRVHOSTAUDIOWASCACHEDEV::ConfigList. */
98	RTLISTNODE ListEntry;
99	/** The device. */
100	PDRVHOSTAUDIOWASCACHEDEV pDevEntry;
101	/** The cached audio client. */
102	IAudioClient *pIAudioClient;
103	/** Output streams: The render client interface. */
104	IAudioRenderClient *pIAudioRenderClient;
105	/** Input streams: The capture client interface. */
106	IAudioCaptureClient *pIAudioCaptureClient;
107	/** The configuration. */
108	PDMAUDIOPCMPROPS Props;
109	/** The buffer size in frames. */
110	uint32_t cFramesBufferSize;
111	/** The device/whatever period in frames. */
112	uint32_t cFramesPeriod;
113	/** The setup status code.
114	* This is set to VERR_AUDIO_STREAM_INIT_IN_PROGRESS while the asynchronous
115	* initialization is still running. */
116	int volatile rcSetup;
117	/** Creation timestamp (just for reference). */
118	uint64_t nsCreated;
119	/** Init complete timestamp (just for reference). */
120	uint64_t nsInited;
121	/** When it was last used. */
122	uint64_t nsLastUsed;
123	/** The stringified properties. */
124	char szProps[32];
125	} DRVHOSTAUDIOWASCACHEDEVCFG;
126	/** Pointer to a pre-initialized audio client. */
127	typedef DRVHOSTAUDIOWASCACHEDEVCFG *PDRVHOSTAUDIOWASCACHEDEVCFG;
128
129	/**
130	* Per audio device (+ direction) cache entry.
131	*/
132	typedef struct DRVHOSTAUDIOWASCACHEDEV
133	{
134	/** Entry in DRVHOSTAUDIOWAS::CacheHead. */
135	RTLISTNODE ListEntry;
136	/** The MM device associated with the stream. */
137	IMMDevice *pIDevice;
138	/** The direction of the device. */
139	PDMAUDIODIR enmDir;
140	#if 0 /* According to https://social.msdn.microsoft.com/Forums/en-US/1d974d90-6636-4121-bba3-a8861d9ab92a,
141	these were always support just missing from the SDK. */
142	/** Support for AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM: -1=unknown, 0=no, 1=yes. */
143	int8_t fSupportsAutoConvertPcm;
144	/** Support for AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY: -1=unknown, 0=no, 1=yes. */
145	int8_t fSupportsSrcDefaultQuality;
146	#endif
147	/** List of cached configurations (DRVHOSTAUDIOWASCACHEDEVCFG). */
148	RTLISTANCHOR ConfigList;
149	/** The device ID length in RTUTF16 units. */
150	size_t cwcDevId;
151	/** The device ID. */
152	RTUTF16 wszDevId[RT_FLEXIBLE_ARRAY];
153	} DRVHOSTAUDIOWASCACHEDEV;
154
155
156	/**
157	* Data for a WASABI stream.
158	*/
159	typedef struct DRVHOSTAUDIOWASSTREAM
160	{
161	/** Common part. */
162	PDMAUDIOBACKENDSTREAM Core;
163
164	/** Entry in DRVHOSTAUDIOWAS::StreamHead. */
165	RTLISTNODE ListEntry;
166	/** The stream's acquired configuration. */
167	PDMAUDIOSTREAMCFG Cfg;
168	/** Cache entry to be relased when destroying the stream. */
169	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg;
170
171	/** Set if the stream is enabled. */
172	bool fEnabled;
173	/** Set if the stream is started (playing/capturing). */
174	bool fStarted;
175	/** Set if the stream is draining (output only). */
176	bool fDraining;
177	/** Set if we should restart the stream on resume (saved pause state). */
178	bool fRestartOnResume;
179	/** Set if we're switching to a new output/input device. */
180	bool fSwitchingDevice;
181
182	/** The RTTimeMilliTS() deadline for the draining of this stream (output). */
183	uint64_t msDrainDeadline;
184	/** Internal stream offset (bytes). */
185	uint64_t offInternal;
186	/** The RTTimeMilliTS() at the end of the last transfer. */
187	uint64_t msLastTransfer;
188
189	/** Input: Current capture buffer (advanced as we read). */
190	uint8_t *pbCapture;
191	/** Input: The number of bytes left in the current capture buffer. */
192	uint32_t cbCapture;
193	/** Input: The full size of what pbCapture is part of (for ReleaseBuffer). */
194	uint32_t cFramesCaptureToRelease;
195
196	/** Critical section protecting: . */
197	RTCRITSECT CritSect;
198	/** Buffer that drvHostWasStreamStatusString uses. */
199	char szStatus[128];
200	} DRVHOSTAUDIOWASSTREAM;
201	/** Pointer to a WASABI stream. */
202	typedef DRVHOSTAUDIOWASSTREAM *PDRVHOSTAUDIOWASSTREAM;
203
204
205	/**
206	* WASAPI-specific device entry.
207	*/
208	typedef struct DRVHOSTAUDIOWASDEV
209	{
210	/** The core structure. */
211	PDMAUDIOHOSTDEV Core;
212	/** The device ID (flexible length). */
213	RTUTF16 wszDevId[RT_FLEXIBLE_ARRAY];
214	} DRVHOSTAUDIOWASDEV;
215	/** Pointer to a DirectSound device entry. */
216	typedef DRVHOSTAUDIOWASDEV *PDRVHOSTAUDIOWASDEV;
217
218
219	/**
220	* Data for a WASAPI host audio instance.
221	*/
222	typedef struct DRVHOSTAUDIOWAS
223	{
224	/** The audio host audio interface we export. */
225	PDMIHOSTAUDIO IHostAudio;
226	/** Pointer to the PDM driver instance. */
227	PPDMDRVINS pDrvIns;
228	/** Audio device enumerator instance that we use for getting the default
229	* devices (or specific ones if overriden by config). Also used for
230	* implementing enumeration. */
231	IMMDeviceEnumerator *pIEnumerator;
232	/** The upwards interface. */
233	PPDMIHOSTAUDIOPORT pIHostAudioPort;
234	/** The output device ID, NULL for default. */
235	PRTUTF16 pwszOutputDevId;
236	/** The input device ID, NULL for default. */
237	PRTUTF16 pwszInputDevId;
238
239	/** Pointer to the MM notification client instance. */
240	DrvHostAudioWasMmNotifyClient *pNotifyClient;
241	/** The input device to use. This can be NULL if there wasn't a suitable one
242	* around when we last looked or if it got removed/disabled/whatever.
243	* All access must be done inside the pNotifyClient critsect. */
244	IMMDevice *pIDeviceInput;
245	/** The output device to use. This can be NULL if there wasn't a suitable one
246	* around when we last looked or if it got removed/disabled/whatever.
247	* All access must be done inside the pNotifyClient critsect. */
248	IMMDevice *pIDeviceOutput;
249
250	/** List of streams (DRVHOSTAUDIOWASSTREAM).
251	* Requires CritSect ownership. */
252	RTLISTANCHOR StreamHead;
253	/** Serializing access to StreamHead. */
254	RTCRITSECTRW CritSectStreamList;
255
256	/** List of cached devices (DRVHOSTAUDIOWASCACHEDEV).
257	* Protected by CritSectCache */
258	RTLISTANCHOR CacheHead;
259	/** Serializing access to CacheHead. */
260	RTCRITSECT CritSectCache;
261	/** Semaphore for signalling that cache purge is done and that the destructor
262	* can do cleanups. */
263	RTSEMEVENTMULTI hEvtCachePurge;
264	/** Total number of device config entire for capturing.
265	* This includes in-use ones. */
266	uint32_t volatile cCacheEntriesIn;
267	/** Total number of device config entire for playback.
268	* This includes in-use ones. */
269	uint32_t volatile cCacheEntriesOut;
270
271	#if 0
272	/** The worker thread. */
273	RTTHREAD hWorkerThread;
274	/** The TID of the worker thread (for posting messages to it). */
275	DWORD idWorkerThread;
276	/** The fixed wParam value for the worker thread. */
277	WPARAM uWorkerThreadFixedParam;
278	#endif
279	} DRVHOSTAUDIOWAS;
280	/** Pointer to the data for a WASAPI host audio driver instance. */
281	typedef DRVHOSTAUDIOWAS *PDRVHOSTAUDIOWAS;
282
283
284
285
286	/**
287	* Gets the stream status.
288	*
289	* @returns Pointer to stream status string.
290	* @param pStreamWas The stream to get the status for.
291	*/
292	static const char *drvHostWasStreamStatusString(PDRVHOSTAUDIOWASSTREAM pStreamWas)
293	{
294	static RTSTRTUPLE const s_aEnable[2] =
295	{
296	{ RT_STR_TUPLE("DISABLED") },
297	{ RT_STR_TUPLE("ENABLED ") },
298	};
299	PCRTSTRTUPLE pTuple = &s_aEnable[pStreamWas->fEnabled];
300	memcpy(pStreamWas->szStatus, pTuple->psz, pTuple->cch);
301	size_t off = pTuple->cch;
302
303	static RTSTRTUPLE const s_aStarted[2] =
304	{
305	{ RT_STR_TUPLE(" STOPPED") },
306	{ RT_STR_TUPLE(" STARTED") },
307	};
308	pTuple = &s_aStarted[pStreamWas->fStarted];
309	memcpy(&pStreamWas->szStatus[off], pTuple->psz, pTuple->cch);
310	off += pTuple->cch;
311
312	static RTSTRTUPLE const s_aDraining[2] =
313	{
314	{ RT_STR_TUPLE("") },
315	{ RT_STR_TUPLE(" DRAINING") },
316	};
317	pTuple = &s_aDraining[pStreamWas->fDraining];
318	memcpy(&pStreamWas->szStatus[off], pTuple->psz, pTuple->cch);
319	off += pTuple->cch;
320
321	Assert(off < sizeof(pStreamWas->szStatus));
322	pStreamWas->szStatus[off] = '\0';
323	return pStreamWas->szStatus;
324	}
325
326
327	/*********************************************************************************************************************************
328	* IMMNotificationClient implementation
329	*********************************************************************************************************************************/
330	/**
331	* Multimedia notification client.
332	*
333	* We want to know when the default device changes so we can switch running
334	* streams to use the new one and so we can pre-activate it in preparation
335	* for new streams.
336	*/
337	class DrvHostAudioWasMmNotifyClient : public IMMNotificationClient
338	{
339	private:
340	/** Reference counter. */
341	uint32_t volatile m_cRefs;
342	/** The WASAPI host audio driver instance data.
343	* @note This can be NULL. Only access after entering critical section. */
344	PDRVHOSTAUDIOWAS m_pDrvWas;
345	/** Critical section serializing access to m_pDrvWas. */
346	RTCRITSECT m_CritSect;
347
348	public:
349	/**
350	* @throws int on critical section init failure.
351	*/
352	DrvHostAudioWasMmNotifyClient(PDRVHOSTAUDIOWAS a_pDrvWas)
353	: m_cRefs(1)
354	, m_pDrvWas(a_pDrvWas)
355	{
356	int rc = RTCritSectInit(&m_CritSect);
357	AssertRCStmt(rc, throw(rc));
358	}
359
360	virtual ~DrvHostAudioWasMmNotifyClient() RT_NOEXCEPT
361	{
362	RTCritSectDelete(&m_CritSect);
363	}
364
365	/**
366	* Called by drvHostAudioWasDestruct to set m_pDrvWas to NULL.
367	*/
368	void notifyDriverDestroyed() RT_NOEXCEPT
369	{
370	RTCritSectEnter(&m_CritSect);
371	m_pDrvWas = NULL;
372	RTCritSectLeave(&m_CritSect);
373	}
374
375	/**
376	* Enters the notification critsect for getting at the IMMDevice members in
377	* PDMHOSTAUDIOWAS.
378	*/
379	void lockEnter() RT_NOEXCEPT
380	{
381	RTCritSectEnter(&m_CritSect);
382	}
383
384	/**
385	* Leaves the notification critsect.
386	*/
387	void lockLeave() RT_NOEXCEPT
388	{
389	RTCritSectLeave(&m_CritSect);
390	}
391
392	/** @name IUnknown interface
393	* @{ */
394	IFACEMETHODIMP_(ULONG) AddRef()
395	{
396	uint32_t cRefs = ASMAtomicIncU32(&m_cRefs);
397	AssertMsg(cRefs < 64, ("%#x\n", cRefs));
398	Log6Func(("returns %u\n", cRefs));
399	return cRefs;
400	}
401
402	IFACEMETHODIMP_(ULONG) Release()
403	{
404	uint32_t cRefs = ASMAtomicDecU32(&m_cRefs);
405	AssertMsg(cRefs < 64, ("%#x\n", cRefs));
406	if (cRefs == 0)
407	delete this;
408	Log6Func(("returns %u\n", cRefs));
409	return cRefs;
410	}
411
412	IFACEMETHODIMP QueryInterface(const IID &rIID, void **ppvInterface)
413	{
414	if (IsEqualIID(rIID, IID_IUnknown))
415	ppvInterface = static_cast<IUnknown >(this);
416	else if (IsEqualIID(rIID, __uuidof(IMMNotificationClient)))
417	ppvInterface = static_cast<IMMNotificationClient >(this);
418	else
419	{
420	LogFunc(("Unknown rIID={%RTuuid}\n", &rIID));
421	*ppvInterface = NULL;
422	return E_NOINTERFACE;
423	}
424	Log6Func(("returns S_OK + %p\n", *ppvInterface));
425	return S_OK;
426	}
427	/** @} */
428
429	/** @name IMMNotificationClient interface
430	* @{ */
431	IFACEMETHODIMP OnDeviceStateChanged(LPCWSTR pwszDeviceId, DWORD dwNewState)
432	{
433	RT_NOREF(pwszDeviceId, dwNewState);
434	Log7Func(("pwszDeviceId=%ls dwNewState=%u (%#x)\n", pwszDeviceId, dwNewState, dwNewState));
435
436	/*
437	* Just trigger device re-enumeration.
438	*/
439	notifyDeviceChanges();
440
441	/** @todo do we need to check for our devices here too? Not when using a
442	* default device. But when using a specific device, we could perhaps
443	* re-init the stream when dwNewState indicates precense. We might
444	* also take action when a devices ceases to be operating, but again
445	* only for non-default devices, probably... */
446
447	return S_OK;
448	}
449
450	IFACEMETHODIMP OnDeviceAdded(LPCWSTR pwszDeviceId)
451	{
452	RT_NOREF(pwszDeviceId);
453	Log7Func(("pwszDeviceId=%ls\n", pwszDeviceId));
454
455	/*
456	* Is this a device we're interested in? Grab the enumerator if it is.
457	*/
458	bool fOutput = false;
459	IMMDeviceEnumerator *pIEnumerator = NULL;
460	RTCritSectEnter(&m_CritSect);
461	if ( m_pDrvWas != NULL
462	&& ( (fOutput = RTUtf16ICmp(m_pDrvWas->pwszOutputDevId, pwszDeviceId) == 0)
463	\|\| RTUtf16ICmp(m_pDrvWas->pwszInputDevId, pwszDeviceId) == 0))
464	{
465	pIEnumerator = m_pDrvWas->pIEnumerator;
466	if (pIEnumerator /* paranoia */)
467	pIEnumerator->AddRef();
468	}
469	RTCritSectLeave(&m_CritSect);
470	if (pIEnumerator)
471	{
472	/*
473	* Get the device and update it.
474	*/
475	IMMDevice *pIDevice = NULL;
476	HRESULT hrc = pIEnumerator->GetDevice(pwszDeviceId, &pIDevice);
477	if (SUCCEEDED(hrc))
478	setDevice(fOutput, pIDevice, pwszDeviceId, __PRETTY_FUNCTION__);
479	else
480	LogRelMax(64, ("WasAPI: Failed to get %s device '%ls' (OnDeviceAdded): %Rhrc\n",
481	fOutput ? "output" : "input", pwszDeviceId, hrc));
482	pIEnumerator->Release();
483
484	/*
485	* Trigger device re-enumeration.
486	*/
487	notifyDeviceChanges();
488	}
489	return S_OK;
490	}
491
492	IFACEMETHODIMP OnDeviceRemoved(LPCWSTR pwszDeviceId)
493	{
494	RT_NOREF(pwszDeviceId);
495	Log7Func(("pwszDeviceId=%ls\n", pwszDeviceId));
496
497	/*
498	* Is this a device we're interested in? Then set it to NULL.
499	*/
500	bool fOutput = false;
501	RTCritSectEnter(&m_CritSect);
502	if ( m_pDrvWas != NULL
503	&& ( (fOutput = RTUtf16ICmp(m_pDrvWas->pwszOutputDevId, pwszDeviceId) == 0)
504	\|\| RTUtf16ICmp(m_pDrvWas->pwszInputDevId, pwszDeviceId) == 0))
505	{
506	RTCritSectLeave(&m_CritSect);
507	setDevice(fOutput, NULL, pwszDeviceId, __PRETTY_FUNCTION__);
508	}
509	else
510	RTCritSectLeave(&m_CritSect);
511
512	/*
513	* Trigger device re-enumeration.
514	*/
515	notifyDeviceChanges();
516	return S_OK;
517	}
518
519	IFACEMETHODIMP OnDefaultDeviceChanged(EDataFlow enmFlow, ERole enmRole, LPCWSTR pwszDefaultDeviceId)
520	{
521	/*
522	* Are we interested in this device? If so grab the enumerator.
523	*/
524	IMMDeviceEnumerator *pIEnumerator = NULL;
525	RTCritSectEnter(&m_CritSect);
526	if ( m_pDrvWas != NULL
527	&& ( (enmFlow == eRender && enmRole == eMultimedia && !m_pDrvWas->pwszOutputDevId)
528	\|\| (enmFlow == eCapture && enmRole == eMultimedia && !m_pDrvWas->pwszInputDevId)))
529	{
530	pIEnumerator = m_pDrvWas->pIEnumerator;
531	if (pIEnumerator /* paranoia */)
532	pIEnumerator->AddRef();
533	}
534	RTCritSectLeave(&m_CritSect);
535	if (pIEnumerator)
536	{
537	/*
538	* Get the device and update it.
539	*/
540	IMMDevice *pIDevice = NULL;
541	HRESULT hrc = pIEnumerator->GetDefaultAudioEndpoint(enmFlow, enmRole, &pIDevice);
542	if (SUCCEEDED(hrc))
543	setDevice(enmFlow == eRender, pIDevice, pwszDefaultDeviceId, __PRETTY_FUNCTION__);
544	else
545	LogRelMax(64, ("WasAPI: Failed to get default %s device (OnDefaultDeviceChange): %Rhrc\n",
546	enmFlow == eRender ? "output" : "input", hrc));
547	pIEnumerator->Release();
548
549	/*
550	* Trigger device re-enumeration.
551	*/
552	notifyDeviceChanges();
553	}
554
555	Log7Func(("enmFlow=%d enmRole=%d pwszDefaultDeviceId=%ls\n", enmFlow, enmRole, pwszDefaultDeviceId));
556	return S_OK;
557	}
558
559	IFACEMETHODIMP OnPropertyValueChanged(LPCWSTR pwszDeviceId, const PROPERTYKEY Key)
560	{
561	RT_NOREF(pwszDeviceId, Key);
562	Log7Func(("pwszDeviceId=%ls Key={%RTuuid, %u (%#x)}\n", pwszDeviceId, &Key.fmtid, Key.pid, Key.pid));
563	return S_OK;
564	}
565	/** @} */
566
567	private:
568	/**
569	* Sets DRVHOSTAUDIOWAS::pIDeviceOutput or DRVHOSTAUDIOWAS::pIDeviceInput to @a pIDevice.
570	*/
571	void setDevice(bool fOutput, IMMDevice pIDevice, LPCWSTR pwszDeviceId, const char pszCaller)
572	{
573	RT_NOREF(pszCaller, pwszDeviceId);
574
575	RTCritSectEnter(&m_CritSect);
576
577	/*
578	* Update our internal device reference.
579	*/
580	if (m_pDrvWas)
581	{
582	if (fOutput)
583	{
584	Log7((LOG_FN_FMT ": Changing output device from %p to %p (%ls)\n",
585	pszCaller, m_pDrvWas->pIDeviceOutput, pIDevice, pwszDeviceId));
586	if (m_pDrvWas->pIDeviceOutput)
587	m_pDrvWas->pIDeviceOutput->Release();
588	m_pDrvWas->pIDeviceOutput = pIDevice;
589	}
590	else
591	{
592	Log7((LOG_FN_FMT ": Changing input device from %p to %p (%ls)\n",
593	pszCaller, m_pDrvWas->pIDeviceInput, pIDevice, pwszDeviceId));
594	if (m_pDrvWas->pIDeviceInput)
595	m_pDrvWas->pIDeviceInput->Release();
596	m_pDrvWas->pIDeviceInput = pIDevice;
597	}
598	}
599	else if (pIDevice)
600	pIDevice->Release();
601
602	/*
603	* Tell DrvAudio that the device has changed for one of the directions.
604	*
605	* We have to exit the critsect when doing so, or we'll create a locking
606	* order violation. So, try make sure the VM won't be destroyed while
607	* till DrvAudio have entered its critical section...
608	*/
609	if (m_pDrvWas)
610	{
611	PPDMIHOSTAUDIOPORT const pIHostAudioPort = m_pDrvWas->pIHostAudioPort;
612	if (pIHostAudioPort)
613	{
614	VMSTATE const enmVmState = PDMDrvHlpVMState(m_pDrvWas->pDrvIns);
615	if (enmVmState < VMSTATE_POWERING_OFF)
616	{
617	RTCritSectLeave(&m_CritSect);
618	pIHostAudioPort->pfnNotifyDeviceChanged(pIHostAudioPort, fOutput ? PDMAUDIODIR_OUT : PDMAUDIODIR_IN, NULL);
619	return;
620	}
621	LogFlowFunc(("Ignoring change: enmVmState=%d\n", enmVmState));
622	}
623	}
624
625	RTCritSectLeave(&m_CritSect);
626	}
627
628	/**
629	* Tell DrvAudio to re-enumerate devices when it get a chance.
630	*
631	* We exit the critsect here too before calling DrvAudio just to be on the safe
632	* side (see setDevice()), even though the current DrvAudio code doesn't take
633	* any critsects.
634	*/
635	void notifyDeviceChanges(void)
636	{
637	RTCritSectEnter(&m_CritSect);
638	if (m_pDrvWas)
639	{
640	PPDMIHOSTAUDIOPORT const pIHostAudioPort = m_pDrvWas->pIHostAudioPort;
641	if (pIHostAudioPort)
642	{
643	VMSTATE const enmVmState = PDMDrvHlpVMState(m_pDrvWas->pDrvIns);
644	if (enmVmState < VMSTATE_POWERING_OFF)
645	{
646	RTCritSectLeave(&m_CritSect);
647	pIHostAudioPort->pfnNotifyDevicesChanged(pIHostAudioPort);
648	return;
649	}
650	LogFlowFunc(("Ignoring change: enmVmState=%d\n", enmVmState));
651	}
652	}
653	RTCritSectLeave(&m_CritSect);
654	}
655	};
656
657
658	/*********************************************************************************************************************************
659	* Pre-configured audio client cache. *
660	*********************************************************************************************************************************/
661	#define WAS_CACHE_MAX_ENTRIES_SAME_DEVICE 2
662
663	/**
664	* Converts from PDM stream config to windows WAVEFORMATEXTENSIBLE struct.
665	*
666	* @param pProps The PDM audio PCM properties to convert from.
667	* @param pFmt The windows structure to initialize.
668	*/
669	static void drvHostAudioWasWaveFmtExtFromProps(PCPDMAUDIOPCMPROPS pProps, PWAVEFORMATEXTENSIBLE pFmt)
670	{
671	RT_ZERO(*pFmt);
672	pFmt->Format.wFormatTag = WAVE_FORMAT_PCM;
673	pFmt->Format.nChannels = PDMAudioPropsChannels(pProps);
674	pFmt->Format.wBitsPerSample = PDMAudioPropsSampleBits(pProps);
675	pFmt->Format.nSamplesPerSec = PDMAudioPropsHz(pProps);
676	pFmt->Format.nBlockAlign = PDMAudioPropsFrameSize(pProps);
677	pFmt->Format.nAvgBytesPerSec = PDMAudioPropsFramesToBytes(pProps, PDMAudioPropsHz(pProps));
678	pFmt->Format.cbSize = 0; /* No extra data specified. */
679
680	/*
681	* We need to use the extensible structure if there are more than two channels
682	* or if the channels have non-standard assignments.
683	*/
684	if ( pFmt->Format.nChannels > 2
685	\|\| ( pFmt->Format.nChannels == 1
686	? pProps->aidChannels[0] != PDMAUDIOCHANNELID_MONO
687	: pProps->aidChannels[0] != PDMAUDIOCHANNELID_FRONT_LEFT
688	\|\| pProps->aidChannels[1] != PDMAUDIOCHANNELID_FRONT_RIGHT))
689	{
690	pFmt->Format.wFormatTag = WAVE_FORMAT_EXTENSIBLE;
691	pFmt->Format.cbSize = sizeof(*pFmt) - sizeof(pFmt->Format);
692	pFmt->Samples.wValidBitsPerSample = PDMAudioPropsSampleBits(pProps);
693	pFmt->SubFormat = KSDATAFORMAT_SUBTYPE_PCM;
694	pFmt->dwChannelMask = 0;
695	unsigned const cSrcChannels = pFmt->Format.nChannels;
696	for (unsigned i = 0; i < cSrcChannels; i++)
697	if ( pProps->aidChannels[i] >= PDMAUDIOCHANNELID_FIRST_STANDARD
698	&& pProps->aidChannels[i] < PDMAUDIOCHANNELID_END_STANDARD)
699	pFmt->dwChannelMask \|= RT_BIT_32(pProps->aidChannels[i] - PDMAUDIOCHANNELID_FIRST_STANDARD);
700	else
701	pFmt->Format.nChannels -= 1;
702	}
703	}
704
705
706	#if 0 /* unused */
707	/**
708	* Converts from windows WAVEFORMATEX and stream props to PDM audio properties.
709	*
710	* @returns VINF_SUCCESS on success, VERR_AUDIO_STREAM_COULD_NOT_CREATE if not
711	* supported.
712	* @param pProps The output properties structure.
713	* @param pFmt The windows wave format structure.
714	* @param pszStream The stream name for error logging.
715	* @param pwszDevId The device ID for error logging.
716	*/
717	static int drvHostAudioWasCacheWaveFmtExToProps(PPDMAUDIOPCMPROPS pProps, WAVEFORMATEX const *pFmt,
718	const char *pszStream, PCRTUTF16 pwszDevId)
719	{
720	if (pFmt->wFormatTag == WAVE_FORMAT_PCM)
721	{
722	if ( pFmt->wBitsPerSample == 8
723	\|\| pFmt->wBitsPerSample == 16
724	\|\| pFmt->wBitsPerSample == 32)
725	{
726	if (pFmt->nChannels > 0 && pFmt->nChannels < 16)
727	{
728	if (pFmt->nSamplesPerSec >= 4096 && pFmt->nSamplesPerSec <= 768000)
729	{
730	PDMAudioPropsInit(pProps, pFmt->wBitsPerSample / 8, true /fSigned/, pFmt->nChannels, pFmt->nSamplesPerSec);
731	if (PDMAudioPropsFrameSize(pProps) == pFmt->nBlockAlign)
732	return VINF_SUCCESS;
733	}
734	}
735	}
736	}
737	LogRelMax(64, ("WasAPI: Error! Unsupported stream format for '%s' suggested by '%ls':\n"
738	"WasAPI: wFormatTag = %RU16 (expected %d)\n"
739	"WasAPI: nChannels = %RU16 (expected 1..15)\n"
740	"WasAPI: nSamplesPerSec = %RU32 (expected 4096..768000)\n"
741	"WasAPI: nAvgBytesPerSec = %RU32\n"
742	"WasAPI: nBlockAlign = %RU16\n"
743	"WasAPI: wBitsPerSample = %RU16 (expected 8, 16, or 32)\n"
744	"WasAPI: cbSize = %RU16\n",
745	pszStream, pwszDevId, pFmt->wFormatTag, WAVE_FORMAT_PCM, pFmt->nChannels, pFmt->nSamplesPerSec, pFmt->nAvgBytesPerSec,
746	pFmt->nBlockAlign, pFmt->wBitsPerSample, pFmt->cbSize));
747	return VERR_AUDIO_STREAM_COULD_NOT_CREATE;
748	}
749	#endif
750
751
752	/**
753	* Destroys a devie config cache entry.
754	*
755	* @param pThis The WASAPI host audio driver instance data.
756	* @param pDevCfg Device config entry. Must not be in the list.
757	*/
758	static void drvHostAudioWasCacheDestroyDevConfig(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg)
759	{
760	if (pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN)
761	ASMAtomicDecU32(&pThis->cCacheEntriesIn);
762	else
763	ASMAtomicDecU32(&pThis->cCacheEntriesOut);
764
765	uint32_t cTypeClientRefs = 0;
766	if (pDevCfg->pIAudioCaptureClient)
767	{
768	cTypeClientRefs = pDevCfg->pIAudioCaptureClient->Release();
769	pDevCfg->pIAudioCaptureClient = NULL;
770	}
771
772	if (pDevCfg->pIAudioRenderClient)
773	{
774	cTypeClientRefs = pDevCfg->pIAudioRenderClient->Release();
775	pDevCfg->pIAudioRenderClient = NULL;
776	}
777
778	uint32_t cClientRefs = 0;
779	if (pDevCfg->pIAudioClient /* paranoia */)
780	{
781	cClientRefs = pDevCfg->pIAudioClient->Release();
782	pDevCfg->pIAudioClient = NULL;
783	}
784
785	Log8Func(("Destroying cache config entry: '%ls: %s' - cClientRefs=%u cTypeClientRefs=%u\n",
786	pDevCfg->pDevEntry->wszDevId, pDevCfg->szProps, cClientRefs, cTypeClientRefs));
787	RT_NOREF(cClientRefs, cTypeClientRefs);
788
789	pDevCfg->pDevEntry = NULL;
790	RTMemFree(pDevCfg);
791	}
792
793
794	/**
795	* Destroys a device cache entry.
796	*
797	* @param pThis The WASAPI host audio driver instance data.
798	* @param pDevEntry The device entry. Must not be in the cache!
799	*/
800	static void drvHostAudioWasCacheDestroyDevEntry(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASCACHEDEV pDevEntry)
801	{
802	Log8Func(("Destroying cache entry: %p - '%ls'\n", pDevEntry, pDevEntry->wszDevId));
803
804	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg, pDevCfgNext;
805	RTListForEachSafe(&pDevEntry->ConfigList, pDevCfg, pDevCfgNext, DRVHOSTAUDIOWASCACHEDEVCFG, ListEntry)
806	{
807	drvHostAudioWasCacheDestroyDevConfig(pThis, pDevCfg);
808	}
809
810	uint32_t cDevRefs = 0;
811	if (pDevEntry->pIDevice /* paranoia */)
812	{
813	cDevRefs = pDevEntry->pIDevice->Release();
814	pDevEntry->pIDevice = NULL;
815	}
816
817	pDevEntry->cwcDevId = 0;
818	pDevEntry->wszDevId[0] = '\0';
819	RTMemFree(pDevEntry);
820	Log8Func(("Destroyed cache entry: %p cDevRefs=%u\n", pDevEntry, cDevRefs));
821	}
822
823
824	/**
825	* Prunes the cache.
826	*/
827	static void drvHostAudioWasCachePrune(PDRVHOSTAUDIOWAS pThis)
828	{
829	/*
830	* Prune each direction separately.
831	*/
832	struct
833	{
834	PDMAUDIODIR enmDir;
835	uint32_t volatile *pcEntries;
836	} aWork[] = { { PDMAUDIODIR_IN, &pThis->cCacheEntriesIn }, { PDMAUDIODIR_OUT, &pThis->cCacheEntriesOut }, };
837	for (uint32_t iWork = 0; iWork < RT_ELEMENTS(aWork); iWork++)
838	{
839	/*
840	* Remove the least recently used entry till we're below the threshold
841	* or there are no more inactive entries.
842	*/
843	LogFlowFunc(("iWork=%u cEntries=%u\n", iWork, *aWork[iWork].pcEntries));
844	while (*aWork[iWork].pcEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
845	{
846	RTCritSectEnter(&pThis->CritSectCache);
847	PDRVHOSTAUDIOWASCACHEDEVCFG pLeastRecentlyUsed = NULL;
848	PDRVHOSTAUDIOWASCACHEDEV pDevEntry;
849	RTListForEach(&pThis->CacheHead, pDevEntry, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
850	{
851	if (pDevEntry->enmDir == aWork[iWork].enmDir)
852	{
853	PDRVHOSTAUDIOWASCACHEDEVCFG pHeadCfg = RTListGetFirst(&pDevEntry->ConfigList,
854	DRVHOSTAUDIOWASCACHEDEVCFG, ListEntry);
855	if ( pHeadCfg
856	&& (!pLeastRecentlyUsed \|\| pHeadCfg->nsLastUsed < pLeastRecentlyUsed->nsLastUsed))
857	pLeastRecentlyUsed = pHeadCfg;
858	}
859	}
860	if (pLeastRecentlyUsed)
861	RTListNodeRemove(&pLeastRecentlyUsed->ListEntry);
862	RTCritSectLeave(&pThis->CritSectCache);
863
864	if (!pLeastRecentlyUsed)
865	break;
866	drvHostAudioWasCacheDestroyDevConfig(pThis, pLeastRecentlyUsed);
867	}
868	}
869	}
870
871
872	/**
873	* Purges all the entries in the cache.
874	*/
875	static void drvHostAudioWasCachePurge(PDRVHOSTAUDIOWAS pThis, bool fOnWorker)
876	{
877	for (;;)
878	{
879	RTCritSectEnter(&pThis->CritSectCache);
880	PDRVHOSTAUDIOWASCACHEDEV pDevEntry = RTListRemoveFirst(&pThis->CacheHead, DRVHOSTAUDIOWASCACHEDEV, ListEntry);
881	RTCritSectLeave(&pThis->CritSectCache);
882	if (!pDevEntry)
883	break;
884	drvHostAudioWasCacheDestroyDevEntry(pThis, pDevEntry);
885	}
886
887	if (fOnWorker)
888	{
889	int rc = RTSemEventMultiSignal(pThis->hEvtCachePurge);
890	AssertRC(rc);
891	}
892	}
893
894
895	/**
896	* Looks up a specific configuration.
897	*
898	* @returns Pointer to the device config (removed from cache) on success. NULL
899	* if no matching config found.
900	* @param pDevEntry Where to perform the lookup.
901	* @param pProps The config properties to match.
902	*/
903	static PDRVHOSTAUDIOWASCACHEDEVCFG
904	drvHostAudioWasCacheLookupLocked(PDRVHOSTAUDIOWASCACHEDEV pDevEntry, PCPDMAUDIOPCMPROPS pProps)
905	{
906	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg;
907	RTListForEach(&pDevEntry->ConfigList, pDevCfg, DRVHOSTAUDIOWASCACHEDEVCFG, ListEntry)
908	{
909	if (PDMAudioPropsAreEqual(&pDevCfg->Props, pProps))
910	{
911	RTListNodeRemove(&pDevCfg->ListEntry);
912	pDevCfg->nsLastUsed = RTTimeNanoTS();
913	return pDevCfg;
914	}
915	}
916	return NULL;
917	}
918
919
920	/**
921	* Initializes a device config entry.
922	*
923	* This is usually done on the worker thread.
924	*
925	* @returns VBox status code.
926	* @param pDevCfg The device configuration entry to initialize.
927	*/
928	static int drvHostAudioWasCacheInitConfig(PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg)
929	{
930	/*
931	* Assert some sanity given that we migth be called on the worker thread
932	* and pDevCfg being a message parameter.
933	*/
934	AssertPtrReturn(pDevCfg, VERR_INTERNAL_ERROR_2);
935	AssertReturn(pDevCfg->rcSetup == VERR_AUDIO_STREAM_INIT_IN_PROGRESS, VERR_INTERNAL_ERROR_2);
936	AssertReturn(pDevCfg->pIAudioClient == NULL, VERR_INTERNAL_ERROR_2);
937	AssertReturn(pDevCfg->pIAudioCaptureClient == NULL, VERR_INTERNAL_ERROR_2);
938	AssertReturn(pDevCfg->pIAudioRenderClient == NULL, VERR_INTERNAL_ERROR_2);
939	AssertReturn(PDMAudioPropsAreValid(&pDevCfg->Props), VERR_INTERNAL_ERROR_2);
940
941	PDRVHOSTAUDIOWASCACHEDEV pDevEntry = pDevCfg->pDevEntry;
942	AssertPtrReturn(pDevEntry, VERR_INTERNAL_ERROR_2);
943	AssertPtrReturn(pDevEntry->pIDevice, VERR_INTERNAL_ERROR_2);
944	AssertReturn(pDevEntry->enmDir == PDMAUDIODIR_IN \|\| pDevEntry->enmDir == PDMAUDIODIR_OUT, VERR_INTERNAL_ERROR_2);
945
946	/*
947	* First we need an IAudioClient interface for calling IsFormatSupported
948	* on so we can get guidance as to what to do next.
949	*
950	* Initially, I thought the AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM was not
951	* supported all the way back to Vista and that we'd had to try different
952	* things here to get the most optimal format. However, according to
953	* https://social.msdn.microsoft.com/Forums/en-US/1d974d90-6636-4121-bba3-a8861d9ab92a
954	* it is supported, just maybe missing from the SDK or something...
955	*
956	* I'll leave the IsFormatSupported call here as it gives us a clue as to
957	* what exactly the WAS needs to convert our audio stream into/from.
958	*/
959	Log8Func(("Activating an IAudioClient for '%ls' ...\n", pDevEntry->wszDevId));
960	IAudioClient *pIAudioClient = NULL;
961	HRESULT hrc = pDevEntry->pIDevice->Activate(__uuidof(IAudioClient), CLSCTX_ALL,
962	NULL /pActivationParams/, (void **)&pIAudioClient);
963	Log8Func(("Activate('%ls', IAudioClient) -> %Rhrc\n", pDevEntry->wszDevId, hrc));
964	if (FAILED(hrc))
965	{
966	LogRelMax(64, ("WasAPI: Activate(%ls, IAudioClient) failed: %Rhrc\n", pDevEntry->wszDevId, hrc));
967	pDevCfg->nsInited = RTTimeNanoTS();
968	pDevCfg->nsLastUsed = pDevCfg->nsInited;
969	return pDevCfg->rcSetup = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
970	}
971
972	WAVEFORMATEXTENSIBLE WaveFmtExt;
973	drvHostAudioWasWaveFmtExtFromProps(&pDevCfg->Props, &WaveFmtExt);
974
975	PWAVEFORMATEX pClosestMatch = NULL;
976	hrc = pIAudioClient->IsFormatSupported(AUDCLNT_SHAREMODE_SHARED, &WaveFmtExt.Format, &pClosestMatch);
977
978	/*
979	* If the format is supported, go ahead and initialize the client instance.
980	*
981	* The docs talks about AUDCLNT_E_UNSUPPORTED_FORMAT being success too, but
982	* that doesn't seem to be the case (at least not for mixing up the
983	* WAVEFORMATEX::wFormatTag values). Seems that is the standard return code
984	* if there is anything it doesn't grok.
985	*/
986	if (SUCCEEDED(hrc))
987	{
988	if (hrc == S_OK)
989	Log8Func(("IsFormatSupported(,%s,) -> S_OK + %p: requested format is supported\n", pDevCfg->szProps, pClosestMatch));
990	else
991	Log8Func(("IsFormatSupported(,%s,) -> %Rhrc + %p: %uch S%u %uHz\n", pDevCfg->szProps, hrc, pClosestMatch,
992	pClosestMatch ? pClosestMatch->nChannels : 0, pClosestMatch ? pClosestMatch->wBitsPerSample : 0,
993	pClosestMatch ? pClosestMatch->nSamplesPerSec : 0));
994
995	REFERENCE_TIME const cBufferSizeInNtTicks = PDMAudioPropsFramesToNtTicks(&pDevCfg->Props, pDevCfg->cFramesBufferSize);
996	uint32_t fInitFlags = AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM
997	\| AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY;
998	hrc = pIAudioClient->Initialize(AUDCLNT_SHAREMODE_SHARED, fInitFlags, cBufferSizeInNtTicks,
999	0 /cPeriodicityInNtTicks/, &WaveFmtExt.Format, NULL /pAudioSessionGuid/);
1000	Log8Func(("Initialize(,%x, %RI64, %s,) -> %Rhrc\n", fInitFlags, cBufferSizeInNtTicks, pDevCfg->szProps, hrc));
1001	if (SUCCEEDED(hrc))
1002	{
1003	/*
1004	* The direction specific client interface.
1005	*/
1006	if (pDevEntry->enmDir == PDMAUDIODIR_IN)
1007	hrc = pIAudioClient->GetService(__uuidof(IAudioCaptureClient), (void **)&pDevCfg->pIAudioCaptureClient);
1008	else
1009	hrc = pIAudioClient->GetService(__uuidof(IAudioRenderClient), (void **)&pDevCfg->pIAudioRenderClient);
1010	Log8Func(("GetService -> %Rhrc + %p\n", hrc, pDevEntry->enmDir == PDMAUDIODIR_IN
1011	? (void )pDevCfg->pIAudioCaptureClient : (void )pDevCfg->pIAudioRenderClient));
1012	if (SUCCEEDED(hrc))
1013	{
1014	/*
1015	* Obtain the actual stream format and buffer config.
1016	*/
1017	UINT32 cFramesBufferSize = 0;
1018	REFERENCE_TIME cDefaultPeriodInNtTicks = 0;
1019	REFERENCE_TIME cMinimumPeriodInNtTicks = 0;
1020	REFERENCE_TIME cLatencyinNtTicks = 0;
1021	hrc = pIAudioClient->GetBufferSize(&cFramesBufferSize);
1022	if (SUCCEEDED(hrc))
1023	{
1024	hrc = pIAudioClient->GetDevicePeriod(&cDefaultPeriodInNtTicks, &cMinimumPeriodInNtTicks);
1025	if (SUCCEEDED(hrc))
1026	{
1027	hrc = pIAudioClient->GetStreamLatency(&cLatencyinNtTicks);
1028	if (SUCCEEDED(hrc))
1029	{
1030	LogRel2(("WasAPI: Aquired buffer parameters for %s:\n"
1031	"WasAPI: cFramesBufferSize = %RU32\n"
1032	"WasAPI: cDefaultPeriodInNtTicks = %RI64\n"
1033	"WasAPI: cMinimumPeriodInNtTicks = %RI64\n"
1034	"WasAPI: cLatencyinNtTicks = %RI64\n",
1035	pDevCfg->szProps, cFramesBufferSize, cDefaultPeriodInNtTicks,
1036	cMinimumPeriodInNtTicks, cLatencyinNtTicks));
1037
1038	pDevCfg->pIAudioClient = pIAudioClient;
1039	pDevCfg->cFramesBufferSize = cFramesBufferSize;
1040	pDevCfg->cFramesPeriod = PDMAudioPropsNanoToFrames(&pDevCfg->Props,
1041	cDefaultPeriodInNtTicks * 100);
1042	pDevCfg->nsInited = RTTimeNanoTS();
1043	pDevCfg->nsLastUsed = pDevCfg->nsInited;
1044	pDevCfg->rcSetup = VINF_SUCCESS;
1045
1046	if (pClosestMatch)
1047	CoTaskMemFree(pClosestMatch);
1048	Log8Func(("returns VINF_SUCCESS (%p (%s) inited in %'RU64 ns)\n",
1049	pDevCfg, pDevCfg->szProps, pDevCfg->nsInited - pDevCfg->nsCreated));
1050	return VINF_SUCCESS;
1051	}
1052	LogRelMax(64, ("WasAPI: GetStreamLatency failed: %Rhrc\n", hrc));
1053	}
1054	else
1055	LogRelMax(64, ("WasAPI: GetDevicePeriod failed: %Rhrc\n", hrc));
1056	}
1057	else
1058	LogRelMax(64, ("WasAPI: GetBufferSize failed: %Rhrc\n", hrc));
1059
1060	if (pDevCfg->pIAudioCaptureClient)
1061	{
1062	pDevCfg->pIAudioCaptureClient->Release();
1063	pDevCfg->pIAudioCaptureClient = NULL;
1064	}
1065
1066	if (pDevCfg->pIAudioRenderClient)
1067	{
1068	pDevCfg->pIAudioRenderClient->Release();
1069	pDevCfg->pIAudioRenderClient = NULL;
1070	}
1071	}
1072	else
1073	LogRelMax(64, ("WasAPI: IAudioClient::GetService(%s) failed: %Rhrc\n", pDevCfg->szProps, hrc));
1074	}
1075	else
1076	LogRelMax(64, ("WasAPI: IAudioClient::Initialize(%s) failed: %Rhrc\n", pDevCfg->szProps, hrc));
1077	}
1078	else
1079	LogRelMax(64,("WasAPI: IAudioClient::IsFormatSupported(,%s,) failed: %Rhrc\n", pDevCfg->szProps, hrc));
1080
1081	pIAudioClient->Release();
1082	if (pClosestMatch)
1083	CoTaskMemFree(pClosestMatch);
1084	pDevCfg->nsInited = RTTimeNanoTS();
1085	pDevCfg->nsLastUsed = 0;
1086	Log8Func(("returns VERR_AUDIO_STREAM_COULD_NOT_CREATE (inited in %'RU64 ns)\n", pDevCfg->nsInited - pDevCfg->nsCreated));
1087	return pDevCfg->rcSetup = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1088	}
1089
1090
1091	/**
1092	* Worker for drvHostAudioWasCacheLookupOrCreate.
1093	*
1094	* If lookup fails, a new entry will be created.
1095	*
1096	* @note Called holding the lock, returning without holding it!
1097	*/
1098	static int drvHostAudioWasCacheLookupOrCreateConfig(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASCACHEDEV pDevEntry,
1099	PCPDMAUDIOSTREAMCFG pCfgReq, bool fOnWorker,
1100	PDRVHOSTAUDIOWASCACHEDEVCFG *ppDevCfg)
1101	{
1102	/*
1103	* Check if we've got a matching config.
1104	*/
1105	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = drvHostAudioWasCacheLookupLocked(pDevEntry, &pCfgReq->Props);
1106	if (pDevCfg)
1107	{
1108	*ppDevCfg = pDevCfg;
1109	RTCritSectLeave(&pThis->CritSectCache);
1110	Log8Func(("Config cache hit '%s' on '%ls': %p\n", pDevCfg->szProps, pDevEntry->wszDevId, pDevCfg));
1111	return VINF_SUCCESS;
1112	}
1113
1114	RTCritSectLeave(&pThis->CritSectCache);
1115
1116	/*
1117	* Allocate an device config entry and hand the creation task over to the
1118	* worker thread, unless we're already on it.
1119	*/
1120	pDevCfg = (PDRVHOSTAUDIOWASCACHEDEVCFG)RTMemAllocZ(sizeof(*pDevCfg));
1121	AssertReturn(pDevCfg, VERR_NO_MEMORY);
1122	RTListInit(&pDevCfg->ListEntry);
1123	pDevCfg->pDevEntry = pDevEntry;
1124	pDevCfg->rcSetup = VERR_AUDIO_STREAM_INIT_IN_PROGRESS;
1125	pDevCfg->Props = pCfgReq->Props;
1126	pDevCfg->cFramesBufferSize = pCfgReq->Backend.cFramesBufferSize;
1127	PDMAudioPropsToString(&pDevCfg->Props, pDevCfg->szProps, sizeof(pDevCfg->szProps));
1128	pDevCfg->nsCreated = RTTimeNanoTS();
1129	pDevCfg->nsLastUsed = pDevCfg->nsCreated;
1130
1131	uint32_t cCacheEntries;
1132	if (pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN)
1133	cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesIn);
1134	else
1135	cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesOut);
1136	if (cCacheEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
1137	{
1138	LogFlowFunc(("Trigger cache pruning.\n"));
1139	int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /pStream/,
1140	DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /pvUser/);
1141	AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
1142	}
1143
1144	if (!fOnWorker)
1145	{
1146	*ppDevCfg = pDevCfg;
1147	LogFlowFunc(("Doing the rest of the work on %p via pfnStreamInitAsync...\n", pDevCfg));
1148	return VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED;
1149	}
1150
1151	/*
1152	* Initialize the entry on the calling thread.
1153	*/
1154	int rc = drvHostAudioWasCacheInitConfig(pDevCfg);
1155	AssertRC(pDevCfg->rcSetup == rc);
1156	if (RT_SUCCESS(rc))
1157	rc = pDevCfg->rcSetup; /* paranoia */
1158	if (RT_SUCCESS(rc))
1159	{
1160	*ppDevCfg = pDevCfg;
1161	LogFlowFunc(("Returning %p\n", pDevCfg));
1162	return VINF_SUCCESS;
1163	}
1164	RTMemFree(pDevCfg);
1165	*ppDevCfg = NULL;
1166	return rc;
1167	}
1168
1169
1170	/**
1171	* Looks up the given device + config combo in the cache, creating a new entry
1172	* if missing.
1173	*
1174	* @returns VBox status code.
1175	* @retval VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED if @a fOnWorker is @c false and
1176	* we created a new entry that needs initalization by calling
1177	* drvHostAudioWasCacheInitConfig() on it.
1178	* @param pThis The WASAPI host audio driver instance data.
1179	* @param pIDevice The device to look up.
1180	* @param pCfgReq The configuration to look up.
1181	* @param fOnWorker Set if we're on a worker thread, otherwise false. When
1182	* set to @c true, VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED will
1183	* not be returned and a new entry will be fully
1184	* initialized before returning.
1185	* @param ppDevCfg Where to return the requested device config.
1186	*/
1187	static int drvHostAudioWasCacheLookupOrCreate(PDRVHOSTAUDIOWAS pThis, IMMDevice *pIDevice, PCPDMAUDIOSTREAMCFG pCfgReq,
1188	bool fOnWorker, PDRVHOSTAUDIOWASCACHEDEVCFG *ppDevCfg)
1189	{
1190	*ppDevCfg = NULL;
1191
1192	/*
1193	* Get the device ID so we can perform the lookup.
1194	*/
1195	int rc = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1196	LPWSTR pwszDevId = NULL;
1197	HRESULT hrc = pIDevice->GetId(&pwszDevId);
1198	if (SUCCEEDED(hrc))
1199	{
1200	size_t cwcDevId = RTUtf16Len(pwszDevId);
1201
1202	/*
1203	* The cache has two levels, so first the device entry.
1204	*/
1205	PDRVHOSTAUDIOWASCACHEDEV pDevEntry;
1206	RTCritSectEnter(&pThis->CritSectCache);
1207	RTListForEach(&pThis->CacheHead, pDevEntry, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
1208	{
1209	if ( pDevEntry->cwcDevId == cwcDevId
1210	&& pDevEntry->enmDir == pCfgReq->enmDir
1211	&& RTUtf16Cmp(pDevEntry->wszDevId, pwszDevId) == 0)
1212	{
1213	CoTaskMemFree(pwszDevId);
1214	Log8Func(("Cache hit for device '%ls': %p\n", pDevEntry->wszDevId, pDevEntry));
1215	return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry, pCfgReq, fOnWorker, ppDevCfg);
1216	}
1217	}
1218	RTCritSectLeave(&pThis->CritSectCache);
1219
1220	/*
1221	* Device not in the cache, add it.
1222	*/
1223	pDevEntry = (PDRVHOSTAUDIOWASCACHEDEV)RTMemAllocZVar(RT_UOFFSETOF_DYN(DRVHOSTAUDIOWASCACHEDEV, wszDevId[cwcDevId + 1]));
1224	if (pDevEntry)
1225	{
1226	pIDevice->AddRef();
1227	pDevEntry->pIDevice = pIDevice;
1228	pDevEntry->enmDir = pCfgReq->enmDir;
1229	pDevEntry->cwcDevId = cwcDevId;
1230	#if 0
1231	pDevEntry->fSupportsAutoConvertPcm = -1;
1232	pDevEntry->fSupportsSrcDefaultQuality = -1;
1233	#endif
1234	RTListInit(&pDevEntry->ConfigList);
1235	memcpy(pDevEntry->wszDevId, pwszDevId, cwcDevId * sizeof(RTUTF16));
1236	pDevEntry->wszDevId[cwcDevId] = '\0';
1237
1238	CoTaskMemFree(pwszDevId);
1239	pwszDevId = NULL;
1240
1241	/*
1242	* Before adding the device, check that someone didn't race us adding it.
1243	*/
1244	RTCritSectEnter(&pThis->CritSectCache);
1245	PDRVHOSTAUDIOWASCACHEDEV pDevEntry2;
1246	RTListForEach(&pThis->CacheHead, pDevEntry2, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
1247	{
1248	if ( pDevEntry2->cwcDevId == cwcDevId
1249	&& pDevEntry2->enmDir == pCfgReq->enmDir
1250	&& RTUtf16Cmp(pDevEntry2->wszDevId, pDevEntry->wszDevId) == 0)
1251	{
1252	pIDevice->Release();
1253	RTMemFree(pDevEntry);
1254	pDevEntry = NULL;
1255
1256	Log8Func(("Lost race adding device '%ls': %p\n", pDevEntry2->wszDevId, pDevEntry2));
1257	return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry2, pCfgReq, fOnWorker, ppDevCfg);
1258	}
1259	}
1260	RTListPrepend(&pThis->CacheHead, &pDevEntry->ListEntry);
1261
1262	Log8Func(("Added device '%ls' to cache: %p\n", pDevEntry->wszDevId, pDevEntry));
1263	return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry, pCfgReq, fOnWorker, ppDevCfg);
1264	}
1265	CoTaskMemFree(pwszDevId);
1266	}
1267	else
1268	LogRelMax(64, ("WasAPI: GetId failed (lookup): %Rhrc\n", hrc));
1269	return rc;
1270	}
1271
1272
1273	/**
1274	* Return the given config to the cache.
1275	*
1276	* @param pThis The WASAPI host audio driver instance data.
1277	* @param pDevCfg The device config to put back.
1278	*/
1279	static void drvHostAudioWasCachePutBack(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg)
1280	{
1281	/*
1282	* Reset the audio client to see that it works and to make sure it's in a sensible state.
1283	*/
1284	HRESULT hrc = pDevCfg->pIAudioClient ? pDevCfg->pIAudioClient->Reset()
1285	: pDevCfg->rcSetup == VERR_AUDIO_STREAM_INIT_IN_PROGRESS ? S_OK : E_FAIL;
1286	if (SUCCEEDED(hrc))
1287	{
1288	Log8Func(("Putting %p/'%s' back\n", pDevCfg, pDevCfg->szProps));
1289	RTCritSectEnter(&pThis->CritSectCache);
1290	RTListAppend(&pDevCfg->pDevEntry->ConfigList, &pDevCfg->ListEntry);
1291	uint32_t const cEntries = pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN ? pThis->cCacheEntriesIn : pThis->cCacheEntriesOut;
1292	RTCritSectLeave(&pThis->CritSectCache);
1293
1294	/* Trigger pruning if we're over the threshold. */
1295	if (cEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
1296	{
1297	LogFlowFunc(("Trigger cache pruning.\n"));
1298	int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /pStream/,
1299	DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /pvUser/);
1300	AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
1301	}
1302	}
1303	else
1304	{
1305	Log8Func(("IAudioClient::Reset failed (%Rhrc) on %p/'%s', destroying it.\n", hrc, pDevCfg, pDevCfg->szProps));
1306	drvHostAudioWasCacheDestroyDevConfig(pThis, pDevCfg);
1307	}
1308	}
1309
1310
1311	static void drvHostWasCacheConfigHinting(PDRVHOSTAUDIOWAS pThis, PPDMAUDIOSTREAMCFG pCfgReq, bool fOnWorker)
1312	{
1313	/*
1314	* Get the device.
1315	*/
1316	pThis->pNotifyClient->lockEnter();
1317	IMMDevice *pIDevice = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pIDeviceInput : pThis->pIDeviceOutput;
1318	if (pIDevice)
1319	pIDevice->AddRef();
1320	pThis->pNotifyClient->lockLeave();
1321	if (pIDevice)
1322	{
1323	/*
1324	* Look up the config and put it back.
1325	*/
1326	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = NULL;
1327	int rc = drvHostAudioWasCacheLookupOrCreate(pThis, pIDevice, pCfgReq, fOnWorker, &pDevCfg);
1328	LogFlowFunc(("pDevCfg=%p rc=%Rrc\n", pDevCfg, rc));
1329	if (pDevCfg && RT_SUCCESS(rc))
1330	drvHostAudioWasCachePutBack(pThis, pDevCfg);
1331	pIDevice->Release();
1332	}
1333	}
1334
1335
1336	/**
1337	* Prefills the cache.
1338	*
1339	* @param pThis The WASAPI host audio driver instance data.
1340	*/
1341	static void drvHostAudioWasCacheFill(PDRVHOSTAUDIOWAS pThis)
1342	{
1343	#if 0 /* we don't have the buffer config nor do we really know which frequences to expect */
1344	Log8Func(("enter\n"));
1345	struct
1346	{
1347	PCRTUTF16 pwszDevId;
1348	PDMAUDIODIR enmDir;
1349	} aToCache[] =
1350	{
1351	{ pThis->pwszInputDevId, PDMAUDIODIR_IN },
1352	{ pThis->pwszOutputDevId, PDMAUDIODIR_OUT }
1353	};
1354	for (unsigned i = 0; i < RT_ELEMENTS(aToCache); i++)
1355	{
1356	PCRTUTF16 pwszDevId = aToCache[i].pwszDevId;
1357	IMMDevice *pIDevice = NULL;
1358	HRESULT hrc;
1359	if (pwszDevId)
1360	hrc = pThis->pIEnumerator->GetDevice(pwszDevId, &pIDevice);
1361	else
1362	{
1363	hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(aToCache[i].enmDir == PDMAUDIODIR_IN ? eCapture : eRender,
1364	eMultimedia, &pIDevice);
1365	pwszDevId = aToCache[i].enmDir == PDMAUDIODIR_IN ? L"{Default-In}" : L"{Default-Out}";
1366	}
1367	if (SUCCEEDED(hrc))
1368	{
1369	PDMAUDIOSTREAMCFG Cfg = { aToCache[i].enmDir, { PDMAUDIOPLAYBACKDST_INVALID },
1370	PDMAUDIOPCMPROPS_INITIALIZER(2, true, 2, 44100, false) };
1371	Cfg.Backend.cFramesBufferSize = PDMAudioPropsMilliToFrames(&Cfg.Props, 300);
1372	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = drvHostAudioWasCacheLookupOrCreate(pThis, pIDevice, &Cfg);
1373	if (pDevCfg)
1374	drvHostAudioWasCachePutBack(pThis, pDevCfg);
1375
1376	pIDevice->Release();
1377	}
1378	else
1379	LogRelMax(64, ("WasAPI: Failed to open audio device '%ls' (pre-caching): %Rhrc\n", pwszDevId, hrc));
1380	}
1381	Log8Func(("leave\n"));
1382	#else
1383	RT_NOREF(pThis);
1384	#endif
1385	}
1386
1387
1388	/*********************************************************************************************************************************
1389	* Worker thread *
1390	*********************************************************************************************************************************/
1391	#if 0
1392
1393	/**
1394	* @callback_method_impl{FNRTTHREAD,
1395	* Asynchronous thread for setting up audio client configs.}
1396	*/
1397	static DECLCALLBACK(int) drvHostWasWorkerThread(RTTHREAD hThreadSelf, void *pvUser)
1398	{
1399	PDRVHOSTAUDIOWAS pThis = (PDRVHOSTAUDIOWAS)pvUser;
1400
1401	/*
1402	* We need to set the thread ID so others can post us thread messages.
1403	* And before we signal that we're ready, make sure we've got a message queue.
1404	*/
1405	pThis->idWorkerThread = GetCurrentThreadId();
1406	LogFunc(("idWorkerThread=%#x (%u)\n", pThis->idWorkerThread, pThis->idWorkerThread));
1407
1408	MSG Msg;
1409	PeekMessageW(&Msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);
1410
1411	int rc = RTThreadUserSignal(hThreadSelf);
1412	AssertRC(rc);
1413
1414	/*
1415	* Message loop.
1416	*/
1417	BOOL fRet;
1418	while ((fRet = GetMessageW(&Msg, NULL, 0, 0)) != FALSE)
1419	{
1420	if (fRet != -1)
1421	{
1422	TranslateMessage(&Msg);
1423	Log9Func(("Msg: time=%u: msg=%#x l=%p w=%p for hwnd=%p\n", Msg.time, Msg.message, Msg.lParam, Msg.wParam, Msg.hwnd));
1424	switch (Msg.message)
1425	{
1426	case WM_DRVHOSTAUDIOWAS_PURGE_CACHE:
1427	{
1428	AssertMsgBreak(Msg.wParam == pThis->uWorkerThreadFixedParam, ("%p\n", Msg.wParam));
1429	AssertBreak(Msg.hwnd == NULL);
1430	AssertBreak(Msg.lParam == 0);
1431
1432	drvHostAudioWasCachePurge(pThis, false /fOnWorker/);
1433	break;
1434	}
1435
1436	default:
1437	break;
1438	}
1439	DispatchMessageW(&Msg);
1440	}
1441	else
1442	AssertMsgFailed(("GetLastError()=%u\n", GetLastError()));
1443	}
1444
1445	LogFlowFunc(("Pre-quit cache purge...\n"));
1446	drvHostAudioWasCachePurge(pThis, false /fOnWorker/);
1447
1448	LogFunc(("Quits\n"));
1449	return VINF_SUCCESS;
1450	}
1451	#endif
1452
1453
1454	/*********************************************************************************************************************************
1455	* PDMIHOSTAUDIO *
1456	*********************************************************************************************************************************/
1457
1458	/**
1459	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetConfig}
1460	*/
1461	static DECLCALLBACK(int) drvHostAudioWasHA_GetConfig(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDCFG pBackendCfg)
1462	{
1463	RT_NOREF(pInterface);
1464	AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
1465	AssertPtrReturn(pBackendCfg, VERR_INVALID_POINTER);
1466
1467
1468	/*
1469	* Fill in the config structure.
1470	*/
1471	RTStrCopy(pBackendCfg->szName, sizeof(pBackendCfg->szName), "WasAPI");
1472	pBackendCfg->cbStream = sizeof(DRVHOSTAUDIOWASSTREAM);
1473	pBackendCfg->fFlags = PDMAUDIOBACKEND_F_ASYNC_HINT;
1474	pBackendCfg->cMaxStreamsIn = UINT32_MAX;
1475	pBackendCfg->cMaxStreamsOut = UINT32_MAX;
1476
1477	return VINF_SUCCESS;
1478	}
1479
1480
1481	/**
1482	* Queries information for @a pDevice and adds an entry to the enumeration.
1483	*
1484	* @returns VBox status code.
1485	* @param pDevEnm The enumeration to add the device to.
1486	* @param pIDevice The device.
1487	* @param enmType The type of device.
1488	* @param fDefault Whether it's the default device.
1489	*/
1490	static int drvHostWasEnumAddDev(PPDMAUDIOHOSTENUM pDevEnm, IMMDevice *pIDevice, EDataFlow enmType, bool fDefault)
1491	{
1492	int rc = VINF_SUCCESS; /* ignore most errors */
1493	RT_NOREF(fDefault); /** @todo default device marking/skipping. */
1494
1495	/*
1496	* Gather the necessary properties.
1497	*/
1498	IPropertyStore *pProperties = NULL;
1499	HRESULT hrc = pIDevice->OpenPropertyStore(STGM_READ, &pProperties);
1500	if (SUCCEEDED(hrc))
1501	{
1502	/* Get the friendly name (string). */
1503	PROPVARIANT VarName;
1504	PropVariantInit(&VarName);
1505	hrc = pProperties->GetValue(PKEY_Device_FriendlyName, &VarName);
1506	if (SUCCEEDED(hrc))
1507	{
1508	/* Get the device ID (string). */
1509	LPWSTR pwszDevId = NULL;
1510	hrc = pIDevice->GetId(&pwszDevId);
1511	if (SUCCEEDED(hrc))
1512	{
1513	size_t const cwcDevId = RTUtf16Len(pwszDevId);
1514
1515	/* Get the device format (blob). */
1516	PROPVARIANT VarFormat;
1517	PropVariantInit(&VarFormat);
1518	hrc = pProperties->GetValue(PKEY_AudioEngine_DeviceFormat, &VarFormat);
1519	if (SUCCEEDED(hrc))
1520	{
1521	WAVEFORMATEX const * const pFormat = (WAVEFORMATEX const *)VarFormat.blob.pBlobData;
1522	AssertPtr(pFormat);
1523
1524	/*
1525	* Create a enumeration entry for it.
1526	*/
1527	size_t const cbDev = RT_ALIGN_Z( RT_OFFSETOF(DRVHOSTAUDIOWASDEV, wszDevId)
1528	+ (cwcDevId + 1) * sizeof(RTUTF16),
1529	64);
1530	PDRVHOSTAUDIOWASDEV pDev = (PDRVHOSTAUDIOWASDEV)PDMAudioHostDevAlloc(cbDev);
1531	if (pDev)
1532	{
1533	pDev->Core.enmType = PDMAUDIODEVICETYPE_BUILTIN;
1534	pDev->Core.enmUsage = enmType == eRender ? PDMAUDIODIR_OUT : PDMAUDIODIR_IN;
1535	if (fDefault)
1536	pDev->Core.fFlags = enmType == eRender ? PDMAUDIOHOSTDEV_F_DEFAULT_OUT : PDMAUDIOHOSTDEV_F_DEFAULT_IN;
1537	if (enmType == eRender)
1538	pDev->Core.cMaxOutputChannels = pFormat->nChannels;
1539	else
1540	pDev->Core.cMaxInputChannels = pFormat->nChannels;
1541
1542	memcpy(pDev->wszDevId, pwszDevId, cwcDevId * sizeof(RTUTF16));
1543	pDev->wszDevId[cwcDevId] = '\0';
1544
1545	char *pszName;
1546	rc = RTUtf16ToUtf8(VarName.pwszVal, &pszName);
1547	if (RT_SUCCESS(rc))
1548	{
1549	RTStrCopy(pDev->Core.szName, sizeof(pDev->Core.szName), pszName);
1550	RTStrFree(pszName);
1551
1552	rc = RTUtf16ToUtf8(pDev->wszDevId, &pDev->Core.pszId);
1553	if (RT_SUCCESS(rc))
1554	{
1555	pDev->Core.fFlags \|= PDMAUDIOHOSTDEV_F_ID_ALLOC;
1556	PDMAudioHostEnumAppend(pDevEnm, &pDev->Core);
1557	}
1558	else
1559	PDMAudioHostDevFree(&pDev->Core);
1560	}
1561	else
1562	PDMAudioHostDevFree(&pDev->Core);
1563	}
1564	else
1565	rc = VERR_NO_MEMORY;
1566	PropVariantClear(&VarFormat);
1567	}
1568	else
1569	LogFunc(("Failed to get PKEY_AudioEngine_DeviceFormat: %Rhrc\n", hrc));
1570	CoTaskMemFree(pwszDevId);
1571	}
1572	else
1573	LogFunc(("Failed to get the device ID: %Rhrc\n", hrc));
1574	PropVariantClear(&VarName);
1575	}
1576	else
1577	LogFunc(("Failed to get PKEY_Device_FriendlyName: %Rhrc\n", hrc));
1578	pProperties->Release();
1579	}
1580	else
1581	LogFunc(("OpenPropertyStore failed: %Rhrc\n", hrc));
1582
1583	if (hrc == E_OUTOFMEMORY && RT_SUCCESS_NP(rc))
1584	rc = VERR_NO_MEMORY;
1585	return rc;
1586	}
1587
1588
1589	/**
1590	* Does a (Re-)enumeration of the host's playback + capturing devices.
1591	*
1592	* @return VBox status code.
1593	* @param pThis The WASAPI host audio driver instance data.
1594	* @param pDevEnm Where to store the enumerated devices.
1595	*/
1596	static int drvHostWasEnumerateDevices(PDRVHOSTAUDIOWAS pThis, PPDMAUDIOHOSTENUM pDevEnm)
1597	{
1598	LogRel2(("WasAPI: Enumerating devices ...\n"));
1599
1600	int rc = VINF_SUCCESS;
1601	for (unsigned idxPass = 0; idxPass < 2 && RT_SUCCESS(rc); idxPass++)
1602	{
1603	EDataFlow const enmType = idxPass == 0 ? EDataFlow::eRender : EDataFlow::eCapture;
1604
1605	/* Get the default device first. */
1606	IMMDevice *pIDefaultDevice = NULL;
1607	HRESULT hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(enmType, eMultimedia, &pIDefaultDevice);
1608	if (SUCCEEDED(hrc))
1609	rc = drvHostWasEnumAddDev(pDevEnm, pIDefaultDevice, enmType, true);
1610	else
1611	pIDefaultDevice = NULL;
1612
1613	/* Enumerate the devices. */
1614	IMMDeviceCollection *pCollection = NULL;
1615	hrc = pThis->pIEnumerator->EnumAudioEndpoints(enmType, DEVICE_STATE_ACTIVE /\| DEVICE_STATE_UNPLUGGED?/, &pCollection);
1616	if (SUCCEEDED(hrc) && pCollection != NULL)
1617	{
1618	UINT cDevices = 0;
1619	hrc = pCollection->GetCount(&cDevices);
1620	if (SUCCEEDED(hrc))
1621	{
1622	for (UINT idxDevice = 0; idxDevice < cDevices && RT_SUCCESS(rc); idxDevice++)
1623	{
1624	IMMDevice *pIDevice = NULL;
1625	hrc = pCollection->Item(idxDevice, &pIDevice);
1626	if (SUCCEEDED(hrc) && pIDevice)
1627	{
1628	if (pIDevice != pIDefaultDevice)
1629	rc = drvHostWasEnumAddDev(pDevEnm, pIDevice, enmType, false);
1630	pIDevice->Release();
1631	}
1632	}
1633	}
1634	pCollection->Release();
1635	}
1636	else
1637	LogRelMax(10, ("EnumAudioEndpoints(%s) failed: %Rhrc\n", idxPass == 0 ? "output" : "input", hrc));
1638
1639	if (pIDefaultDevice)
1640	pIDefaultDevice->Release();
1641	}
1642
1643	LogRel2(("WasAPI: Enumerating devices done - %u device (%Rrc)\n", pDevEnm->cDevices, rc));
1644	return rc;
1645	}
1646
1647
1648	/**
1649	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetDevices}
1650	*/
1651	static DECLCALLBACK(int) drvHostAudioWasHA_GetDevices(PPDMIHOSTAUDIO pInterface, PPDMAUDIOHOSTENUM pDeviceEnum)
1652	{
1653	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
1654	AssertPtrReturn(pDeviceEnum, VERR_INVALID_POINTER);
1655
1656	PDMAudioHostEnumInit(pDeviceEnum);
1657	int rc = drvHostWasEnumerateDevices(pThis, pDeviceEnum);
1658	if (RT_FAILURE(rc))
1659	PDMAudioHostEnumDelete(pDeviceEnum);
1660
1661	LogFlowFunc(("Returning %Rrc\n", rc));
1662	return rc;
1663	}
1664
1665
1666	/**
1667	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetStatus}
1668	*/
1669	static DECLCALLBACK(PDMAUDIOBACKENDSTS) drvHostAudioWasHA_GetStatus(PPDMIHOSTAUDIO pInterface, PDMAUDIODIR enmDir)
1670	{
1671	RT_NOREF(pInterface, enmDir);
1672	return PDMAUDIOBACKENDSTS_RUNNING;
1673	}
1674
1675
1676	/**
1677	* Performs the actual switching of device config.
1678	*
1679	* Worker for drvHostAudioWasDoStreamDevSwitch() and
1680	* drvHostAudioWasHA_StreamNotifyDeviceChanged().
1681	*/
1682	static void drvHostAudioWasCompleteStreamDevSwitch(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASSTREAM pStreamWas,
1683	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg)
1684	{
1685	RTCritSectEnter(&pStreamWas->CritSect);
1686
1687	/* Do the switch. */
1688	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfgOld = pStreamWas->pDevCfg;
1689	pStreamWas->pDevCfg = pDevCfg;
1690
1691	/* The new stream is neither started nor draining. */
1692	pStreamWas->fStarted = false;
1693	pStreamWas->fDraining = false;
1694
1695	/* Device switching is done now. */
1696	pStreamWas->fSwitchingDevice = false;
1697
1698	/* Stop the old stream or Reset() will fail when putting it back into the cache. */
1699	if (pStreamWas->fEnabled && pDevCfgOld->pIAudioClient)
1700	pDevCfgOld->pIAudioClient->Stop();
1701
1702	RTCritSectLeave(&pStreamWas->CritSect);
1703
1704	/* Notify DrvAudio. */
1705	pThis->pIHostAudioPort->pfnStreamNotifyDeviceChanged(pThis->pIHostAudioPort, &pStreamWas->Core, false /fReInit/);
1706
1707	/* Put the old config back into the cache. */
1708	drvHostAudioWasCachePutBack(pThis, pDevCfgOld);
1709
1710	LogFlowFunc(("returns with '%s' state: %s\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
1711	}
1712
1713
1714	/**
1715	* Called on a worker thread to initialize a new device config and switch the
1716	* given stream to using it.
1717	*
1718	* @sa drvHostAudioWasHA_StreamNotifyDeviceChanged
1719	*/
1720	static void drvHostAudioWasDoStreamDevSwitch(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASSTREAM pStreamWas,
1721	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg)
1722	{
1723	/*
1724	* Do the initializing.
1725	*/
1726	int rc = drvHostAudioWasCacheInitConfig(pDevCfg);
1727	if (RT_SUCCESS(rc))
1728	drvHostAudioWasCompleteStreamDevSwitch(pThis, pStreamWas, pDevCfg);
1729	else
1730	{
1731	LogRelMax(64, ("WasAPI: Failed to set up new device config '%ls:%s' for stream '%s': %Rrc\n",
1732	pDevCfg->pDevEntry->wszDevId, pDevCfg->szProps, pStreamWas->Cfg.szName, rc));
1733	drvHostAudioWasCacheDestroyDevConfig(pThis, pDevCfg);
1734	pThis->pIHostAudioPort->pfnStreamNotifyDeviceChanged(pThis->pIHostAudioPort, &pStreamWas->Core, true /fReInit/);
1735	}
1736	}
1737
1738
1739	/**
1740	* @interface_method_impl{PDMIHOSTAUDIO,pfnDoOnWorkerThread}
1741	*/
1742	static DECLCALLBACK(void) drvHostAudioWasHA_DoOnWorkerThread(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1743	uintptr_t uUser, void *pvUser)
1744	{
1745	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
1746	LogFlowFunc(("uUser=%#zx pStream=%p pvUser=%p\n", uUser, pStream, pvUser));
1747
1748	switch (uUser)
1749	{
1750	case DRVHOSTAUDIOWAS_DO_PURGE_CACHE:
1751	Assert(pStream == NULL);
1752	Assert(pvUser == NULL);
1753	drvHostAudioWasCachePurge(pThis, true /fOnWorker/);
1754	break;
1755
1756	case DRVHOSTAUDIOWAS_DO_PRUNE_CACHE:
1757	Assert(pStream == NULL);
1758	Assert(pvUser == NULL);
1759	drvHostAudioWasCachePrune(pThis);
1760	break;
1761
1762	case DRVHOSTAUDIOWAS_DO_STREAM_DEV_SWITCH:
1763	AssertPtr(pStream);
1764	AssertPtr(pvUser);
1765	drvHostAudioWasDoStreamDevSwitch(pThis, (PDRVHOSTAUDIOWASSTREAM)pStream, (PDRVHOSTAUDIOWASCACHEDEVCFG)pvUser);
1766	break;
1767
1768	default:
1769	AssertMsgFailedBreak(("%#zx\n", uUser));
1770	}
1771	}
1772
1773
1774	/**
1775	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamConfigHint}
1776	*
1777	* @note This is called on a DrvAudio worker thread.
1778	*/
1779	static DECLCALLBACK(void) drvHostAudioWasHA_StreamConfigHint(PPDMIHOSTAUDIO pInterface, PPDMAUDIOSTREAMCFG pCfg)
1780	{
1781	#if 0 /* disable to test async stream creation. */
1782	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
1783	LogFlowFunc(("pCfg=%p\n", pCfg));
1784
1785	drvHostWasCacheConfigHinting(pThis, pCfg);
1786	#else
1787	RT_NOREF(pInterface, pCfg);
1788	#endif
1789	}
1790
1791
1792	/**
1793	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCreate}
1794	*/
1795	static DECLCALLBACK(int) drvHostAudioWasHA_StreamCreate(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1796	PCPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
1797	{
1798	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
1799	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
1800	AssertPtrReturn(pStreamWas, VERR_INVALID_POINTER);
1801	AssertPtrReturn(pCfgReq, VERR_INVALID_POINTER);
1802	AssertPtrReturn(pCfgAcq, VERR_INVALID_POINTER);
1803	AssertReturn(pCfgReq->enmDir == PDMAUDIODIR_IN \|\| pCfgReq->enmDir == PDMAUDIODIR_OUT, VERR_INVALID_PARAMETER);
1804	Assert(PDMAudioStrmCfgEquals(pCfgReq, pCfgAcq));
1805
1806	const char * const pszStreamType = pCfgReq->enmDir == PDMAUDIODIR_IN ? "capture" : "playback"; RT_NOREF(pszStreamType);
1807	LogFlowFunc(("enmPath=%s '%s'\n", PDMAudioPathGetName(pCfgReq->enmPath), pCfgReq->szName));
1808	#if defined(RTLOG_REL_ENABLED) \|\| defined(LOG_ENABLED)
1809	char szTmp[64];
1810	#endif
1811	LogRel2(("WasAPI: Opening %s stream '%s' (%s)\n", pCfgReq->szName, pszStreamType,
1812	PDMAudioPropsToString(&pCfgReq->Props, szTmp, sizeof(szTmp))));
1813
1814	RTListInit(&pStreamWas->ListEntry);
1815
1816	/*
1817	* Do configuration conversion.
1818	*/
1819	WAVEFORMATEXTENSIBLE WaveFmtExt;
1820	drvHostAudioWasWaveFmtExtFromProps(&pCfgReq->Props, &WaveFmtExt);
1821	LogRel2(("WasAPI: Requested %s format for '%s':\n"
1822	"WasAPI: wFormatTag = %#RX16\n"
1823	"WasAPI: nChannels = %RU16\n"
1824	"WasAPI: nSamplesPerSec = %RU32\n"
1825	"WasAPI: nAvgBytesPerSec = %RU32\n"
1826	"WasAPI: nBlockAlign = %RU16\n"
1827	"WasAPI: wBitsPerSample = %RU16\n"
1828	"WasAPI: cbSize = %RU16\n"
1829	"WasAPI: cBufferSizeInNtTicks = %RU64\n",
1830	pszStreamType, pCfgReq->szName, WaveFmtExt.Format.wFormatTag, WaveFmtExt.Format.nChannels,
1831	WaveFmtExt.Format.nSamplesPerSec, WaveFmtExt.Format.nAvgBytesPerSec, WaveFmtExt.Format.nBlockAlign,
1832	WaveFmtExt.Format.wBitsPerSample, WaveFmtExt.Format.cbSize,
1833	PDMAudioPropsFramesToNtTicks(&pCfgReq->Props, pCfgReq->Backend.cFramesBufferSize) ));
1834	if (WaveFmtExt.Format.cbSize != 0)
1835	LogRel2(("WasAPI: dwChannelMask = %#RX32\n"
1836	"WasAPI: wValidBitsPerSample = %RU16\n",
1837	WaveFmtExt.dwChannelMask, WaveFmtExt.Samples.wValidBitsPerSample));
1838
1839	/* Set up the acquired format here as channel count + layout may have
1840	changed and need to be communicated to caller and used in cache lookup. */
1841	pCfgAcq = pCfgReq;
1842	if (WaveFmtExt.Format.cbSize != 0)
1843	{
1844	PDMAudioPropsSetChannels(&pCfgAcq->Props, WaveFmtExt.Format.nChannels);
1845	uint8_t idCh = 0;
1846	for (unsigned iBit = 0; iBit < 32 && idCh < WaveFmtExt.Format.nChannels; iBit++)
1847	if (WaveFmtExt.dwChannelMask & RT_BIT_32(iBit))
1848	{
1849	pCfgAcq->Props.aidChannels[idCh] = (unsigned)PDMAUDIOCHANNELID_FIRST_STANDARD + iBit;
1850	idCh++;
1851	}
1852	Assert(idCh == WaveFmtExt.Format.nChannels);
1853	}
1854
1855	/*
1856	* Get the device we're supposed to use.
1857	* (We cache this as it takes ~2ms to get the default device on a random W10 19042 system.)
1858	*/
1859	pThis->pNotifyClient->lockEnter();
1860	IMMDevice *pIDevice = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pIDeviceInput : pThis->pIDeviceOutput;
1861	if (pIDevice)
1862	pIDevice->AddRef();
1863	pThis->pNotifyClient->lockLeave();
1864
1865	PRTUTF16 pwszDevId = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pwszInputDevId : pThis->pwszOutputDevId;
1866	PRTUTF16 const pwszDevIdDesc = pwszDevId ? pwszDevId : pCfgReq->enmDir == PDMAUDIODIR_IN ? L"{Default-In}" : L"{Default-Out}";
1867	if (!pIDevice)
1868	{
1869	/** @todo we can eliminate this too... */
1870	HRESULT hrc;
1871	if (pwszDevId)
1872	hrc = pThis->pIEnumerator->GetDevice(pwszDevId, &pIDevice);
1873	else
1874	hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(pCfgReq->enmDir == PDMAUDIODIR_IN ? eCapture : eRender,
1875	eMultimedia, &pIDevice);
1876	LogFlowFunc(("Got device %p (%Rhrc)\n", pIDevice, hrc));
1877	if (FAILED(hrc))
1878	{
1879	LogRelMax(64, ("WasAPI: Failed to open audio %s device '%ls': %Rhrc\n", pszStreamType, pwszDevIdDesc, hrc));
1880	return VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1881	}
1882	}
1883
1884	/*
1885	* Ask the cache to retrieve or instantiate the requested configuration.
1886	*/
1887	/** @todo make it return a status code too and retry if the default device
1888	* was invalidated/changed while we where working on it here. */
1889	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = NULL;
1890	int rc = drvHostAudioWasCacheLookupOrCreate(pThis, pIDevice, pCfgAcq, false /fOnWorker/, &pDevCfg);
1891
1892	pIDevice->Release();
1893	pIDevice = NULL;
1894
1895	if (pDevCfg && RT_SUCCESS(rc))
1896	{
1897	pStreamWas->pDevCfg = pDevCfg;
1898
1899	pCfgAcq->Props = pDevCfg->Props;
1900	pCfgAcq->Backend.cFramesBufferSize = pDevCfg->cFramesBufferSize;
1901	pCfgAcq->Backend.cFramesPeriod = pDevCfg->cFramesPeriod;
1902	pCfgAcq->Backend.cFramesPreBuffering = pCfgReq->Backend.cFramesPreBuffering * pDevCfg->cFramesBufferSize
1903	/ RT_MAX(pCfgReq->Backend.cFramesBufferSize, 1);
1904
1905	PDMAudioStrmCfgCopy(&pStreamWas->Cfg, pCfgAcq);
1906
1907	/* Finally, the critical section. */
1908	int rc2 = RTCritSectInit(&pStreamWas->CritSect);
1909	if (RT_SUCCESS(rc2))
1910	{
1911	RTCritSectRwEnterExcl(&pThis->CritSectStreamList);
1912	RTListAppend(&pThis->StreamHead, &pStreamWas->ListEntry);
1913	RTCritSectRwLeaveExcl(&pThis->CritSectStreamList);
1914
1915	if (pStreamWas->pDevCfg->pIAudioClient != NULL)
1916	{
1917	LogFlowFunc(("returns VINF_SUCCESS\n", rc));
1918	return VINF_SUCCESS;
1919	}
1920	LogFlowFunc(("returns VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED\n", rc));
1921	return VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED;
1922	}
1923
1924	LogRelMax(64, ("WasAPI: Failed to create critical section for stream.\n"));
1925	drvHostAudioWasCachePutBack(pThis, pDevCfg);
1926	pStreamWas->pDevCfg = NULL;
1927	}
1928	else
1929	LogRelMax(64, ("WasAPI: Failed to setup %s on audio device '%ls' (%Rrc).\n", pszStreamType, pwszDevIdDesc, rc));
1930
1931	LogFlowFunc(("returns %Rrc\n", rc));
1932	return rc;
1933	}
1934
1935
1936	/**
1937	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamInitAsync}
1938	*/
1939	static DECLCALLBACK(int) drvHostAudioWasHA_StreamInitAsync(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1940	bool fDestroyed)
1941	{
1942	RT_NOREF(pInterface);
1943	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
1944	AssertPtrReturn(pStreamWas, VERR_INVALID_POINTER);
1945	LogFlowFunc(("Stream '%s'%s\n", pStreamWas->Cfg.szName, fDestroyed ? " - destroyed!" : ""));
1946
1947	/*
1948	* Assert sane preconditions for this call.
1949	*/
1950	AssertPtrReturn(pStreamWas->Core.pStream, VERR_INTERNAL_ERROR);
1951	AssertPtrReturn(pStreamWas->pDevCfg, VERR_INTERNAL_ERROR_2);
1952	AssertPtrReturn(pStreamWas->pDevCfg->pDevEntry, VERR_INTERNAL_ERROR_3);
1953	AssertPtrReturn(pStreamWas->pDevCfg->pDevEntry->pIDevice, VERR_INTERNAL_ERROR_4);
1954	AssertReturn(pStreamWas->pDevCfg->pDevEntry->enmDir == pStreamWas->Core.pStream->enmDir, VERR_INTERNAL_ERROR_4);
1955	AssertReturn(pStreamWas->pDevCfg->pIAudioClient == NULL, VERR_INTERNAL_ERROR_5);
1956	AssertReturn(pStreamWas->pDevCfg->pIAudioRenderClient == NULL, VERR_INTERNAL_ERROR_5);
1957	AssertReturn(pStreamWas->pDevCfg->pIAudioCaptureClient == NULL, VERR_INTERNAL_ERROR_5);
1958
1959	/*
1960	* Do the job.
1961	*/
1962	int rc;
1963	if (!fDestroyed)
1964	rc = drvHostAudioWasCacheInitConfig(pStreamWas->pDevCfg);
1965	else
1966	{
1967	AssertReturn(pStreamWas->pDevCfg->rcSetup == VERR_AUDIO_STREAM_INIT_IN_PROGRESS, VERR_INTERNAL_ERROR_2);
1968	pStreamWas->pDevCfg->rcSetup = VERR_WRONG_ORDER;
1969	rc = VINF_SUCCESS;
1970	}
1971
1972	LogFlowFunc(("returns %Rrc (%s)\n", rc, pStreamWas->Cfg.szName));
1973	return rc;
1974	}
1975
1976
1977	/**
1978	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamDestroy}
1979	*/
1980	static DECLCALLBACK(int) drvHostAudioWasHA_StreamDestroy(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1981	bool fImmediate)
1982	{
1983	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
1984	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
1985	AssertPtrReturn(pStreamWas, VERR_INVALID_POINTER);
1986	LogFlowFunc(("Stream '%s'\n", pStreamWas->Cfg.szName));
1987	RT_NOREF(fImmediate);
1988	HRESULT hrc;
1989
1990	if (RTCritSectIsInitialized(&pStreamWas->CritSect))
1991	{
1992	RTCritSectRwEnterExcl(&pThis->CritSectStreamList);
1993	RTListNodeRemove(&pStreamWas->ListEntry);
1994	RTCritSectRwLeaveExcl(&pThis->CritSectStreamList);
1995
1996	RTCritSectDelete(&pStreamWas->CritSect);
1997	}
1998
1999	if (pStreamWas->fStarted && pStreamWas->pDevCfg && pStreamWas->pDevCfg->pIAudioClient)
2000	{
2001	hrc = pStreamWas->pDevCfg->pIAudioClient->Stop();
2002	LogFunc(("Stop('%s') -> %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2003	pStreamWas->fStarted = false;
2004	}
2005
2006	if (pStreamWas->cFramesCaptureToRelease)
2007	{
2008	hrc = pStreamWas->pDevCfg->pIAudioCaptureClient->ReleaseBuffer(0);
2009	Log4Func(("Releasing capture buffer (%#x frames): %Rhrc\n", pStreamWas->cFramesCaptureToRelease, hrc));
2010	pStreamWas->cFramesCaptureToRelease = 0;
2011	pStreamWas->pbCapture = NULL;
2012	pStreamWas->cbCapture = 0;
2013	}
2014
2015	if (pStreamWas->pDevCfg)
2016	{
2017	drvHostAudioWasCachePutBack(pThis, pStreamWas->pDevCfg);
2018	pStreamWas->pDevCfg = NULL;
2019	}
2020
2021	LogFlowFunc(("returns\n"));
2022	return VINF_SUCCESS;
2023	}
2024
2025
2026	/**
2027	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamNotifyDeviceChanged}
2028	*/
2029	static DECLCALLBACK(void) drvHostAudioWasHA_StreamNotifyDeviceChanged(PPDMIHOSTAUDIO pInterface,
2030	PPDMAUDIOBACKENDSTREAM pStream, void *pvUser)
2031	{
2032	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
2033	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2034	LogFlowFunc(("pStreamWas=%p (%s)\n", pStreamWas, pStreamWas->Cfg.szName));
2035	RT_NOREF(pvUser);
2036
2037	/*
2038	* See if we've got a cached config for the new device around.
2039	* We ignore this entirely, for now at least, if the device was
2040	* disconnected and there is no replacement.
2041	*/
2042	pThis->pNotifyClient->lockEnter();
2043	IMMDevice *pIDevice = pStreamWas->Cfg.enmDir == PDMAUDIODIR_IN ? pThis->pIDeviceInput : pThis->pIDeviceOutput;
2044	if (pIDevice)
2045	pIDevice->AddRef();
2046	pThis->pNotifyClient->lockLeave();
2047	if (pIDevice)
2048	{
2049	PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = NULL;
2050	int rc = drvHostAudioWasCacheLookupOrCreate(pThis, pIDevice, &pStreamWas->Cfg, false /fOnWorker/, &pDevCfg);
2051
2052	pIDevice->Release();
2053	pIDevice = NULL;
2054
2055	/*
2056	* If we have a working audio client, just do the switch.
2057	*/
2058	if (RT_SUCCESS(rc) && pDevCfg->pIAudioClient)
2059	{
2060	LogFlowFunc(("New device config is ready already!\n"));
2061	Assert(rc == VINF_SUCCESS);
2062	drvHostAudioWasCompleteStreamDevSwitch(pThis, pStreamWas, pDevCfg);
2063	}
2064	/*
2065	* Otherwise create one asynchronously on a worker thread.
2066	*/
2067	else if (RT_SUCCESS(rc))
2068	{
2069	LogFlowFunc(("New device config needs async init ...\n"));
2070	Assert(rc == VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED);
2071
2072	RTCritSectEnter(&pStreamWas->CritSect);
2073	pStreamWas->fSwitchingDevice = true;
2074	RTCritSectLeave(&pStreamWas->CritSect);
2075
2076	pThis->pIHostAudioPort->pfnStreamNotifyPreparingDeviceSwitch(pThis->pIHostAudioPort, &pStreamWas->Core);
2077
2078	rc = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, &pStreamWas->Core,
2079	DRVHOSTAUDIOWAS_DO_STREAM_DEV_SWITCH, pDevCfg);
2080	AssertRCStmt(rc, drvHostAudioWasDoStreamDevSwitch(pThis, pStreamWas, pDevCfg));
2081	}
2082	else
2083	{
2084	LogRelMax(64, ("WasAPI: Failed to create new device config '%ls:%s' for stream '%s': %Rrc\n",
2085	pDevCfg->pDevEntry->wszDevId, pDevCfg->szProps, pStreamWas->Cfg.szName, rc));
2086
2087	pThis->pIHostAudioPort->pfnStreamNotifyDeviceChanged(pThis->pIHostAudioPort, &pStreamWas->Core, true /fReInit/);
2088	}
2089	}
2090	else
2091	LogFlowFunc(("no new device, leaving it as-is\n"));
2092	}
2093
2094
2095	/**
2096	* Wrapper for starting a stream.
2097	*
2098	* @returns VBox status code.
2099	* @param pThis The WASAPI host audio driver instance data.
2100	* @param pStreamWas The stream.
2101	* @param pszOperation The operation we're doing.
2102	*/
2103	static int drvHostAudioWasStreamStartWorker(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASSTREAM pStreamWas, const char *pszOperation)
2104	{
2105	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->Start();
2106	LogFlow(("%s: Start(%s) returns %Rhrc\n", pszOperation, pStreamWas->Cfg.szName, hrc));
2107	AssertStmt(hrc != AUDCLNT_E_NOT_STOPPED, hrc = S_OK);
2108	if (SUCCEEDED(hrc))
2109	{
2110	pStreamWas->fStarted = true;
2111	return VINF_SUCCESS;
2112	}
2113
2114	/** @todo try re-setup the stuff on AUDCLNT_E_DEVICEINVALIDATED.
2115	* Need some way of telling the caller (e.g. playback, capture) so they can
2116	* retry what they're doing */
2117	RT_NOREF(pThis);
2118
2119	pStreamWas->fStarted = false;
2120	LogRelMax(64, ("WasAPI: Starting '%s' failed (%s): %Rhrc\n", pStreamWas->Cfg.szName, pszOperation, hrc));
2121	return VERR_AUDIO_STREAM_NOT_READY;
2122	}
2123
2124
2125	/**
2126	* @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamEnable}
2127	*/
2128	static DECLCALLBACK(int) drvHostAudioWasHA_StreamEnable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2129	{
2130	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
2131	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2132	LogFlowFunc(("Stream '%s' {%s}\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2133	HRESULT hrc;
2134	RTCritSectEnter(&pStreamWas->CritSect);
2135
2136	Assert(!pStreamWas->fEnabled);
2137	Assert(!pStreamWas->fStarted);
2138
2139	/*
2140	* We always reset the buffer before enabling the stream (normally never necessary).
2141	*/
2142	if (pStreamWas->cFramesCaptureToRelease)
2143	{
2144	hrc = pStreamWas->pDevCfg->pIAudioCaptureClient->ReleaseBuffer(pStreamWas->cFramesCaptureToRelease);
2145	Log4Func(("Releasing capture buffer (%#x frames): %Rhrc\n", pStreamWas->cFramesCaptureToRelease, hrc));
2146	pStreamWas->cFramesCaptureToRelease = 0;
2147	pStreamWas->pbCapture = NULL;
2148	pStreamWas->cbCapture = 0;
2149	}
2150
2151	hrc = pStreamWas->pDevCfg->pIAudioClient->Reset();
2152	if (FAILED(hrc))
2153	LogRelMax(64, ("WasAPI: Stream reset failed when enabling '%s': %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2154	pStreamWas->offInternal = 0;
2155	pStreamWas->fDraining = false;
2156	pStreamWas->fEnabled = true;
2157	pStreamWas->fRestartOnResume = false;
2158
2159	/*
2160	* Input streams will start capturing, while output streams will only start
2161	* playing once we get some audio data to play.
2162	*/
2163	int rc = VINF_SUCCESS;
2164	if (pStreamWas->Cfg.enmDir == PDMAUDIODIR_IN)
2165	rc = drvHostAudioWasStreamStartWorker(pThis, pStreamWas, "enable");
2166	else
2167	Assert(pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT);
2168
2169	RTCritSectLeave(&pStreamWas->CritSect);
2170	LogFlowFunc(("returns %Rrc\n", rc));
2171	return rc;
2172	}
2173
2174
2175	/**
2176	* @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamDisable}
2177	*/
2178	static DECLCALLBACK(int) drvHostAudioWasHA_StreamDisable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2179	{
2180	RT_NOREF(pInterface);
2181	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2182	LogFlowFunc(("cMsLastTransfer=%RI64 ms, stream '%s' {%s} \n",
2183	pStreamWas->msLastTransfer ? RTTimeMilliTS() - pStreamWas->msLastTransfer : -1,
2184	pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
2185	RTCritSectEnter(&pStreamWas->CritSect);
2186
2187	/*
2188	* Always try stop it (draining or no).
2189	*/
2190	pStreamWas->fEnabled = false;
2191	pStreamWas->fRestartOnResume = false;
2192	Assert(!pStreamWas->fDraining \|\| pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT);
2193
2194	int rc = VINF_SUCCESS;
2195	if (pStreamWas->fStarted)
2196	{
2197	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->Stop();
2198	LogFlowFunc(("Stop(%s) returns %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2199	if (FAILED(hrc))
2200	{
2201	LogRelMax(64, ("WasAPI: Stopping '%s' failed (disable): %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2202	rc = VERR_GENERAL_FAILURE;
2203	}
2204	pStreamWas->fStarted = false;
2205	pStreamWas->fDraining = false;
2206	}
2207
2208	RTCritSectLeave(&pStreamWas->CritSect);
2209	LogFlowFunc(("returns %Rrc {%s}\n", rc, drvHostWasStreamStatusString(pStreamWas)));
2210	return rc;
2211	}
2212
2213
2214	/**
2215	* @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamPause}
2216	*
2217	* @note Basically the same as drvHostAudioWasHA_StreamDisable, just w/o the
2218	* buffer resetting and fEnabled change.
2219	*/
2220	static DECLCALLBACK(int) drvHostAudioWasHA_StreamPause(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2221	{
2222	RT_NOREF(pInterface);
2223	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2224	LogFlowFunc(("cMsLastTransfer=%RI64 ms, stream '%s' {%s} \n",
2225	pStreamWas->msLastTransfer ? RTTimeMilliTS() - pStreamWas->msLastTransfer : -1,
2226	pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
2227	RTCritSectEnter(&pStreamWas->CritSect);
2228
2229	/*
2230	* Unless we're draining the stream, stop it if it's started.
2231	*/
2232	int rc = VINF_SUCCESS;
2233	if (pStreamWas->fStarted && !pStreamWas->fDraining)
2234	{
2235	pStreamWas->fRestartOnResume = true;
2236
2237	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->Stop();
2238	LogFlowFunc(("Stop(%s) returns %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2239	if (FAILED(hrc))
2240	{
2241	LogRelMax(64, ("WasAPI: Stopping '%s' failed (pause): %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2242	rc = VERR_GENERAL_FAILURE;
2243	}
2244	pStreamWas->fStarted = false;
2245	}
2246	else
2247	{
2248	pStreamWas->fRestartOnResume = false;
2249	if (pStreamWas->fDraining)
2250	{
2251	LogFunc(("Stream '%s' is draining\n", pStreamWas->Cfg.szName));
2252	Assert(pStreamWas->fStarted);
2253	}
2254	}
2255
2256	RTCritSectLeave(&pStreamWas->CritSect);
2257	LogFlowFunc(("returns %Rrc {%s}\n", rc, drvHostWasStreamStatusString(pStreamWas)));
2258	return rc;
2259	}
2260
2261
2262	/**
2263	* @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamResume}
2264	*/
2265	static DECLCALLBACK(int) drvHostAudioWasHA_StreamResume(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2266	{
2267	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
2268	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2269	LogFlowFunc(("Stream '%s' {%s}\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2270	RTCritSectEnter(&pStreamWas->CritSect);
2271
2272	/*
2273	* Resume according to state saved by drvHostAudioWasHA_StreamPause.
2274	*/
2275	int rc;
2276	if (pStreamWas->fRestartOnResume)
2277	rc = drvHostAudioWasStreamStartWorker(pThis, pStreamWas, "resume");
2278	else
2279	rc = VINF_SUCCESS;
2280	pStreamWas->fRestartOnResume = false;
2281
2282	RTCritSectLeave(&pStreamWas->CritSect);
2283	LogFlowFunc(("returns %Rrc {%s}\n", rc, drvHostWasStreamStatusString(pStreamWas)));
2284	return rc;
2285	}
2286
2287
2288	/**
2289	* @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamDrain}
2290	*/
2291	static DECLCALLBACK(int) drvHostAudioWasHA_StreamDrain(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2292	{
2293	RT_NOREF(pInterface);
2294	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2295	AssertReturn(pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT, VERR_INVALID_PARAMETER);
2296	LogFlowFunc(("cMsLastTransfer=%RI64 ms, stream '%s' {%s} \n",
2297	pStreamWas->msLastTransfer ? RTTimeMilliTS() - pStreamWas->msLastTransfer : -1,
2298	pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
2299
2300	/*
2301	* If the stram was started, calculate when the buffered data has finished
2302	* playing and switch to drain mode. DrvAudio will keep on calling
2303	* pfnStreamPlay with an empty buffer while we're draining, so we'll use
2304	* that for checking the deadline and finally stopping the stream.
2305	*/
2306	RTCritSectEnter(&pStreamWas->CritSect);
2307	int rc = VINF_SUCCESS;
2308	if (pStreamWas->fStarted)
2309	{
2310	if (!pStreamWas->fDraining)
2311	{
2312	uint64_t const msNow = RTTimeMilliTS();
2313	uint64_t msDrainDeadline = 0;
2314	UINT32 cFramesPending = 0;
2315	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->GetCurrentPadding(&cFramesPending);
2316	if (SUCCEEDED(hrc))
2317	msDrainDeadline = msNow
2318	+ PDMAudioPropsFramesToMilli(&pStreamWas->Cfg.Props,
2319	RT_MIN(cFramesPending,
2320	pStreamWas->Cfg.Backend.cFramesBufferSize * 2))
2321	+ 1 /fudge/;
2322	else
2323	{
2324	msDrainDeadline = msNow;
2325	LogRelMax(64, ("WasAPI: GetCurrentPadding fail on '%s' when starting draining: %Rhrc\n",
2326	pStreamWas->Cfg.szName, hrc));
2327	}
2328	pStreamWas->msDrainDeadline = msDrainDeadline;
2329	pStreamWas->fDraining = true;
2330	}
2331	else
2332	LogFlowFunc(("Already draining '%s' ...\n", pStreamWas->Cfg.szName));
2333	}
2334	else
2335	{
2336	LogFlowFunc(("Drain requested for '%s', but not started playback...\n", pStreamWas->Cfg.szName));
2337	AssertStmt(!pStreamWas->fDraining, pStreamWas->fDraining = false);
2338	}
2339	RTCritSectLeave(&pStreamWas->CritSect);
2340
2341	LogFlowFunc(("returns %Rrc {%s}\n", rc, drvHostWasStreamStatusString(pStreamWas)));
2342	return rc;
2343	}
2344
2345
2346	/**
2347	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamControl}
2348	*/
2349	static DECLCALLBACK(int) drvHostAudioWasHA_StreamControl(PPDMIHOSTAUDIO pInterface,
2350	PPDMAUDIOBACKENDSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
2351	{
2352	/** @todo r=bird: I'd like to get rid of this pfnStreamControl method,
2353	* replacing it with individual StreamXxxx methods. That would save us
2354	* potentally huge switches and more easily see which drivers implement
2355	* which operations (grep for pfnStreamXxxx). */
2356	switch (enmStreamCmd)
2357	{
2358	case PDMAUDIOSTREAMCMD_ENABLE:
2359	return drvHostAudioWasHA_StreamEnable(pInterface, pStream);
2360	case PDMAUDIOSTREAMCMD_DISABLE:
2361	return drvHostAudioWasHA_StreamDisable(pInterface, pStream);
2362	case PDMAUDIOSTREAMCMD_PAUSE:
2363	return drvHostAudioWasHA_StreamPause(pInterface, pStream);
2364	case PDMAUDIOSTREAMCMD_RESUME:
2365	return drvHostAudioWasHA_StreamResume(pInterface, pStream);
2366	case PDMAUDIOSTREAMCMD_DRAIN:
2367	return drvHostAudioWasHA_StreamDrain(pInterface, pStream);
2368
2369	case PDMAUDIOSTREAMCMD_END:
2370	case PDMAUDIOSTREAMCMD_32BIT_HACK:
2371	case PDMAUDIOSTREAMCMD_INVALID:
2372	/* no default*/
2373	break;
2374	}
2375	return VERR_NOT_SUPPORTED;
2376	}
2377
2378
2379	/**
2380	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetReadable}
2381	*/
2382	static DECLCALLBACK(uint32_t) drvHostAudioWasHA_StreamGetReadable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2383	{
2384	RT_NOREF(pInterface);
2385	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2386	AssertPtrReturn(pStreamWas, 0);
2387	Assert(pStreamWas->Cfg.enmDir == PDMAUDIODIR_IN);
2388
2389	uint32_t cbReadable = 0;
2390	RTCritSectEnter(&pStreamWas->CritSect);
2391
2392	if (pStreamWas->pDevCfg->pIAudioCaptureClient /* paranoia */)
2393	{
2394	UINT32 cFramesPending = 0;
2395	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->GetCurrentPadding(&cFramesPending);
2396	if (SUCCEEDED(hrc))
2397	{
2398	/* An unreleased buffer is included in the pending frame count, so subtract
2399	whatever we've got hanging around since the previous pfnStreamCapture call. */
2400	AssertMsgStmt(cFramesPending >= pStreamWas->cFramesCaptureToRelease,
2401	("%#x vs %#x\n", cFramesPending, pStreamWas->cFramesCaptureToRelease),
2402	cFramesPending = pStreamWas->cFramesCaptureToRelease);
2403	cFramesPending -= pStreamWas->cFramesCaptureToRelease;
2404
2405	/* Add what we've got left in said buffer. */
2406	uint32_t cFramesCurPacket = PDMAudioPropsBytesToFrames(&pStreamWas->Cfg.Props, pStreamWas->cbCapture);
2407	cFramesPending += cFramesCurPacket;
2408
2409	/* Paranoia: Make sure we don't exceed the buffer size. */
2410	AssertMsgStmt(cFramesPending <= pStreamWas->Cfg.Backend.cFramesBufferSize,
2411	("cFramesPending=%#x cFramesCaptureToRelease=%#x cFramesCurPacket=%#x cFramesBufferSize=%#x\n",
2412	cFramesPending, pStreamWas->cFramesCaptureToRelease, cFramesCurPacket,
2413	pStreamWas->Cfg.Backend.cFramesBufferSize),
2414	cFramesPending = pStreamWas->Cfg.Backend.cFramesBufferSize);
2415
2416	cbReadable = PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props, cFramesPending);
2417	}
2418	else
2419	LogRelMax(64, ("WasAPI: GetCurrentPadding failed on '%s': %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2420	}
2421
2422	RTCritSectLeave(&pStreamWas->CritSect);
2423
2424	LogFlowFunc(("returns %#x (%u) {%s}\n", cbReadable, cbReadable, drvHostWasStreamStatusString(pStreamWas)));
2425	return cbReadable;
2426	}
2427
2428
2429	/**
2430	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetWritable}
2431	*/
2432	static DECLCALLBACK(uint32_t) drvHostAudioWasHA_StreamGetWritable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2433	{
2434	RT_NOREF(pInterface);
2435	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2436	AssertPtrReturn(pStreamWas, 0);
2437	LogFlowFunc(("Stream '%s' {%s}\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2438	Assert(pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT);
2439
2440	uint32_t cbWritable = 0;
2441	RTCritSectEnter(&pStreamWas->CritSect);
2442
2443	if ( pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT
2444	&& pStreamWas->pDevCfg->pIAudioClient /* paranoia */)
2445	{
2446	UINT32 cFramesPending = 0;
2447	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->GetCurrentPadding(&cFramesPending);
2448	if (SUCCEEDED(hrc))
2449	{
2450	if (cFramesPending < pStreamWas->Cfg.Backend.cFramesBufferSize)
2451	cbWritable = PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props,
2452	pStreamWas->Cfg.Backend.cFramesBufferSize - cFramesPending);
2453	else if (cFramesPending > pStreamWas->Cfg.Backend.cFramesBufferSize)
2454	{
2455	LogRelMax(64, ("WasAPI: Warning! GetCurrentPadding('%s') return too high: cFramesPending=%#x > cFramesBufferSize=%#x\n",
2456	pStreamWas->Cfg.szName, cFramesPending, pStreamWas->Cfg.Backend.cFramesBufferSize));
2457	AssertMsgFailed(("cFramesPending=%#x > cFramesBufferSize=%#x\n",
2458	cFramesPending, pStreamWas->Cfg.Backend.cFramesBufferSize));
2459	}
2460	}
2461	else
2462	LogRelMax(64, ("WasAPI: GetCurrentPadding failed on '%s': %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2463	}
2464
2465	RTCritSectLeave(&pStreamWas->CritSect);
2466
2467	LogFlowFunc(("returns %#x (%u) {%s}\n", cbWritable, cbWritable, drvHostWasStreamStatusString(pStreamWas)));
2468	return cbWritable;
2469	}
2470
2471
2472	/**
2473	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetPending}
2474	*/
2475	static DECLCALLBACK(uint32_t) drvHostAudioWasHA_StreamGetPending(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
2476	{
2477	RT_NOREF(pInterface);
2478	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2479	AssertPtrReturn(pStreamWas, 0);
2480	LogFlowFunc(("Stream '%s' {%s}\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2481	AssertReturn(pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT, 0);
2482
2483	uint32_t cbPending = 0;
2484	RTCritSectEnter(&pStreamWas->CritSect);
2485
2486	if ( pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT
2487	&& pStreamWas->pDevCfg->pIAudioClient /* paranoia */)
2488	{
2489	if (pStreamWas->fStarted)
2490	{
2491	UINT32 cFramesPending = 0;
2492	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->GetCurrentPadding(&cFramesPending);
2493	if (SUCCEEDED(hrc))
2494	{
2495	AssertMsg(cFramesPending <= pStreamWas->Cfg.Backend.cFramesBufferSize,
2496	("cFramesPending=%#x cFramesBufferSize=%#x\n",
2497	cFramesPending, pStreamWas->Cfg.Backend.cFramesBufferSize));
2498	cbPending = PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props, RT_MIN(cFramesPending, VBOX_WASAPI_MAX_PADDING));
2499	}
2500	else
2501	LogRelMax(64, ("WasAPI: GetCurrentPadding failed on '%s': %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2502	}
2503	}
2504
2505	RTCritSectLeave(&pStreamWas->CritSect);
2506
2507	LogFlowFunc(("returns %#x (%u) {%s}\n", cbPending, cbPending, drvHostWasStreamStatusString(pStreamWas)));
2508	return cbPending;
2509	}
2510
2511
2512	/**
2513	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetState}
2514	*/
2515	static DECLCALLBACK(PDMHOSTAUDIOSTREAMSTATE) drvHostAudioWasHA_StreamGetState(PPDMIHOSTAUDIO pInterface,
2516	PPDMAUDIOBACKENDSTREAM pStream)
2517	{
2518	RT_NOREF(pInterface);
2519	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2520	AssertPtrReturn(pStreamWas, PDMHOSTAUDIOSTREAMSTATE_INVALID);
2521
2522	PDMHOSTAUDIOSTREAMSTATE enmState;
2523	AssertPtr(pStreamWas->pDevCfg);
2524	if (pStreamWas->pDevCfg /paranoia/)
2525	{
2526	if (RT_SUCCESS(pStreamWas->pDevCfg->rcSetup))
2527	{
2528	if (!pStreamWas->fDraining)
2529	enmState = PDMHOSTAUDIOSTREAMSTATE_OKAY;
2530	else
2531	{
2532	Assert(pStreamWas->Cfg.enmDir == PDMAUDIODIR_OUT);
2533	enmState = PDMHOSTAUDIOSTREAMSTATE_DRAINING;
2534	}
2535	}
2536	else if ( pStreamWas->pDevCfg->rcSetup == VERR_AUDIO_STREAM_INIT_IN_PROGRESS
2537	\|\| pStreamWas->fSwitchingDevice )
2538	enmState = PDMHOSTAUDIOSTREAMSTATE_INITIALIZING;
2539	else
2540	enmState = PDMHOSTAUDIOSTREAMSTATE_NOT_WORKING;
2541	}
2542	else if (pStreamWas->fSwitchingDevice)
2543	enmState = PDMHOSTAUDIOSTREAMSTATE_INITIALIZING;
2544	else
2545	enmState = PDMHOSTAUDIOSTREAMSTATE_NOT_WORKING;
2546
2547	LogFlowFunc(("returns %d for '%s' {%s}\n", enmState, pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2548	return enmState;
2549	}
2550
2551
2552	/**
2553	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamPlay}
2554	*/
2555	static DECLCALLBACK(int) drvHostAudioWasHA_StreamPlay(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
2556	const void pvBuf, uint32_t cbBuf, uint32_t pcbWritten)
2557	{
2558	PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
2559	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2560	AssertPtrReturn(pStreamWas, VERR_INVALID_POINTER);
2561	AssertPtrReturn(pcbWritten, VERR_INVALID_POINTER);
2562	if (cbBuf)
2563	AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
2564	Assert(PDMAudioPropsIsSizeAligned(&pStreamWas->Cfg.Props, cbBuf));
2565
2566	RTCritSectEnter(&pStreamWas->CritSect);
2567	if (pStreamWas->fEnabled)
2568	{ /* likely */ }
2569	else
2570	{
2571	RTCritSectLeave(&pStreamWas->CritSect);
2572	*pcbWritten = 0;
2573	LogFunc(("Skipping %#x byte write to disabled stream {%s}\n", cbBuf, drvHostWasStreamStatusString(pStreamWas)));
2574	return VINF_SUCCESS;
2575	}
2576	Log4Func(("cbBuf=%#x stream '%s' {%s}\n", cbBuf, pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
2577
2578	/*
2579	* Transfer loop.
2580	*/
2581	int rc = VINF_SUCCESS;
2582	uint32_t cReInits = 0;
2583	uint32_t cbWritten = 0;
2584	while (cbBuf > 0)
2585	{
2586	AssertBreakStmt(pStreamWas->pDevCfg && pStreamWas->pDevCfg->pIAudioRenderClient && pStreamWas->pDevCfg->pIAudioClient,
2587	rc = VERR_AUDIO_STREAM_NOT_READY);
2588
2589	/*
2590	* Figure out how much we can possibly write.
2591	*/
2592	UINT32 cFramesPending = 0;
2593	uint32_t cbWritable = 0;
2594	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->GetCurrentPadding(&cFramesPending);
2595	if (SUCCEEDED(hrc))
2596	cbWritable = PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props,
2597	pStreamWas->Cfg.Backend.cFramesBufferSize
2598	- RT_MIN(cFramesPending, pStreamWas->Cfg.Backend.cFramesBufferSize));
2599	else
2600	{
2601	LogRelMax(64, ("WasAPI: GetCurrentPadding(%s) failed during playback: %Rhrc (@%#RX64)\n",
2602	pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2603	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2604	rc = VERR_AUDIO_STREAM_NOT_READY;
2605	break;
2606	}
2607	if (cbWritable <= PDMAudioPropsFrameSize(&pStreamWas->Cfg.Props))
2608	break;
2609
2610	uint32_t const cbToWrite = PDMAudioPropsFloorBytesToFrame(&pStreamWas->Cfg.Props, RT_MIN(cbWritable, cbBuf));
2611	uint32_t const cFramesToWrite = PDMAudioPropsBytesToFrames(&pStreamWas->Cfg.Props, cbToWrite);
2612	Assert(PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props, cFramesToWrite) == cbToWrite);
2613	Log3Func(("@%#RX64: cFramesPending=%#x -> cbWritable=%#x cbToWrite=%#x cFramesToWrite=%#x {%s}\n",
2614	pStreamWas->offInternal, cFramesPending, cbWritable, cbToWrite, cFramesToWrite,
2615	drvHostWasStreamStatusString(pStreamWas) ));
2616
2617	/*
2618	* Get the buffer, copy the data into it, and relase it back to the WAS machinery.
2619	*/
2620	BYTE *pbData = NULL;
2621	hrc = pStreamWas->pDevCfg->pIAudioRenderClient->GetBuffer(cFramesToWrite, &pbData);
2622	if (SUCCEEDED(hrc))
2623	{
2624	memcpy(pbData, pvBuf, cbToWrite);
2625	hrc = pStreamWas->pDevCfg->pIAudioRenderClient->ReleaseBuffer(cFramesToWrite, 0 /fFlags/);
2626	if (SUCCEEDED(hrc))
2627	{
2628	/*
2629	* Before we advance the buffer position (so we can resubmit it
2630	* after re-init), make sure we've successfully started stream.
2631	*/
2632	if (pStreamWas->fStarted)
2633	{ }
2634	else
2635	{
2636	rc = drvHostAudioWasStreamStartWorker(pThis, pStreamWas, "play");
2637	if (rc == VINF_SUCCESS)
2638	{ /* likely */ }
2639	else if (RT_SUCCESS(rc) && ++cReInits < 5)
2640	continue; /* re-submit buffer after re-init */
2641	else
2642	break;
2643	}
2644
2645	/* advance. */
2646	pvBuf = (uint8_t *)pvBuf + cbToWrite;
2647	cbBuf -= cbToWrite;
2648	cbWritten += cbToWrite;
2649	pStreamWas->offInternal += cbToWrite;
2650	}
2651	else
2652	{
2653	LogRelMax(64, ("WasAPI: ReleaseBuffer(%#x) failed on '%s' during playback: %Rhrc (@%#RX64)\n",
2654	cFramesToWrite, pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2655	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2656	rc = VERR_AUDIO_STREAM_NOT_READY;
2657	break;
2658	}
2659	}
2660	else
2661	{
2662	LogRelMax(64, ("WasAPI: GetBuffer(%#x) failed on '%s' during playback: %Rhrc (@%#RX64)\n",
2663	cFramesToWrite, pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2664	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2665	rc = VERR_AUDIO_STREAM_NOT_READY;
2666	break;
2667	}
2668	}
2669
2670	/*
2671	* Do draining deadline processing.
2672	*/
2673	uint64_t const msNow = RTTimeMilliTS();
2674	if ( !pStreamWas->fDraining
2675	\|\| msNow < pStreamWas->msDrainDeadline)
2676	{ /* likely */ }
2677	else
2678	{
2679	LogRel2(("WasAPI: Stopping draining of '%s' {%s} ...\n", pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas)));
2680	HRESULT hrc = pStreamWas->pDevCfg->pIAudioClient->Stop();
2681	if (FAILED(hrc))
2682	LogRelMax(64, ("WasAPI: Failed to stop draining stream '%s': %Rhrc\n", pStreamWas->Cfg.szName, hrc));
2683	pStreamWas->fDraining = false;
2684	pStreamWas->fStarted = false;
2685	}
2686
2687	/*
2688	* Done.
2689	*/
2690	uint64_t const msPrev = pStreamWas->msLastTransfer;
2691	if (cbWritten)
2692	pStreamWas->msLastTransfer = msNow;
2693
2694	RTCritSectLeave(&pStreamWas->CritSect);
2695
2696	*pcbWritten = cbWritten;
2697	if (RT_SUCCESS(rc) \|\| !cbWritten)
2698	{ }
2699	else
2700	{
2701	LogFlowFunc(("Suppressing %Rrc to report %#x bytes written\n", rc, cbWritten));
2702	rc = VINF_SUCCESS;
2703	}
2704	LogFlowFunc(("@%#RX64: rc=%Rrc cbWritten=%RU32 cMsDelta=%RU64 (%RU64 -> %RU64) {%s}\n", pStreamWas->offInternal, rc, cbWritten,
2705	msPrev ? msNow - msPrev : 0, msPrev, pStreamWas->msLastTransfer, drvHostWasStreamStatusString(pStreamWas) ));
2706	return rc;
2707	}
2708
2709
2710	/**
2711	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCapture}
2712	*/
2713	static DECLCALLBACK(int) drvHostAudioWasHA_StreamCapture(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
2714	void pvBuf, uint32_t cbBuf, uint32_t pcbRead)
2715	{
2716	RT_NOREF(pInterface); //PDRVHOSTAUDIOWAS pThis = RT_FROM_MEMBER(pInterface, DRVHOSTAUDIOWAS, IHostAudio);
2717	PDRVHOSTAUDIOWASSTREAM pStreamWas = (PDRVHOSTAUDIOWASSTREAM)pStream;
2718	AssertPtrReturn(pStreamWas, 0);
2719	AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
2720	AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
2721	AssertPtrReturn(pcbRead, VERR_INVALID_POINTER);
2722	Assert(PDMAudioPropsIsSizeAligned(&pStreamWas->Cfg.Props, cbBuf));
2723
2724	RTCritSectEnter(&pStreamWas->CritSect);
2725	if (pStreamWas->fEnabled)
2726	{ /* likely */ }
2727	else
2728	{
2729	RTCritSectLeave(&pStreamWas->CritSect);
2730	*pcbRead = 0;
2731	LogFunc(("Skipping %#x byte read from disabled stream {%s}\n", cbBuf, drvHostWasStreamStatusString(pStreamWas)));
2732	return VINF_SUCCESS;
2733	}
2734	Log4Func(("cbBuf=%#x stream '%s' {%s}\n", cbBuf, pStreamWas->Cfg.szName, drvHostWasStreamStatusString(pStreamWas) ));
2735
2736
2737	/*
2738	* Transfer loop.
2739	*/
2740	int rc = VINF_SUCCESS;
2741	uint32_t cbRead = 0;
2742	uint32_t const cbFrame = PDMAudioPropsFrameSize(&pStreamWas->Cfg.Props);
2743	while (cbBuf >= cbFrame)
2744	{
2745	AssertBreakStmt(pStreamWas->pDevCfg->pIAudioCaptureClient && pStreamWas->pDevCfg->pIAudioClient, rc = VERR_AUDIO_STREAM_NOT_READY);
2746
2747	/*
2748	* Anything pending from last call?
2749	* (This is rather similar to the Pulse interface.)
2750	*/
2751	if (pStreamWas->cFramesCaptureToRelease)
2752	{
2753	uint32_t const cbToCopy = RT_MIN(pStreamWas->cbCapture, cbBuf);
2754	memcpy(pvBuf, pStreamWas->pbCapture, cbToCopy);
2755	pvBuf = (uint8_t *)pvBuf + cbToCopy;
2756	cbBuf -= cbToCopy;
2757	cbRead += cbToCopy;
2758	pStreamWas->offInternal += cbToCopy;
2759	pStreamWas->pbCapture += cbToCopy;
2760	pStreamWas->cbCapture -= cbToCopy;
2761	if (!pStreamWas->cbCapture)
2762	{
2763	HRESULT hrc = pStreamWas->pDevCfg->pIAudioCaptureClient->ReleaseBuffer(pStreamWas->cFramesCaptureToRelease);
2764	Log4Func(("@%#RX64: Releasing capture buffer (%#x frames): %Rhrc\n",
2765	pStreamWas->offInternal, pStreamWas->cFramesCaptureToRelease, hrc));
2766	if (SUCCEEDED(hrc))
2767	{
2768	pStreamWas->cFramesCaptureToRelease = 0;
2769	pStreamWas->pbCapture = NULL;
2770	}
2771	else
2772	{
2773	LogRelMax(64, ("WasAPI: ReleaseBuffer(%s) failed during capture: %Rhrc (@%#RX64)\n",
2774	pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2775	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2776	rc = VERR_AUDIO_STREAM_NOT_READY;
2777	break;
2778	}
2779	}
2780	if (cbBuf < cbFrame)
2781	break;
2782	}
2783
2784	/*
2785	* Figure out if there is any data available to be read now. (Docs hint that we can not
2786	* skip this and go straight for GetBuffer or we risk getting unwritten buffer space back).
2787	*/
2788	UINT32 cFramesCaptured = 0;
2789	HRESULT hrc = pStreamWas->pDevCfg->pIAudioCaptureClient->GetNextPacketSize(&cFramesCaptured);
2790	if (SUCCEEDED(hrc))
2791	{
2792	if (!cFramesCaptured)
2793	break;
2794	}
2795	else
2796	{
2797	LogRelMax(64, ("WasAPI: GetNextPacketSize(%s) failed during capture: %Rhrc (@%#RX64)\n",
2798	pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2799	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2800	rc = VERR_AUDIO_STREAM_NOT_READY;
2801	break;
2802	}
2803
2804	/*
2805	* Get the buffer.
2806	*/
2807	cFramesCaptured = 0;
2808	UINT64 uQpsNtTicks = 0;
2809	UINT64 offDevice = 0;
2810	DWORD fBufFlags = 0;
2811	BYTE *pbData = NULL;
2812	hrc = pStreamWas->pDevCfg->pIAudioCaptureClient->GetBuffer(&pbData, &cFramesCaptured, &fBufFlags, &offDevice, &uQpsNtTicks);
2813	Log4Func(("@%#RX64: GetBuffer -> %Rhrc pbData=%p cFramesCaptured=%#x fBufFlags=%#x offDevice=%#RX64 uQpcNtTicks=%#RX64\n",
2814	pStreamWas->offInternal, hrc, pbData, cFramesCaptured, fBufFlags, offDevice, uQpsNtTicks));
2815	if (SUCCEEDED(hrc))
2816	{
2817	Assert(cFramesCaptured < VBOX_WASAPI_MAX_PADDING);
2818	pStreamWas->pbCapture = pbData;
2819	pStreamWas->cFramesCaptureToRelease = cFramesCaptured;
2820	pStreamWas->cbCapture = PDMAudioPropsFramesToBytes(&pStreamWas->Cfg.Props, cFramesCaptured);
2821	/* Just loop and re-use the copying code above. Can optimize later. */
2822	}
2823	else
2824	{
2825	LogRelMax(64, ("WasAPI: GetBuffer() failed on '%s' during capture: %Rhrc (@%#RX64)\n",
2826	pStreamWas->Cfg.szName, hrc, pStreamWas->offInternal));
2827	/** @todo reinit on AUDCLNT_E_DEVICEINVALIDATED? */
2828	rc = VERR_AUDIO_STREAM_NOT_READY;
2829	break;
2830	}
2831	}
2832
2833	/*
2834	* Done.
2835	*/
2836	uint64_t const msPrev = pStreamWas->msLastTransfer;
2837	uint64_t const msNow = RTTimeMilliTS();
2838	if (cbRead)
2839	pStreamWas->msLastTransfer = msNow;
2840
2841	RTCritSectLeave(&pStreamWas->CritSect);
2842
2843	*pcbRead = cbRead;
2844	if (RT_SUCCESS(rc) \|\| !cbRead)
2845	{ }
2846	else
2847	{
2848	LogFlowFunc(("Suppressing %Rrc to report %#x bytes read\n", rc, cbRead));
2849	rc = VINF_SUCCESS;
2850	}
2851	LogFlowFunc(("@%#RX64: rc=%Rrc cbRead=%#RX32 cMsDelta=%RU64 (%RU64 -> %RU64) {%s}\n", pStreamWas->offInternal, rc, cbRead,
2852	msPrev ? msNow - msPrev : 0, msPrev, pStreamWas->msLastTransfer, drvHostWasStreamStatusString(pStreamWas) ));
2853	return rc;
2854	}
2855
2856
2857	/*********************************************************************************************************************************
2858	* PDMDRVINS::IBase Interface *
2859	*********************************************************************************************************************************/
2860
2861	/**
2862	* @callback_method_impl{PDMIBASE,pfnQueryInterface}
2863	*/
2864	static DECLCALLBACK(void ) drvHostAudioWasQueryInterface(PPDMIBASE pInterface, const char pszIID)
2865	{
2866	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
2867	PDRVHOSTAUDIOWAS pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTAUDIOWAS);
2868
2869	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
2870	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHOSTAUDIO, &pThis->IHostAudio);
2871	return NULL;
2872	}
2873
2874
2875	/*********************************************************************************************************************************
2876	* PDMDRVREG Interface *
2877	*********************************************************************************************************************************/
2878
2879	/**
2880	* @callback_method_impl{FNPDMDRVDESTRUCT, pfnDestruct}
2881	*/
2882	static DECLCALLBACK(void) drvHostAudioWasPowerOff(PPDMDRVINS pDrvIns)
2883	{
2884	PDRVHOSTAUDIOWAS pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTAUDIOWAS);
2885
2886	/*
2887	* Start purging the cache asynchronously before we get to destruct.
2888	* This might speed up VM shutdown a tiny fraction and also stress
2889	* the shutting down of the thread pool a little.
2890	*/
2891	#if 0
2892	if (pThis->hWorkerThread != NIL_RTTHREAD)
2893	{
2894	BOOL fRc = PostThreadMessageW(pThis->idWorkerThread, WM_DRVHOSTAUDIOWAS_PURGE_CACHE, pThis->uWorkerThreadFixedParam, 0);
2895	LogFlowFunc(("Posted WM_DRVHOSTAUDIOWAS_PURGE_CACHE: %d\n", fRc));
2896	Assert(fRc); RT_NOREF(fRc);
2897	}
2898	#else
2899	if (!RTListIsEmpty(&pThis->CacheHead) && pThis->pIHostAudioPort)
2900	{
2901	int rc = RTSemEventMultiCreate(&pThis->hEvtCachePurge);
2902	if (RT_SUCCESS(rc))
2903	{
2904	rc = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL/pStream/,
2905	DRVHOSTAUDIOWAS_DO_PURGE_CACHE, NULL /pvUser/);
2906	if (RT_FAILURE(rc))
2907	{
2908	LogFunc(("pfnDoOnWorkerThread/DRVHOSTAUDIOWAS_DO_PURGE_CACHE failed: %Rrc\n", rc));
2909	RTSemEventMultiDestroy(pThis->hEvtCachePurge);
2910	pThis->hEvtCachePurge = NIL_RTSEMEVENTMULTI;
2911	}
2912	}
2913	}
2914	#endif
2915
2916	/*
2917	* Deregister the notification client to reduce the risk of notifications
2918	* comming in while we're being detatched or the VM is being destroyed.
2919	*/
2920	if (pThis->pNotifyClient)
2921	{
2922	pThis->pNotifyClient->notifyDriverDestroyed();
2923	pThis->pIEnumerator->UnregisterEndpointNotificationCallback(pThis->pNotifyClient);
2924	pThis->pNotifyClient->Release();
2925	pThis->pNotifyClient = NULL;
2926	}
2927	}
2928
2929
2930	/**
2931	* @callback_method_impl{FNPDMDRVDESTRUCT, pfnDestruct}
2932	*/
2933	static DECLCALLBACK(void) drvHostAudioWasDestruct(PPDMDRVINS pDrvIns)
2934	{
2935	PDRVHOSTAUDIOWAS pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTAUDIOWAS);
2936	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
2937	LogFlowFuncEnter();
2938
2939	/*
2940	* Release the notification client first.
2941	*/
2942	if (pThis->pNotifyClient)
2943	{
2944	pThis->pNotifyClient->notifyDriverDestroyed();
2945	pThis->pIEnumerator->UnregisterEndpointNotificationCallback(pThis->pNotifyClient);
2946	pThis->pNotifyClient->Release();
2947	pThis->pNotifyClient = NULL;
2948	}
2949
2950	#if 0
2951	if (pThis->hWorkerThread != NIL_RTTHREAD)
2952	{
2953	BOOL fRc = PostThreadMessageW(pThis->idWorkerThread, WM_QUIT, 0, 0);
2954	Assert(fRc); RT_NOREF(fRc);
2955
2956	int rc = RTThreadWait(pThis->hWorkerThread, RT_MS_15SEC, NULL);
2957	AssertRC(rc);
2958	}
2959	#endif
2960
2961	if (RTCritSectIsInitialized(&pThis->CritSectCache))
2962	{
2963	drvHostAudioWasCachePurge(pThis, false /fOnWorker/);
2964	if (pThis->hEvtCachePurge != NIL_RTSEMEVENTMULTI)
2965	RTSemEventMultiWait(pThis->hEvtCachePurge, RT_MS_30SEC);
2966	RTCritSectDelete(&pThis->CritSectCache);
2967	}
2968
2969	if (pThis->hEvtCachePurge != NIL_RTSEMEVENTMULTI)
2970	{
2971	RTSemEventMultiDestroy(pThis->hEvtCachePurge);
2972	pThis->hEvtCachePurge = NIL_RTSEMEVENTMULTI;
2973	}
2974
2975	if (pThis->pIEnumerator)
2976	{
2977	uint32_t cRefs = pThis->pIEnumerator->Release(); RT_NOREF(cRefs);
2978	LogFlowFunc(("cRefs=%d\n", cRefs));
2979	}
2980
2981	if (pThis->pIDeviceOutput)
2982	{
2983	pThis->pIDeviceOutput->Release();
2984	pThis->pIDeviceOutput = NULL;
2985	}
2986
2987	if (pThis->pIDeviceInput)
2988	{
2989	pThis->pIDeviceInput->Release();
2990	pThis->pIDeviceInput = NULL;
2991	}
2992
2993
2994	if (RTCritSectRwIsInitialized(&pThis->CritSectStreamList))
2995	RTCritSectRwDelete(&pThis->CritSectStreamList);
2996
2997	LogFlowFuncLeave();
2998	}
2999
3000
3001	/**
3002	* @callback_method_impl{FNPDMDRVCONSTRUCT, pfnConstruct}
3003	*/
3004	static DECLCALLBACK(int) drvHostAudioWasConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
3005	{
3006	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
3007	PDRVHOSTAUDIOWAS pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTAUDIOWAS);
3008	RT_NOREF(fFlags, pCfg);
3009
3010	/*
3011	* Init basic data members and interfaces.
3012	*/
3013	pThis->pDrvIns = pDrvIns;
3014	pThis->hEvtCachePurge = NIL_RTSEMEVENTMULTI;
3015	#if 0
3016	pThis->hWorkerThread = NIL_RTTHREAD;
3017	pThis->idWorkerThread = 0;
3018	#endif
3019	RTListInit(&pThis->StreamHead);
3020	RTListInit(&pThis->CacheHead);
3021	/* IBase */
3022	pDrvIns->IBase.pfnQueryInterface = drvHostAudioWasQueryInterface;
3023	/* IHostAudio */
3024	pThis->IHostAudio.pfnGetConfig = drvHostAudioWasHA_GetConfig;
3025	pThis->IHostAudio.pfnGetDevices = drvHostAudioWasHA_GetDevices;
3026	pThis->IHostAudio.pfnSetDevice = NULL;
3027	pThis->IHostAudio.pfnGetStatus = drvHostAudioWasHA_GetStatus;
3028	pThis->IHostAudio.pfnDoOnWorkerThread = drvHostAudioWasHA_DoOnWorkerThread;
3029	pThis->IHostAudio.pfnStreamConfigHint = drvHostAudioWasHA_StreamConfigHint;
3030	pThis->IHostAudio.pfnStreamCreate = drvHostAudioWasHA_StreamCreate;
3031	pThis->IHostAudio.pfnStreamInitAsync = drvHostAudioWasHA_StreamInitAsync;
3032	pThis->IHostAudio.pfnStreamDestroy = drvHostAudioWasHA_StreamDestroy;
3033	pThis->IHostAudio.pfnStreamNotifyDeviceChanged = drvHostAudioWasHA_StreamNotifyDeviceChanged;
3034	pThis->IHostAudio.pfnStreamControl = drvHostAudioWasHA_StreamControl;
3035	pThis->IHostAudio.pfnStreamGetReadable = drvHostAudioWasHA_StreamGetReadable;
3036	pThis->IHostAudio.pfnStreamGetWritable = drvHostAudioWasHA_StreamGetWritable;
3037	pThis->IHostAudio.pfnStreamGetPending = drvHostAudioWasHA_StreamGetPending;
3038	pThis->IHostAudio.pfnStreamGetState = drvHostAudioWasHA_StreamGetState;
3039	pThis->IHostAudio.pfnStreamPlay = drvHostAudioWasHA_StreamPlay;
3040	pThis->IHostAudio.pfnStreamCapture = drvHostAudioWasHA_StreamCapture;
3041
3042	/*
3043	* Validate and read the configuration.
3044	*/
3045	PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "VmName\|VmUuid", "");
3046	/** @todo make it possible to override the default device selection. */
3047
3048	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
3049	("Configuration error: Not possible to attach anything to this driver!\n"),
3050	VERR_PDM_DRVINS_NO_ATTACH);
3051
3052	/*
3053	* Initialize the critical sections early.
3054	*/
3055	int rc = RTCritSectRwInit(&pThis->CritSectStreamList);
3056	AssertRCReturn(rc, rc);
3057
3058	rc = RTCritSectInit(&pThis->CritSectCache);
3059	AssertRCReturn(rc, rc);
3060
3061	/*
3062	* Create an enumerator instance that we can get the default devices from
3063	* as well as do enumeration thru.
3064	*/
3065	HRESULT hrc = CoCreateInstance(__uuidof(MMDeviceEnumerator), 0, CLSCTX_ALL, __uuidof(IMMDeviceEnumerator),
3066	(void **)&pThis->pIEnumerator);
3067	if (FAILED(hrc))
3068	{
3069	pThis->pIEnumerator = NULL;
3070	LogRel(("WasAPI: Failed to create an MMDeviceEnumerator object: %Rhrc\n", hrc));
3071	return VERR_AUDIO_BACKEND_INIT_FAILED;
3072	}
3073	AssertPtr(pThis->pIEnumerator);
3074
3075	/*
3076	* Resolve the interface to the driver above us.
3077	*/
3078	pThis->pIHostAudioPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIHOSTAUDIOPORT);
3079	AssertPtrReturn(pThis->pIHostAudioPort, VERR_PDM_MISSING_INTERFACE_ABOVE);
3080
3081	/*
3082	* Instantiate and register the notification client with the enumerator.
3083	*
3084	* Failure here isn't considered fatal at this time as we'll just miss
3085	* default device changes.
3086	*/
3087	try
3088	{
3089	pThis->pNotifyClient = new DrvHostAudioWasMmNotifyClient(pThis);
3090	}
3091	catch (std::bad_alloc &)
3092	{
3093	return VERR_NO_MEMORY;
3094	}
3095	catch (int rcXcpt)
3096	{
3097	return rcXcpt;
3098	}
3099	hrc = pThis->pIEnumerator->RegisterEndpointNotificationCallback(pThis->pNotifyClient);
3100	AssertMsg(SUCCEEDED(hrc), ("%Rhrc\n", hrc));
3101	if (FAILED(hrc))
3102	{
3103	LogRel(("WasAPI: RegisterEndpointNotificationCallback failed: %Rhrc (ignored)\n"
3104	"WasAPI: Warning! Will not be able to detect default device changes!\n"));
3105	pThis->pNotifyClient->notifyDriverDestroyed();
3106	pThis->pNotifyClient->Release();
3107	pThis->pNotifyClient = NULL;
3108	}
3109
3110	/*
3111	* Retrieve the input and output device.
3112	*/
3113	IMMDevice *pIDeviceInput = NULL;
3114	if (pThis->pwszInputDevId)
3115	hrc = pThis->pIEnumerator->GetDevice(pThis->pwszInputDevId, &pIDeviceInput);
3116	else
3117	hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(eCapture, eMultimedia, &pIDeviceInput);
3118	if (SUCCEEDED(hrc))
3119	LogFlowFunc(("pIDeviceInput=%p\n", pIDeviceInput));
3120	else
3121	{
3122	LogRel(("WasAPI: Failed to get audio input device '%ls': %Rhrc\n",
3123	pThis->pwszInputDevId ? pThis->pwszInputDevId : L"{Default}", hrc));
3124	pIDeviceInput = NULL;
3125	}
3126
3127	IMMDevice *pIDeviceOutput = NULL;
3128	if (pThis->pwszOutputDevId)
3129	hrc = pThis->pIEnumerator->GetDevice(pThis->pwszOutputDevId, &pIDeviceOutput);
3130	else
3131	hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(eRender, eMultimedia, &pIDeviceOutput);
3132	if (SUCCEEDED(hrc))
3133	LogFlowFunc(("pIDeviceOutput=%p\n", pIDeviceOutput));
3134	else
3135	{
3136	LogRel(("WasAPI: Failed to get audio output device '%ls': %Rhrc\n",
3137	pThis->pwszOutputDevId ? pThis->pwszOutputDevId : L"{Default}", hrc));
3138	pIDeviceOutput = NULL;
3139	}
3140
3141	/* Carefully place them in the instance data: */
3142	pThis->pNotifyClient->lockEnter();
3143
3144	if (pThis->pIDeviceInput)
3145	pThis->pIDeviceInput->Release();
3146	pThis->pIDeviceInput = pIDeviceInput;
3147
3148	if (pThis->pIDeviceOutput)
3149	pThis->pIDeviceOutput->Release();
3150	pThis->pIDeviceOutput = pIDeviceOutput;
3151
3152	pThis->pNotifyClient->lockLeave();
3153
3154	#if 0
3155	/*
3156	* Create the worker thread. This thread has a message loop and will be
3157	* signalled by DrvHostAudioWasMmNotifyClient while the VM is paused/whatever,
3158	* so better make it a regular thread rather than PDM thread.
3159	*/
3160	pThis->uWorkerThreadFixedParam = (WPARAM)RTRandU64();
3161	rc = RTThreadCreateF(&pThis->hWorkerThread, drvHostWasWorkerThread, pThis, 0 /cbStack/, RTTHREADTYPE_DEFAULT,
3162	RTTHREADFLAGS_WAITABLE \| RTTHREADFLAGS_COM_MTA, "WasWork%u", pDrvIns->iInstance);
3163	AssertRCReturn(rc, rc);
3164
3165	rc = RTThreadUserWait(pThis->hWorkerThread, RT_MS_10SEC);
3166	AssertRC(rc);
3167	#endif
3168
3169	/*
3170	* Prime the cache.
3171	*/
3172	drvHostAudioWasCacheFill(pThis);
3173
3174	return VINF_SUCCESS;
3175	}
3176
3177
3178	/**
3179	* PDM driver registration for WasAPI.
3180	*/
3181	const PDMDRVREG g_DrvHostAudioWas =
3182	{
3183	/* u32Version */
3184	PDM_DRVREG_VERSION,
3185	/* szName */
3186	"HostAudioWas",
3187	/* szRCMod */
3188	"",
3189	/* szR0Mod */
3190	"",
3191	/* pszDescription */
3192	"Windows Audio Session API (WASAPI) host audio driver",
3193	/* fFlags */
3194	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
3195	/* fClass. */
3196	PDM_DRVREG_CLASS_AUDIO,
3197	/* cMaxInstances */
3198	~0U,
3199	/* cbInstance */
3200	sizeof(DRVHOSTAUDIOWAS),
3201	/* pfnConstruct */
3202	drvHostAudioWasConstruct,
3203	/* pfnDestruct */
3204	drvHostAudioWasDestruct,
3205	/* pfnRelocate */
3206	NULL,
3207	/* pfnIOCtl */
3208	NULL,
3209	/* pfnPowerOn */
3210	NULL,
3211	/* pfnReset */
3212	NULL,
3213	/* pfnSuspend */
3214	NULL,
3215	/* pfnResume */
3216	NULL,
3217	/* pfnAttach */
3218	NULL,
3219	/* pfnDetach */
3220	NULL,
3221	/* pfnPowerOff */
3222	drvHostAudioWasPowerOff,
3223	/* pfnSoftReset */
3224	NULL,
3225	/* u32EndVersion */
3226	PDM_DRVREG_VERSION
3227	};
3228

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/Audio/DrvHostAudioWasApi.cpp@ 89487

Download in other formats: