DrvHostAudioPulseAudio.cpp@ 89518

Last change on this file since 89518 was 89510, checked in by vboxsync, 4 years ago
Audio: Split up PDMIHOSTAUDIO::pfnStreamControl into individual methods for each command. bugref:9890
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 82.6 KB

Line
1	/* $Id: DrvHostAudioPulseAudio.cpp 89510 2021-06-04 13:20:02Z vboxsync $ */
2	/** @file
3	* Host audio driver - Pulse Audio.
4	*/
5
6	/*
7	* Copyright (C) 2006-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	#include <VBox/log.h>
24	#include <VBox/vmm/pdmaudioifs.h>
25	#include <VBox/vmm/pdmaudioinline.h>
26	#include <VBox/vmm/pdmaudiohostenuminline.h>
27
28	#include <stdio.h>
29
30	#include <iprt/alloc.h>
31	#include <iprt/mem.h>
32	#include <iprt/uuid.h>
33	#include <iprt/semaphore.h>
34
35	#include "DrvHostAudioPulseAudioStubsMangling.h"
36	#include "DrvHostAudioPulseAudioStubs.h"
37
38	#include <pulse/pulseaudio.h>
39	#ifndef PA_STREAM_NOFLAGS
40	# define PA_STREAM_NOFLAGS (pa_context_flags_t)0x0000U /* since 0.9.19 */
41	#endif
42	#ifndef PA_CONTEXT_NOFLAGS
43	# define PA_CONTEXT_NOFLAGS (pa_context_flags_t)0x0000U /* since 0.9.19 */
44	#endif
45
46	#include "VBoxDD.h"
47
48
49	/*********************************************************************************************************************************
50	* Defines *
51	*********************************************************************************************************************************/
52	/** Max number of errors reported by drvHstAudPaError per instance.
53	* @todo Make this configurable thru driver config. */
54	#define VBOX_PULSEAUDIO_MAX_LOG_REL_ERRORS 99
55
56
57	/** @name DRVHSTAUDPAENUMCB_F_XXX
58	* @{ */
59	/** No flags specified. */
60	#define DRVHSTAUDPAENUMCB_F_NONE 0
61	/** (Release) log found devices. */
62	#define DRVHSTAUDPAENUMCB_F_LOG RT_BIT(0)
63	/** Only do default devices. */
64	#define DRVHSTAUDPAENUMCB_F_DEFAULT_ONLY RT_BIT(1)
65	/** @} */
66
67
68	/*********************************************************************************************************************************
69	* Structures *
70	*********************************************************************************************************************************/
71	/** Pointer to the instance data for a pulse audio host audio driver. */
72	typedef struct DRVHSTAUDPA *PDRVHSTAUDPA;
73
74
75	/**
76	* Callback context for the server init context state changed callback.
77	*/
78	typedef struct DRVHSTAUDPASTATECHGCTX
79	{
80	/** The event semaphore. */
81	RTSEMEVENT hEvtInit;
82	/** The returned context state. */
83	pa_context_state_t volatile enmCtxState;
84	} DRVHSTAUDPASTATECHGCTX;
85	/** Pointer to a server init context state changed callback context. */
86	typedef DRVHSTAUDPASTATECHGCTX *PDRVHSTAUDPASTATECHGCTX;
87
88
89	/**
90	* Enumeration callback context used by the pfnGetConfig code.
91	*/
92	typedef struct DRVHSTAUDPAENUMCBCTX
93	{
94	/** Pointer to PulseAudio's threaded main loop. */
95	pa_threaded_mainloop *pMainLoop;
96	/** Enumeration flags, DRVHSTAUDPAENUMCB_F_XXX. */
97	uint32_t fFlags;
98	/** VBox status code for the operation.
99	* The caller sets this to VERR_AUDIO_ENUMERATION_FAILED, the callback never
100	* uses that status code. */
101	int32_t rcEnum;
102	/** Name of default sink being used. Must be free'd using RTStrFree(). */
103	char *pszDefaultSink;
104	/** Name of default source being used. Must be free'd using RTStrFree(). */
105	char *pszDefaultSource;
106	/** The device enumeration to fill, NULL if pfnGetConfig context. */
107	PPDMAUDIOHOSTENUM pDeviceEnum;
108	} DRVHSTAUDPAENUMCBCTX;
109	/** Pointer to an enumeration callback context. */
110	typedef DRVHSTAUDPAENUMCBCTX *PDRVHSTAUDPAENUMCBCTX;
111
112
113	/**
114	* Pulse audio device enumeration entry.
115	*/
116	typedef struct DRVHSTAUDPADEVENTRY
117	{
118	/** The part we share with others. */
119	PDMAUDIOHOSTDEV Core;
120	} DRVHSTAUDPADEVENTRY;
121	/** Pointer to a pulse audio device enumeration entry. */
122	typedef DRVHSTAUDPADEVENTRY *PDRVHSTAUDPADEVENTRY;
123
124
125	/**
126	* Pulse audio stream data.
127	*/
128	typedef struct DRVHSTAUDPASTREAM
129	{
130	/** Common part. */
131	PDMAUDIOBACKENDSTREAM Core;
132	/** The stream's acquired configuration. */
133	PDMAUDIOSTREAMCFG Cfg;
134	/** Pointer to driver instance. */
135	PDRVHSTAUDPA pDrv;
136	/** Pointer to opaque PulseAudio stream. */
137	pa_stream *pStream;
138	/** Input: Pointer to Pulse sample peek buffer. */
139	const uint8_t *pbPeekBuf;
140	/** Input: Current size (in bytes) of peeked data in buffer. */
141	size_t cbPeekBuf;
142	/** Input: Our offset (in bytes) in peek data buffer. */
143	size_t offPeekBuf;
144	/** Output: Asynchronous drain operation. This is used as an indicator of
145	* whether we're currently draining the stream (will be cleaned up before
146	* resume/re-enable). */
147	pa_operation *pDrainOp;
148	/** Asynchronous cork/uncork operation.
149	* (This solely for cancelling before destroying the stream, so the callback
150	* won't do any after-freed accesses.) */
151	pa_operation *pCorkOp;
152	/** Asynchronous trigger operation.
153	* (This solely for cancelling before destroying the stream, so the callback
154	* won't do any after-freed accesses.) */
155	pa_operation *pTriggerOp;
156	/** Output: Current latency (in microsecs). */
157	uint64_t cUsLatency;
158	#ifdef LOG_ENABLED
159	/** Creation timestamp (in microsecs) of stream playback / recording. */
160	pa_usec_t tsStartUs;
161	/** Timestamp (in microsecs) when last read from / written to the stream. */
162	pa_usec_t tsLastReadWrittenUs;
163	#endif
164	#ifdef DEBUG
165	/** Number of occurred audio data underflows. */
166	uint32_t cUnderflows;
167	#endif
168	/** Pulse sample format and attribute specification. */
169	pa_sample_spec SampleSpec;
170	/** Channel map. */
171	pa_channel_map ChannelMap;
172	/** Pulse playback and buffer metrics. */
173	pa_buffer_attr BufAttr;
174	} DRVHSTAUDPASTREAM;
175	/** Pointer to pulse audio stream data. */
176	typedef DRVHSTAUDPASTREAM *PDRVHSTAUDPASTREAM;
177
178
179	/**
180	* Pulse audio host audio driver instance data.
181	* @implements PDMIAUDIOCONNECTOR
182	*/
183	typedef struct DRVHSTAUDPA
184	{
185	/** Pointer to the driver instance structure. */
186	PPDMDRVINS pDrvIns;
187	/** Pointer to PulseAudio's threaded main loop. */
188	pa_threaded_mainloop *pMainLoop;
189	/**
190	* Pointer to our PulseAudio context.
191	* @note We use a pMainLoop in a separate thread (pContext).
192	* So either use callback functions or protect these functions
193	* by pa_threaded_mainloop_lock() / pa_threaded_mainloop_unlock().
194	*/
195	pa_context *pContext;
196	/** Shutdown indicator. */
197	volatile bool fAbortLoop;
198	/** Error count for not flooding the release log.
199	* Specify UINT32_MAX for unlimited logging. */
200	uint32_t cLogErrors;
201	/** The stream (base) name; needed for distinguishing
202	* streams in the PulseAudio mixer controls if multiple
203	* VMs are running at the same time. */
204	char szStreamName[64];
205	/** Don't want to put this on the stack... */
206	DRVHSTAUDPASTATECHGCTX InitStateChgCtx;
207	/** Pointer to host audio interface. */
208	PDMIHOSTAUDIO IHostAudio;
209	} DRVHSTAUDPA;
210
211
212
213	/*
214	* Glue to make the code work systems with PulseAudio < 0.9.11.
215	*/
216	#if !defined(PA_CONTEXT_IS_GOOD) && PA_API_VERSION < 12 /* 12 = 0.9.11 where PA_STREAM_IS_GOOD was added */
217	DECLINLINE(bool) PA_CONTEXT_IS_GOOD(pa_context_state_t enmState)
218	{
219	return enmState == PA_CONTEXT_CONNECTING
220	\|\| enmState == PA_CONTEXT_AUTHORIZING
221	\|\| enmState == PA_CONTEXT_SETTING_NAME
222	\|\| enmState == PA_CONTEXT_READY;
223	}
224	#endif
225
226	#if !defined(PA_STREAM_IS_GOOD) && PA_API_VERSION < 12 /* 12 = 0.9.11 where PA_STREAM_IS_GOOD was added */
227	DECLINLINE(bool) PA_STREAM_IS_GOOD(pa_stream_state_t enmState)
228	{
229	return enmState == PA_STREAM_CREATING
230	\|\| enmState == PA_STREAM_READY;
231	}
232	#endif
233
234
235	/**
236	* Converts a pulse audio error to a VBox status.
237	*
238	* @returns VBox status code.
239	* @param rcPa The error code to convert.
240	*/
241	static int drvHstAudPaErrorToVBox(int rcPa)
242	{
243	/** @todo Implement some PulseAudio -> VBox mapping here. */
244	RT_NOREF(rcPa);
245	return VERR_GENERAL_FAILURE;
246	}
247
248
249	/**
250	* Logs a pulse audio (from context) and converts it to VBox status.
251	*
252	* @returns VBox status code.
253	* @param pThis Our instance data.
254	* @param pszFormat The format string for the release log (no newline) .
255	* @param ... Format string arguments.
256	*/
257	static int drvHstAudPaError(PDRVHSTAUDPA pThis, const char *pszFormat, ...)
258	{
259	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
260	AssertPtr(pszFormat);
261
262	int const rcPa = pa_context_errno(pThis->pContext);
263	int const rcVBox = drvHstAudPaErrorToVBox(rcPa);
264
265	if ( pThis->cLogErrors < VBOX_PULSEAUDIO_MAX_LOG_REL_ERRORS
266	&& LogRelIs2Enabled())
267	{
268	va_list va;
269	va_start(va, pszFormat);
270	LogRel(("PulseAudio: %N: %s (%d, %Rrc)\n", pszFormat, &va, pa_strerror(rcPa), rcPa, rcVBox));
271	va_end(va);
272
273	if (++pThis->cLogErrors == VBOX_PULSEAUDIO_MAX_LOG_REL_ERRORS)
274	LogRel(("PulseAudio: muting errors (max %u)\n", VBOX_PULSEAUDIO_MAX_LOG_REL_ERRORS));
275	}
276
277	return rcVBox;
278	}
279
280
281	/**
282	* Signal the main loop to abort. Just signalling isn't sufficient as the
283	* mainloop might not have been entered yet.
284	*/
285	static void drvHstAudPaSignalWaiter(PDRVHSTAUDPA pThis)
286	{
287	if (pThis)
288	{
289	pThis->fAbortLoop = true;
290	pa_threaded_mainloop_signal(pThis->pMainLoop, 0);
291	}
292	}
293
294
295	/**
296	* Wrapper around pa_threaded_mainloop_wait().
297	*/
298	static void drvHstAudPaMainloopWait(PDRVHSTAUDPA pThis)
299	{
300	/** @todo r=bird: explain this logic. */
301	if (!pThis->fAbortLoop)
302	pa_threaded_mainloop_wait(pThis->pMainLoop);
303	pThis->fAbortLoop = false;
304	}
305
306
307	/**
308	* Pulse audio callback for context status changes, init variant.
309	*/
310	static void drvHstAudPaCtxCallbackStateChanged(pa_context pCtx, void pvUser)
311	{
312	AssertPtrReturnVoid(pCtx);
313
314	PDRVHSTAUDPA pThis = (PDRVHSTAUDPA)pvUser;
315	AssertPtrReturnVoid(pThis);
316
317	switch (pa_context_get_state(pCtx))
318	{
319	case PA_CONTEXT_READY:
320	case PA_CONTEXT_TERMINATED:
321	case PA_CONTEXT_FAILED:
322	drvHstAudPaSignalWaiter(pThis);
323	break;
324
325	default:
326	break;
327	}
328	}
329
330
331	/**
332	* Synchronously wait until an operation completed.
333	*
334	* This will consume the pOperation reference.
335	*/
336	static int drvHstAudPaWaitForEx(PDRVHSTAUDPA pThis, pa_operation *pOperation, RTMSINTERVAL cMsTimeout)
337	{
338	AssertPtrReturn(pOperation, VERR_INVALID_POINTER);
339
340	uint64_t const msStart = RTTimeMilliTS();
341	pa_operation_state_t enmOpState;
342	while ((enmOpState = pa_operation_get_state(pOperation)) == PA_OPERATION_RUNNING)
343	{
344	if (!pThis->fAbortLoop) /** @todo r=bird: I do _not_ get the logic behind this fAbortLoop mechanism, it looks more
345	* than a little mixed up and too much generalized see drvHstAudPaSignalWaiter. */
346	{
347	AssertPtr(pThis->pMainLoop);
348	pa_threaded_mainloop_wait(pThis->pMainLoop);
349	if ( !pThis->pContext
350	\|\| pa_context_get_state(pThis->pContext) != PA_CONTEXT_READY)
351	{
352	pa_operation_cancel(pOperation);
353	pa_operation_unref(pOperation);
354	LogRel(("PulseAudio: pa_context_get_state context not ready\n"));
355	return VERR_INVALID_STATE;
356	}
357	}
358	pThis->fAbortLoop = false;
359
360	/*
361	* Note! This timeout business is a bit bogus as pa_threaded_mainloop_wait is indefinite.
362	*/
363	if (RTTimeMilliTS() - msStart >= cMsTimeout)
364	{
365	enmOpState = pa_operation_get_state(pOperation);
366	if (enmOpState != PA_OPERATION_RUNNING)
367	break;
368	pa_operation_cancel(pOperation);
369	pa_operation_unref(pOperation);
370	return VERR_TIMEOUT;
371	}
372	}
373
374	pa_operation_unref(pOperation);
375	if (enmOpState == PA_OPERATION_DONE)
376	return VINF_SUCCESS;
377	return VERR_CANCELLED;
378	}
379
380
381	static int drvHstAudPaWaitFor(PDRVHSTAUDPA pThis, pa_operation *pOP)
382	{
383	return drvHstAudPaWaitForEx(pThis, pOP, 10 * RT_MS_1SEC);
384	}
385
386
387
388	/*********************************************************************************************************************************
389	* PDMIHOSTAUDIO *
390	*********************************************************************************************************************************/
391
392	/**
393	* Worker for drvHstAudPaEnumSourceCallback() and
394	* drvHstAudPaEnumSinkCallback() that adds an entry to the enumeration
395	* result.
396	*/
397	static void drvHstAudPaEnumAddDevice(PDRVHSTAUDPAENUMCBCTX pCbCtx, PDMAUDIODIR enmDir, const char *pszName,
398	const char *pszDesc, uint8_t cChannelsInput, uint8_t cChannelsOutput,
399	const char *pszDefaultName)
400	{
401	size_t const cbId = strlen(pszName) + 1;
402	size_t const cbName = pszDesc && *pszDesc ? strlen(pszDesc) + 1 : cbId;
403	PDRVHSTAUDPADEVENTRY pDev = (PDRVHSTAUDPADEVENTRY)PDMAudioHostDevAlloc(sizeof(*pDev), cbName, cbId);
404	if (pDev != NULL)
405	{
406	pDev->Core.enmUsage = enmDir;
407	pDev->Core.enmType = RTStrIStr(pszDesc, "built-in") != NULL
408	? PDMAUDIODEVICETYPE_BUILTIN : PDMAUDIODEVICETYPE_UNKNOWN;
409	if (RTStrCmp(pszName, pszDefaultName) != 0)
410	pDev->Core.fFlags = PDMAUDIOHOSTDEV_F_NONE;
411	else
412	pDev->Core.fFlags = enmDir == PDMAUDIODIR_IN ? PDMAUDIOHOSTDEV_F_DEFAULT_IN : PDMAUDIOHOSTDEV_F_DEFAULT_OUT;
413	pDev->Core.cMaxInputChannels = cChannelsInput;
414	pDev->Core.cMaxOutputChannels = cChannelsOutput;
415
416	int rc = RTStrCopy(pDev->Core.pszId, cbId, pszName);
417	AssertRC(rc);
418
419	rc = RTStrCopy(pDev->Core.pszName, cbName, pszDesc && *pszDesc ? pszDesc : pszName);
420	AssertRC(rc);
421
422	PDMAudioHostEnumAppend(pCbCtx->pDeviceEnum, &pDev->Core);
423	}
424	else
425	pCbCtx->rcEnum = VERR_NO_MEMORY;
426	}
427
428
429	/**
430	* Enumeration callback - source info.
431	*
432	* @param pCtx The context (DRVHSTAUDPA::pContext).
433	* @param pInfo The info. NULL when @a eol is not zero.
434	* @param eol Error-or-last indicator or something like that:
435	* - 0: Normal call with info.
436	* - 1: End of list, no info.
437	* - -1: Error callback, no info.
438	* @param pvUserData Pointer to our DRVHSTAUDPAENUMCBCTX structure.
439	*/
440	static void drvHstAudPaEnumSourceCallback(pa_context pCtx, const pa_source_info pInfo, int eol, void *pvUserData)
441	{
442	LogFlowFunc(("pCtx=%p pInfo=%p eol=%d pvUserData=%p\n", pCtx, pInfo, eol, pvUserData));
443	PDRVHSTAUDPAENUMCBCTX pCbCtx = (PDRVHSTAUDPAENUMCBCTX)pvUserData;
444	AssertPtrReturnVoid(pCbCtx);
445	Assert((pInfo == NULL) == (eol != 0));
446	RT_NOREF(pCtx);
447
448	if (eol == 0 && pInfo != NULL)
449	{
450	LogRel2(("Pulse Audio: Source #%u: %u Hz %uch format=%u name='%s' desc='%s' driver='%s' flags=%#x\n",
451	pInfo->index, pInfo->sample_spec.rate, pInfo->sample_spec.channels, pInfo->sample_spec.format,
452	pInfo->name, pInfo->description, pInfo->driver, pInfo->flags));
453	drvHstAudPaEnumAddDevice(pCbCtx, PDMAUDIODIR_IN, pInfo->name, pInfo->description,
454	pInfo->sample_spec.channels, 0 /cChannelsOutput/, pCbCtx->pszDefaultSource);
455	}
456	else if (eol == 1 && !pInfo && pCbCtx->rcEnum == VERR_AUDIO_ENUMERATION_FAILED)
457	pCbCtx->rcEnum = VINF_SUCCESS;
458
459	/* Wake up the calling thread when done: */
460	if (eol != 0)
461	pa_threaded_mainloop_signal(pCbCtx->pMainLoop, 0);
462	}
463
464
465	/**
466	* Enumeration callback - sink info.
467	*
468	* @param pCtx The context (DRVHSTAUDPA::pContext).
469	* @param pInfo The info. NULL when @a eol is not zero.
470	* @param eol Error-or-last indicator or something like that:
471	* - 0: Normal call with info.
472	* - 1: End of list, no info.
473	* - -1: Error callback, no info.
474	* @param pvUserData Pointer to our DRVHSTAUDPAENUMCBCTX structure.
475	*/
476	static void drvHstAudPaEnumSinkCallback(pa_context pCtx, const pa_sink_info pInfo, int eol, void *pvUserData)
477	{
478	LogFlowFunc(("pCtx=%p pInfo=%p eol=%d pvUserData=%p\n", pCtx, pInfo, eol, pvUserData));
479	PDRVHSTAUDPAENUMCBCTX pCbCtx = (PDRVHSTAUDPAENUMCBCTX)pvUserData;
480	AssertPtrReturnVoid(pCbCtx);
481	Assert((pInfo == NULL) == (eol != 0));
482	RT_NOREF(pCtx);
483
484	if (eol == 0 && pInfo != NULL)
485	{
486	LogRel2(("Pulse Audio: Sink #%u: %u Hz %uch format=%u name='%s' desc='%s' driver='%s' flags=%#x\n",
487	pInfo->index, pInfo->sample_spec.rate, pInfo->sample_spec.channels, pInfo->sample_spec.format,
488	pInfo->name, pInfo->description, pInfo->driver, pInfo->flags));
489	drvHstAudPaEnumAddDevice(pCbCtx, PDMAUDIODIR_OUT, pInfo->name, pInfo->description,
490	0 /cChannelsInput/, pInfo->sample_spec.channels, pCbCtx->pszDefaultSink);
491	}
492	else if (eol == 1 && !pInfo && pCbCtx->rcEnum == VERR_AUDIO_ENUMERATION_FAILED)
493	pCbCtx->rcEnum = VINF_SUCCESS;
494
495	/* Wake up the calling thread when done: */
496	if (eol != 0)
497	pa_threaded_mainloop_signal(pCbCtx->pMainLoop, 0);
498	}
499
500
501	/**
502	* Enumeration callback - service info.
503	*
504	* Copy down the default names.
505	*/
506	static void drvHstAudPaEnumServerCallback(pa_context pCtx, const pa_server_info pInfo, void *pvUserData)
507	{
508	LogFlowFunc(("pCtx=%p pInfo=%p pvUserData=%p\n", pCtx, pInfo, pvUserData));
509	PDRVHSTAUDPAENUMCBCTX pCbCtx = (PDRVHSTAUDPAENUMCBCTX)pvUserData;
510	AssertPtrReturnVoid(pCbCtx);
511	RT_NOREF(pCtx);
512
513	if (pInfo)
514	{
515	LogRel2(("PulseAudio: Server info: user=%s host=%s ver=%s name=%s defsink=%s defsrc=%s spec: %d %uHz %uch\n",
516	pInfo->user_name, pInfo->host_name, pInfo->server_version, pInfo->server_name,
517	pInfo->default_sink_name, pInfo->default_source_name,
518	pInfo->sample_spec.format, pInfo->sample_spec.rate, pInfo->sample_spec.channels));
519
520	Assert(!pCbCtx->pszDefaultSink);
521	Assert(!pCbCtx->pszDefaultSource);
522	Assert(pCbCtx->rcEnum == VERR_AUDIO_ENUMERATION_FAILED);
523	pCbCtx->rcEnum = VINF_SUCCESS;
524
525	if (pInfo->default_sink_name)
526	{
527	Assert(RTStrIsValidEncoding(pInfo->default_sink_name));
528	pCbCtx->pszDefaultSink = RTStrDup(pInfo->default_sink_name);
529	AssertStmt(pCbCtx->pszDefaultSink, pCbCtx->rcEnum = VERR_NO_STR_MEMORY);
530	}
531
532	if (pInfo->default_source_name)
533	{
534	Assert(RTStrIsValidEncoding(pInfo->default_source_name));
535	pCbCtx->pszDefaultSource = RTStrDup(pInfo->default_source_name);
536	AssertStmt(pCbCtx->pszDefaultSource, pCbCtx->rcEnum = VERR_NO_STR_MEMORY);
537	}
538	}
539	else
540	pCbCtx->rcEnum = VERR_INVALID_POINTER;
541
542	pa_threaded_mainloop_signal(pCbCtx->pMainLoop, 0);
543	}
544
545
546	/**
547	* @note Called with the PA main loop locked.
548	*/
549	static int drvHstAudPaEnumerate(PDRVHSTAUDPA pThis, uint32_t fEnum, PPDMAUDIOHOSTENUM pDeviceEnum)
550	{
551	DRVHSTAUDPAENUMCBCTX CbCtx = { pThis->pMainLoop, fEnum, VERR_AUDIO_ENUMERATION_FAILED, NULL, NULL, pDeviceEnum };
552	bool const fLog = (fEnum & DRVHSTAUDPAENUMCB_F_LOG);
553	bool const fOnlyDefault = (fEnum & DRVHSTAUDPAENUMCB_F_DEFAULT_ONLY);
554	int rc;
555
556	/*
557	* Check if server information is available and bail out early if it isn't.
558	* This should give us a default (playback) sink and (recording) source.
559	*/
560	LogRel(("PulseAudio: Retrieving server information ...\n"));
561	CbCtx.rcEnum = VERR_AUDIO_ENUMERATION_FAILED;
562	pa_operation *paOpServerInfo = pa_context_get_server_info(pThis->pContext, drvHstAudPaEnumServerCallback, &CbCtx);
563	if (paOpServerInfo)
564	rc = drvHstAudPaWaitFor(pThis, paOpServerInfo);
565	else
566	{
567	LogRel(("PulseAudio: Server information not available, skipping enumeration.\n"));
568	return VINF_SUCCESS;
569	}
570	if (RT_SUCCESS(rc))
571	rc = CbCtx.rcEnum;
572	if (RT_FAILURE(rc))
573	{
574	if (fLog)
575	LogRel(("PulseAudio: Error enumerating PulseAudio server properties: %Rrc\n", rc));
576	return rc;
577	}
578
579	/*
580	* Get info about the playback sink.
581	*/
582	if (fLog && CbCtx.pszDefaultSink)
583	LogRel2(("PulseAudio: Default output sink is '%s'\n", CbCtx.pszDefaultSink));
584	else if (fLog)
585	LogRel2(("PulseAudio: No default output sink found\n"));
586
587	if (CbCtx.pszDefaultSink \|\| !fOnlyDefault)
588	{
589	CbCtx.rcEnum = VERR_AUDIO_ENUMERATION_FAILED;
590	if (!fOnlyDefault)
591	rc = drvHstAudPaWaitFor(pThis,
592	pa_context_get_sink_info_list(pThis->pContext, drvHstAudPaEnumSinkCallback, &CbCtx));
593	else
594	rc = drvHstAudPaWaitFor(pThis, pa_context_get_sink_info_by_name(pThis->pContext, CbCtx.pszDefaultSink,
595	drvHstAudPaEnumSinkCallback, &CbCtx));
596	if (RT_SUCCESS(rc))
597	rc = CbCtx.rcEnum;
598	if (fLog && RT_FAILURE(rc))
599	LogRel(("PulseAudio: Error enumerating properties for default output sink '%s': %Rrc\n",
600	CbCtx.pszDefaultSink, rc));
601	}
602
603	/*
604	* Get info about the recording source.
605	*/
606	if (fLog && CbCtx.pszDefaultSource)
607	LogRel2(("PulseAudio: Default input source is '%s'\n", CbCtx.pszDefaultSource));
608	else if (fLog)
609	LogRel2(("PulseAudio: No default input source found\n"));
610	if (CbCtx.pszDefaultSource \|\| !fOnlyDefault)
611	{
612	CbCtx.rcEnum = VERR_AUDIO_ENUMERATION_FAILED;
613	int rc2;
614	if (!fOnlyDefault)
615	rc2 = drvHstAudPaWaitFor(pThis, pa_context_get_source_info_list(pThis->pContext,
616	drvHstAudPaEnumSourceCallback, &CbCtx));
617	else
618	rc2 = drvHstAudPaWaitFor(pThis, pa_context_get_source_info_by_name(pThis->pContext, CbCtx.pszDefaultSource,
619	drvHstAudPaEnumSourceCallback, &CbCtx));
620	if (RT_SUCCESS(rc2))
621	rc2 = CbCtx.rcEnum;
622	if (fLog && RT_FAILURE(rc2))
623	LogRel(("PulseAudio: Error enumerating properties for default input source '%s': %Rrc\n",
624	CbCtx.pszDefaultSource, rc));
625	if (RT_SUCCESS(rc))
626	rc = rc2;
627	}
628
629	/* clean up */
630	RTStrFree(CbCtx.pszDefaultSink);
631	RTStrFree(CbCtx.pszDefaultSource);
632
633	LogFlowFuncLeaveRC(rc);
634	return rc;
635	}
636
637
638	/**
639	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetConfig}
640	*/
641	static DECLCALLBACK(int) drvHstAudPaHA_GetConfig(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDCFG pBackendCfg)
642	{
643	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
644	AssertPtrReturn(pBackendCfg, VERR_INVALID_POINTER);
645
646	/*
647	* The configuration.
648	*/
649	RTStrCopy(pBackendCfg->szName, sizeof(pBackendCfg->szName), "PulseAudio");
650	pBackendCfg->cbStream = sizeof(DRVHSTAUDPASTREAM);
651	pBackendCfg->fFlags = 0;
652	pBackendCfg->cMaxStreamsOut = UINT32_MAX;
653	pBackendCfg->cMaxStreamsIn = UINT32_MAX;
654
655	#if 0
656	/*
657	* In case we want to gather info about default devices, we can do this:
658	*/
659	PDMAUDIOHOSTENUM DeviceEnum;
660	PDMAudioHostEnumInit(&DeviceEnum);
661	pa_threaded_mainloop_lock(pThis->pMainLoop);
662	int rc = drvHstAudPaEnumerate(pThis, DRVHSTAUDPAENUMCB_F_DEFAULT_ONLY \| DRVHSTAUDPAENUMCB_F_LOG, &DeviceEnum);
663	pa_threaded_mainloop_unlock(pThis->pMainLoop);
664	AssertRCReturn(rc, rc);
665	/** @todo do stuff with DeviceEnum. */
666	PDMAudioHostEnumDelete(&DeviceEnum);
667	#else
668	RT_NOREF(pThis);
669	#endif
670	return VINF_SUCCESS;
671	}
672
673
674	/**
675	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetDevices}
676	*/
677	static DECLCALLBACK(int) drvHstAudPaHA_GetDevices(PPDMIHOSTAUDIO pInterface, PPDMAUDIOHOSTENUM pDeviceEnum)
678	{
679	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
680	AssertPtrReturn(pDeviceEnum, VERR_INVALID_POINTER);
681	PDMAudioHostEnumInit(pDeviceEnum);
682
683	/* Refine it or something (currently only some LogRel2 stuff): */
684	pa_threaded_mainloop_lock(pThis->pMainLoop);
685	int rc = drvHstAudPaEnumerate(pThis, DRVHSTAUDPAENUMCB_F_NONE, pDeviceEnum);
686	pa_threaded_mainloop_unlock(pThis->pMainLoop);
687	return rc;
688	}
689
690
691	/**
692	* @interface_method_impl{PDMIHOSTAUDIO,pfnGetStatus}
693	*/
694	static DECLCALLBACK(PDMAUDIOBACKENDSTS) drvHstAudPaHA_GetStatus(PPDMIHOSTAUDIO pInterface, PDMAUDIODIR enmDir)
695	{
696	RT_NOREF(pInterface, enmDir);
697	return PDMAUDIOBACKENDSTS_RUNNING;
698	}
699
700
701	/**
702	* Stream status changed.
703	*/
704	static void drvHstAudPaStreamStateChangedCallback(pa_stream pStream, void pvUser)
705	{
706	AssertPtrReturnVoid(pStream);
707
708	PDRVHSTAUDPA pThis = (PDRVHSTAUDPA)pvUser;
709	AssertPtrReturnVoid(pThis);
710
711	switch (pa_stream_get_state(pStream))
712	{
713	case PA_STREAM_READY:
714	case PA_STREAM_FAILED:
715	case PA_STREAM_TERMINATED:
716	drvHstAudPaSignalWaiter(pThis);
717	break;
718
719	default:
720	break;
721	}
722	}
723
724	#ifdef DEBUG
725
726	/**
727	* Debug PA callback: Need data to output.
728	*/
729	static void drvHstAudPaStreamReqWriteDebugCallback(pa_stream pStream, size_t cbLen, void pvContext)
730	{
731	RT_NOREF(cbLen, pvContext);
732	pa_usec_t cUsLatency = 0;
733	int fNegative = 0;
734	int rcPa = pa_stream_get_latency(pStream, &cUsLatency, &fNegative);
735	Log2Func(("Requesting %zu bytes; Latency: %'RU64 us%s\n",
736	cbLen, cUsLatency, rcPa == 0 ? " - pa_stream_get_latency failed!" : ""));
737	}
738
739
740	/**
741	* Debug PA callback: Underflow. This may happen when draing/corking.
742	*/
743	static void drvHstAudPaStreamUnderflowDebugCallback(pa_stream pStream, void pvContext)
744	{
745	PDRVHSTAUDPASTREAM pStrm = (PDRVHSTAUDPASTREAM)pvContext;
746	AssertPtrReturnVoid(pStrm);
747
748	pStrm->cUnderflows++;
749
750	LogRel2(("PulseAudio: Warning: Hit underflow #%RU32\n", pStrm->cUnderflows));
751
752	if ( pStrm->cUnderflows >= 6 /** @todo Make this check configurable. */
753	&& pStrm->cUsLatency < 2U*RT_US_1SEC)
754	{
755	pStrm->cUsLatency = pStrm->cUsLatency * 3 / 2;
756	LogRel2(("PulseAudio: Increasing output latency to %'RU64 us\n", pStrm->cUsLatency));
757
758	pStrm->BufAttr.maxlength = pa_usec_to_bytes(pStrm->cUsLatency, &pStrm->SampleSpec);
759	pStrm->BufAttr.tlength = pa_usec_to_bytes(pStrm->cUsLatency, &pStrm->SampleSpec);
760	pa_operation *pOperation = pa_stream_set_buffer_attr(pStream, &pStrm->BufAttr, NULL, NULL);
761	if (pOperation)
762	pa_operation_unref(pOperation);
763	else
764	LogRel2(("pa_stream_set_buffer_attr failed!\n"));
765
766	pStrm->cUnderflows = 0;
767	}
768
769	pa_usec_t cUsLatency = 0;
770	int fNegative = 0;
771	pa_stream_get_latency(pStream, &cUsLatency, &fNegative);
772	LogRel2(("PulseAudio: Latency now is %'RU64 us\n", cUsLatency));
773
774	# ifdef LOG_ENABLED
775	if (LogIs2Enabled())
776	{
777	const pa_timing_info *pTInfo = pa_stream_get_timing_info(pStream);
778	AssertReturnVoid(pTInfo);
779	const pa_sample_spec *pSpec = pa_stream_get_sample_spec(pStream);
780	AssertReturnVoid(pSpec);
781	Log2Func(("writepos=%'RU64 us, readpost=%'RU64 us, age=%'RU64 us, latency=%'RU64 us (%RU32Hz %RU8ch)\n",
782	pa_bytes_to_usec(pTInfo->write_index, pSpec), pa_bytes_to_usec(pTInfo->read_index, pSpec),
783	pa_rtclock_now() - pStrm->tsStartUs, cUsLatency, pSpec->rate, pSpec->channels));
784	}
785	# endif
786	}
787
788
789	/**
790	* Debug PA callback: Overflow. This may happen when draing/corking.
791	*/
792	static void drvHstAudPaStreamOverflowDebugCallback(pa_stream pStream, void pvContext)
793	{
794	RT_NOREF(pStream, pvContext);
795	Log2Func(("Warning: Hit overflow\n"));
796	}
797
798	#endif /* DEBUG */
799
800	/**
801	* Converts from PDM PCM properties to pulse audio format.
802	*
803	* Worker for the stream creation code.
804	*
805	* @returns PA format.
806	* @retval PA_SAMPLE_INVALID if format not supported.
807	* @param pProps The PDM audio source properties.
808	*/
809	static pa_sample_format_t drvHstAudPaPropsToPulse(PCPDMAUDIOPCMPROPS pProps)
810	{
811	switch (PDMAudioPropsSampleSize(pProps))
812	{
813	case 1:
814	if (!PDMAudioPropsIsSigned(pProps))
815	return PA_SAMPLE_U8;
816	break;
817
818	case 2:
819	if (PDMAudioPropsIsSigned(pProps))
820	return PDMAudioPropsIsLittleEndian(pProps) ? PA_SAMPLE_S16LE : PA_SAMPLE_S16BE;
821	break;
822
823	#ifdef PA_SAMPLE_S32LE
824	case 4:
825	if (PDMAudioPropsIsSigned(pProps))
826	return PDMAudioPropsIsLittleEndian(pProps) ? PA_SAMPLE_S32LE : PA_SAMPLE_S32BE;
827	break;
828	#endif
829	}
830
831	AssertMsgFailed(("%RU8%s not supported\n", PDMAudioPropsSampleSize(pProps), PDMAudioPropsIsSigned(pProps) ? "S" : "U"));
832	return PA_SAMPLE_INVALID;
833	}
834
835
836	/**
837	* Converts from pulse audio sample specification to PDM PCM audio properties.
838	*
839	* Worker for the stream creation code.
840	*
841	* @returns VBox status code.
842	* @param pProps The PDM audio source properties.
843	* @param enmPulseFmt The PA format.
844	* @param cChannels The number of channels.
845	* @param uHz The frequency.
846	*/
847	static int drvHstAudPaToAudioProps(PPDMAUDIOPCMPROPS pProps, pa_sample_format_t enmPulseFmt, uint8_t cChannels, uint32_t uHz)
848	{
849	AssertReturn(cChannels > 0, VERR_INVALID_PARAMETER);
850	AssertReturn(cChannels < 16, VERR_INVALID_PARAMETER);
851
852	switch (enmPulseFmt)
853	{
854	case PA_SAMPLE_U8:
855	PDMAudioPropsInit(pProps, 1 /8-bit/, false /signed/, cChannels, uHz);
856	break;
857
858	case PA_SAMPLE_S16LE:
859	PDMAudioPropsInitEx(pProps, 2 /16-bit/, true /signed/, cChannels, uHz, true /fLittleEndian/, false /fRaw/);
860	break;
861
862	case PA_SAMPLE_S16BE:
863	PDMAudioPropsInitEx(pProps, 2 /16-bit/, true /signed/, cChannels, uHz, false /fLittleEndian/, false /fRaw/);
864	break;
865
866	#ifdef PA_SAMPLE_S32LE
867	case PA_SAMPLE_S32LE:
868	PDMAudioPropsInitEx(pProps, 4 /32-bit/, true /signed/, cChannels, uHz, true /fLittleEndian/, false /fRaw/);
869	break;
870	#endif
871
872	#ifdef PA_SAMPLE_S32BE
873	case PA_SAMPLE_S32BE:
874	PDMAudioPropsInitEx(pProps, 4 /32-bit/, true /signed/, cChannels, uHz, false /fLittleEndian/, false /fRaw/);
875	break;
876	#endif
877
878	default:
879	AssertLogRelMsgFailed(("PulseAudio: Format (%d) not supported\n", enmPulseFmt));
880	return VERR_NOT_SUPPORTED;
881	}
882
883	return VINF_SUCCESS;
884	}
885
886
887	/**
888	* Worker that does the actual creation of an PA stream.
889	*
890	* @returns VBox status code.
891	* @param pThis Our driver instance data.
892	* @param pStreamPA Our stream data.
893	* @param pszName How we name the stream.
894	* @param pCfgAcq The requested stream properties, the Props member is
895	* updated upon successful return.
896	*
897	* @note Caller owns the mainloop lock.
898	*/
899	static int drvHstAudPaStreamCreateLocked(PDRVHSTAUDPA pThis, PDRVHSTAUDPASTREAM pStreamPA,
900	const char *pszName, PPDMAUDIOSTREAMCFG pCfgAcq)
901	{
902	/*
903	* Create the stream.
904	*/
905	pa_stream *pStream = pa_stream_new(pThis->pContext, pszName, &pStreamPA->SampleSpec, &pStreamPA->ChannelMap);
906	if (!pStream)
907	{
908	LogRel(("PulseAudio: Failed to create stream '%s': %s (%d)\n",
909	pszName, pa_strerror(pa_context_errno(pThis->pContext)), pa_context_errno(pThis->pContext)));
910	return VERR_AUDIO_STREAM_COULD_NOT_CREATE;
911	}
912
913	/*
914	* Set the state callback, and in debug builds a few more...
915	*/
916	#ifdef DEBUG
917	pa_stream_set_write_callback( pStream, drvHstAudPaStreamReqWriteDebugCallback, pStreamPA);
918	pa_stream_set_underflow_callback( pStream, drvHstAudPaStreamUnderflowDebugCallback, pStreamPA);
919	if (pCfgAcq->enmDir == PDMAUDIODIR_OUT)
920	pa_stream_set_overflow_callback(pStream, drvHstAudPaStreamOverflowDebugCallback, pStreamPA);
921	#endif
922	pa_stream_set_state_callback( pStream, drvHstAudPaStreamStateChangedCallback, pThis);
923
924	/*
925	* Connect the stream.
926	*/
927	int rc;
928	unsigned const fFlags = PA_STREAM_START_CORKED /* Require explicit starting (uncorking). */
929	/* For using pa_stream_get_latency() and pa_stream_get_time(). */
930	\| PA_STREAM_INTERPOLATE_TIMING \| PA_STREAM_AUTO_TIMING_UPDATE
931	#if PA_API_VERSION >= 12
932	\| PA_STREAM_ADJUST_LATENCY
933	#endif
934	;
935	if (pCfgAcq->enmDir == PDMAUDIODIR_IN)
936	{
937	LogFunc(("Input stream attributes: maxlength=%d fragsize=%d\n",
938	pStreamPA->BufAttr.maxlength, pStreamPA->BufAttr.fragsize));
939	rc = pa_stream_connect_record(pStream, NULL /dev/, &pStreamPA->BufAttr, (pa_stream_flags_t)fFlags);
940	}
941	else
942	{
943	LogFunc(("Output buffer attributes: maxlength=%d tlength=%d prebuf=%d minreq=%d\n",
944	pStreamPA->BufAttr.maxlength, pStreamPA->BufAttr.tlength, pStreamPA->BufAttr.prebuf, pStreamPA->BufAttr.minreq));
945	rc = pa_stream_connect_playback(pStream, NULL /dev/, &pStreamPA->BufAttr, (pa_stream_flags_t)fFlags,
946	NULL /volume/, NULL /sync_stream/);
947	}
948	if (rc >= 0)
949	{
950	/*
951	* Wait for the stream to become ready.
952	*/
953	uint64_t const nsStart = RTTimeNanoTS();
954	pa_stream_state_t enmStreamState;
955	while ( (enmStreamState = pa_stream_get_state(pStream)) != PA_STREAM_READY
956	&& PA_STREAM_IS_GOOD(enmStreamState)
957	&& RTTimeNanoTS() - nsStart < RT_NS_10SEC /* not really timed */ )
958	drvHstAudPaMainloopWait(pThis);
959	if (enmStreamState == PA_STREAM_READY)
960	{
961	LogFunc(("Connecting stream took %'RU64 ns\n", RTTimeNanoTS() - nsStart));
962	#ifdef LOG_ENABLED
963	pStreamPA->tsStartUs = pa_rtclock_now();
964	#endif
965	/*
966	* Update the buffer attributes.
967	*/
968	const pa_buffer_attr *pBufAttribs = pa_stream_get_buffer_attr(pStream);
969	AssertPtr(pBufAttribs);
970	if (pBufAttribs)
971	{
972	pStreamPA->BufAttr = *pBufAttribs;
973	LogFunc(("Obtained %s buffer attributes: maxlength=%RU32 tlength=%RU32 prebuf=%RU32 minreq=%RU32 fragsize=%RU32\n",
974	pCfgAcq->enmDir == PDMAUDIODIR_IN ? "input" : "output", pBufAttribs->maxlength, pBufAttribs->tlength,
975	pBufAttribs->prebuf, pBufAttribs->minreq, pBufAttribs->fragsize));
976
977	/*
978	* Convert the sample spec back to PDM speak.
979	* Note! This isn't strictly speaking needed as SampleSpec has not been
980	* modified since the caller converted it from pCfgReq.
981	*/
982	rc = drvHstAudPaToAudioProps(&pCfgAcq->Props, pStreamPA->SampleSpec.format,
983	pStreamPA->SampleSpec.channels, pStreamPA->SampleSpec.rate);
984	if (RT_SUCCESS(rc))
985	{
986	pStreamPA->pStream = pStream;
987	LogFlowFunc(("returns VINF_SUCCESS\n"));
988	return VINF_SUCCESS;
989	}
990	}
991	else
992	{
993	LogRelMax(99, ("PulseAudio: Failed to get buffer attribs for stream '%s': %s (%d)\n",
994	pszName, pa_strerror(pa_context_errno(pThis->pContext)), pa_context_errno(pThis->pContext)));
995	rc = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
996	}
997	}
998	else
999	{
1000	LogRelMax(99, ("PulseAudio: Failed to initialize stream '%s': state=%d, waited %'RU64 ns\n",
1001	pszName, enmStreamState, RTTimeNanoTS() - nsStart));
1002	rc = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1003	}
1004	pa_stream_disconnect(pStream);
1005	}
1006	else
1007	{
1008	LogRelMax(99, ("PulseAudio: Could not connect %s stream '%s': %s (%d/%d)\n",
1009	pCfgAcq->enmDir == PDMAUDIODIR_IN ? "input" : "output",
1010	pszName, pa_strerror(pa_context_errno(pThis->pContext)), pa_context_errno(pThis->pContext), rc));
1011	rc = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1012	}
1013
1014	pa_stream_unref(pStream);
1015	Assert(RT_FAILURE_NP(rc));
1016	LogFlowFunc(("returns %Rrc\n", rc));
1017	return rc;
1018	}
1019
1020
1021	/**
1022	* Translates a PDM channel ID to a PA channel position.
1023	*
1024	* @returns PA channel position, INVALID if no mapping found.
1025	*/
1026	static pa_channel_position_t drvHstAudPaConvertChannelId(uint8_t idChannel)
1027	{
1028	switch (idChannel)
1029	{
1030	case PDMAUDIOCHANNELID_FRONT_LEFT: return PA_CHANNEL_POSITION_FRONT_LEFT;
1031	case PDMAUDIOCHANNELID_FRONT_RIGHT: return PA_CHANNEL_POSITION_FRONT_RIGHT;
1032	case PDMAUDIOCHANNELID_FRONT_CENTER: return PA_CHANNEL_POSITION_FRONT_CENTER;
1033	case PDMAUDIOCHANNELID_LFE: return PA_CHANNEL_POSITION_LFE;
1034	case PDMAUDIOCHANNELID_REAR_LEFT: return PA_CHANNEL_POSITION_REAR_LEFT;
1035	case PDMAUDIOCHANNELID_REAR_RIGHT: return PA_CHANNEL_POSITION_REAR_RIGHT;
1036	case PDMAUDIOCHANNELID_FRONT_LEFT_OF_CENTER: return PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER;
1037	case PDMAUDIOCHANNELID_FRONT_RIGHT_OF_CENTER: return PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER;
1038	case PDMAUDIOCHANNELID_REAR_CENTER: return PA_CHANNEL_POSITION_REAR_CENTER;
1039	case PDMAUDIOCHANNELID_SIDE_LEFT: return PA_CHANNEL_POSITION_SIDE_LEFT;
1040	case PDMAUDIOCHANNELID_SIDE_RIGHT: return PA_CHANNEL_POSITION_SIDE_RIGHT;
1041	case PDMAUDIOCHANNELID_TOP_CENTER: return PA_CHANNEL_POSITION_TOP_CENTER;
1042	case PDMAUDIOCHANNELID_FRONT_LEFT_HEIGHT: return PA_CHANNEL_POSITION_TOP_FRONT_LEFT;
1043	case PDMAUDIOCHANNELID_FRONT_CENTER_HEIGHT: return PA_CHANNEL_POSITION_TOP_FRONT_CENTER;
1044	case PDMAUDIOCHANNELID_FRONT_RIGHT_HEIGHT: return PA_CHANNEL_POSITION_TOP_FRONT_RIGHT;
1045	case PDMAUDIOCHANNELID_REAR_LEFT_HEIGHT: return PA_CHANNEL_POSITION_TOP_REAR_LEFT;
1046	case PDMAUDIOCHANNELID_REAR_CENTER_HEIGHT: return PA_CHANNEL_POSITION_TOP_REAR_CENTER;
1047	case PDMAUDIOCHANNELID_REAR_RIGHT_HEIGHT: return PA_CHANNEL_POSITION_TOP_REAR_RIGHT;
1048	default: return PA_CHANNEL_POSITION_INVALID;
1049	}
1050	}
1051
1052
1053	/**
1054	* Translates a PA channel position to a PDM channel ID.
1055	*
1056	* @returns PDM channel ID, UNKNOWN if no mapping found.
1057	*/
1058	static PDMAUDIOCHANNELID drvHstAudPaConvertChannelPos(pa_channel_position_t enmChannelPos)
1059	{
1060	switch (enmChannelPos)
1061	{
1062	case PA_CHANNEL_POSITION_INVALID: return PDMAUDIOCHANNELID_INVALID;
1063	case PA_CHANNEL_POSITION_MONO: return PDMAUDIOCHANNELID_MONO;
1064	case PA_CHANNEL_POSITION_FRONT_LEFT: return PDMAUDIOCHANNELID_FRONT_LEFT;
1065	case PA_CHANNEL_POSITION_FRONT_RIGHT: return PDMAUDIOCHANNELID_FRONT_RIGHT;
1066	case PA_CHANNEL_POSITION_FRONT_CENTER: return PDMAUDIOCHANNELID_FRONT_CENTER;
1067	case PA_CHANNEL_POSITION_LFE: return PDMAUDIOCHANNELID_LFE;
1068	case PA_CHANNEL_POSITION_REAR_LEFT: return PDMAUDIOCHANNELID_REAR_LEFT;
1069	case PA_CHANNEL_POSITION_REAR_RIGHT: return PDMAUDIOCHANNELID_REAR_RIGHT;
1070	case PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER: return PDMAUDIOCHANNELID_FRONT_LEFT_OF_CENTER;
1071	case PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER: return PDMAUDIOCHANNELID_FRONT_RIGHT_OF_CENTER;
1072	case PA_CHANNEL_POSITION_REAR_CENTER: return PDMAUDIOCHANNELID_REAR_CENTER;
1073	case PA_CHANNEL_POSITION_SIDE_LEFT: return PDMAUDIOCHANNELID_SIDE_LEFT;
1074	case PA_CHANNEL_POSITION_SIDE_RIGHT: return PDMAUDIOCHANNELID_SIDE_RIGHT;
1075	case PA_CHANNEL_POSITION_TOP_CENTER: return PDMAUDIOCHANNELID_TOP_CENTER;
1076	case PA_CHANNEL_POSITION_TOP_FRONT_LEFT: return PDMAUDIOCHANNELID_FRONT_LEFT_HEIGHT;
1077	case PA_CHANNEL_POSITION_TOP_FRONT_CENTER: return PDMAUDIOCHANNELID_FRONT_CENTER_HEIGHT;
1078	case PA_CHANNEL_POSITION_TOP_FRONT_RIGHT: return PDMAUDIOCHANNELID_FRONT_RIGHT_HEIGHT;
1079	case PA_CHANNEL_POSITION_TOP_REAR_LEFT: return PDMAUDIOCHANNELID_REAR_LEFT_HEIGHT;
1080	case PA_CHANNEL_POSITION_TOP_REAR_CENTER: return PDMAUDIOCHANNELID_REAR_CENTER_HEIGHT;
1081	case PA_CHANNEL_POSITION_TOP_REAR_RIGHT: return PDMAUDIOCHANNELID_REAR_RIGHT_HEIGHT;
1082	default: return PDMAUDIOCHANNELID_UNKNOWN;
1083	}
1084	}
1085
1086
1087
1088	/**
1089	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCreate}
1090	*/
1091	static DECLCALLBACK(int) drvHstAudPaHA_StreamCreate(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1092	PCPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
1093	{
1094	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1095	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1096	AssertPtrReturn(pStreamPA, VERR_INVALID_POINTER);
1097	AssertPtrReturn(pCfgReq, VERR_INVALID_POINTER);
1098	AssertPtrReturn(pCfgAcq, VERR_INVALID_POINTER);
1099	AssertReturn(pCfgReq->enmDir == PDMAUDIODIR_IN \|\| pCfgReq->enmDir == PDMAUDIODIR_OUT, VERR_INVALID_PARAMETER);
1100	Assert(PDMAudioStrmCfgEquals(pCfgReq, pCfgAcq));
1101	int rc;
1102
1103	/*
1104	* Prepare name, sample spec and the stream instance data.
1105	*/
1106	char szName[256];
1107	RTStrPrintf(szName, sizeof(szName), "VirtualBox %s [%s]", PDMAudioPathGetName(pCfgReq->enmPath), pThis->szStreamName);
1108
1109	pStreamPA->pDrv = pThis;
1110	pStreamPA->pDrainOp = NULL;
1111	pStreamPA->pbPeekBuf = NULL;
1112	pStreamPA->SampleSpec.rate = PDMAudioPropsHz(&pCfgReq->Props);
1113	pStreamPA->SampleSpec.channels = PDMAudioPropsChannels(&pCfgReq->Props);
1114	pStreamPA->SampleSpec.format = drvHstAudPaPropsToPulse(&pCfgReq->Props);
1115
1116	/*
1117	* Initialize the channelmap. This may change the channel count.
1118	*/
1119	AssertCompile(RT_ELEMENTS(pStreamPA->ChannelMap.map) >= PDMAUDIO_MAX_CHANNELS);
1120	uint8_t const cSrcChannels = pStreamPA->ChannelMap.channels = PDMAudioPropsChannels(&pCfgReq->Props);
1121	uintptr_t iDst = 0;
1122	if (cSrcChannels == 1 && pCfgReq->Props.aidChannels[0] == PDMAUDIOCHANNELID_MONO)
1123	pStreamPA->ChannelMap.map[iDst++] = PA_CHANNEL_POSITION_MONO;
1124	else
1125	{
1126	uintptr_t iSrc;
1127	for (iSrc = iDst = 0; iSrc < cSrcChannels; iSrc++)
1128	{
1129	pStreamPA->ChannelMap.map[iDst] = drvHstAudPaConvertChannelId(pCfgReq->Props.aidChannels[iSrc]);
1130	if (pStreamPA->ChannelMap.map[iDst] != PA_CHANNEL_POSITION_INVALID)
1131	iDst++;
1132	else
1133	{
1134	LogRel2(("PulseAudio: Dropping channel #%u (%d/%s)\n", iSrc, pCfgReq->Props.aidChannels[iSrc],
1135	PDMAudioChannelIdGetName((PDMAUDIOCHANNELID)pCfgReq->Props.aidChannels[iSrc])));
1136	pStreamPA->ChannelMap.channels--;
1137	pStreamPA->SampleSpec.channels--;
1138	PDMAudioPropsSetChannels(&pCfgAcq->Props, pStreamPA->SampleSpec.channels);
1139	}
1140	}
1141	Assert(iDst == pStreamPA->ChannelMap.channels);
1142	}
1143	while (iDst < RT_ELEMENTS(pStreamPA->ChannelMap.map))
1144	pStreamPA->ChannelMap.map[iDst++] = PA_CHANNEL_POSITION_INVALID;
1145
1146	LogFunc(("Opening '%s', rate=%dHz, channels=%d (%d), format=%s\n", szName, pStreamPA->SampleSpec.rate,
1147	pStreamPA->SampleSpec.channels, cSrcChannels, pa_sample_format_to_string(pStreamPA->SampleSpec.format)));
1148
1149	if (pa_sample_spec_valid(&pStreamPA->SampleSpec))
1150	{
1151	/*
1152	* Set up buffer attributes according to the stream type.
1153	*
1154	* For output streams we configure pre-buffering as requested, since
1155	* there is little point in using a different size than DrvAudio. This
1156	* assumes that a 'drain' request will override the prebuf size.
1157	*/
1158	pStreamPA->BufAttr.maxlength = UINT32_MAX; /* Let the PulseAudio server choose the biggest size it can handle. */
1159	if (pCfgReq->enmDir == PDMAUDIODIR_IN)
1160	{
1161	pStreamPA->BufAttr.fragsize = PDMAudioPropsFramesToBytes(&pCfgAcq->Props, pCfgReq->Backend.cFramesPeriod);
1162	LogFunc(("Requesting: BufAttr: fragsize=%RU32\n", pStreamPA->BufAttr.fragsize));
1163	/* (rlength, minreq and prebuf are playback only) */
1164	}
1165	else
1166	{
1167	pStreamPA->cUsLatency = PDMAudioPropsFramesToMicro(&pCfgAcq->Props, pCfgReq->Backend.cFramesBufferSize);
1168	pStreamPA->BufAttr.tlength = pa_usec_to_bytes(pStreamPA->cUsLatency, &pStreamPA->SampleSpec);
1169	pStreamPA->BufAttr.minreq = PDMAudioPropsFramesToBytes(&pCfgAcq->Props, pCfgReq->Backend.cFramesPeriod);
1170	pStreamPA->BufAttr.prebuf = pa_usec_to_bytes(PDMAudioPropsFramesToMicro(&pCfgAcq->Props,
1171	pCfgReq->Backend.cFramesPreBuffering),
1172	&pStreamPA->SampleSpec);
1173	/* (fragsize is capture only) */
1174	LogRel2(("PulseAudio: Initial output latency is %RU64 us (%RU32 bytes)\n",
1175	pStreamPA->cUsLatency, pStreamPA->BufAttr.tlength));
1176	LogFunc(("Requesting: BufAttr: tlength=%RU32 maxLength=%RU32 minReq=%RU32 maxlength=-1\n",
1177	pStreamPA->BufAttr.tlength, pStreamPA->BufAttr.maxlength, pStreamPA->BufAttr.minreq));
1178	}
1179
1180	/*
1181	* Do the actual PA stream creation.
1182	*/
1183	pa_threaded_mainloop_lock(pThis->pMainLoop);
1184	rc = drvHstAudPaStreamCreateLocked(pThis, pStreamPA, szName, pCfgAcq);
1185	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1186	if (RT_SUCCESS(rc))
1187	{
1188	/*
1189	* Set the acquired stream config according to the actual buffer
1190	* attributes we got and the stream type.
1191	*/
1192	if (pCfgReq->enmDir == PDMAUDIODIR_IN)
1193	{
1194	pCfgAcq->Backend.cFramesPeriod = PDMAudioPropsBytesToFrames(&pCfgAcq->Props, pStreamPA->BufAttr.fragsize);
1195	pCfgAcq->Backend.cFramesBufferSize = pStreamPA->BufAttr.maxlength != UINT32_MAX /* paranoia */
1196	? PDMAudioPropsBytesToFrames(&pCfgAcq->Props, pStreamPA->BufAttr.maxlength)
1197	: pCfgAcq->Backend.cFramesPeriod * 2 /* whatever */;
1198	pCfgAcq->Backend.cFramesPreBuffering = pCfgAcq->Backend.cFramesPeriod;
1199	}
1200	else
1201	{
1202	pCfgAcq->Backend.cFramesPeriod = PDMAudioPropsBytesToFrames(&pCfgAcq->Props, pStreamPA->BufAttr.minreq);
1203	pCfgAcq->Backend.cFramesBufferSize = PDMAudioPropsBytesToFrames(&pCfgAcq->Props, pStreamPA->BufAttr.tlength);
1204	pCfgAcq->Backend.cFramesPreBuffering = pCfgReq->Backend.cFramesPreBuffering
1205	* pCfgAcq->Backend.cFramesBufferSize
1206	/ RT_MAX(pCfgReq->Backend.cFramesBufferSize, 1);
1207	}
1208
1209	/*
1210	* Translate back the channel mapping.
1211	*/
1212	for (iDst = 0; iDst < pStreamPA->ChannelMap.channels; iDst++)
1213	pCfgAcq->Props.aidChannels[iDst] = drvHstAudPaConvertChannelPos(pStreamPA->ChannelMap.map[iDst]);
1214	while (iDst < RT_ELEMENTS(pCfgAcq->Props.aidChannels))
1215	pCfgAcq->Props.aidChannels[iDst++] = PDMAUDIOCHANNELID_INVALID;
1216
1217	PDMAudioStrmCfgCopy(&pStreamPA->Cfg, pCfgAcq);
1218	}
1219	}
1220	else
1221	{
1222	LogRel(("PulseAudio: Unsupported sample specification for stream '%s'\n", szName));
1223	rc = VERR_AUDIO_STREAM_COULD_NOT_CREATE;
1224	}
1225
1226	LogFlowFuncLeaveRC(rc);
1227	return rc;
1228	}
1229
1230	/**
1231	* Cancel and release any pending stream requests (drain and cork/uncork).
1232	*
1233	* @note Caller has locked the mainloop.
1234	*/
1235	static void drvHstAudPaStreamCancelAndReleaseOperations(PDRVHSTAUDPASTREAM pStreamPA)
1236	{
1237	if (pStreamPA->pDrainOp)
1238	{
1239	LogFlowFunc(("drain operation (%p) status: %d\n", pStreamPA->pDrainOp, pa_operation_get_state(pStreamPA->pDrainOp)));
1240	pa_operation_cancel(pStreamPA->pDrainOp);
1241	pa_operation_unref(pStreamPA->pDrainOp);
1242	pStreamPA->pDrainOp = NULL;
1243	}
1244
1245	if (pStreamPA->pCorkOp)
1246	{
1247	LogFlowFunc(("cork operation (%p) status: %d\n", pStreamPA->pCorkOp, pa_operation_get_state(pStreamPA->pCorkOp)));
1248	pa_operation_cancel(pStreamPA->pCorkOp);
1249	pa_operation_unref(pStreamPA->pCorkOp);
1250	pStreamPA->pCorkOp = NULL;
1251	}
1252
1253	if (pStreamPA->pTriggerOp)
1254	{
1255	LogFlowFunc(("trigger operation (%p) status: %d\n", pStreamPA->pTriggerOp, pa_operation_get_state(pStreamPA->pTriggerOp)));
1256	pa_operation_cancel(pStreamPA->pTriggerOp);
1257	pa_operation_unref(pStreamPA->pTriggerOp);
1258	pStreamPA->pTriggerOp = NULL;
1259	}
1260	}
1261
1262
1263	/**
1264	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamDestroy}
1265	*/
1266	static DECLCALLBACK(int) drvHstAudPaHA_StreamDestroy(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream, bool fImmediate)
1267	{
1268	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1269	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1270	AssertPtrReturn(pStreamPA, VERR_INVALID_POINTER);
1271	RT_NOREF(fImmediate);
1272
1273	if (pStreamPA->pStream)
1274	{
1275	pa_threaded_mainloop_lock(pThis->pMainLoop);
1276
1277	drvHstAudPaStreamCancelAndReleaseOperations(pStreamPA);
1278	pa_stream_disconnect(pStreamPA->pStream);
1279
1280	pa_stream_unref(pStreamPA->pStream);
1281	pStreamPA->pStream = NULL;
1282
1283	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1284	}
1285
1286	return VINF_SUCCESS;
1287	}
1288
1289
1290	/**
1291	* Common worker for the cork/uncork completion callbacks.
1292	* @note This is fully async, so nobody is waiting for this.
1293	*/
1294	static void drvHstAudPaStreamCorkUncorkCommon(PDRVHSTAUDPASTREAM pStreamPA, int fSuccess, const char *pszOperation)
1295	{
1296	AssertPtrReturnVoid(pStreamPA);
1297	LogFlowFunc(("%s '%s': fSuccess=%RTbool\n", pszOperation, pStreamPA->Cfg.szName, fSuccess));
1298
1299	if (!fSuccess)
1300	drvHstAudPaError(pStreamPA->pDrv, "%s stream '%s' failed", pszOperation, pStreamPA->Cfg.szName);
1301
1302	if (pStreamPA->pCorkOp)
1303	{
1304	pa_operation_unref(pStreamPA->pCorkOp);
1305	pStreamPA->pCorkOp = NULL;
1306	}
1307	}
1308
1309
1310	/**
1311	* Completion callback used with pa_stream_cork(,false,).
1312	*/
1313	static void drvHstAudPaStreamUncorkCompletionCallback(pa_stream pStream, int fSuccess, void pvUser)
1314	{
1315	RT_NOREF(pStream);
1316	drvHstAudPaStreamCorkUncorkCommon((PDRVHSTAUDPASTREAM)pvUser, fSuccess, "Uncorking");
1317	}
1318
1319
1320	/**
1321	* Completion callback used with pa_stream_cork(,true,).
1322	*/
1323	static void drvHstAudPaStreamCorkCompletionCallback(pa_stream pStream, int fSuccess, void pvUser)
1324	{
1325	RT_NOREF(pStream);
1326	drvHstAudPaStreamCorkUncorkCommon((PDRVHSTAUDPASTREAM)pvUser, fSuccess, "Corking");
1327	}
1328
1329
1330	/**
1331	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamEnable}
1332	*/
1333	static DECLCALLBACK(int) drvHstAudPaHA_StreamEnable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1334	{
1335	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1336	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1337	LogFlowFunc(("\n"));
1338
1339	/*
1340	* Uncork (start or resume playback/capture) the stream.
1341	*/
1342	pa_threaded_mainloop_lock(pThis->pMainLoop);
1343
1344	drvHstAudPaStreamCancelAndReleaseOperations(pStreamPA);
1345	pStreamPA->pCorkOp = pa_stream_cork(pStreamPA->pStream, 0 /uncork it/,
1346	drvHstAudPaStreamUncorkCompletionCallback, pStreamPA);
1347	LogFlowFunc(("Uncorking '%s': %p (async)\n", pStreamPA->Cfg.szName, pStreamPA->pCorkOp));
1348	int const rc = pStreamPA->pCorkOp ? VINF_SUCCESS
1349	: drvHstAudPaError(pThis, "pa_stream_cork('%s', 0 /uncork it/,,) failed", pStreamPA->Cfg.szName);
1350
1351
1352	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1353
1354	LogFlowFunc(("returns %Rrc\n", rc));
1355	return rc;
1356	}
1357
1358
1359	/**
1360	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamDisable}
1361	*/
1362	static DECLCALLBACK(int) drvHstAudPaHA_StreamDisable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1363	{
1364	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1365	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1366	LogFlowFunc(("\n"));
1367
1368	pa_threaded_mainloop_lock(pThis->pMainLoop);
1369
1370	/*
1371	* For output streams, we will ignore the request if there is a pending drain
1372	* as it will cork the stream in the end.
1373	*/
1374	if (pStreamPA->Cfg.enmDir == PDMAUDIODIR_OUT)
1375	{
1376	if (pStreamPA->pDrainOp)
1377	{
1378	pa_operation_state_t const enmOpState = pa_operation_get_state(pStreamPA->pDrainOp);
1379	if (enmOpState == PA_OPERATION_RUNNING)
1380	{
1381	/** @todo consider corking it immediately instead, as that's what the caller
1382	* wants now... */
1383	LogFlowFunc(("Drain (%p) already running on '%s', skipping.\n", pStreamPA->pDrainOp, pStreamPA->Cfg.szName));
1384	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1385	return VINF_SUCCESS;
1386	}
1387	LogFlowFunc(("Drain (%p) not running: %d\n", pStreamPA->pDrainOp, enmOpState));
1388	}
1389	}
1390	/*
1391	* For input stream we always cork it, but we clean up the peek buffer first.
1392	*/
1393	/** @todo r=bird: It is (probably) not technically be correct to drop the peek buffer
1394	* here when we're only pausing the stream (VM paused) as it means we'll
1395	* risk underruns when later resuming. */
1396	else if (pStreamPA->pbPeekBuf) /** @todo Do we need to drop the peek buffer?*/
1397	{
1398	pStreamPA->pbPeekBuf = NULL;
1399	pStreamPA->cbPeekBuf = 0;
1400	pa_stream_drop(pStreamPA->pStream);
1401	}
1402
1403	/*
1404	* Cork (pause playback/capture) the stream.
1405	*/
1406	drvHstAudPaStreamCancelAndReleaseOperations(pStreamPA);
1407	pStreamPA->pCorkOp = pa_stream_cork(pStreamPA->pStream, 1 /* cork it */,
1408	drvHstAudPaStreamCorkCompletionCallback, pStreamPA);
1409	LogFlowFunc(("Corking '%s': %p (async)\n", pStreamPA->Cfg.szName, pStreamPA->pCorkOp));
1410	int const rc = pStreamPA->pCorkOp ? VINF_SUCCESS
1411	: drvHstAudPaError(pThis, "pa_stream_cork('%s', 1 /cork/,,) failed", pStreamPA->Cfg.szName);
1412
1413	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1414	LogFlowFunc(("returns %Rrc\n", rc));
1415	return rc;
1416	}
1417
1418
1419	/**
1420	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamPause}
1421	*/
1422	static DECLCALLBACK(int) drvHstAudPaHA_StreamPause(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1423	{
1424	/* Same as disable. */
1425	return drvHstAudPaHA_StreamDisable(pInterface, pStream);
1426	}
1427
1428
1429	/**
1430	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamResume}
1431	*/
1432	static DECLCALLBACK(int) drvHstAudPaHA_StreamResume(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1433	{
1434	/* Same as enable. */
1435	return drvHstAudPaHA_StreamEnable(pInterface, pStream);
1436	}
1437
1438
1439	/**
1440	* Pulse audio pa_stream_drain() completion callback.
1441	* @note This is fully async, so nobody is waiting for this.
1442	*/
1443	static void drvHstAudPaStreamDrainCompletionCallback(pa_stream pStream, int fSuccess, void pvUser)
1444	{
1445	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pvUser;
1446	AssertPtrReturnVoid(pStreamPA);
1447	Assert(pStreamPA->pStream == pStream);
1448	LogFlowFunc(("'%s': fSuccess=%RTbool\n", pStreamPA->Cfg.szName, fSuccess));
1449
1450	if (!fSuccess)
1451	drvHstAudPaError(pStreamPA->pDrv, "Draining stream '%s' failed", pStreamPA->Cfg.szName);
1452
1453	/* Now cork the stream (doing it unconditionally atm). */
1454	if (pStreamPA->pCorkOp)
1455	{
1456	LogFlowFunc(("Cancelling & releasing cork/uncork operation %p (state: %d)\n",
1457	pStreamPA->pCorkOp, pa_operation_get_state(pStreamPA->pCorkOp)));
1458	pa_operation_cancel(pStreamPA->pCorkOp);
1459	pa_operation_unref(pStreamPA->pCorkOp);
1460	}
1461
1462	pStreamPA->pCorkOp = pa_stream_cork(pStream, 1 /* cork it*/, drvHstAudPaStreamCorkCompletionCallback, pStreamPA);
1463	if (pStreamPA->pCorkOp)
1464	LogFlowFunc(("Started cork operation %p of %s (following drain)\n", pStreamPA->pCorkOp, pStreamPA->Cfg.szName));
1465	else
1466	drvHstAudPaError(pStreamPA->pDrv, "pa_stream_cork failed on '%s' (following drain)", pStreamPA->Cfg.szName);
1467	}
1468
1469
1470	/**
1471	* Callback used with pa_stream_tigger(), starts draining.
1472	*/
1473	static void drvHstAudPaStreamTriggerCompletionCallback(pa_stream pStream, int fSuccess, void pvUser)
1474	{
1475	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pvUser;
1476	AssertPtrReturnVoid(pStreamPA);
1477	RT_NOREF(pStream);
1478	LogFlowFunc(("'%s': fSuccess=%RTbool\n", pStreamPA->Cfg.szName, fSuccess));
1479
1480	if (!fSuccess)
1481	drvHstAudPaError(pStreamPA->pDrv, "Forcing playback before drainig '%s' failed", pStreamPA->Cfg.szName);
1482
1483	if (pStreamPA->pTriggerOp)
1484	{
1485	pa_operation_unref(pStreamPA->pTriggerOp);
1486	pStreamPA->pTriggerOp = NULL;
1487	}
1488	}
1489
1490
1491	/**
1492	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamDrain}
1493	*/
1494	static DECLCALLBACK(int) drvHstAudPaHA_StreamDrain(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1495	{
1496	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1497	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1498	AssertReturn(pStreamPA->Cfg.enmDir == PDMAUDIODIR_OUT, VERR_INVALID_PARAMETER);
1499	LogFlowFunc(("\n"));
1500
1501	pa_threaded_mainloop_lock(pThis->pMainLoop);
1502
1503	/*
1504	* If there is a drain running already, don't try issue another as pulse
1505	* doesn't support more than one concurrent drain per stream.
1506	*/
1507	if (pStreamPA->pDrainOp)
1508	{
1509	if (pa_operation_get_state(pStreamPA->pDrainOp) == PA_OPERATION_RUNNING)
1510	{
1511	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1512	LogFlowFunc(("returns VINF_SUCCESS (drain already running)\n"));
1513	return VINF_SUCCESS;
1514	}
1515	LogFlowFunc(("Releasing drain operation %p (state: %d)\n", pStreamPA->pDrainOp, pa_operation_get_state(pStreamPA->pDrainOp)));
1516	pa_operation_unref(pStreamPA->pDrainOp);
1517	pStreamPA->pDrainOp = NULL;
1518	}
1519
1520	/*
1521	* Make sure pre-buffered data is played before we drain it.
1522	*
1523	* ASSUMES that the async stream requests are executed in the order they're
1524	* issued here, so that we avoid waiting for the trigger request to complete.
1525	*/
1526	int rc = VINF_SUCCESS;
1527	if (true /** @todo skip this if we're already playing or haven't written any data to the stream since xxxx. */)
1528	{
1529	if (pStreamPA->pTriggerOp)
1530	{
1531	LogFlowFunc(("Cancelling & releasing trigger operation %p (state: %d)\n",
1532	pStreamPA->pTriggerOp, pa_operation_get_state(pStreamPA->pTriggerOp)));
1533	pa_operation_cancel(pStreamPA->pTriggerOp);
1534	pa_operation_unref(pStreamPA->pTriggerOp);
1535	}
1536	pStreamPA->pTriggerOp = pa_stream_trigger(pStreamPA->pStream, drvHstAudPaStreamTriggerCompletionCallback, pStreamPA);
1537	if (pStreamPA->pTriggerOp)
1538	LogFlowFunc(("Started tigger operation %p on %s\n", pStreamPA->pTriggerOp, pStreamPA->Cfg.szName));
1539	else
1540	rc = drvHstAudPaError(pStreamPA->pDrv, "pa_stream_trigger failed on '%s'", pStreamPA->Cfg.szName);
1541	}
1542
1543	/*
1544	* Initiate the draining (async), will cork the stream when it completes.
1545	*/
1546	pStreamPA->pDrainOp = pa_stream_drain(pStreamPA->pStream, drvHstAudPaStreamDrainCompletionCallback, pStreamPA);
1547	if (pStreamPA->pDrainOp)
1548	LogFlowFunc(("Started drain operation %p of %s\n", pStreamPA->pDrainOp, pStreamPA->Cfg.szName));
1549	else
1550	rc = drvHstAudPaError(pStreamPA->pDrv, "pa_stream_drain failed on '%s'", pStreamPA->Cfg.szName);
1551
1552	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1553	LogFlowFunc(("returns %Rrc\n", rc));
1554	return rc;
1555	}
1556
1557
1558	/**
1559	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetState}
1560	*/
1561	static DECLCALLBACK(PDMHOSTAUDIOSTREAMSTATE) drvHstAudPaHA_StreamGetState(PPDMIHOSTAUDIO pInterface,
1562	PPDMAUDIOBACKENDSTREAM pStream)
1563	{
1564	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1565	AssertPtrReturn(pStream, PDMHOSTAUDIOSTREAMSTATE_INVALID);
1566	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1567	AssertPtrReturn(pStreamPA, PDMHOSTAUDIOSTREAMSTATE_INVALID);
1568
1569	/* Check PulseAudio's general status. */
1570	PDMHOSTAUDIOSTREAMSTATE enmBackendStreamState = PDMHOSTAUDIOSTREAMSTATE_NOT_WORKING;
1571	if (pThis->pContext)
1572	{
1573	pa_context_state_t const enmPaCtxState = pa_context_get_state(pThis->pContext);
1574	if (PA_CONTEXT_IS_GOOD(enmPaCtxState))
1575	{
1576	pa_stream_state_t const enmPaStreamState = pa_stream_get_state(pStreamPA->pStream);
1577	if (PA_STREAM_IS_GOOD(enmPaStreamState))
1578	{
1579	if (enmPaStreamState != PA_STREAM_CREATING)
1580	{
1581	if ( pStreamPA->Cfg.enmDir != PDMAUDIODIR_OUT
1582	\|\| pStreamPA->pDrainOp == NULL
1583	\|\| pa_operation_get_state(pStreamPA->pDrainOp) != PA_OPERATION_RUNNING)
1584	enmBackendStreamState = PDMHOSTAUDIOSTREAMSTATE_OKAY;
1585	else
1586	enmBackendStreamState = PDMHOSTAUDIOSTREAMSTATE_DRAINING;
1587	}
1588	else
1589	enmBackendStreamState = PDMHOSTAUDIOSTREAMSTATE_INITIALIZING;
1590	}
1591	else
1592	LogFunc(("non-good PA stream state: %d\n", enmPaStreamState));
1593	}
1594	else
1595	LogFunc(("non-good PA context state: %d\n", enmPaCtxState));
1596	}
1597	else
1598	LogFunc(("No context!\n"));
1599	LogFlowFunc(("returns %s for stream '%s'\n", PDMHostAudioStreamStateGetName(enmBackendStreamState), pStreamPA->Cfg.szName));
1600	return enmBackendStreamState;
1601	}
1602
1603
1604	/**
1605	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetWritable}
1606	*/
1607	static DECLCALLBACK(uint32_t) drvHstAudPaHA_StreamGetWritable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1608	{
1609	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1610	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1611	uint32_t cbWritable = 0;
1612	if (pStreamPA->Cfg.enmDir == PDMAUDIODIR_OUT)
1613	{
1614	pa_threaded_mainloop_lock(pThis->pMainLoop);
1615
1616	pa_stream_state_t const enmState = pa_stream_get_state(pStreamPA->pStream);
1617	if (PA_STREAM_IS_GOOD(enmState))
1618	{
1619	size_t cbWritablePa = pa_stream_writable_size(pStreamPA->pStream);
1620	if (cbWritablePa != (size_t)-1)
1621	cbWritable = cbWritablePa <= UINT32_MAX ? (uint32_t)cbWritablePa : UINT32_MAX;
1622	else
1623	drvHstAudPaError(pThis, "pa_stream_writable_size failed on '%s'", pStreamPA->Cfg.szName);
1624	}
1625	else
1626	LogFunc(("non-good stream state: %d\n", enmState));
1627
1628	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1629	}
1630	Log3Func(("returns %#x (%u) [max=%#RX32 min=%#RX32]\n",
1631	cbWritable, cbWritable, pStreamPA->BufAttr.maxlength, pStreamPA->BufAttr.minreq));
1632	return cbWritable;
1633	}
1634
1635
1636	/**
1637	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamPlay}
1638	*/
1639	static DECLCALLBACK(int) drvHstAudPaHA_StreamPlay(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1640	const void pvBuf, uint32_t cbBuf, uint32_t pcbWritten)
1641	{
1642	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1643	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1644	AssertPtrReturn(pStreamPA, VERR_INVALID_POINTER);
1645	AssertPtrReturn(pcbWritten, VERR_INVALID_POINTER);
1646	if (cbBuf)
1647	AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1648	else
1649	{
1650	/* Fend off draining calls. */
1651	*pcbWritten = 0;
1652	return VINF_SUCCESS;
1653	}
1654
1655	pa_threaded_mainloop_lock(pThis->pMainLoop);
1656
1657	#ifdef LOG_ENABLED
1658	const pa_usec_t tsNowUs = pa_rtclock_now();
1659	Log3Func(("play delta: %'RU64 us; cbBuf=%#x\n", tsNowUs - pStreamPA->tsLastReadWrittenUs, cbBuf));
1660	pStreamPA->tsLastReadWrittenUs = tsNowUs;
1661	#endif
1662
1663	/*
1664	* Using a loop here so we can take maxlength into account when writing.
1665	*/
1666	int rc = VINF_SUCCESS;
1667	uint32_t cbTotalWritten = 0;
1668	uint32_t iLoop;
1669	for (iLoop = 0; ; iLoop++)
1670	{
1671	size_t const cbWriteable = pa_stream_writable_size(pStreamPA->pStream);
1672	if ( cbWriteable != (size_t)-1
1673	&& cbWriteable >= PDMAudioPropsFrameSize(&pStreamPA->Cfg.Props))
1674	{
1675	uint32_t cbToWrite = (uint32_t)RT_MIN(RT_MIN(cbWriteable, pStreamPA->BufAttr.maxlength), cbBuf);
1676	cbToWrite = PDMAudioPropsFloorBytesToFrame(&pStreamPA->Cfg.Props, cbToWrite);
1677	if (pa_stream_write(pStreamPA->pStream, pvBuf, cbToWrite, NULL /pfnFree/, 0 /offset/, PA_SEEK_RELATIVE) >= 0)
1678	{
1679	cbTotalWritten += cbToWrite;
1680	cbBuf -= cbToWrite;
1681	if (!cbBuf)
1682	break;
1683	pvBuf = (uint8_t const *)pvBuf + cbToWrite;
1684	Log3Func(("%#x left to write\n", cbBuf));
1685	}
1686	else
1687	{
1688	rc = drvHstAudPaError(pStreamPA->pDrv, "Failed to write to output stream");
1689	break;
1690	}
1691	}
1692	else
1693	{
1694	if (cbWriteable == (size_t)-1)
1695	rc = drvHstAudPaError(pStreamPA->pDrv, "pa_stream_writable_size failed on '%s'", pStreamPA->Cfg.szName);
1696	break;
1697	}
1698	}
1699
1700	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1701
1702	*pcbWritten = cbTotalWritten;
1703	if (RT_SUCCESS(rc) \|\| cbTotalWritten == 0)
1704	{ /* likely */ }
1705	else
1706	{
1707	LogFunc(("Supressing %Rrc because we wrote %#x bytes\n", rc, cbTotalWritten));
1708	rc = VINF_SUCCESS;
1709	}
1710	Log3Func(("returns %Rrc *pcbWritten=%#x iLoop=%u\n", rc, cbTotalWritten, iLoop));
1711	return rc;
1712	}
1713
1714
1715	/**
1716	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetReadable}
1717	*/
1718	static DECLCALLBACK(uint32_t) drvHstAudPaHA_StreamGetReadable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
1719	{
1720	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1721	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1722	uint32_t cbReadable = 0;
1723	if (pStreamPA->Cfg.enmDir == PDMAUDIODIR_IN)
1724	{
1725	pa_threaded_mainloop_lock(pThis->pMainLoop);
1726
1727	pa_stream_state_t const enmState = pa_stream_get_state(pStreamPA->pStream);
1728	if (PA_STREAM_IS_GOOD(enmState))
1729	{
1730	size_t cbReadablePa = pa_stream_readable_size(pStreamPA->pStream);
1731	if (cbReadablePa != (size_t)-1)
1732	cbReadable = (uint32_t)cbReadablePa;
1733	else
1734	drvHstAudPaError(pThis, "pa_stream_readable_size failed on '%s'", pStreamPA->Cfg.szName);
1735	}
1736	else
1737	LogFunc(("non-good stream state: %d\n", enmState));
1738
1739	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1740	}
1741	Log3Func(("returns %#x (%u)\n", cbReadable, cbReadable));
1742	return cbReadable;
1743	}
1744
1745
1746	/**
1747	* @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCapture}
1748	*/
1749	static DECLCALLBACK(int) drvHstAudPaHA_StreamCapture(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
1750	void pvBuf, uint32_t cbBuf, uint32_t pcbRead)
1751	{
1752	PDRVHSTAUDPA pThis = RT_FROM_MEMBER(pInterface, DRVHSTAUDPA, IHostAudio);
1753	PDRVHSTAUDPASTREAM pStreamPA = (PDRVHSTAUDPASTREAM)pStream;
1754	AssertPtrReturn(pStreamPA, VERR_INVALID_POINTER);
1755	AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1756	AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
1757	AssertPtrReturn(pcbRead, VERR_INVALID_POINTER);
1758
1759	#ifdef LOG_ENABLED
1760	const pa_usec_t tsNowUs = pa_rtclock_now();
1761	Log3Func(("capture delta: %'RU64 us; cbBuf=%#x\n", tsNowUs - pStreamPA->tsLastReadWrittenUs, cbBuf));
1762	pStreamPA->tsLastReadWrittenUs = tsNowUs;
1763	#endif
1764
1765	/*
1766	* If we have left over peek buffer space from the last call,
1767	* copy out the data from there.
1768	*/
1769	uint32_t cbTotalRead = 0;
1770	if ( pStreamPA->pbPeekBuf
1771	&& pStreamPA->offPeekBuf < pStreamPA->cbPeekBuf)
1772	{
1773	uint32_t cbToCopy = pStreamPA->cbPeekBuf - pStreamPA->offPeekBuf;
1774	if (cbToCopy >= cbBuf)
1775	{
1776	memcpy(pvBuf, &pStreamPA->pbPeekBuf[pStreamPA->offPeekBuf], cbBuf);
1777	pStreamPA->offPeekBuf += cbBuf;
1778	*pcbRead = cbBuf;
1779	if (cbToCopy == cbBuf)
1780	{
1781	pa_threaded_mainloop_lock(pThis->pMainLoop);
1782	pStreamPA->pbPeekBuf = NULL;
1783	pStreamPA->cbPeekBuf = 0;
1784	pa_stream_drop(pStreamPA->pStream);
1785	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1786	}
1787	Log3Func(("returns *pcbRead=%#x from prev peek buf (%#x/%#x)\n", cbBuf, pStreamPA->offPeekBuf, pStreamPA->cbPeekBuf));
1788	return VINF_SUCCESS;
1789	}
1790
1791	memcpy(pvBuf, &pStreamPA->pbPeekBuf[pStreamPA->offPeekBuf], cbToCopy);
1792	cbBuf -= cbToCopy;
1793	pvBuf = (uint8_t *)pvBuf + cbToCopy;
1794	cbTotalRead += cbToCopy;
1795	pStreamPA->offPeekBuf = pStreamPA->cbPeekBuf;
1796	}
1797
1798	/*
1799	* Copy out what we can.
1800	*/
1801	int rc = VINF_SUCCESS;
1802	pa_threaded_mainloop_lock(pThis->pMainLoop);
1803	while (cbBuf > 0)
1804	{
1805	/*
1806	* Drop the old peek buffer first, if we have one.
1807	*/
1808	if (pStreamPA->pbPeekBuf)
1809	{
1810	Assert(pStreamPA->offPeekBuf >= pStreamPA->cbPeekBuf);
1811	pStreamPA->pbPeekBuf = NULL;
1812	pStreamPA->cbPeekBuf = 0;
1813	pa_stream_drop(pStreamPA->pStream);
1814	}
1815
1816	/*
1817	* Check if there is anything to read, the get the peek buffer for it.
1818	*/
1819	size_t cbAvail = pa_stream_readable_size(pStreamPA->pStream);
1820	if (cbAvail > 0 && cbAvail != (size_t)-1)
1821	{
1822	pStreamPA->pbPeekBuf = NULL;
1823	pStreamPA->cbPeekBuf = 0;
1824	int rcPa = pa_stream_peek(pStreamPA->pStream, (const void **)&pStreamPA->pbPeekBuf, &pStreamPA->cbPeekBuf);
1825	if (rcPa == 0)
1826	{
1827	if (pStreamPA->cbPeekBuf)
1828	{
1829	if (pStreamPA->pbPeekBuf)
1830	{
1831	/*
1832	* We got data back. Copy it into the return buffer, return if it's full.
1833	*/
1834	if (cbBuf < pStreamPA->cbPeekBuf)
1835	{
1836	memcpy(pvBuf, pStreamPA->pbPeekBuf, cbBuf);
1837	cbTotalRead += cbBuf;
1838	pStreamPA->offPeekBuf = cbBuf;
1839	cbBuf = 0;
1840	break;
1841	}
1842	memcpy(pvBuf, pStreamPA->pbPeekBuf, pStreamPA->cbPeekBuf);
1843	cbBuf -= pStreamPA->cbPeekBuf;
1844	pvBuf = (uint8_t *)pvBuf + pStreamPA->cbPeekBuf;
1845	cbTotalRead += pStreamPA->cbPeekBuf;
1846
1847	pStreamPA->pbPeekBuf = NULL;
1848	}
1849	else
1850	{
1851	/*
1852	* We got a hole (drop needed). We will skip it as we leave it to
1853	* the device's DMA engine to fill in buffer gaps with silence.
1854	*/
1855	LogFunc(("pa_stream_peek returned a %#zx (%zu) byte hole - skipping.\n",
1856	pStreamPA->cbPeekBuf, pStreamPA->cbPeekBuf));
1857	}
1858	pStreamPA->cbPeekBuf = 0;
1859	pa_stream_drop(pStreamPA->pStream);
1860	}
1861	else
1862	{
1863	Assert(!pStreamPA->pbPeekBuf);
1864	LogFunc(("pa_stream_peek returned empty buffer\n"));
1865	break;
1866	}
1867	}
1868	else
1869	{
1870	rc = drvHstAudPaError(pStreamPA->pDrv, "pa_stream_peek failed on '%s' (%d)", pStreamPA->Cfg.szName, rcPa);
1871	pStreamPA->pbPeekBuf = NULL;
1872	pStreamPA->cbPeekBuf = 0;
1873	break;
1874	}
1875	}
1876	else
1877	{
1878	if (cbAvail != (size_t)-1)
1879	rc = drvHstAudPaError(pStreamPA->pDrv, "pa_stream_readable_size failed on '%s'", pStreamPA->Cfg.szName);
1880	break;
1881	}
1882	}
1883	pa_threaded_mainloop_unlock(pThis->pMainLoop);
1884
1885	*pcbRead = cbTotalRead;
1886	if (RT_SUCCESS(rc) \|\| cbTotalRead == 0)
1887	{ /* likely */ }
1888	else
1889	{
1890	LogFunc(("Supressing %Rrc because we're returning %#x bytes\n", rc, cbTotalRead));
1891	rc = VINF_SUCCESS;
1892	}
1893	Log3Func(("returns %Rrc *pcbRead=%#x (%#x left, peek %#x/%#x)\n",
1894	rc, cbTotalRead, cbBuf, pStreamPA->offPeekBuf, pStreamPA->cbPeekBuf));
1895	return rc;
1896	}
1897
1898
1899	/*********************************************************************************************************************************
1900	* PDMIBASE *
1901	*********************************************************************************************************************************/
1902
1903	/**
1904	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
1905	*/
1906	static DECLCALLBACK(void ) drvHstAudPaQueryInterface(PPDMIBASE pInterface, const char pszIID)
1907	{
1908	AssertPtrReturn(pInterface, NULL);
1909	AssertPtrReturn(pszIID, NULL);
1910
1911	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
1912	PDRVHSTAUDPA pThis = PDMINS_2_DATA(pDrvIns, PDRVHSTAUDPA);
1913	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
1914	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHOSTAUDIO, &pThis->IHostAudio);
1915
1916	return NULL;
1917	}
1918
1919
1920	/*********************************************************************************************************************************
1921	* PDMDRVREG *
1922	*********************************************************************************************************************************/
1923
1924	/**
1925	* Destructs a PulseAudio Audio driver instance.
1926	*
1927	* @copydoc FNPDMDRVDESTRUCT
1928	*/
1929	static DECLCALLBACK(void) drvHstAudPaDestruct(PPDMDRVINS pDrvIns)
1930	{
1931	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1932	PDRVHSTAUDPA pThis = PDMINS_2_DATA(pDrvIns, PDRVHSTAUDPA);
1933	LogFlowFuncEnter();
1934
1935	if (pThis->pMainLoop)
1936	pa_threaded_mainloop_stop(pThis->pMainLoop);
1937
1938	if (pThis->pContext)
1939	{
1940	pa_context_disconnect(pThis->pContext);
1941	pa_context_unref(pThis->pContext);
1942	pThis->pContext = NULL;
1943	}
1944
1945	if (pThis->pMainLoop)
1946	{
1947	pa_threaded_mainloop_free(pThis->pMainLoop);
1948	pThis->pMainLoop = NULL;
1949	}
1950
1951	LogFlowFuncLeave();
1952	}
1953
1954
1955	/**
1956	* Pulse audio callback for context status changes, init variant.
1957	*
1958	* Signalls our event semaphore so we can do a timed wait from
1959	* drvHstAudPaConstruct().
1960	*/
1961	static void drvHstAudPaCtxCallbackStateChangedInit(pa_context pCtx, void pvUser)
1962	{
1963	AssertPtrReturnVoid(pCtx);
1964	PDRVHSTAUDPASTATECHGCTX pStateChgCtx = (PDRVHSTAUDPASTATECHGCTX)pvUser;
1965	pa_context_state_t enmCtxState = pa_context_get_state(pCtx);
1966	switch (enmCtxState)
1967	{
1968	case PA_CONTEXT_READY:
1969	case PA_CONTEXT_TERMINATED:
1970	case PA_CONTEXT_FAILED:
1971	AssertPtrReturnVoid(pStateChgCtx);
1972	pStateChgCtx->enmCtxState = enmCtxState;
1973	RTSemEventSignal(pStateChgCtx->hEvtInit);
1974	break;
1975
1976	default:
1977	break;
1978	}
1979	}
1980
1981
1982	/**
1983	* Constructs a PulseAudio Audio driver instance.
1984	*
1985	* @copydoc FNPDMDRVCONSTRUCT
1986	*/
1987	static DECLCALLBACK(int) drvHstAudPaConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1988	{
1989	RT_NOREF(pCfg, fFlags);
1990	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1991	PDRVHSTAUDPA pThis = PDMINS_2_DATA(pDrvIns, PDRVHSTAUDPA);
1992	LogRel(("Audio: Initializing PulseAudio driver\n"));
1993
1994	/*
1995	* Initialize instance data.
1996	*/
1997	pThis->pDrvIns = pDrvIns;
1998	/* IBase */
1999	pDrvIns->IBase.pfnQueryInterface = drvHstAudPaQueryInterface;
2000	/* IHostAudio */
2001	pThis->IHostAudio.pfnGetConfig = drvHstAudPaHA_GetConfig;
2002	pThis->IHostAudio.pfnGetDevices = drvHstAudPaHA_GetDevices;
2003	pThis->IHostAudio.pfnSetDevice = NULL;
2004	pThis->IHostAudio.pfnGetStatus = drvHstAudPaHA_GetStatus;
2005	pThis->IHostAudio.pfnDoOnWorkerThread = NULL;
2006	pThis->IHostAudio.pfnStreamConfigHint = NULL;
2007	pThis->IHostAudio.pfnStreamCreate = drvHstAudPaHA_StreamCreate;
2008	pThis->IHostAudio.pfnStreamInitAsync = NULL;
2009	pThis->IHostAudio.pfnStreamDestroy = drvHstAudPaHA_StreamDestroy;
2010	pThis->IHostAudio.pfnStreamNotifyDeviceChanged = NULL;
2011	pThis->IHostAudio.pfnStreamEnable = drvHstAudPaHA_StreamEnable;
2012	pThis->IHostAudio.pfnStreamDisable = drvHstAudPaHA_StreamDisable;
2013	pThis->IHostAudio.pfnStreamPause = drvHstAudPaHA_StreamPause;
2014	pThis->IHostAudio.pfnStreamResume = drvHstAudPaHA_StreamResume;
2015	pThis->IHostAudio.pfnStreamDrain = drvHstAudPaHA_StreamDrain;
2016	pThis->IHostAudio.pfnStreamGetState = drvHstAudPaHA_StreamGetState;
2017	pThis->IHostAudio.pfnStreamGetPending = NULL;
2018	pThis->IHostAudio.pfnStreamGetWritable = drvHstAudPaHA_StreamGetWritable;
2019	pThis->IHostAudio.pfnStreamPlay = drvHstAudPaHA_StreamPlay;
2020	pThis->IHostAudio.pfnStreamGetReadable = drvHstAudPaHA_StreamGetReadable;
2021	pThis->IHostAudio.pfnStreamCapture = drvHstAudPaHA_StreamCapture;
2022
2023	/*
2024	* Read configuration.
2025	*/
2026	int rc2 = CFGMR3QueryString(pCfg, "VmName", pThis->szStreamName, sizeof(pThis->szStreamName));
2027	AssertMsgRCReturn(rc2, ("Confguration error: No/bad \"VmName\" value, rc=%Rrc\n", rc2), rc2);
2028
2029	/*
2030	* Load the pulse audio library.
2031	*/
2032	int rc = audioLoadPulseLib();
2033	if (RT_SUCCESS(rc))
2034	LogRel(("PulseAudio: Using version %s\n", pa_get_library_version()));
2035	else
2036	{
2037	LogRel(("PulseAudio: Failed to load the PulseAudio shared library! Error %Rrc\n", rc));
2038	return rc;
2039	}
2040
2041	/*
2042	* Set up the basic pulse audio bits (remember the destructore is always called).
2043	*/
2044	//pThis->fAbortLoop = false;
2045	pThis->pMainLoop = pa_threaded_mainloop_new();
2046	if (!pThis->pMainLoop)
2047	{
2048	LogRel(("PulseAudio: Failed to allocate main loop: %s\n", pa_strerror(pa_context_errno(pThis->pContext))));
2049	return VERR_NO_MEMORY;
2050	}
2051
2052	pThis->pContext = pa_context_new(pa_threaded_mainloop_get_api(pThis->pMainLoop), "VirtualBox");
2053	if (!pThis->pContext)
2054	{
2055	LogRel(("PulseAudio: Failed to allocate context: %s\n", pa_strerror(pa_context_errno(pThis->pContext))));
2056	return VERR_NO_MEMORY;
2057	}
2058
2059	if (pa_threaded_mainloop_start(pThis->pMainLoop) < 0)
2060	{
2061	LogRel(("PulseAudio: Failed to start threaded mainloop: %s\n", pa_strerror(pa_context_errno(pThis->pContext))));
2062	return VERR_AUDIO_BACKEND_INIT_FAILED;
2063	}
2064
2065	/*
2066	* Connect to the pulse audio server.
2067	*
2068	* We install an init state callback so we can do a timed wait in case
2069	* connecting to the pulseaudio server should take too long.
2070	*/
2071	pThis->InitStateChgCtx.hEvtInit = NIL_RTSEMEVENT;
2072	pThis->InitStateChgCtx.enmCtxState = PA_CONTEXT_UNCONNECTED;
2073	rc = RTSemEventCreate(&pThis->InitStateChgCtx.hEvtInit);
2074	AssertLogRelRCReturn(rc, rc);
2075
2076	pa_threaded_mainloop_lock(pThis->pMainLoop);
2077	pa_context_set_state_callback(pThis->pContext, drvHstAudPaCtxCallbackStateChangedInit, &pThis->InitStateChgCtx);
2078	if (!pa_context_connect(pThis->pContext, NULL /* pszServer */, PA_CONTEXT_NOFLAGS, NULL))
2079	{
2080	pa_threaded_mainloop_unlock(pThis->pMainLoop);
2081
2082	rc = RTSemEventWait(pThis->InitStateChgCtx.hEvtInit, RT_MS_10SEC); /* 10 seconds should be plenty. */
2083	if (RT_SUCCESS(rc))
2084	{
2085	if (pThis->InitStateChgCtx.enmCtxState == PA_CONTEXT_READY)
2086	{
2087	/* Install the main state changed callback to know if something happens to our acquired context. */
2088	pa_threaded_mainloop_lock(pThis->pMainLoop);
2089	pa_context_set_state_callback(pThis->pContext, drvHstAudPaCtxCallbackStateChanged, pThis /* pvUserData */);
2090	pa_threaded_mainloop_unlock(pThis->pMainLoop);
2091	}
2092	else
2093	{
2094	LogRel(("PulseAudio: Failed to initialize context (state %d, rc=%Rrc)\n", pThis->InitStateChgCtx.enmCtxState, rc));
2095	rc = VERR_AUDIO_BACKEND_INIT_FAILED;
2096	}
2097	}
2098	else
2099	{
2100	LogRel(("PulseAudio: Waiting for context to become ready failed: %Rrc\n", rc));
2101	rc = VERR_AUDIO_BACKEND_INIT_FAILED;
2102	}
2103	}
2104	else
2105	{
2106	pa_threaded_mainloop_unlock(pThis->pMainLoop);
2107	LogRel(("PulseAudio: Failed to connect to server: %s\n", pa_strerror(pa_context_errno(pThis->pContext))));
2108	rc = VERR_AUDIO_BACKEND_INIT_FAILED; /* bird: This used to be VINF_SUCCESS. */
2109	}
2110
2111	RTSemEventDestroy(pThis->InitStateChgCtx.hEvtInit);
2112	pThis->InitStateChgCtx.hEvtInit = NIL_RTSEMEVENT;
2113
2114	return rc;
2115	}
2116
2117
2118	/**
2119	* Pulse audio driver registration record.
2120	*/
2121	const PDMDRVREG g_DrvHostPulseAudio =
2122	{
2123	/* u32Version */
2124	PDM_DRVREG_VERSION,
2125	/* szName */
2126	"PulseAudio",
2127	/* szRCMod */
2128	"",
2129	/* szR0Mod */
2130	"",
2131	/* pszDescription */
2132	"Pulse Audio host driver",
2133	/* fFlags */
2134	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
2135	/* fClass. */
2136	PDM_DRVREG_CLASS_AUDIO,
2137	/* cMaxInstances */
2138	~0U,
2139	/* cbInstance */
2140	sizeof(DRVHSTAUDPA),
2141	/* pfnConstruct */
2142	drvHstAudPaConstruct,
2143	/* pfnDestruct */
2144	drvHstAudPaDestruct,
2145	/* pfnRelocate */
2146	NULL,
2147	/* pfnIOCtl */
2148	NULL,
2149	/* pfnPowerOn */
2150	NULL,
2151	/* pfnReset */
2152	NULL,
2153	/* pfnSuspend */
2154	NULL,
2155	/* pfnResume */
2156	NULL,
2157	/* pfnAttach */
2158	NULL,
2159	/* pfnDetach */
2160	NULL,
2161	/* pfnPowerOff */
2162	NULL,
2163	/* pfnSoftReset */
2164	NULL,
2165	/* u32EndVersion */
2166	PDM_DRVREG_VERSION
2167	};
2168

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

source: vbox/trunk/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp@ 89518

Download in other formats: