VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/DrvAudio.cpp@ 73838

最後變更 在這個檔案從73838是 73830,由 vboxsync 提交於 7 年 前

Audio/DrvAudio: Logging.
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 124.2 KB
行 
1/* $Id: DrvAudio.cpp 73830 2018-08-22 14:26:41Z vboxsync $ */
2/** @file
3 * Intermediate audio driver header.
4 *
5 * @remarks Intermediate audio driver for connecting the audio device emulation
6 * with the host backend.
7 */
8
9/*
10 * Copyright (C) 2006-2018 Oracle Corporation
11 *
12 * This file is part of VirtualBox Open Source Edition (OSE), as
13 * available from http://www.alldomusa.eu.org. This file is free software;
14 * you can redistribute it and/or modify it under the terms of the GNU
15 * General Public License (GPL) as published by the Free Software
16 * Foundation, in version 2 as it comes in the "COPYING" file of the
17 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 */
20
21#define LOG_GROUP LOG_GROUP_DRV_AUDIO
22#include <VBox/log.h>
23#include <VBox/vmm/pdm.h>
24#include <VBox/err.h>
25#include <VBox/vmm/mm.h>
26#include <VBox/vmm/pdmaudioifs.h>
27
28#include <iprt/alloc.h>
29#include <iprt/asm-math.h>
30#include <iprt/assert.h>
31#include <iprt/circbuf.h>
32#include <iprt/string.h>
33#include <iprt/uuid.h>
34
35#include "VBoxDD.h"
36
37#include <ctype.h>
38#include <stdlib.h>
39
40#include "DrvAudio.h"
41#include "AudioMixBuffer.h"
42
43#ifdef VBOX_WITH_AUDIO_ENUM
44static int drvAudioDevicesEnumerateInternal(PDRVAUDIO pThis, bool fLog, PPDMAUDIODEVICEENUM pDevEnum);
45#endif
46
47static DECLCALLBACK(int) drvAudioStreamDestroy(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream);
48static int drvAudioStreamControlInternalBackend(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd);
49static int drvAudioStreamControlInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd);
50static int drvAudioStreamCreateInternalBackend(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq);
51static int drvAudioStreamDestroyInternalBackend(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream);
52static void drvAudioStreamFree(PPDMAUDIOSTREAM pStream);
53static int drvAudioStreamUninitInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream);
54static int drvAudioStreamInitInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PPDMAUDIOSTREAMCFG pCfgHost, PPDMAUDIOSTREAMCFG pCfgGuest);
55static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream);
56static int drvAudioStreamReInitInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream);
57static void drvAudioStreamResetInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream);
58
59#ifndef VBOX_AUDIO_TESTCASE
60
61# if 0 /* unused */
62
63static PDMAUDIOFMT drvAudioGetConfFormat(PCFGMNODE pCfgHandle, const char *pszKey,
64 PDMAUDIOFMT enmDefault, bool *pfDefault)
65{
66 if ( pCfgHandle == NULL
67 || pszKey == NULL)
68 {
69 *pfDefault = true;
70 return enmDefault;
71 }
72
73 char *pszValue = NULL;
74 int rc = CFGMR3QueryStringAlloc(pCfgHandle, pszKey, &pszValue);
75 if (RT_FAILURE(rc))
76 {
77 *pfDefault = true;
78 return enmDefault;
79 }
80
81 PDMAUDIOFMT fmt = DrvAudioHlpStrToAudFmt(pszValue);
82 if (fmt == PDMAUDIOFMT_INVALID)
83 {
84 *pfDefault = true;
85 return enmDefault;
86 }
87
88 *pfDefault = false;
89 return fmt;
90}
91
92static int drvAudioGetConfInt(PCFGMNODE pCfgHandle, const char *pszKey,
93 int iDefault, bool *pfDefault)
94{
95
96 if ( pCfgHandle == NULL
97 || pszKey == NULL)
98 {
99 *pfDefault = true;
100 return iDefault;
101 }
102
103 uint64_t u64Data = 0;
104 int rc = CFGMR3QueryInteger(pCfgHandle, pszKey, &u64Data);
105 if (RT_FAILURE(rc))
106 {
107 *pfDefault = true;
108 return iDefault;
109
110 }
111
112 *pfDefault = false;
113 return u64Data;
114}
115
116static const char *drvAudioGetConfStr(PCFGMNODE pCfgHandle, const char *pszKey,
117 const char *pszDefault, bool *pfDefault)
118{
119 if ( pCfgHandle == NULL
120 || pszKey == NULL)
121 {
122 *pfDefault = true;
123 return pszDefault;
124 }
125
126 char *pszValue = NULL;
127 int rc = CFGMR3QueryStringAlloc(pCfgHandle, pszKey, &pszValue);
128 if (RT_FAILURE(rc))
129 {
130 *pfDefault = true;
131 return pszDefault;
132 }
133
134 *pfDefault = false;
135 return pszValue;
136}
137
138# endif /* unused */
139
140#ifdef LOG_ENABLED
141/**
142 * Converts an audio stream status to a string.
143 *
144 * @returns Stringified stream status flags. Must be free'd with RTStrFree().
145 * "NONE" if no flags set.
146 * @param fStatus Stream status flags to convert.
147 */
148static char *dbgAudioStreamStatusToStr(PDMAUDIOSTREAMSTS fStatus)
149{
150#define APPEND_FLAG_TO_STR(_aFlag) \
151 if (fStatus & PDMAUDIOSTREAMSTS_FLAG_##_aFlag) \
152 { \
153 if (pszFlags) \
154 { \
155 rc2 = RTStrAAppend(&pszFlags, " "); \
156 if (RT_FAILURE(rc2)) \
157 break; \
158 } \
159 \
160 rc2 = RTStrAAppend(&pszFlags, #_aFlag); \
161 if (RT_FAILURE(rc2)) \
162 break; \
163 } \
164
165 char *pszFlags = NULL;
166 int rc2 = VINF_SUCCESS;
167
168 do
169 {
170 APPEND_FLAG_TO_STR(INITIALIZED );
171 APPEND_FLAG_TO_STR(ENABLED );
172 APPEND_FLAG_TO_STR(PAUSED );
173 APPEND_FLAG_TO_STR(PENDING_DISABLE);
174 APPEND_FLAG_TO_STR(PENDING_REINIT );
175 } while (0);
176
177 if (!pszFlags)
178 rc2 = RTStrAAppend(&pszFlags, "NONE");
179
180 if ( RT_FAILURE(rc2)
181 && pszFlags)
182 {
183 RTStrFree(pszFlags);
184 pszFlags = NULL;
185 }
186
187#undef APPEND_FLAG_TO_STR
188
189 return pszFlags;
190}
191#endif /* defined(VBOX_STRICT) || defined(LOG_ENABLED) */
192
193# if 0 /* unused */
194static int drvAudioProcessOptions(PCFGMNODE pCfgHandle, const char *pszPrefix, audio_option *paOpts, size_t cOpts)
195{
196 AssertPtrReturn(pCfgHandle, VERR_INVALID_POINTER);
197 AssertPtrReturn(pszPrefix, VERR_INVALID_POINTER);
198 /* oaOpts and cOpts are optional. */
199
200 PCFGMNODE pCfgChildHandle = NULL;
201 PCFGMNODE pCfgChildChildHandle = NULL;
202
203 /* If pCfgHandle is NULL, let NULL be passed to get int and get string functions..
204 * The getter function will return default values.
205 */
206 if (pCfgHandle != NULL)
207 {
208 /* If its audio general setting, need to traverse to one child node.
209 * /Devices/ichac97/0/LUN#0/Config/Audio
210 */
211 if(!strncmp(pszPrefix, "AUDIO", 5)) /** @todo Use a \#define */
212 {
213 pCfgChildHandle = CFGMR3GetFirstChild(pCfgHandle);
214 if(pCfgChildHandle)
215 pCfgHandle = pCfgChildHandle;
216 }
217 else
218 {
219 /* If its driver specific configuration , then need to traverse two level deep child
220 * child nodes. for eg. in case of DirectSoundConfiguration item
221 * /Devices/ichac97/0/LUN#0/Config/Audio/DirectSoundConfig
222 */
223 pCfgChildHandle = CFGMR3GetFirstChild(pCfgHandle);
224 if (pCfgChildHandle)
225 {
226 pCfgChildChildHandle = CFGMR3GetFirstChild(pCfgChildHandle);
227 if (pCfgChildChildHandle)
228 pCfgHandle = pCfgChildChildHandle;
229 }
230 }
231 }
232
233 for (size_t i = 0; i < cOpts; i++)
234 {
235 audio_option *pOpt = &paOpts[i];
236 if (!pOpt->valp)
237 {
238 LogFlowFunc(("Option value pointer for `%s' is not set\n", pOpt->name));
239 continue;
240 }
241
242 bool fUseDefault;
243
244 switch (pOpt->tag)
245 {
246 case AUD_OPT_BOOL:
247 case AUD_OPT_INT:
248 {
249 int *intp = (int *)pOpt->valp;
250 *intp = drvAudioGetConfInt(pCfgHandle, pOpt->name, *intp, &fUseDefault);
251
252 break;
253 }
254
255 case AUD_OPT_FMT:
256 {
257 PDMAUDIOFMT *fmtp = (PDMAUDIOFMT *)pOpt->valp;
258 *fmtp = drvAudioGetConfFormat(pCfgHandle, pOpt->name, *fmtp, &fUseDefault);
259
260 break;
261 }
262
263 case AUD_OPT_STR:
264 {
265 const char **strp = (const char **)pOpt->valp;
266 *strp = drvAudioGetConfStr(pCfgHandle, pOpt->name, *strp, &fUseDefault);
267
268 break;
269 }
270
271 default:
272 LogFlowFunc(("Bad value tag for option `%s' - %d\n", pOpt->name, pOpt->tag));
273 fUseDefault = false;
274 break;
275 }
276
277 if (!pOpt->overridenp)
278 pOpt->overridenp = &pOpt->overriden;
279
280 *pOpt->overridenp = !fUseDefault;
281 }
282
283 return VINF_SUCCESS;
284}
285# endif /* unused */
286#endif /* !VBOX_AUDIO_TESTCASE */
287
288/**
289 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamControl}
290 */
291static DECLCALLBACK(int) drvAudioStreamControl(PPDMIAUDIOCONNECTOR pInterface,
292 PPDMAUDIOSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
293{
294 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
295
296 if (!pStream)
297 return VINF_SUCCESS;
298
299 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
300
301 int rc = RTCritSectEnter(&pThis->CritSect);
302 if (RT_FAILURE(rc))
303 return rc;
304
305 LogFlowFunc(("[%s] enmStreamCmd=%s\n", pStream->szName, DrvAudioHlpStreamCmdToStr(enmStreamCmd)));
306
307 rc = drvAudioStreamControlInternal(pThis, pStream, enmStreamCmd);
308
309 int rc2 = RTCritSectLeave(&pThis->CritSect);
310 if (RT_SUCCESS(rc))
311 rc = rc2;
312
313 return rc;
314}
315
316/**
317 * Controls an audio stream.
318 *
319 * @returns IPRT status code.
320 * @param pThis Pointer to driver instance.
321 * @param pStream Stream to control.
322 * @param enmStreamCmd Control command.
323 */
324static int drvAudioStreamControlInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
325{
326 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
327 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
328
329 LogFunc(("[%s] enmStreamCmd=%s\n", pStream->szName, DrvAudioHlpStreamCmdToStr(enmStreamCmd)));
330
331#ifdef LOG_ENABLED
332 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
333 LogFlowFunc(("fStatus=%s\n", pszStreamSts));
334 RTStrFree(pszStreamSts);
335#endif /* LOG_ENABLED */
336
337 int rc = VINF_SUCCESS;
338
339 switch (enmStreamCmd)
340 {
341 case PDMAUDIOSTREAMCMD_ENABLE:
342 {
343 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED))
344 {
345 /* Is a pending disable outstanding? Then disable first. */
346 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE)
347 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
348
349 if (RT_SUCCESS(rc))
350 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_ENABLE);
351
352 if (RT_SUCCESS(rc))
353 pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAG_ENABLED;
354 }
355 break;
356 }
357
358 case PDMAUDIOSTREAMCMD_DISABLE:
359 {
360 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED)
361 {
362 /*
363 * For playback (output) streams first mark the host stream as pending disable,
364 * so that the rest of the remaining audio data will be played first before
365 * closing the stream.
366 */
367 if (pStream->enmDir == PDMAUDIODIR_OUT)
368 {
369 LogFunc(("[%s] Pending disable/pause\n", pStream->szName));
370 pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE;
371 }
372
373 /* Can we close the host stream as well (not in pending disable mode)? */
374 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE))
375 {
376 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
377 if (RT_SUCCESS(rc))
378 pStream->fStatus &= ~PDMAUDIOSTREAMSTS_FLAG_ENABLED;
379 }
380 }
381 break;
382 }
383
384 case PDMAUDIOSTREAMCMD_PAUSE:
385 {
386 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED))
387 {
388 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_PAUSE);
389 if (RT_SUCCESS(rc))
390 pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAG_PAUSED;
391 }
392 break;
393 }
394
395 case PDMAUDIOSTREAMCMD_RESUME:
396 {
397 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
398 {
399 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_RESUME);
400 if (RT_SUCCESS(rc))
401 pStream->fStatus &= ~PDMAUDIOSTREAMSTS_FLAG_PAUSED;
402 }
403 break;
404 }
405
406 case PDMAUDIOSTREAMCMD_DROP:
407 {
408 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DROP);
409 if (RT_SUCCESS(rc))
410 {
411 drvAudioStreamResetInternal(pThis, pStream);
412 }
413 break;
414 }
415
416 default:
417 rc = VERR_NOT_IMPLEMENTED;
418 break;
419 }
420
421 if (RT_FAILURE(rc))
422 LogFunc(("[%s] Failed with %Rrc\n", pStream->szName, rc));
423
424 return rc;
425}
426
427/**
428 * Controls a stream's backend.
429 * If the stream has no backend available, VERR_NOT_FOUND is returned.
430 *
431 * @returns IPRT status code.
432 * @param pThis Pointer to driver instance.
433 * @param pStream Stream to control.
434 * @param enmStreamCmd Control command.
435 */
436static int drvAudioStreamControlInternalBackend(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
437{
438 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
439 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
440
441#ifdef LOG_ENABLED
442 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
443 LogFlowFunc(("[%s] enmStreamCmd=%s, fStatus=%s\n", pStream->szName, DrvAudioHlpStreamCmdToStr(enmStreamCmd), pszStreamSts));
444 RTStrFree(pszStreamSts);
445#endif /* LOG_ENABLED */
446
447 if (!pThis->pHostDrvAudio) /* If not lower driver is configured, bail out. */
448 return VINF_SUCCESS;
449
450 LogRel2(("Audio: %s stream '%s'\n", DrvAudioHlpStreamCmdToStr(enmStreamCmd), pStream->szName));
451
452 int rc = VINF_SUCCESS;
453
454 switch (enmStreamCmd)
455 {
456 case PDMAUDIOSTREAMCMD_ENABLE:
457 {
458 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED))
459 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_ENABLE);
460 break;
461 }
462
463 case PDMAUDIOSTREAMCMD_DISABLE:
464 {
465 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED)
466 {
467 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_DISABLE);
468 if (RT_SUCCESS(rc))
469 AudioMixBufReset(&pStream->Host.MixBuf);
470 }
471 break;
472 }
473
474 case PDMAUDIOSTREAMCMD_PAUSE:
475 {
476 /* Only pause if the stream is enabled. */
477 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED))
478 break;
479
480 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED))
481 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_PAUSE);
482 break;
483 }
484
485 case PDMAUDIOSTREAMCMD_RESUME:
486 {
487 /* Only need to resume if the stream is enabled. */
488 if (!(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED))
489 break;
490
491 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
492 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_RESUME);
493 break;
494 }
495
496 case PDMAUDIOSTREAMCMD_DRAIN:
497 {
498 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_DRAIN);
499 break;
500 }
501
502 case PDMAUDIOSTREAMCMD_DROP:
503 {
504 rc = pThis->pHostDrvAudio->pfnStreamControl(pThis->pHostDrvAudio, pStream->pvBackend, PDMAUDIOSTREAMCMD_DROP);
505 break;
506 }
507
508 default:
509 {
510 AssertMsgFailed(("Command %RU32 not implemented\n", enmStreamCmd));
511 rc = VERR_NOT_IMPLEMENTED;
512 break;
513 }
514 }
515
516 if (RT_FAILURE(rc))
517 {
518 if ( rc != VERR_NOT_IMPLEMENTED
519 && rc != VERR_NOT_SUPPORTED)
520 LogRel(("Audio: %s stream '%s' failed with %Rrc\n", DrvAudioHlpStreamCmdToStr(enmStreamCmd), pStream->szName, rc));
521
522 LogFunc(("[%s] %s failed with %Rrc\n", pStream->szName, DrvAudioHlpStreamCmdToStr(enmStreamCmd), rc));
523 }
524
525 return rc;
526}
527
528/**
529 * Initializes an audio stream with a given host and guest stream configuration.
530 *
531 * @returns IPRT status code.
532 * @param pThis Pointer to driver instance.
533 * @param pStream Stream to initialize.
534 * @param pCfgHost Stream configuration to use for the host side (backend).
535 * @param pCfgGuest Stream configuration to use for the guest side.
536 */
537static int drvAudioStreamInitInternal(PDRVAUDIO pThis,
538 PPDMAUDIOSTREAM pStream, PPDMAUDIOSTREAMCFG pCfgHost, PPDMAUDIOSTREAMCFG pCfgGuest)
539{
540 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
541 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
542 AssertPtrReturn(pCfgHost, VERR_INVALID_POINTER);
543 AssertPtrReturn(pCfgGuest, VERR_INVALID_POINTER);
544
545 /*
546 * Init host stream.
547 */
548
549 /* Set the host's default audio data layout. */
550 pCfgHost->enmLayout = PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED;
551
552#ifdef DEBUG
553 LogFunc(("[%s] Requested host format:\n", pStream->szName));
554 DrvAudioHlpStreamCfgPrint(pCfgHost);
555#endif
556
557 LogRel2(("Audio: Creating stream '%s'\n", pStream->szName));
558 LogRel2(("Audio: Guest %s format for '%s': %RU32Hz, %RU8%s, %RU8 %s\n",
559 pCfgGuest->enmDir == PDMAUDIODIR_IN ? "recording" : "playback", pStream->szName,
560 pCfgGuest->Props.uHz, pCfgGuest->Props.cBytes * 8, pCfgGuest->Props.fSigned ? "S" : "U",
561 pCfgGuest->Props.cChannels, pCfgGuest->Props.cChannels == 1 ? "Channel" : "Channels"));
562 LogRel2(("Audio: Requested host %s format for '%s': %RU32Hz, %RU8%s, %RU8 %s\n",
563 pCfgHost->enmDir == PDMAUDIODIR_IN ? "recording" : "playback", pStream->szName,
564 pCfgHost->Props.uHz, pCfgHost->Props.cBytes * 8, pCfgHost->Props.fSigned ? "S" : "U",
565 pCfgHost->Props.cChannels, pCfgHost->Props.cChannels == 1 ? "Channel" : "Channels"));
566
567 PDMAUDIOSTREAMCFG CfgHostAcq;
568 int rc = drvAudioStreamCreateInternalBackend(pThis, pStream, pCfgHost, &CfgHostAcq);
569 if (RT_FAILURE(rc))
570 return rc;
571
572#ifdef DEBUG
573 LogFunc(("[%s] Acquired host format:\n", pStream->szName));
574 DrvAudioHlpStreamCfgPrint(&CfgHostAcq);
575#endif
576
577 LogRel2(("Audio: Acquired host %s format for '%s': %RU32Hz, %RU8%s, %RU8 %s\n",
578 CfgHostAcq.enmDir == PDMAUDIODIR_IN ? "recording" : "playback", pStream->szName,
579 CfgHostAcq.Props.uHz, CfgHostAcq.Props.cBytes * 8, CfgHostAcq.Props.fSigned ? "S" : "U",
580 CfgHostAcq.Props.cChannels, CfgHostAcq.Props.cChannels == 1 ? "Channel" : "Channels"));
581
582 /* Let the user know if the backend changed some of the tweakable values. */
583 if (CfgHostAcq.Backend.cfBufferSize != pCfgHost->Backend.cfBufferSize)
584 LogRel2(("Audio: Backend changed buffer size from %RU64ms (%RU32 frames) to %RU64ms (%RU32 frames)\n",
585 DrvAudioHlpFramesToMilli(pCfgHost->Backend.cfBufferSize, &pCfgHost->Props), pCfgHost->Backend.cfBufferSize,
586 DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfBufferSize, &CfgHostAcq.Props), CfgHostAcq.Backend.cfBufferSize));
587
588 if (CfgHostAcq.Backend.cfPeriod != pCfgHost->Backend.cfPeriod)
589 LogRel2(("Audio: Backend changed period size from %RU64ms (%RU32 frames) to %RU64ms (%RU32 frames)\n",
590 DrvAudioHlpFramesToMilli(pCfgHost->Backend.cfPeriod, &pCfgHost->Props), pCfgHost->Backend.cfPeriod,
591 DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfPeriod, &CfgHostAcq.Props), CfgHostAcq.Backend.cfPeriod));
592
593 if (CfgHostAcq.Backend.cfPreBuf != pCfgHost->Backend.cfPreBuf)
594 LogRel2(("Audio: Backend changed pre-buffering size from %RU64ms (%RU32 frames) to %RU64ms (%RU32 frames)\n",
595 DrvAudioHlpFramesToMilli(pCfgHost->Backend.cfPreBuf, &pCfgHost->Props), pCfgHost->Backend.cfPreBuf,
596 DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfPreBuf, &CfgHostAcq.Props), CfgHostAcq.Backend.cfPreBuf));
597 /*
598 * Configure host buffers.
599 */
600
601 /* Check if the backend did return sane values and correct if necessary.
602 * Should never happen with our own backends, but you never know ... */
603 if (CfgHostAcq.Backend.cfBufferSize < CfgHostAcq.Backend.cfPreBuf)
604 {
605 LogRel2(("Audio: Warning: Pre-buffering size (%RU32 frames) of stream '%s' does not match buffer size (%RU32 frames), "
606 "setting pre-buffering size to %RU32 frames\n",
607 CfgHostAcq.Backend.cfPreBuf, pStream->szName, CfgHostAcq.Backend.cfBufferSize, CfgHostAcq.Backend.cfBufferSize));
608 CfgHostAcq.Backend.cfPreBuf = CfgHostAcq.Backend.cfBufferSize;
609 }
610
611 if (CfgHostAcq.Backend.cfPeriod > CfgHostAcq.Backend.cfBufferSize)
612 {
613 LogRel2(("Audio: Warning: Period size (%RU32 frames) of stream '%s' does not match buffer size (%RU32 frames), setting to %RU32 frames\n",
614 CfgHostAcq.Backend.cfPeriod, pStream->szName, CfgHostAcq.Backend.cfBufferSize, CfgHostAcq.Backend.cfBufferSize));
615 CfgHostAcq.Backend.cfPeriod = CfgHostAcq.Backend.cfBufferSize;
616 }
617
618 uint64_t msBufferSize = DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfBufferSize, &CfgHostAcq.Props);
619
620 LogRel2(("Audio: Buffer size of stream '%s' is %RU64ms (%RU32 frames)\n",
621 pStream->szName, msBufferSize, CfgHostAcq.Backend.cfBufferSize));
622
623 /* If no own pre-buffer is set, let the backend choose. */
624 uint64_t msPreBuf = DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfPreBuf, &CfgHostAcq.Props);
625 LogRel2(("Audio: Pre-buffering size of stream '%s' is %RU64ms (%RU32 frames)\n",
626 pStream->szName, msPreBuf, CfgHostAcq.Backend.cfPreBuf));
627
628 /* Make sure the configured buffer size by the backend at least can hold the configured latency. */
629 const uint32_t msPeriod = DrvAudioHlpFramesToMilli(CfgHostAcq.Backend.cfPeriod, &CfgHostAcq.Props);
630
631 LogRel2(("Audio: Period size of stream '%s' is %RU64ms (%RU32 frames)\n",
632 pStream->szName, msPeriod, CfgHostAcq.Backend.cfPeriod));
633
634 /* Destroy any former mixing buffer. */
635 AudioMixBufDestroy(&pStream->Host.MixBuf);
636
637 /* Make sure to (re-)set the host buffer's shift size. */
638 CfgHostAcq.Props.cShift = PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(CfgHostAcq.Props.cBytes, CfgHostAcq.Props.cChannels);
639
640 rc = AudioMixBufInit(&pStream->Host.MixBuf, pStream->szName, &CfgHostAcq.Props, CfgHostAcq.Backend.cfBufferSize);
641 AssertRC(rc);
642
643 /* Make a copy of the acquired host stream configuration. */
644 rc = DrvAudioHlpStreamCfgCopy(&pStream->Host.Cfg, &CfgHostAcq);
645 AssertRC(rc);
646
647 /*
648 * Init guest stream.
649 */
650
651 if (pCfgGuest->Device.uSchedulingHintMs)
652 LogRel2(("Audio: Stream '%s' got a scheduling hint of %RU32ms (%RU32 bytes)\n",
653 pStream->szName, pCfgGuest->Device.uSchedulingHintMs,
654 DrvAudioHlpMilliToBytes(pCfgGuest->Device.uSchedulingHintMs, &pCfgGuest->Props)));
655
656 /* Destroy any former mixing buffer. */
657 AudioMixBufDestroy(&pStream->Guest.MixBuf);
658
659 /* Set the guests's default audio data layout. */
660 pCfgGuest->enmLayout = PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED;
661
662 /* Make sure to (re-)set the guest buffer's shift size. */
663 pCfgGuest->Props.cShift = PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(pCfgGuest->Props.cBytes, pCfgGuest->Props.cChannels);
664
665 rc = AudioMixBufInit(&pStream->Guest.MixBuf, pStream->szName, &pCfgGuest->Props, CfgHostAcq.Backend.cfBufferSize);
666 AssertRC(rc);
667
668 /* Make a copy of the guest stream configuration. */
669 rc = DrvAudioHlpStreamCfgCopy(&pStream->Guest.Cfg, pCfgGuest);
670 AssertRC(rc);
671
672 if (RT_FAILURE(rc))
673 LogRel(("Audio: Creating stream '%s' failed with %Rrc\n", pStream->szName, rc));
674
675 if (pCfgGuest->enmDir == PDMAUDIODIR_IN)
676 {
677 /* Host (Parent) -> Guest (Child). */
678 rc = AudioMixBufLinkTo(&pStream->Host.MixBuf, &pStream->Guest.MixBuf);
679 AssertRC(rc);
680 }
681 else
682 {
683 /* Guest (Parent) -> Host (Child). */
684 rc = AudioMixBufLinkTo(&pStream->Guest.MixBuf, &pStream->Host.MixBuf);
685 AssertRC(rc);
686 }
687
688#ifdef VBOX_WITH_STATISTICS
689 char szStatName[255];
690
691 if (pCfgGuest->enmDir == PDMAUDIODIR_IN)
692 {
693 RTStrPrintf(szStatName, sizeof(szStatName), "Guest/%s/BytesElapsed", pStream->szName);
694 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->In.Stats.BytesElapsed,
695 szStatName, STAMUNIT_BYTES, "Elapsed bytes read.");
696
697 RTStrPrintf(szStatName, sizeof(szStatName), "Guest/%s/BytesRead", pStream->szName);
698 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->In.Stats.BytesTotalRead,
699 szStatName, STAMUNIT_BYTES, "Total bytes read.");
700
701 RTStrPrintf(szStatName, sizeof(szStatName), "Host/%s/FramesCaptured", pStream->szName);
702 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->In.Stats.FramesCaptured,
703 szStatName, STAMUNIT_COUNT, "Total frames captured.");
704 }
705 else if (pCfgGuest->enmDir == PDMAUDIODIR_OUT)
706 {
707 RTStrPrintf(szStatName, sizeof(szStatName), "Guest/%s/BytesElapsed", pStream->szName);
708 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->Out.Stats.BytesElapsed,
709 szStatName, STAMUNIT_BYTES, "Elapsed bytes written.");
710
711 RTStrPrintf(szStatName, sizeof(szStatName), "Guest/%s/BytesWritten", pStream->szName);
712 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->Out.Stats.BytesTotalWritten,
713 szStatName, STAMUNIT_BYTES, "Total bytes written.");
714
715 RTStrPrintf(szStatName, sizeof(szStatName), "Host/%s/FramesPlayed", pStream->szName);
716 PDMDrvHlpSTAMRegCounterEx(pThis->pDrvIns, &pStream->Out.Stats.FramesPlayed,
717 szStatName, STAMUNIT_COUNT, "Total frames played.");
718 }
719 else
720 AssertFailed();
721#endif
722
723 LogFlowFunc(("[%s] Returning %Rrc\n", pStream->szName, rc));
724 return rc;
725}
726
727/**
728 * Frees an audio stream and its allocated resources.
729 *
730 * @param pStream Audio stream to free.
731 * After this call the pointer will not be valid anymore.
732 */
733static void drvAudioStreamFree(PPDMAUDIOSTREAM pStream)
734{
735 if (!pStream)
736 return;
737
738 if (pStream->pvBackend)
739 {
740 Assert(pStream->cbBackend);
741 RTMemFree(pStream->pvBackend);
742 pStream->pvBackend = NULL;
743 }
744
745 RTMemFree(pStream);
746 pStream = NULL;
747}
748
749#ifdef VBOX_WITH_AUDIO_CALLBACKS
750/**
751 * Schedules a re-initialization of all current audio streams.
752 * The actual re-initialization will happen at some later point in time.
753 *
754 * @returns IPRT status code.
755 * @param pThis Pointer to driver instance.
756 */
757static int drvAudioScheduleReInitInternal(PDRVAUDIO pThis)
758{
759 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
760
761 LogFunc(("\n"));
762
763 /* Mark all host streams to re-initialize. */
764 PPDMAUDIOSTREAM pStream;
765 RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
766 pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT;
767
768# ifdef VBOX_WITH_AUDIO_ENUM
769 /* Re-enumerate all host devices as soon as possible. */
770 pThis->fEnumerateDevices = true;
771# endif
772
773 return VINF_SUCCESS;
774}
775#endif /* VBOX_WITH_AUDIO_CALLBACKS */
776
777/**
778 * Re-initializes an audio stream with its existing host and guest stream configuration.
779 * This might be the case if the backend told us we need to re-initialize because something
780 * on the host side has changed.
781 *
782 * @returns IPRT status code.
783 * @param pThis Pointer to driver instance.
784 * @param pStream Stream to re-initialize.
785 */
786static int drvAudioStreamReInitInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream)
787{
788 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
789 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
790
791 LogFlowFunc(("[%s]\n", pStream->szName));
792
793 /*
794 * Gather current stream status.
795 */
796 bool fIsEnabled = RT_BOOL(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED); /* Stream is enabled? */
797
798 /*
799 * Destroy and re-create stream on backend side.
800 */
801 int rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
802 if (RT_SUCCESS(rc))
803 {
804 rc = drvAudioStreamDestroyInternalBackend(pThis, pStream);
805 if (RT_SUCCESS(rc))
806 {
807 rc = drvAudioStreamCreateInternalBackend(pThis, pStream, &pStream->Host.Cfg, NULL /* pCfgAcq */);
808 /** @todo Validate (re-)acquired configuration with pStream->Host.Cfg? */
809 }
810 }
811
812 /* Do the internal reset. */
813 drvAudioStreamResetInternal(pThis, pStream);
814
815 /*
816 * Restore previous stream state.
817 */
818 if (fIsEnabled)
819 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_ENABLE);
820
821 if (RT_FAILURE(rc))
822 LogRel(("Audio: Re-initializing stream '%s' failed with %Rrc\n", pStream->szName, rc));
823
824 LogFunc(("[%s] Returning %Rrc\n", pStream->szName, rc));
825 return rc;
826}
827
828static void drvAudioStreamResetInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream)
829{
830 RT_NOREF(pThis);
831
832 AudioMixBufReset(&pStream->Guest.MixBuf);
833 AudioMixBufReset(&pStream->Host.MixBuf);
834
835#ifdef VBOX_WITH_STATISTICS
836 /*
837 * Reset statistics.
838 */
839 if (pStream->enmDir == PDMAUDIODIR_IN)
840 {
841 STAM_COUNTER_RESET(&pStream->In.Stats.BytesElapsed);
842 STAM_COUNTER_RESET(&pStream->In.Stats.BytesTotalRead);
843 STAM_COUNTER_RESET(&pStream->In.Stats.FramesCaptured);
844 }
845 else if (pStream->enmDir == PDMAUDIODIR_OUT)
846 {
847 STAM_COUNTER_RESET(&pStream->Out.Stats.BytesElapsed);
848 STAM_COUNTER_RESET(&pStream->Out.Stats.BytesTotalWritten);
849 STAM_COUNTER_RESET(&pStream->Out.Stats.FramesPlayed);
850 }
851 else
852 AssertFailed();
853#endif
854}
855
856/**
857 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamWrite}
858 */
859static DECLCALLBACK(int) drvAudioStreamWrite(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream,
860 const void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
861{
862 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
863 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
864 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
865 AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
866 /* pcbWritten is optional. */
867
868 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
869
870 AssertMsg(pStream->enmDir == PDMAUDIODIR_OUT,
871 ("Stream '%s' is not an output stream and therefore cannot be written to (direction is 0x%x)\n",
872 pStream->szName, pStream->enmDir));
873
874 uint32_t cbWrittenTotal = 0;
875
876 int rc = RTCritSectEnter(&pThis->CritSect);
877 if (RT_FAILURE(rc))
878 return rc;
879
880#ifdef VBOX_WITH_STATISTICS
881 STAM_PROFILE_ADV_START(&pThis->Stats.DelayOut, out);
882#endif
883
884#ifdef LOG_ENABLED
885 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
886 AssertPtr(pszStreamSts);
887#endif
888
889 /* Whether to discard the incoming data or not. */
890 bool fToBitBucket = false;
891
892 do
893 {
894 if ( !pThis->Out.fEnabled
895 || !DrvAudioHlpStreamStatusIsReady(pStream->fStatus))
896 {
897 rc = VERR_AUDIO_STREAM_NOT_READY;
898 break;
899 }
900
901 if (pThis->pHostDrvAudio)
902 {
903 /* If the backend's stream is not writable, all written data goes to /dev/null. */
904 if (!DrvAudioHlpStreamStatusCanWrite(
905 pThis->pHostDrvAudio->pfnStreamGetStatus(pThis->pHostDrvAudio, pStream->pvBackend)))
906 {
907 fToBitBucket = true;
908 break;
909 }
910 }
911
912 const uint32_t cbFree = AudioMixBufFreeBytes(&pStream->Host.MixBuf);
913 if (cbFree < cbBuf)
914 LogRel2(("Audio: Lost audio output (%RU64ms, %RU32 free but needs %RU32) due to full host stream buffer '%s'\n",
915 DrvAudioHlpBytesToMilli(cbBuf - cbFree, &pStream->Host.Cfg.Props), cbFree, cbBuf, pStream->szName));
916
917 uint32_t cbToWrite = RT_MIN(cbBuf, cbFree);
918 if (!cbToWrite)
919 {
920 rc = VERR_BUFFER_OVERFLOW;
921 break;
922 }
923
924 /* We use the guest side mixing buffer as an intermediate buffer to do some
925 * (first) processing (if needed), so always write the incoming data at offset 0. */
926 uint32_t cfGstWritten = 0;
927 rc = AudioMixBufWriteAt(&pStream->Guest.MixBuf, 0 /* offFrames */, pvBuf, cbToWrite, &cfGstWritten);
928 if ( RT_FAILURE(rc)
929 || !cfGstWritten)
930 {
931 AssertMsgFailed(("[%s] Write failed: cbToWrite=%RU32, cfWritten=%RU32, rc=%Rrc\n",
932 pStream->szName, cbToWrite, cfGstWritten, rc));
933 break;
934 }
935
936 if (pThis->Out.Cfg.Dbg.fEnabled)
937 DrvAudioHlpFileWrite(pStream->Out.Dbg.pFileStreamWrite, pvBuf, cbToWrite, 0 /* fFlags */);
938
939#ifdef VBOX_WITH_STATISTICS
940 STAM_COUNTER_ADD(&pThis->Stats.TotalFramesWritten, cfGstWritten);
941#endif
942 uint32_t cfGstMixed = 0;
943 if (cfGstWritten)
944 {
945 int rc2 = AudioMixBufMixToParentEx(&pStream->Guest.MixBuf, 0 /* cSrcOffset */, cfGstWritten /* cSrcFrames */,
946 &cfGstMixed /* pcSrcMixed */);
947 if (RT_FAILURE(rc2))
948 {
949 AssertMsgFailed(("[%s] Mixing failed: cbToWrite=%RU32, cfWritten=%RU32, cfMixed=%RU32, rc=%Rrc\n",
950 pStream->szName, cbToWrite, cfGstWritten, cfGstMixed, rc2));
951 }
952 else
953 {
954 Log3Func(("[%s] Writing %RU32 frames (%RU64ms), now filled with %RU64ms -- %RU8%%\n",
955 pStream->szName, cfGstWritten, DrvAudioHlpFramesToMilli(cfGstWritten, &pStream->Guest.Cfg.Props),
956 DrvAudioHlpFramesToMilli(AudioMixBufUsed(&pStream->Host.MixBuf), &pStream->Host.Cfg.Props),
957 AudioMixBufUsed(&pStream->Host.MixBuf) * 100 / AudioMixBufSize(&pStream->Host.MixBuf)));
958
959 pStream->tsLastReadWrittenNs = RTTimeNanoTS();
960#ifdef DEBUG
961 pStream->Out.Dbg.cfWrittenSinceLastPlay += AUDIOMIXBUF_F2F_RATIO(&pStream->Guest.MixBuf, cfGstMixed);
962#endif
963 /* Keep going. */
964 }
965
966 if (RT_SUCCESS(rc))
967 rc = rc2;
968
969 cbWrittenTotal = AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfGstWritten);
970
971#ifdef VBOX_WITH_STATISTICS
972 STAM_COUNTER_ADD(&pThis->Stats.TotalFramesMixedOut, cfGstMixed);
973 Assert(cfGstWritten >= cfGstMixed);
974 STAM_COUNTER_ADD(&pThis->Stats.TotalFramesLostOut, cfGstWritten - cfGstMixed);
975 STAM_COUNTER_ADD(&pThis->Stats.TotalBytesWritten, cbWrittenTotal);
976 STAM_COUNTER_ADD(&pStream->Out.Stats.BytesTotalWritten, cbWrittenTotal);
977#endif
978 }
979
980 Log3Func(("[%s] Dbg: cbBuf=%RU32, cbToWrite=%RU32, cfHstUsed=%RU32, cfHstfLive=%RU32, cfGstWritten=%RU32, "
981 "cfGstMixed=%RU32, cbWrittenTotal=%RU32, rc=%Rrc\n",
982 pStream->szName, cbBuf, cbToWrite, AudioMixBufUsed(&pStream->Host.MixBuf),
983 AudioMixBufLive(&pStream->Host.MixBuf), cfGstWritten, cfGstMixed, cbWrittenTotal, rc));
984
985 } while (0);
986
987#ifdef LOG_ENABLED
988 RTStrFree(pszStreamSts);
989#endif
990
991 int rc2 = RTCritSectLeave(&pThis->CritSect);
992 if (RT_SUCCESS(rc))
993 rc = rc2;
994
995 if (RT_SUCCESS(rc))
996 {
997 if (fToBitBucket)
998 {
999 Log3Func(("[%s] Backend stream not ready (yet), discarding written data\n", pStream->szName));
1000 cbWrittenTotal = cbBuf; /* Report all data as being written to the caller. */
1001 }
1002
1003 if (pcbWritten)
1004 *pcbWritten = cbWrittenTotal;
1005 }
1006
1007 return rc;
1008}
1009
1010/**
1011 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamRetain}
1012 */
1013static DECLCALLBACK(uint32_t) drvAudioStreamRetain(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
1014{
1015 AssertPtrReturn(pInterface, UINT32_MAX);
1016 AssertPtrReturn(pStream, UINT32_MAX);
1017
1018 NOREF(pInterface);
1019
1020 return ++pStream->cRefs;
1021}
1022
1023/**
1024 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamRelease}
1025 */
1026static DECLCALLBACK(uint32_t) drvAudioStreamRelease(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
1027{
1028 AssertPtrReturn(pInterface, UINT32_MAX);
1029 AssertPtrReturn(pStream, UINT32_MAX);
1030
1031 NOREF(pInterface);
1032
1033 if (pStream->cRefs > 1) /* 1 reference always is kept by this audio driver. */
1034 pStream->cRefs--;
1035
1036 return pStream->cRefs;
1037}
1038
1039/**
1040 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamIterate}
1041 */
1042static DECLCALLBACK(int) drvAudioStreamIterate(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
1043{
1044 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
1045 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1046
1047 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
1048
1049 int rc = RTCritSectEnter(&pThis->CritSect);
1050 if (RT_FAILURE(rc))
1051 return rc;
1052
1053 rc = drvAudioStreamIterateInternal(pThis, pStream);
1054
1055 int rc2 = RTCritSectLeave(&pThis->CritSect);
1056 if (RT_SUCCESS(rc))
1057 rc = rc2;
1058
1059 if (RT_FAILURE(rc))
1060 LogFlowFuncLeaveRC(rc);
1061
1062 return rc;
1063}
1064
1065/**
1066 * Does one iteration of an audio stream.
1067 * This function gives the backend the chance of iterating / altering data and
1068 * does the actual mixing between the guest <-> host mixing buffers.
1069 *
1070 * @returns IPRT status code.
1071 * @param pThis Pointer to driver instance.
1072 * @param pStream Stream to iterate.
1073 */
1074static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream)
1075{
1076 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1077
1078 if (!pThis->pHostDrvAudio)
1079 return VINF_SUCCESS;
1080
1081 if (!pStream)
1082 return VINF_SUCCESS;
1083
1084 int rc;
1085
1086 /* Is the stream scheduled for re-initialization? Do so now. */
1087 if (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT)
1088 {
1089#ifdef VBOX_WITH_AUDIO_ENUM
1090 if (pThis->fEnumerateDevices)
1091 {
1092 /* Re-enumerate all host devices. */
1093 drvAudioDevicesEnumerateInternal(pThis, true /* fLog */, NULL /* pDevEnum */);
1094
1095 pThis->fEnumerateDevices = false;
1096 }
1097#endif /* VBOX_WITH_AUDIO_ENUM */
1098
1099 /* Remove the pending re-init flag in any case, regardless whether the actual re-initialization succeeded
1100 * or not. If it failed, the backend needs to notify us again to try again at some later point in time. */
1101 pStream->fStatus &= ~PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT;
1102
1103 rc = drvAudioStreamReInitInternal(pThis, pStream);
1104 if (RT_FAILURE(rc))
1105 return rc;
1106 }
1107
1108#ifdef LOG_ENABLED
1109 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
1110 Log3Func(("[%s] fStatus=%s\n", pStream->szName, pszStreamSts));
1111 RTStrFree(pszStreamSts);
1112#endif /* LOG_ENABLED */
1113
1114 /* Not enabled or paused? Skip iteration. */
1115 if ( !(pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED)
1116 || (pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED))
1117 {
1118 return VINF_SUCCESS;
1119 }
1120
1121 /* Whether to try closing a pending to close stream. */
1122 bool fTryClosePending = false;
1123
1124 do
1125 {
1126 rc = pThis->pHostDrvAudio->pfnStreamIterate(pThis->pHostDrvAudio, pStream->pvBackend);
1127 if (RT_FAILURE(rc))
1128 break;
1129
1130 if (pStream->enmDir == PDMAUDIODIR_OUT)
1131 {
1132 /* No audio frames to transfer from guest to host (anymore)?
1133 * Then try closing this stream if marked so in the next block. */
1134 const uint32_t cfLive = AudioMixBufLive(&pStream->Host.MixBuf);
1135 fTryClosePending = cfLive == 0;
1136 Log3Func(("[%s] fTryClosePending=%RTbool, cfLive=%RU32\n", pStream->szName, fTryClosePending, cfLive));
1137 }
1138
1139 /* Has the host stream marked as pending to disable?
1140 * Try disabling the stream then. */
1141 if ( pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE
1142 && fTryClosePending)
1143 {
1144 /* Tell the backend to drain the stream, that is, play the remaining (buffered) data
1145 * on the backend side. */
1146 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DRAIN);
1147 if (rc == VERR_NOT_SUPPORTED) /* Not all backends support draining. */
1148 rc = VINF_SUCCESS;
1149
1150 if (RT_SUCCESS(rc))
1151 {
1152 if (pThis->pHostDrvAudio->pfnStreamGetPending) /* Optional to implement. */
1153 {
1154 const uint32_t cxPending = pThis->pHostDrvAudio->pfnStreamGetPending(pThis->pHostDrvAudio, pStream->pvBackend);
1155 Log3Func(("[%s] cxPending=%RU32\n", pStream->szName, cxPending));
1156
1157 /* Only try close pending if no audio data is pending on the backend-side anymore. */
1158 fTryClosePending = cxPending == 0;
1159 }
1160
1161 if (fTryClosePending)
1162 {
1163 LogFunc(("[%s] Closing pending stream\n", pStream->szName));
1164 rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
1165 if (RT_SUCCESS(rc))
1166 {
1167 pStream->fStatus &= ~(PDMAUDIOSTREAMSTS_FLAG_ENABLED | PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE);
1168 }
1169 else
1170 LogFunc(("[%s] Backend vetoed against closing pending input stream, rc=%Rrc\n", pStream->szName, rc));
1171 }
1172 }
1173 }
1174
1175 } while (0);
1176
1177 /* Update timestamps. */
1178 pStream->tsLastIteratedNs = RTTimeNanoTS();
1179
1180 if (RT_FAILURE(rc))
1181 LogFunc(("[%s] Failed with %Rrc\n", pStream->szName, rc));
1182
1183 return rc;
1184}
1185
1186/**
1187 * Plays an audio host output stream which has been configured for non-interleaved (layout) data.
1188 *
1189 * @return IPRT status code.
1190 * @param pThis Pointer to driver instance.
1191 * @param pStream Stream to play.
1192 * @param cfToPlay Number of audio frames to play.
1193 * @param pcfPlayed Returns number of audio frames played. Optional.
1194 */
1195static int drvAudioStreamPlayNonInterleaved(PDRVAUDIO pThis,
1196 PPDMAUDIOSTREAM pStream, uint32_t cfToPlay, uint32_t *pcfPlayed)
1197{
1198 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1199 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1200 /* pcfPlayed is optional. */
1201
1202 if (!cfToPlay)
1203 {
1204 if (pcfPlayed)
1205 *pcfPlayed = 0;
1206 return VINF_SUCCESS;
1207 }
1208
1209 /* Sanity. */
1210 Assert(pStream->enmDir == PDMAUDIODIR_OUT);
1211 Assert(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED);
1212
1213 int rc = VINF_SUCCESS;
1214
1215 uint32_t cfPlayedTotal = 0;
1216
1217 uint8_t auBuf[256]; /** @todo Get rid of this here. */
1218
1219 uint32_t cfLeft = cfToPlay;
1220 uint32_t cbChunk = sizeof(auBuf);
1221
1222 while (cfLeft)
1223 {
1224 uint32_t cfRead = 0;
1225 rc = AudioMixBufAcquireReadBlock(&pStream->Host.MixBuf,
1226 auBuf, RT_MIN(cbChunk, AUDIOMIXBUF_F2B(&pStream->Host.MixBuf, cfLeft)),
1227 &cfRead);
1228 if (RT_FAILURE(rc))
1229 break;
1230
1231 uint32_t cbRead = AUDIOMIXBUF_F2B(&pStream->Host.MixBuf, cfRead);
1232 Assert(cbRead <= cbChunk);
1233
1234 uint32_t cfPlayed = 0;
1235 uint32_t cbPlayed = 0;
1236 rc = pThis->pHostDrvAudio->pfnStreamPlay(pThis->pHostDrvAudio, pStream->pvBackend,
1237 auBuf, cbRead, &cbPlayed);
1238 if ( RT_SUCCESS(rc)
1239 && cbPlayed)
1240 {
1241 if (pThis->Out.Cfg.Dbg.fEnabled)
1242 DrvAudioHlpFileWrite(pStream->Out.Dbg.pFilePlayNonInterleaved, auBuf, cbPlayed, 0 /* fFlags */);
1243
1244 if (cbRead != cbPlayed)
1245 LogRel2(("Audio: Host stream '%s' played wrong amount (%RU32 bytes read but played %RU32)\n",
1246 pStream->szName, cbRead, cbPlayed));
1247
1248 cfPlayed = AUDIOMIXBUF_B2F(&pStream->Host.MixBuf, cbPlayed);
1249 cfPlayedTotal += cfPlayed;
1250
1251 Assert(cfLeft >= cfPlayed);
1252 cfLeft -= cfPlayed;
1253 }
1254
1255 AudioMixBufReleaseReadBlock(&pStream->Host.MixBuf, cfPlayed);
1256
1257 if (RT_FAILURE(rc))
1258 break;
1259 }
1260
1261 Log3Func(("[%s] Played %RU32/%RU32 frames, rc=%Rrc\n", pStream->szName, cfPlayedTotal, cfToPlay, rc));
1262
1263 if (RT_SUCCESS(rc))
1264 {
1265 if (pcfPlayed)
1266 *pcfPlayed = cfPlayedTotal;
1267 }
1268
1269 return rc;
1270}
1271
1272/**
1273 * Plays an audio host output stream which has been configured for raw audio (layout) data.
1274 *
1275 * @return IPRT status code.
1276 * @param pThis Pointer to driver instance.
1277 * @param pStream Stream to play.
1278 * @param cfToPlay Number of audio frames to play.
1279 * @param pcfPlayed Returns number of audio frames played. Optional.
1280 */
1281static int drvAudioStreamPlayRaw(PDRVAUDIO pThis,
1282 PPDMAUDIOSTREAM pStream, uint32_t cfToPlay, uint32_t *pcfPlayed)
1283{
1284 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1285 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1286 /* pcfPlayed is optional. */
1287
1288 /* Sanity. */
1289 Assert(pStream->enmDir == PDMAUDIODIR_OUT);
1290 Assert(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
1291
1292 if (!cfToPlay)
1293 {
1294 if (pcfPlayed)
1295 *pcfPlayed = 0;
1296 return VINF_SUCCESS;
1297 }
1298
1299 int rc = VINF_SUCCESS;
1300
1301 uint32_t cfPlayedTotal = 0;
1302
1303 PDMAUDIOFRAME aFrameBuf[_4K]; /** @todo Get rid of this here. */
1304
1305 uint32_t cfLeft = cfToPlay;
1306 while (cfLeft)
1307 {
1308 uint32_t cfRead = 0;
1309 rc = AudioMixBufPeek(&pStream->Host.MixBuf, cfLeft, aFrameBuf,
1310 RT_MIN(cfLeft, RT_ELEMENTS(aFrameBuf)), &cfRead);
1311
1312 if (RT_SUCCESS(rc))
1313 {
1314 if (cfRead)
1315 {
1316 uint32_t cfPlayed;
1317
1318 /* Note: As the stream layout is RPDMAUDIOSTREAMLAYOUT_RAW, operate on audio frames
1319 * rather on bytes. */
1320 Assert(cfRead <= RT_ELEMENTS(aFrameBuf));
1321 rc = pThis->pHostDrvAudio->pfnStreamPlay(pThis->pHostDrvAudio, pStream->pvBackend,
1322 aFrameBuf, cfRead, &cfPlayed);
1323 if ( RT_FAILURE(rc)
1324 || !cfPlayed)
1325 {
1326 break;
1327 }
1328
1329 cfPlayedTotal += cfPlayed;
1330 Assert(cfPlayedTotal <= cfToPlay);
1331
1332 Assert(cfLeft >= cfRead);
1333 cfLeft -= cfRead;
1334 }
1335 else
1336 {
1337 if (rc == VINF_AUDIO_MORE_DATA_AVAILABLE) /* Do another peeking round if there is more data available. */
1338 continue;
1339
1340 break;
1341 }
1342 }
1343 else if (RT_FAILURE(rc))
1344 break;
1345 }
1346
1347 Log3Func(("[%s] Played %RU32/%RU32 frames, rc=%Rrc\n", pStream->szName, cfPlayedTotal, cfToPlay, rc));
1348
1349 if (RT_SUCCESS(rc))
1350 {
1351 if (pcfPlayed)
1352 *pcfPlayed = cfPlayedTotal;
1353
1354 }
1355
1356 return rc;
1357}
1358
1359/**
1360 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamPlay}
1361 */
1362static DECLCALLBACK(int) drvAudioStreamPlay(PPDMIAUDIOCONNECTOR pInterface,
1363 PPDMAUDIOSTREAM pStream, uint32_t *pcFramesPlayed)
1364{
1365 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
1366 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1367 /* pcFramesPlayed is optional. */
1368
1369 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
1370
1371 int rc = RTCritSectEnter(&pThis->CritSect);
1372 if (RT_FAILURE(rc))
1373 return rc;
1374
1375 AssertMsg(pStream->enmDir == PDMAUDIODIR_OUT,
1376 ("Stream '%s' is not an output stream and therefore cannot be played back (direction is 0x%x)\n",
1377 pStream->szName, pStream->enmDir));
1378
1379 uint32_t cfPlayedTotal = 0;
1380
1381 PDMAUDIOSTREAMSTS stsStream = pStream->fStatus;
1382#ifdef LOG_ENABLED
1383 char *pszStreamSts = dbgAudioStreamStatusToStr(stsStream);
1384 Log3Func(("[%s] Start fStatus=%s\n", pStream->szName, pszStreamSts));
1385 RTStrFree(pszStreamSts);
1386#endif /* LOG_ENABLED */
1387
1388 do
1389 {
1390 if (!pThis->pHostDrvAudio)
1391 {
1392 rc = VERR_AUDIO_STREAM_NOT_READY;
1393 break;
1394 }
1395
1396 if ( !pThis->Out.fEnabled
1397 || !DrvAudioHlpStreamStatusIsReady(stsStream))
1398 {
1399 rc = VERR_AUDIO_STREAM_NOT_READY;
1400 break;
1401 }
1402
1403 const uint32_t cfLive = AudioMixBufLive(&pStream->Host.MixBuf);
1404#ifdef LOG_ENABLED
1405 const uint8_t uLivePercent = (100 * cfLive) / AudioMixBufSize(&pStream->Host.MixBuf);
1406#endif
1407 const uint64_t tsDeltaPlayedCapturedNs = RTTimeNanoTS() - pStream->tsLastPlayedCapturedNs;
1408 const uint32_t cfPassedReal = DrvAudioHlpNanoToFrames(tsDeltaPlayedCapturedNs, &pStream->Host.Cfg.Props);
1409
1410 const uint32_t cfPeriod = pStream->Host.Cfg.Backend.cfPeriod;
1411
1412 Log3Func(("[%s] Last played %RU64ns (%RU64ms), filled with %RU64ms (%RU8%%) total (fThresholdReached=%RTbool)\n",
1413 pStream->szName, tsDeltaPlayedCapturedNs, tsDeltaPlayedCapturedNs / RT_NS_1MS_64,
1414 DrvAudioHlpFramesToMilli(cfLive, &pStream->Host.Cfg.Props), uLivePercent, pStream->fThresholdReached));
1415
1416 bool fDoPlay = pStream->fThresholdReached;
1417 bool fJustStarted = false;
1418 if (!fDoPlay)
1419 {
1420 /* Did we reach the backend's playback (pre-buffering) threshold? Can be 0 if no threshold set. */
1421 if (cfLive >= pStream->Host.Cfg.Backend.cfPreBuf)
1422 {
1423 LogRel2(("Audio: Stream '%s' buffering complete\n", pStream->szName));
1424 Log3Func(("[%s] Dbg: Buffering complete\n", pStream->szName));
1425 fDoPlay = true;
1426 }
1427 /* Some audio files are shorter than the pre-buffering level (e.g. the "click" Explorer sounds on some Windows guests),
1428 * so make sure that we also play those by checking if the stream already is pending disable mode, even if we didn't
1429 * hit the pre-buffering watermark yet.
1430 *
1431 * To reproduce, use "Windows Navigation Start.wav" on Windows 7 (2824 samples). */
1432 else if ( cfLive
1433 && pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE)
1434 {
1435 LogRel2(("Audio: Stream '%s' buffering complete (short sound)\n", pStream->szName));
1436 Log3Func(("[%s] Dbg: Buffering complete (short)\n", pStream->szName));
1437 fDoPlay = true;
1438 }
1439
1440 if (fDoPlay)
1441 {
1442 pStream->fThresholdReached = true;
1443 fJustStarted = true;
1444 LogRel2(("Audio: Stream '%s' started playing\n", pStream->szName));
1445 Log3Func(("[%s] Dbg: started playing\n", pStream->szName));
1446 }
1447 else /* Not yet, so still buffering audio data. */
1448 LogRel2(("Audio: Stream '%s' is buffering (%RU8%% complete)\n",
1449 pStream->szName, (100 * cfLive) / pStream->Host.Cfg.Backend.cfPreBuf));
1450 }
1451
1452 if (fDoPlay)
1453 {
1454 uint32_t cfWritable = PDMAUDIOPCMPROPS_B2F(&pStream->Host.Cfg.Props,
1455 pThis->pHostDrvAudio->pfnStreamGetWritable(pThis->pHostDrvAudio, pStream->pvBackend));
1456
1457 uint32_t cfToPlay = 0;
1458 if (fJustStarted)
1459 cfToPlay = RT_MIN(cfWritable, cfPeriod);
1460
1461 if (!cfToPlay)
1462 {
1463 /* Did we reach/pass (in real time) the device scheduling slot?
1464 * Play as much as we can write to the backend then. */
1465 if (cfPassedReal >= DrvAudioHlpMilliToFrames(pStream->Guest.Cfg.Device.uSchedulingHintMs, &pStream->Host.Cfg.Props))
1466 cfToPlay = cfWritable;
1467 }
1468
1469 if (cfToPlay > cfLive) /* Don't try to play more than available. */
1470 cfToPlay = cfLive;
1471#ifdef DEBUG
1472 Log3Func(("[%s] Playing %RU32 frames (%RU64ms), now filled with %RU64ms -- %RU8%%\n",
1473 pStream->szName, cfToPlay, DrvAudioHlpFramesToMilli(cfToPlay, &pStream->Host.Cfg.Props),
1474 DrvAudioHlpFramesToMilli(AudioMixBufUsed(&pStream->Host.MixBuf), &pStream->Host.Cfg.Props),
1475 AudioMixBufUsed(&pStream->Host.MixBuf) * 100 / AudioMixBufSize(&pStream->Host.MixBuf)));
1476#endif
1477 if (cfToPlay)
1478 {
1479 if (pThis->pHostDrvAudio->pfnStreamPlayBegin)
1480 pThis->pHostDrvAudio->pfnStreamPlayBegin(pThis->pHostDrvAudio, pStream->pvBackend);
1481
1482 if (RT_LIKELY(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED))
1483 {
1484 rc = drvAudioStreamPlayNonInterleaved(pThis, pStream, cfToPlay, &cfPlayedTotal);
1485 }
1486 else if (pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW)
1487 {
1488 rc = drvAudioStreamPlayRaw(pThis, pStream, cfToPlay, &cfPlayedTotal);
1489 }
1490 else
1491 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1492
1493 if (pThis->pHostDrvAudio->pfnStreamPlayEnd)
1494 pThis->pHostDrvAudio->pfnStreamPlayEnd(pThis->pHostDrvAudio, pStream->pvBackend);
1495
1496 pStream->tsLastPlayedCapturedNs = RTTimeNanoTS();
1497#ifdef DEBUG
1498 Log3Func(("[%s] Dbg: cfWrittenSinceLastPlay=%RU64 (%RU64ms)\n",
1499 pStream->szName,
1500 pStream->Out.Dbg.cfWrittenSinceLastPlay, DrvAudioHlpFramesToMilli(pStream->Out.Dbg.cfWrittenSinceLastPlay, &pStream->Host.Cfg.Props)));
1501 pStream->Out.Dbg.cfWrittenSinceLastPlay = 0;
1502#endif
1503 }
1504
1505 Log3Func(("[%s] Dbg: fJustStarted=%RTbool, cfSched=%RU32 (%RU64ms), cfPassedReal=%RU32 (%RU64ms), "
1506 "cfLive=%RU32 (%RU64ms), cfPeriod=%RU32 (%RU64ms), cfWritable=%RU32 (%RU64ms), "
1507 "-> cfToPlay=%RU32 (%RU64ms), cfPlayed=%RU32 (%RU64ms)\n",
1508 pStream->szName, fJustStarted,
1509 DrvAudioHlpMilliToFrames(pStream->Guest.Cfg.Device.uSchedulingHintMs, &pStream->Host.Cfg.Props),
1510 pStream->Guest.Cfg.Device.uSchedulingHintMs,
1511 cfPassedReal, DrvAudioHlpFramesToMilli(cfPassedReal, &pStream->Host.Cfg.Props),
1512 cfLive, DrvAudioHlpFramesToMilli(cfLive, &pStream->Host.Cfg.Props),
1513 cfPeriod, DrvAudioHlpFramesToMilli(cfPeriod, &pStream->Host.Cfg.Props),
1514 cfWritable, DrvAudioHlpFramesToMilli(cfWritable, &pStream->Host.Cfg.Props),
1515 cfToPlay, DrvAudioHlpFramesToMilli(cfToPlay, &pStream->Host.Cfg.Props),
1516 cfPlayedTotal, DrvAudioHlpFramesToMilli(cfPlayedTotal, &pStream->Host.Cfg.Props)));
1517 }
1518
1519 if (RT_SUCCESS(rc))
1520 {
1521 AudioMixBufFinish(&pStream->Host.MixBuf, cfPlayedTotal);
1522
1523#ifdef VBOX_WITH_STATISTICS
1524 STAM_COUNTER_ADD (&pThis->Stats.TotalFramesOut, cfPlayedTotal);
1525 STAM_PROFILE_ADV_STOP(&pThis->Stats.DelayOut, out);
1526 STAM_COUNTER_ADD (&pStream->Out.Stats.FramesPlayed, cfPlayedTotal);
1527#endif
1528 }
1529
1530 } while (0);
1531
1532#ifdef LOG_ENABLED
1533 uint32_t cfLive = AudioMixBufLive(&pStream->Host.MixBuf);
1534 pszStreamSts = dbgAudioStreamStatusToStr(stsStream);
1535 Log3Func(("[%s] End fStatus=%s, cfLive=%RU32, cfPlayedTotal=%RU32, rc=%Rrc\n",
1536 pStream->szName, pszStreamSts, cfLive, cfPlayedTotal, rc));
1537 RTStrFree(pszStreamSts);
1538#endif /* LOG_ENABLED */
1539
1540 int rc2 = RTCritSectLeave(&pThis->CritSect);
1541 if (RT_SUCCESS(rc))
1542 rc = rc2;
1543
1544 if (RT_SUCCESS(rc))
1545 {
1546 if (pcFramesPlayed)
1547 *pcFramesPlayed = cfPlayedTotal;
1548 }
1549
1550 if (RT_FAILURE(rc))
1551 LogFlowFunc(("[%s] Failed with %Rrc\n", pStream->szName, rc));
1552
1553 return rc;
1554}
1555
1556/**
1557 * Captures non-interleaved input from a host stream.
1558 *
1559 * @returns IPRT status code.
1560 * @param pThis Driver instance.
1561 * @param pStream Stream to capture from.
1562 * @param pcfCaptured Number of (host) audio frames captured. Optional.
1563 */
1564static int drvAudioStreamCaptureNonInterleaved(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, uint32_t *pcfCaptured)
1565{
1566 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1567 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1568 /* pcfCaptured is optional. */
1569
1570 /* Sanity. */
1571 Assert(pStream->enmDir == PDMAUDIODIR_IN);
1572 Assert(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED);
1573
1574 int rc = VINF_SUCCESS;
1575
1576 uint32_t cfCapturedTotal = 0;
1577
1578 AssertPtr(pThis->pHostDrvAudio->pfnStreamGetReadable);
1579
1580 uint8_t auBuf[_1K]; /** @todo Get rid of this. */
1581 uint32_t cbBuf = sizeof(auBuf);
1582
1583 uint32_t cbReadable = pThis->pHostDrvAudio->pfnStreamGetReadable(pThis->pHostDrvAudio, pStream->pvBackend);
1584 if (!cbReadable)
1585 Log2Func(("[%s] No readable data available\n", pStream->szName));
1586
1587 uint32_t cbFree = AudioMixBufFreeBytes(&pStream->Guest.MixBuf); /* Parent */
1588 if (!cbFree)
1589 Log2Func(("[%s] Buffer full\n", pStream->szName));
1590
1591 if (cbReadable > cbFree) /* More data readable than we can store at the moment? Limit. */
1592 cbReadable = cbFree;
1593
1594 while (cbReadable)
1595 {
1596 uint32_t cbCaptured;
1597 rc = pThis->pHostDrvAudio->pfnStreamCapture(pThis->pHostDrvAudio, pStream->pvBackend,
1598 auBuf, RT_MIN(cbReadable, cbBuf), &cbCaptured);
1599 if (RT_FAILURE(rc))
1600 {
1601 int rc2 = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
1602 AssertRC(rc2);
1603
1604 break;
1605 }
1606
1607 Assert(cbCaptured <= cbBuf);
1608 if (cbCaptured > cbBuf) /* Paranoia. */
1609 cbCaptured = cbBuf;
1610
1611 /* We use the host side mixing buffer as an intermediate buffer to do some
1612 * (first) processing (if needed), so always write the incoming data at offset 0. */
1613 uint32_t cfHstWritten = 0;
1614 rc = AudioMixBufWriteAt(&pStream->Host.MixBuf, 0 /* offFrames */, auBuf, cbCaptured, &cfHstWritten);
1615 if ( RT_FAILURE(rc)
1616 || !cfHstWritten)
1617 {
1618 AssertMsgFailed(("[%s] Write failed: cbCaptured=%RU32, cfHstWritten=%RU32, rc=%Rrc\n",
1619 pStream->szName, cbCaptured, cfHstWritten, rc));
1620 break;
1621 }
1622
1623 if (pThis->In.Cfg.Dbg.fEnabled)
1624 DrvAudioHlpFileWrite(pStream->In.Dbg.pFileCaptureNonInterleaved, auBuf, cbCaptured, 0 /* fFlags */);
1625
1626 uint32_t cfHstMixed = 0;
1627 if (cfHstWritten)
1628 {
1629 int rc2 = AudioMixBufMixToParentEx(&pStream->Host.MixBuf, 0 /* cSrcOffset */, cfHstWritten /* cSrcFrames */,
1630 &cfHstMixed /* pcSrcMixed */);
1631 Log3Func(("[%s] cbCaptured=%RU32, cfWritten=%RU32, cfMixed=%RU32, rc=%Rrc\n",
1632 pStream->szName, cbCaptured, cfHstWritten, cfHstMixed, rc2));
1633 AssertRC(rc2);
1634 }
1635
1636 Assert(cbReadable >= cbCaptured);
1637 cbReadable -= cbCaptured;
1638 cfCapturedTotal += cfHstMixed;
1639 }
1640
1641 if (RT_SUCCESS(rc))
1642 {
1643 if (cfCapturedTotal)
1644 Log2Func(("[%s] %RU32 frames captured, rc=%Rrc\n", pStream->szName, cfCapturedTotal, rc));
1645 }
1646 else
1647 LogFunc(("[%s] Capturing failed with rc=%Rrc\n", pStream->szName, rc));
1648
1649 if (pcfCaptured)
1650 *pcfCaptured = cfCapturedTotal;
1651
1652 return rc;
1653}
1654
1655/**
1656 * Captures raw input from a host stream.
1657 * Raw input means that the backend directly operates on PDMAUDIOFRAME structs without
1658 * no data layout processing done in between.
1659 *
1660 * Needed for e.g. the VRDP audio backend (in Main).
1661 *
1662 * @returns IPRT status code.
1663 * @param pThis Driver instance.
1664 * @param pStream Stream to capture from.
1665 * @param pcfCaptured Number of (host) audio frames captured. Optional.
1666 */
1667static int drvAudioStreamCaptureRaw(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream, uint32_t *pcfCaptured)
1668{
1669 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1670 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
1671 /* pcfCaptured is optional. */
1672
1673 /* Sanity. */
1674 Assert(pStream->enmDir == PDMAUDIODIR_IN);
1675 Assert(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
1676
1677 int rc = VINF_SUCCESS;
1678
1679 uint32_t cfCapturedTotal = 0;
1680
1681 AssertPtr(pThis->pHostDrvAudio->pfnStreamGetReadable);
1682
1683 /* Note: Raw means *audio frames*, not bytes! */
1684 uint32_t cfReadable = pThis->pHostDrvAudio->pfnStreamGetReadable(pThis->pHostDrvAudio, pStream->pvBackend);
1685 if (!cfReadable)
1686 Log2Func(("[%s] No readable data available\n", pStream->szName));
1687
1688 const uint32_t cfFree = AudioMixBufFree(&pStream->Guest.MixBuf); /* Parent */
1689 if (!cfFree)
1690 Log2Func(("[%s] Buffer full\n", pStream->szName));
1691
1692 if (cfReadable > cfFree) /* More data readable than we can store at the moment? Limit. */
1693 cfReadable = cfFree;
1694
1695 while (cfReadable)
1696 {
1697 PPDMAUDIOFRAME paFrames;
1698 uint32_t cfWritable;
1699 rc = AudioMixBufPeekMutable(&pStream->Host.MixBuf, cfReadable, &paFrames, &cfWritable);
1700 if ( RT_FAILURE(rc)
1701 || !cfWritable)
1702 {
1703 break;
1704 }
1705
1706 uint32_t cfCaptured;
1707 rc = pThis->pHostDrvAudio->pfnStreamCapture(pThis->pHostDrvAudio, pStream->pvBackend,
1708 paFrames, cfWritable, &cfCaptured);
1709 if (RT_FAILURE(rc))
1710 {
1711 int rc2 = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
1712 AssertRC(rc2);
1713
1714 break;
1715 }
1716
1717 Assert(cfCaptured <= cfWritable);
1718 if (cfCaptured > cfWritable) /* Paranoia. */
1719 cfCaptured = cfWritable;
1720
1721 Assert(cfReadable >= cfCaptured);
1722 cfReadable -= cfCaptured;
1723 cfCapturedTotal += cfCaptured;
1724 }
1725
1726 Log2Func(("[%s] %RU32 frames captured, rc=%Rrc\n", pStream->szName, cfCapturedTotal, rc));
1727
1728 if (pcfCaptured)
1729 *pcfCaptured = cfCapturedTotal;
1730
1731 return rc;
1732}
1733
1734/**
1735 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamCapture}
1736 */
1737static DECLCALLBACK(int) drvAudioStreamCapture(PPDMIAUDIOCONNECTOR pInterface,
1738 PPDMAUDIOSTREAM pStream, uint32_t *pcFramesCaptured)
1739{
1740 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
1741
1742 int rc = RTCritSectEnter(&pThis->CritSect);
1743 if (RT_FAILURE(rc))
1744 return rc;
1745
1746 AssertMsg(pStream->enmDir == PDMAUDIODIR_IN,
1747 ("Stream '%s' is not an input stream and therefore cannot be captured (direction is 0x%x)\n",
1748 pStream->szName, pStream->enmDir));
1749
1750 uint32_t cfCaptured = 0;
1751
1752#ifdef LOG_ENABLED
1753 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
1754 Log3Func(("[%s] fStatus=%s\n", pStream->szName, pszStreamSts));
1755 RTStrFree(pszStreamSts);
1756#endif /* LOG_ENABLED */
1757
1758 do
1759 {
1760 if (!pThis->pHostDrvAudio)
1761 {
1762 rc = VERR_AUDIO_STREAM_NOT_READY;
1763 break;
1764 }
1765
1766 if ( !pThis->In.fEnabled
1767 || !DrvAudioHlpStreamStatusCanRead(pStream->fStatus))
1768 {
1769 rc = VERR_AUDIO_STREAM_NOT_READY;
1770 break;
1771 }
1772
1773 /*
1774 * Do the actual capturing.
1775 */
1776
1777 if (pThis->pHostDrvAudio->pfnStreamCaptureBegin)
1778 pThis->pHostDrvAudio->pfnStreamCaptureBegin(pThis->pHostDrvAudio, pStream->pvBackend);
1779
1780 if (RT_LIKELY(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED))
1781 {
1782 rc = drvAudioStreamCaptureNonInterleaved(pThis, pStream, &cfCaptured);
1783 }
1784 else if (pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW)
1785 {
1786 rc = drvAudioStreamCaptureRaw(pThis, pStream, &cfCaptured);
1787 }
1788 else
1789 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1790
1791 if (pThis->pHostDrvAudio->pfnStreamCaptureEnd)
1792 pThis->pHostDrvAudio->pfnStreamCaptureEnd(pThis->pHostDrvAudio, pStream->pvBackend);
1793
1794 if (RT_SUCCESS(rc))
1795 {
1796 Log3Func(("[%s] %RU32 frames captured, rc=%Rrc\n", pStream->szName, cfCaptured, rc));
1797
1798#ifdef VBOX_WITH_STATISTICS
1799 STAM_COUNTER_ADD(&pThis->Stats.TotalFramesIn, cfCaptured);
1800 STAM_COUNTER_ADD(&pStream->In.Stats.FramesCaptured, cfCaptured);
1801#endif
1802 }
1803 else if (RT_UNLIKELY(RT_FAILURE(rc)))
1804 {
1805 LogRel(("Audio: Capturing stream '%s' failed with %Rrc\n", pStream->szName, rc));
1806 }
1807
1808 } while (0);
1809
1810 if (pcFramesCaptured)
1811 *pcFramesCaptured = cfCaptured;
1812
1813 int rc2 = RTCritSectLeave(&pThis->CritSect);
1814 if (RT_SUCCESS(rc))
1815 rc = rc2;
1816
1817 if (RT_FAILURE(rc))
1818 LogFlowFuncLeaveRC(rc);
1819
1820 return rc;
1821}
1822
1823#ifdef VBOX_WITH_AUDIO_CALLBACKS
1824/**
1825 * Duplicates an audio callback.
1826 *
1827 * @returns Pointer to duplicated callback, or NULL on failure.
1828 * @param pCB Callback to duplicate.
1829 */
1830static PPDMAUDIOCBRECORD drvAudioCallbackDuplicate(PPDMAUDIOCBRECORD pCB)
1831{
1832 AssertPtrReturn(pCB, NULL);
1833
1834 PPDMAUDIOCBRECORD pCBCopy = (PPDMAUDIOCBRECORD)RTMemDup((void *)pCB, sizeof(PDMAUDIOCBRECORD));
1835 if (!pCBCopy)
1836 return NULL;
1837
1838 if (pCB->pvCtx)
1839 {
1840 pCBCopy->pvCtx = RTMemDup(pCB->pvCtx, pCB->cbCtx);
1841 if (!pCBCopy->pvCtx)
1842 {
1843 RTMemFree(pCBCopy);
1844 return NULL;
1845 }
1846
1847 pCBCopy->cbCtx = pCB->cbCtx;
1848 }
1849
1850 return pCBCopy;
1851}
1852
1853/**
1854 * Destroys a given callback.
1855 *
1856 * @param pCB Callback to destroy.
1857 */
1858static void drvAudioCallbackDestroy(PPDMAUDIOCBRECORD pCB)
1859{
1860 if (!pCB)
1861 return;
1862
1863 RTListNodeRemove(&pCB->Node);
1864 if (pCB->pvCtx)
1865 {
1866 Assert(pCB->cbCtx);
1867 RTMemFree(pCB->pvCtx);
1868 }
1869 RTMemFree(pCB);
1870}
1871
1872/**
1873 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnRegisterCallbacks}
1874 */
1875static DECLCALLBACK(int) drvAudioRegisterCallbacks(PPDMIAUDIOCONNECTOR pInterface,
1876 PPDMAUDIOCBRECORD paCallbacks, size_t cCallbacks)
1877{
1878 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
1879 AssertPtrReturn(paCallbacks, VERR_INVALID_POINTER);
1880 AssertReturn(cCallbacks, VERR_INVALID_PARAMETER);
1881
1882 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
1883
1884 int rc = RTCritSectEnter(&pThis->CritSect);
1885 if (RT_FAILURE(rc))
1886 return rc;
1887
1888 for (size_t i = 0; i < cCallbacks; i++)
1889 {
1890 PPDMAUDIOCBRECORD pCB = drvAudioCallbackDuplicate(&paCallbacks[i]);
1891 if (!pCB)
1892 {
1893 rc = VERR_NO_MEMORY;
1894 break;
1895 }
1896
1897 switch (pCB->enmSource)
1898 {
1899 case PDMAUDIOCBSOURCE_DEVICE:
1900 {
1901 switch (pCB->Device.enmType)
1902 {
1903 case PDMAUDIODEVICECBTYPE_DATA_INPUT:
1904 RTListAppend(&pThis->In.lstCB, &pCB->Node);
1905 break;
1906
1907 case PDMAUDIODEVICECBTYPE_DATA_OUTPUT:
1908 RTListAppend(&pThis->Out.lstCB, &pCB->Node);
1909 break;
1910
1911 default:
1912 AssertMsgFailed(("Not supported\n"));
1913 break;
1914 }
1915
1916 break;
1917 }
1918
1919 default:
1920 AssertMsgFailed(("Not supported\n"));
1921 break;
1922 }
1923 }
1924
1925 /** @todo Undo allocations on error. */
1926
1927 int rc2 = RTCritSectLeave(&pThis->CritSect);
1928 if (RT_SUCCESS(rc))
1929 rc = rc2;
1930
1931 return rc;
1932}
1933#endif /* VBOX_WITH_AUDIO_CALLBACKS */
1934
1935#ifdef VBOX_WITH_AUDIO_CALLBACKS
1936/**
1937 * Backend callback implementation.
1938 *
1939 * Important: No calls back to the backend within this function, as the backend
1940 * might hold any locks / critical sections while executing this callback.
1941 * Will result in some ugly deadlocks (or at least locking order violations) then.
1942 *
1943 * @copydoc FNPDMHOSTAUDIOCALLBACK
1944 */
1945static DECLCALLBACK(int) drvAudioBackendCallback(PPDMDRVINS pDrvIns,
1946 PDMAUDIOBACKENDCBTYPE enmType, void *pvUser, size_t cbUser)
1947{
1948 AssertPtrReturn(pDrvIns, VERR_INVALID_POINTER);
1949 RT_NOREF(pvUser, cbUser);
1950 /* pvUser and cbUser are optional. */
1951
1952 /* Get the upper driver (PDMIAUDIOCONNECTOR). */
1953 AssertPtr(pDrvIns->pUpBase);
1954 PPDMIAUDIOCONNECTOR pInterface = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIAUDIOCONNECTOR);
1955 AssertPtr(pInterface);
1956 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
1957
1958 int rc = RTCritSectEnter(&pThis->CritSect);
1959 AssertRCReturn(rc, rc);
1960
1961 LogFunc(("pThis=%p, enmType=%RU32, pvUser=%p, cbUser=%zu\n", pThis, enmType, pvUser, cbUser));
1962
1963 switch (enmType)
1964 {
1965 case PDMAUDIOBACKENDCBTYPE_DEVICES_CHANGED:
1966 LogRel(("Audio: Host audio device configuration has changed\n"));
1967 rc = drvAudioScheduleReInitInternal(pThis);
1968 break;
1969
1970 default:
1971 AssertMsgFailed(("Not supported\n"));
1972 break;
1973 }
1974
1975 int rc2 = RTCritSectLeave(&pThis->CritSect);
1976 if (RT_SUCCESS(rc))
1977 rc = rc2;
1978
1979 LogFlowFunc(("Returning %Rrc\n", rc));
1980 return rc;
1981}
1982#endif /* VBOX_WITH_AUDIO_CALLBACKS */
1983
1984#ifdef VBOX_WITH_AUDIO_ENUM
1985/**
1986 * Enumerates all host audio devices.
1987 * This functionality might not be implemented by all backends and will return VERR_NOT_SUPPORTED
1988 * if not being supported.
1989 *
1990 * @returns IPRT status code.
1991 * @param pThis Driver instance to be called.
1992 * @param fLog Whether to print the enumerated device to the release log or not.
1993 * @param pDevEnum Where to store the device enumeration.
1994 */
1995static int drvAudioDevicesEnumerateInternal(PDRVAUDIO pThis, bool fLog, PPDMAUDIODEVICEENUM pDevEnum)
1996{
1997 int rc;
1998
1999 /*
2000 * If the backend supports it, do a device enumeration.
2001 */
2002 if (pThis->pHostDrvAudio->pfnGetDevices)
2003 {
2004 PDMAUDIODEVICEENUM DevEnum;
2005 rc = pThis->pHostDrvAudio->pfnGetDevices(pThis->pHostDrvAudio, &DevEnum);
2006 if (RT_SUCCESS(rc))
2007 {
2008 if (fLog)
2009 LogRel(("Audio: Found %RU16 devices\n", DevEnum.cDevices));
2010
2011 PPDMAUDIODEVICE pDev;
2012 RTListForEach(&DevEnum.lstDevices, pDev, PDMAUDIODEVICE, Node)
2013 {
2014 if (fLog)
2015 {
2016 char *pszFlags = DrvAudioHlpAudDevFlagsToStrA(pDev->fFlags);
2017
2018 LogRel(("Audio: Device '%s':\n", pDev->szName));
2019 LogRel(("Audio: \tUsage = %s\n", DrvAudioHlpAudDirToStr(pDev->enmUsage)));
2020 LogRel(("Audio: \tFlags = %s\n", pszFlags ? pszFlags : "<NONE>"));
2021 LogRel(("Audio: \tInput channels = %RU8\n", pDev->cMaxInputChannels));
2022 LogRel(("Audio: \tOutput channels = %RU8\n", pDev->cMaxOutputChannels));
2023
2024 if (pszFlags)
2025 RTStrFree(pszFlags);
2026 }
2027 }
2028
2029 if (pDevEnum)
2030 rc = DrvAudioHlpDeviceEnumCopy(pDevEnum, &DevEnum);
2031
2032 DrvAudioHlpDeviceEnumFree(&DevEnum);
2033 }
2034 else
2035 {
2036 if (fLog)
2037 LogRel(("Audio: Device enumeration failed with %Rrc\n", rc));
2038 /* Not fatal. */
2039 }
2040 }
2041 else
2042 {
2043 rc = VERR_NOT_SUPPORTED;
2044
2045 if (fLog)
2046 LogRel3(("Audio: Host audio backend does not support audio device enumeration, skipping\n"));
2047 }
2048
2049 LogFunc(("Returning %Rrc\n", rc));
2050 return rc;
2051}
2052#endif /* VBOX_WITH_AUDIO_ENUM */
2053
2054/**
2055 * Initializes the host backend and queries its initial configuration.
2056 * If the host backend fails, VERR_AUDIO_BACKEND_INIT_FAILED will be returned.
2057 *
2058 * Note: As this routine is called when attaching to the device LUN in the
2059 * device emulation, we either check for success or VERR_AUDIO_BACKEND_INIT_FAILED.
2060 * Everything else is considered as fatal and must be handled separately in
2061 * the device emulation!
2062 *
2063 * @return IPRT status code.
2064 * @param pThis Driver instance to be called.
2065 * @param pCfgHandle CFGM configuration handle to use for this driver.
2066 */
2067static int drvAudioHostInit(PDRVAUDIO pThis, PCFGMNODE pCfgHandle)
2068{
2069 /* pCfgHandle is optional. */
2070 NOREF(pCfgHandle);
2071 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2072
2073 LogFlowFuncEnter();
2074
2075 AssertPtr(pThis->pHostDrvAudio);
2076 int rc = pThis->pHostDrvAudio->pfnInit(pThis->pHostDrvAudio);
2077 if (RT_FAILURE(rc))
2078 {
2079 LogRel(("Audio: Initialization of host backend failed with %Rrc\n", rc));
2080 return VERR_AUDIO_BACKEND_INIT_FAILED;
2081 }
2082
2083 /*
2084 * Get the backend configuration.
2085 */
2086 rc = pThis->pHostDrvAudio->pfnGetConfig(pThis->pHostDrvAudio, &pThis->BackendCfg);
2087 if (RT_FAILURE(rc))
2088 {
2089 LogRel(("Audio: Getting host backend configuration failed with %Rrc\n", rc));
2090 return VERR_AUDIO_BACKEND_INIT_FAILED;
2091 }
2092
2093 pThis->In.cStreamsFree = pThis->BackendCfg.cMaxStreamsIn;
2094 pThis->Out.cStreamsFree = pThis->BackendCfg.cMaxStreamsOut;
2095
2096 LogFlowFunc(("cStreamsFreeIn=%RU8, cStreamsFreeOut=%RU8\n", pThis->In.cStreamsFree, pThis->Out.cStreamsFree));
2097
2098 LogRel2(("Audio: Host audio backend supports %RU32 input streams and %RU32 output streams at once\n",
2099 /* Clamp for logging. Unlimited streams are defined by UINT32_MAX. */
2100 RT_MIN(64, pThis->In.cStreamsFree), RT_MIN(64, pThis->Out.cStreamsFree)));
2101
2102#ifdef VBOX_WITH_AUDIO_ENUM
2103 int rc2 = drvAudioDevicesEnumerateInternal(pThis, true /* fLog */, NULL /* pDevEnum */);
2104 if (rc2 != VERR_NOT_SUPPORTED) /* Some backends don't implement device enumeration. */
2105 AssertRC(rc2);
2106
2107 RT_NOREF(rc2);
2108 /* Ignore rc. */
2109#endif
2110
2111#ifdef VBOX_WITH_AUDIO_CALLBACKS
2112 /*
2113 * If the backend supports it, offer a callback to this connector.
2114 */
2115 if (pThis->pHostDrvAudio->pfnSetCallback)
2116 {
2117 rc2 = pThis->pHostDrvAudio->pfnSetCallback(pThis->pHostDrvAudio, drvAudioBackendCallback);
2118 if (RT_FAILURE(rc2))
2119 LogRel(("Audio: Error registering backend callback, rc=%Rrc\n", rc2));
2120 /* Not fatal. */
2121 }
2122#endif
2123
2124 LogFlowFuncLeave();
2125 return VINF_SUCCESS;
2126}
2127
2128/**
2129 * Handles state changes for all audio streams.
2130 *
2131 * @param pDrvIns Pointer to driver instance.
2132 * @param enmCmd Stream command to set for all streams.
2133 */
2134static void drvAudioStateHandler(PPDMDRVINS pDrvIns, PDMAUDIOSTREAMCMD enmCmd)
2135{
2136 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
2137 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
2138
2139 LogFlowFunc(("enmCmd=%s\n", DrvAudioHlpStreamCmdToStr(enmCmd)));
2140
2141 int rc2 = RTCritSectEnter(&pThis->CritSect);
2142 AssertRC(rc2);
2143
2144 if (pThis->pHostDrvAudio)
2145 {
2146 PPDMAUDIOSTREAM pStream;
2147 RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
2148 drvAudioStreamControlInternal(pThis, pStream, enmCmd);
2149 }
2150
2151 rc2 = RTCritSectLeave(&pThis->CritSect);
2152 AssertRC(rc2);
2153}
2154
2155/**
2156 * Retrieves an audio configuration from the specified CFGM node.
2157 *
2158 * @return VBox status code.
2159 * @param pThis Driver instance to be called.
2160 * @param pCfg Where to store the retrieved audio configuration to.
2161 * @param pNode Where to get the audio configuration from.
2162 */
2163static int drvAudioGetCfgFromCFGM(PDRVAUDIO pThis, PDRVAUDIOCFG pCfg, PCFGMNODE pNode)
2164{
2165 RT_NOREF(pThis);
2166
2167 /* Debug stuff. */
2168 CFGMR3QueryBoolDef(pNode, "DebugEnabled", &pCfg->Dbg.fEnabled, false);
2169 int rc2 = CFGMR3QueryString(pNode, "DebugPathOut", pCfg->Dbg.szPathOut, sizeof(pCfg->Dbg.szPathOut));
2170 if ( RT_FAILURE(rc2)
2171 || !strlen(pCfg->Dbg.szPathOut))
2172 {
2173 RTStrPrintf(pCfg->Dbg.szPathOut, sizeof(pCfg->Dbg.szPathOut), VBOX_AUDIO_DEBUG_DUMP_PCM_DATA_PATH);
2174 }
2175
2176 if (pCfg->Dbg.fEnabled)
2177 LogRel(("Audio: Debugging enabled (audio data written to '%s')\n", pCfg->Dbg.szPathOut));
2178
2179 /* Buffering stuff. */
2180 CFGMR3QueryU32Def(pNode, "PeriodSizeMs", &pCfg->uPeriodSizeMs, 0);
2181 CFGMR3QueryU32Def(pNode, "BufferSizeMs", &pCfg->uBufferSizeMs, 0);
2182 CFGMR3QueryU32Def(pNode, "PreBufferSizeMs", &pCfg->uPreBufSizeMs, UINT32_MAX /* No custom value set */);
2183
2184 LogFunc(("pCfg=%p, uPeriodSizeMs=%RU32, uBufferSizeMs=%RU32, uPreBufSizeMs=%RU32\n",
2185 pCfg, pCfg->uPeriodSizeMs, pCfg->uBufferSizeMs, pCfg->uPreBufSizeMs));
2186
2187 return VINF_SUCCESS;
2188}
2189
2190/**
2191 * Intializes an audio driver instance.
2192 *
2193 * @returns IPRT status code.
2194 * @param pDrvIns Pointer to driver instance.
2195 * @param pCfgHandle CFGM handle to use for configuration.
2196 */
2197static int drvAudioInit(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
2198{
2199 AssertPtrReturn(pCfgHandle, VERR_INVALID_POINTER);
2200 AssertPtrReturn(pDrvIns, VERR_INVALID_POINTER);
2201
2202 LogRel2(("Audio: Verbose logging enabled\n"));
2203
2204 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
2205
2206 int rc = RTCritSectInit(&pThis->CritSect);
2207 AssertRCReturn(rc, rc);
2208
2209 /*
2210 * Configure driver from CFGM.
2211 */
2212#ifdef DEBUG
2213 CFGMR3Dump(pCfgHandle);
2214#endif
2215
2216 pThis->fTerminate = false;
2217 pThis->pCFGMNode = pCfgHandle;
2218
2219 int rc2 = CFGMR3QueryString(pThis->pCFGMNode, "DriverName", pThis->szName, sizeof(pThis->szName));
2220 if (RT_FAILURE(rc2))
2221 RTStrPrintf(pThis->szName, sizeof(pThis->szName), "Untitled");
2222
2223 /* By default we don't enable anything if wrongly / not set-up. */
2224 CFGMR3QueryBoolDef(pThis->pCFGMNode, "InputEnabled", &pThis->In.fEnabled, false);
2225 CFGMR3QueryBoolDef(pThis->pCFGMNode, "OutputEnabled", &pThis->Out.fEnabled, false);
2226
2227 LogRel2(("Audio: Initial status for driver '%s': Input is %s, output is %s\n",
2228 pThis->szName, pThis->In.fEnabled ? "enabled" : "disabled", pThis->Out.fEnabled ? "enabled" : "disabled"));
2229
2230 /*
2231 * Load configurations.
2232 */
2233 rc = drvAudioGetCfgFromCFGM(pThis, &pThis->In.Cfg, pThis->pCFGMNode);
2234 if (RT_SUCCESS(rc))
2235 rc = drvAudioGetCfgFromCFGM(pThis, &pThis->Out.Cfg, pThis->pCFGMNode);
2236
2237 LogFunc(("[%s] rc=%Rrc\n", pThis->szName, rc));
2238 return rc;
2239}
2240
2241/**
2242 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamRead}
2243 */
2244static DECLCALLBACK(int) drvAudioStreamRead(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream,
2245 void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead)
2246{
2247 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2248 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2249
2250 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
2251 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
2252 AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
2253 /* pcbRead is optional. */
2254
2255 AssertMsg(pStream->enmDir == PDMAUDIODIR_IN,
2256 ("Stream '%s' is not an input stream and therefore cannot be read from (direction is 0x%x)\n",
2257 pStream->szName, pStream->enmDir));
2258
2259 uint32_t cbReadTotal = 0;
2260
2261 int rc = RTCritSectEnter(&pThis->CritSect);
2262 if (RT_FAILURE(rc))
2263 return rc;
2264
2265 do
2266 {
2267 if ( !pThis->In.fEnabled
2268 || !DrvAudioHlpStreamStatusCanRead(pStream->fStatus))
2269 {
2270 rc = VERR_AUDIO_STREAM_NOT_READY;
2271 break;
2272 }
2273
2274 /*
2275 * Read from the parent buffer (that is, the guest buffer) which
2276 * should have the audio data in the format the guest needs.
2277 */
2278 uint32_t cfReadTotal = 0;
2279
2280 const uint32_t cfBuf = AUDIOMIXBUF_B2F(&pStream->Guest.MixBuf, cbBuf);
2281
2282 uint32_t cfToRead = RT_MIN(cfBuf, AudioMixBufLive(&pStream->Guest.MixBuf));
2283 while (cfToRead)
2284 {
2285 uint32_t cfRead;
2286 rc = AudioMixBufAcquireReadBlock(&pStream->Guest.MixBuf,
2287 (uint8_t *)pvBuf + AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfReadTotal),
2288 AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfToRead), &cfRead);
2289 if (RT_FAILURE(rc))
2290 break;
2291
2292#ifdef VBOX_WITH_STATISTICS
2293 const uint32_t cbRead = AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfRead);
2294
2295 STAM_COUNTER_ADD(&pThis->Stats.TotalBytesRead, cbRead);
2296 STAM_COUNTER_ADD(&pStream->In.Stats.BytesTotalRead, cbRead);
2297#endif
2298 Assert(cfToRead >= cfRead);
2299 cfToRead -= cfRead;
2300
2301 cfReadTotal += cfRead;
2302
2303 AudioMixBufReleaseReadBlock(&pStream->Guest.MixBuf, cfRead);
2304 }
2305
2306 if (cfReadTotal)
2307 {
2308 if (pThis->In.Cfg.Dbg.fEnabled)
2309 DrvAudioHlpFileWrite(pStream->In.Dbg.pFileStreamRead,
2310 pvBuf, AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfReadTotal), 0 /* fFlags */);
2311
2312 AudioMixBufFinish(&pStream->Guest.MixBuf, cfReadTotal);
2313 }
2314
2315 /* If we were not able to read as much data as requested, fill up the returned
2316 * data with silence.
2317 *
2318 * This is needed to keep the device emulation DMA transfers up and running at a constant rate. */
2319 if (cfReadTotal < cfBuf)
2320 {
2321 Log3Func(("[%s] Filling in silence (%RU64ms / %RU64ms)\n", pStream->szName,
2322 DrvAudioHlpFramesToMilli(cfBuf - cfReadTotal, &pStream->Guest.Cfg.Props),
2323 DrvAudioHlpFramesToMilli(cfBuf, &pStream->Guest.Cfg.Props)));
2324
2325 DrvAudioHlpClearBuf(&pStream->Guest.Cfg.Props,
2326 (uint8_t *)pvBuf + AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfReadTotal),
2327 AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfBuf - cfReadTotal),
2328 cfBuf - cfReadTotal);
2329
2330 cfReadTotal = cfBuf;
2331 }
2332
2333 cbReadTotal = AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfReadTotal);
2334
2335 pStream->tsLastReadWrittenNs = RTTimeNanoTS();
2336
2337 Log3Func(("[%s] fEnabled=%RTbool, cbReadTotal=%RU32, rc=%Rrc\n", pStream->szName, pThis->In.fEnabled, cbReadTotal, rc));
2338
2339 } while (0);
2340
2341
2342 int rc2 = RTCritSectLeave(&pThis->CritSect);
2343 if (RT_SUCCESS(rc))
2344 rc = rc2;
2345
2346 if (RT_SUCCESS(rc))
2347 {
2348 if (pcbRead)
2349 *pcbRead = cbReadTotal;
2350 }
2351
2352 return rc;
2353}
2354
2355/**
2356 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamCreate}
2357 */
2358static DECLCALLBACK(int) drvAudioStreamCreate(PPDMIAUDIOCONNECTOR pInterface,
2359 PPDMAUDIOSTREAMCFG pCfgHost, PPDMAUDIOSTREAMCFG pCfgGuest,
2360 PPDMAUDIOSTREAM *ppStream)
2361{
2362 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
2363 AssertPtrReturn(pCfgHost, VERR_INVALID_POINTER);
2364 AssertPtrReturn(pCfgGuest, VERR_INVALID_POINTER);
2365 AssertPtrReturn(ppStream, VERR_INVALID_POINTER);
2366
2367 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2368
2369 int rc = RTCritSectEnter(&pThis->CritSect);
2370 if (RT_FAILURE(rc))
2371 return rc;
2372
2373 LogFlowFunc(("Host=%s, Guest=%s\n", pCfgHost->szName, pCfgGuest->szName));
2374#ifdef DEBUG
2375 DrvAudioHlpStreamCfgPrint(pCfgHost);
2376 DrvAudioHlpStreamCfgPrint(pCfgGuest);
2377#endif
2378
2379 PPDMAUDIOSTREAM pStream = NULL;
2380
2381#define RC_BREAK(x) { rc = x; break; }
2382
2383 do
2384 {
2385 if ( !DrvAudioHlpStreamCfgIsValid(pCfgHost)
2386 || !DrvAudioHlpStreamCfgIsValid(pCfgGuest))
2387 {
2388 RC_BREAK(VERR_INVALID_PARAMETER);
2389 }
2390
2391 /* Make sure that both configurations actually intend the same thing. */
2392 if (pCfgHost->enmDir != pCfgGuest->enmDir)
2393 {
2394 AssertMsgFailed(("Stream configuration directions do not match\n"));
2395 RC_BREAK(VERR_INVALID_PARAMETER);
2396 }
2397
2398 /* Note: cbHstStrm will contain the size of the data the backend needs to operate on. */
2399 size_t cbHstStrm = 0;
2400 if (pCfgHost->enmDir == PDMAUDIODIR_IN)
2401 {
2402 if (!pThis->In.cStreamsFree)
2403 LogFunc(("Warning: No more input streams free to use\n"));
2404
2405 cbHstStrm = pThis->BackendCfg.cbStreamIn;
2406 }
2407 else /* Out */
2408 {
2409 if (!pThis->Out.cStreamsFree)
2410 {
2411 LogFlowFunc(("Maximum number of host output streams reached\n"));
2412 RC_BREAK(VERR_AUDIO_NO_FREE_OUTPUT_STREAMS);
2413 }
2414
2415 cbHstStrm = pThis->BackendCfg.cbStreamOut;
2416 }
2417
2418 /*
2419 * Allocate and initialize common state.
2420 */
2421
2422 pStream = (PPDMAUDIOSTREAM)RTMemAllocZ(sizeof(PDMAUDIOSTREAM));
2423 AssertPtrBreakStmt(pStream, rc = VERR_NO_MEMORY);
2424
2425 /* Retrieve host driver name for easier identification. */
2426 AssertPtr(pThis->pHostDrvAudio);
2427 PPDMDRVINS pDrvAudioInst = PDMIBASE_2_PDMDRV(pThis->pDrvIns->pDownBase);
2428 AssertPtr(pDrvAudioInst);
2429 AssertPtr(pDrvAudioInst->pReg);
2430
2431 char szDriver[64];
2432 RTStrPrintf(szDriver, RT_ELEMENTS(szDriver), "%s", pDrvAudioInst->pReg->szName);
2433 if (!strlen(szDriver))
2434 {
2435 RTStrPrintf(szDriver, RT_ELEMENTS(szDriver), "Untitled");
2436 AssertFailed(); /* Should never happen. */
2437 }
2438
2439 RTStrPrintf(pStream->szName, RT_ELEMENTS(pStream->szName), "[%s] %s",
2440 szDriver, strlen(pCfgHost->szName) ? pCfgHost->szName : "<Untitled>");
2441 pStream->enmDir = pCfgHost->enmDir;
2442
2443 /*
2444 * Allocate and init backend-specific data.
2445 */
2446
2447 if (cbHstStrm) /* High unlikely that backends do not have an own space for data, but better check. */
2448 {
2449 pStream->pvBackend = RTMemAllocZ(cbHstStrm);
2450 AssertPtrBreakStmt(pStream->pvBackend, rc = VERR_NO_MEMORY);
2451
2452 pStream->cbBackend = cbHstStrm;
2453 }
2454
2455 /*
2456 * Try to init the rest.
2457 */
2458
2459 rc = drvAudioStreamInitInternal(pThis, pStream, pCfgHost, pCfgGuest);
2460 if (RT_FAILURE(rc))
2461 break;
2462
2463 } while (0);
2464
2465#undef RC_BREAK
2466
2467 if (RT_FAILURE(rc))
2468 {
2469 if (pStream)
2470 {
2471 int rc2 = drvAudioStreamUninitInternal(pThis, pStream);
2472 if (RT_SUCCESS(rc2))
2473 {
2474 drvAudioStreamFree(pStream);
2475 pStream = NULL;
2476 }
2477 }
2478 }
2479 else
2480 {
2481 /* Append the stream to our stream list. */
2482 RTListAppend(&pThis->lstStreams, &pStream->Node);
2483
2484 /* Set initial reference counts. */
2485 pStream->cRefs = 1;
2486
2487 if (pCfgHost->enmDir == PDMAUDIODIR_IN)
2488 {
2489 if (pThis->In.Cfg.Dbg.fEnabled)
2490 {
2491 char szFile[RTPATH_MAX + 1];
2492
2493 int rc2 = DrvAudioHlpFileNameGet(szFile, RT_ELEMENTS(szFile), pThis->In.Cfg.Dbg.szPathOut, "CaptureNonInterleaved",
2494 pThis->pDrvIns->iInstance, PDMAUDIOFILETYPE_WAV, PDMAUDIOFILENAME_FLAG_NONE);
2495 if (RT_SUCCESS(rc2))
2496 {
2497 rc2 = DrvAudioHlpFileCreate(PDMAUDIOFILETYPE_WAV, szFile, PDMAUDIOFILE_FLAG_NONE,
2498 &pStream->In.Dbg.pFileCaptureNonInterleaved);
2499 if (RT_SUCCESS(rc2))
2500 rc2 = DrvAudioHlpFileOpen(pStream->In.Dbg.pFileCaptureNonInterleaved, PDMAUDIOFILE_DEFAULT_OPEN_FLAGS,
2501 &pStream->Host.Cfg.Props);
2502 }
2503
2504 if (RT_SUCCESS(rc2))
2505 {
2506 rc2 = DrvAudioHlpFileNameGet(szFile, RT_ELEMENTS(szFile), pThis->In.Cfg.Dbg.szPathOut, "StreamRead",
2507 pThis->pDrvIns->iInstance, PDMAUDIOFILETYPE_WAV, PDMAUDIOFILENAME_FLAG_NONE);
2508 if (RT_SUCCESS(rc2))
2509 {
2510 rc2 = DrvAudioHlpFileCreate(PDMAUDIOFILETYPE_WAV, szFile, PDMAUDIOFILE_FLAG_NONE,
2511 &pStream->In.Dbg.pFileStreamRead);
2512 if (RT_SUCCESS(rc2))
2513 rc2 = DrvAudioHlpFileOpen(pStream->In.Dbg.pFileStreamRead, PDMAUDIOFILE_DEFAULT_OPEN_FLAGS,
2514 &pStream->Host.Cfg.Props);
2515 }
2516 }
2517 }
2518
2519 if (pThis->In.cStreamsFree)
2520 pThis->In.cStreamsFree--;
2521 }
2522 else /* Out */
2523 {
2524 if (pThis->Out.Cfg.Dbg.fEnabled)
2525 {
2526 char szFile[RTPATH_MAX + 1];
2527
2528 int rc2 = DrvAudioHlpFileNameGet(szFile, RT_ELEMENTS(szFile), pThis->Out.Cfg.Dbg.szPathOut, "PlayNonInterleaved",
2529 pThis->pDrvIns->iInstance, PDMAUDIOFILETYPE_WAV, PDMAUDIOFILENAME_FLAG_NONE);
2530 if (RT_SUCCESS(rc2))
2531 {
2532 rc2 = DrvAudioHlpFileCreate(PDMAUDIOFILETYPE_WAV, szFile, PDMAUDIOFILE_FLAG_NONE,
2533 &pStream->Out.Dbg.pFilePlayNonInterleaved);
2534 if (RT_SUCCESS(rc2))
2535 rc = DrvAudioHlpFileOpen(pStream->Out.Dbg.pFilePlayNonInterleaved, PDMAUDIOFILE_DEFAULT_OPEN_FLAGS,
2536 &pStream->Host.Cfg.Props);
2537 }
2538
2539 if (RT_SUCCESS(rc2))
2540 {
2541 rc2 = DrvAudioHlpFileNameGet(szFile, RT_ELEMENTS(szFile), pThis->Out.Cfg.Dbg.szPathOut, "StreamWrite",
2542 pThis->pDrvIns->iInstance, PDMAUDIOFILETYPE_WAV, PDMAUDIOFILENAME_FLAG_NONE);
2543 if (RT_SUCCESS(rc2))
2544 {
2545 rc2 = DrvAudioHlpFileCreate(PDMAUDIOFILETYPE_WAV, szFile, PDMAUDIOFILE_FLAG_NONE,
2546 &pStream->Out.Dbg.pFileStreamWrite);
2547 if (RT_SUCCESS(rc2))
2548 rc2 = DrvAudioHlpFileOpen(pStream->Out.Dbg.pFileStreamWrite, PDMAUDIOFILE_DEFAULT_OPEN_FLAGS,
2549 &pStream->Host.Cfg.Props);
2550 }
2551 }
2552 }
2553
2554 if (pThis->Out.cStreamsFree)
2555 pThis->Out.cStreamsFree--;
2556 }
2557
2558#ifdef VBOX_WITH_STATISTICS
2559 STAM_COUNTER_ADD(&pThis->Stats.TotalStreamsCreated, 1);
2560#endif
2561 *ppStream = pStream;
2562 }
2563
2564 int rc2 = RTCritSectLeave(&pThis->CritSect);
2565 if (RT_SUCCESS(rc))
2566 rc = rc2;
2567
2568 LogFlowFuncLeaveRC(rc);
2569 return rc;
2570}
2571
2572/**
2573 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnEnable}
2574 */
2575static DECLCALLBACK(int) drvAudioEnable(PPDMIAUDIOCONNECTOR pInterface, PDMAUDIODIR enmDir, bool fEnable)
2576{
2577 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
2578
2579 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2580
2581 int rc = RTCritSectEnter(&pThis->CritSect);
2582 if (RT_FAILURE(rc))
2583 return rc;
2584
2585 bool *pfEnabled;
2586 if (enmDir == PDMAUDIODIR_IN)
2587 pfEnabled = &pThis->In.fEnabled;
2588 else if (enmDir == PDMAUDIODIR_OUT)
2589 pfEnabled = &pThis->Out.fEnabled;
2590 else
2591 AssertFailedReturn(VERR_INVALID_PARAMETER);
2592
2593 if (fEnable != *pfEnabled)
2594 {
2595 LogRel(("Audio: %s %s\n",
2596 fEnable ? "Enabling" : "Disabling", enmDir == PDMAUDIODIR_IN ? "input" : "output"));
2597
2598 PPDMAUDIOSTREAM pStream;
2599 RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
2600 {
2601 if (pStream->enmDir != enmDir) /* Skip unwanted streams. */
2602 continue;
2603
2604 int rc2 = drvAudioStreamControlInternal(pThis, pStream,
2605 fEnable ? PDMAUDIOSTREAMCMD_ENABLE : PDMAUDIOSTREAMCMD_DISABLE);
2606 if (RT_FAILURE(rc2))
2607 LogRel(("Audio: Failed to %s %s stream '%s', rc=%Rrc\n",
2608 fEnable ? "enable" : "disable", enmDir == PDMAUDIODIR_IN ? "input" : "output", pStream->szName, rc2));
2609
2610 if (RT_SUCCESS(rc))
2611 rc = rc2;
2612
2613 /* Keep going. */
2614 }
2615
2616 *pfEnabled = fEnable;
2617 }
2618
2619 int rc3 = RTCritSectLeave(&pThis->CritSect);
2620 if (RT_SUCCESS(rc))
2621 rc = rc3;
2622
2623 LogFlowFuncLeaveRC(rc);
2624 return rc;
2625}
2626
2627/**
2628 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnIsEnabled}
2629 */
2630static DECLCALLBACK(bool) drvAudioIsEnabled(PPDMIAUDIOCONNECTOR pInterface, PDMAUDIODIR enmDir)
2631{
2632 AssertPtrReturn(pInterface, false);
2633
2634 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2635
2636 int rc2 = RTCritSectEnter(&pThis->CritSect);
2637 if (RT_FAILURE(rc2))
2638 return false;
2639
2640 bool *pfEnabled;
2641 if (enmDir == PDMAUDIODIR_IN)
2642 pfEnabled = &pThis->In.fEnabled;
2643 else if (enmDir == PDMAUDIODIR_OUT)
2644 pfEnabled = &pThis->Out.fEnabled;
2645 else
2646 AssertFailedReturn(false);
2647
2648 const bool fIsEnabled = *pfEnabled;
2649
2650 rc2 = RTCritSectLeave(&pThis->CritSect);
2651 AssertRC(rc2);
2652
2653 return fIsEnabled;
2654}
2655
2656/**
2657 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnGetConfig}
2658 */
2659static DECLCALLBACK(int) drvAudioGetConfig(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOBACKENDCFG pCfg)
2660{
2661 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
2662 AssertPtrReturn(pCfg, VERR_INVALID_POINTER);
2663
2664 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2665
2666 int rc = RTCritSectEnter(&pThis->CritSect);
2667 if (RT_FAILURE(rc))
2668 return rc;
2669
2670 if (pThis->pHostDrvAudio)
2671 {
2672 if (pThis->pHostDrvAudio->pfnGetConfig)
2673 rc = pThis->pHostDrvAudio->pfnGetConfig(pThis->pHostDrvAudio, pCfg);
2674 else
2675 rc = VERR_NOT_SUPPORTED;
2676 }
2677 else
2678 AssertFailed();
2679
2680 int rc2 = RTCritSectLeave(&pThis->CritSect);
2681 if (RT_SUCCESS(rc))
2682 rc = rc2;
2683
2684 LogFlowFuncLeaveRC(rc);
2685 return rc;
2686}
2687
2688/**
2689 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnGetStatus}
2690 */
2691static DECLCALLBACK(PDMAUDIOBACKENDSTS) drvAudioGetStatus(PPDMIAUDIOCONNECTOR pInterface, PDMAUDIODIR enmDir)
2692{
2693 AssertPtrReturn(pInterface, PDMAUDIOBACKENDSTS_UNKNOWN);
2694
2695 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2696
2697 PDMAUDIOBACKENDSTS backendSts = PDMAUDIOBACKENDSTS_UNKNOWN;
2698
2699 int rc = RTCritSectEnter(&pThis->CritSect);
2700 if (RT_SUCCESS(rc))
2701 {
2702 if (pThis->pHostDrvAudio)
2703 {
2704 if (pThis->pHostDrvAudio->pfnGetStatus)
2705 backendSts = pThis->pHostDrvAudio->pfnGetStatus(pThis->pHostDrvAudio, enmDir);
2706 }
2707 else
2708 backendSts = PDMAUDIOBACKENDSTS_NOT_ATTACHED;
2709
2710 int rc2 = RTCritSectLeave(&pThis->CritSect);
2711 if (RT_SUCCESS(rc))
2712 rc = rc2;
2713 }
2714
2715 LogFlowFuncLeaveRC(rc);
2716 return backendSts;
2717}
2718
2719/**
2720 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamGetReadable}
2721 */
2722static DECLCALLBACK(uint32_t) drvAudioStreamGetReadable(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
2723{
2724 AssertPtrReturn(pInterface, 0);
2725 AssertPtrReturn(pStream, 0);
2726
2727 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2728
2729 int rc2 = RTCritSectEnter(&pThis->CritSect);
2730 AssertRC(rc2);
2731
2732 AssertMsg(pStream->enmDir == PDMAUDIODIR_IN, ("Can't read from a non-input stream\n"));
2733
2734 uint32_t cbReadable = 0;
2735
2736 if (DrvAudioHlpStreamStatusCanRead(pStream->fStatus))
2737 {
2738 const uint32_t cfReadable = AudioMixBufLive(&pStream->Guest.MixBuf);
2739
2740 cbReadable = AUDIOMIXBUF_F2B(&pStream->Guest.MixBuf, cfReadable);
2741
2742 if (!cbReadable)
2743 {
2744 /*
2745 * If nothing is readable, check if the stream on the backend side is ready to be read from.
2746 * If it isn't, return the number of bytes readable since the last read from this stream.
2747 *
2748 * This is needed for backends (e.g. VRDE) which do not provide any input data in certain
2749 * situations, but the device emulation needs input data to keep the DMA transfers moving.
2750 * Reading the actual data from a stream then will return silence then.
2751 */
2752 if (!DrvAudioHlpStreamStatusCanRead(
2753 pThis->pHostDrvAudio->pfnStreamGetStatus(pThis->pHostDrvAudio, pStream->pvBackend)))
2754 {
2755 cbReadable = DrvAudioHlpNanoToBytes(RTTimeNanoTS() - pStream->tsLastReadWrittenNs,
2756 &pStream->Host.Cfg.Props);
2757 Log3Func(("[%s] Backend stream not ready, returning silence\n", pStream->szName));
2758 }
2759 }
2760
2761 /* Make sure to align the readable size to the guest's frame size. */
2762 cbReadable = DrvAudioHlpBytesAlign(cbReadable, &pStream->Guest.Cfg.Props);
2763 }
2764
2765 Log3Func(("[%s] cbReadable=%RU32 (%RU64ms)\n",
2766 pStream->szName, cbReadable, DrvAudioHlpBytesToMilli(cbReadable, &pStream->Host.Cfg.Props)));
2767
2768 rc2 = RTCritSectLeave(&pThis->CritSect);
2769 AssertRC(rc2);
2770
2771 /* Return bytes instead of audio frames. */
2772 return cbReadable;
2773}
2774
2775/**
2776 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamGetWritable}
2777 */
2778static DECLCALLBACK(uint32_t) drvAudioStreamGetWritable(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
2779{
2780 AssertPtrReturn(pInterface, 0);
2781 AssertPtrReturn(pStream, 0);
2782
2783 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2784
2785 int rc2 = RTCritSectEnter(&pThis->CritSect);
2786 AssertRC(rc2);
2787
2788 AssertMsg(pStream->enmDir == PDMAUDIODIR_OUT, ("Can't write to a non-output stream\n"));
2789
2790 uint32_t cbWritable = 0;
2791
2792 /* Note: We don't propage the backend stream's status to the outside -- it's the job of this
2793 * audio connector to make sense of it. */
2794 if (DrvAudioHlpStreamStatusCanWrite(pStream->fStatus))
2795 {
2796 cbWritable = AudioMixBufFreeBytes(&pStream->Host.MixBuf);
2797
2798 /* Make sure to align the writable size to the host's frame size. */
2799 cbWritable = DrvAudioHlpBytesAlign(cbWritable, &pStream->Host.Cfg.Props);
2800 }
2801
2802 Log3Func(("[%s] cbWritable=%RU32 (%RU64ms)\n",
2803 pStream->szName, cbWritable, DrvAudioHlpBytesToMilli(cbWritable, &pStream->Host.Cfg.Props)));
2804
2805 rc2 = RTCritSectLeave(&pThis->CritSect);
2806 AssertRC(rc2);
2807
2808 return cbWritable;
2809}
2810
2811/**
2812 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamGetStatus}
2813 */
2814static DECLCALLBACK(PDMAUDIOSTREAMSTS) drvAudioStreamGetStatus(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
2815{
2816 AssertPtrReturn(pInterface, false);
2817
2818 if (!pStream)
2819 return PDMAUDIOSTREAMSTS_FLAG_NONE;
2820
2821 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2822
2823 int rc2 = RTCritSectEnter(&pThis->CritSect);
2824 AssertRC(rc2);
2825
2826 PDMAUDIOSTREAMSTS stsStream = pStream->fStatus;
2827
2828#ifdef LOG_ENABLED
2829 char *pszStreamSts = dbgAudioStreamStatusToStr(stsStream);
2830 Log3Func(("[%s] %s\n", pStream->szName, pszStreamSts));
2831 RTStrFree(pszStreamSts);
2832#endif
2833
2834 rc2 = RTCritSectLeave(&pThis->CritSect);
2835 AssertRC(rc2);
2836
2837 return stsStream;
2838}
2839
2840/**
2841 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamSetVolume}
2842 */
2843static DECLCALLBACK(int) drvAudioStreamSetVolume(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream, PPDMAUDIOVOLUME pVol)
2844{
2845 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
2846 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
2847 AssertPtrReturn(pVol, VERR_INVALID_POINTER);
2848
2849 LogFlowFunc(("[%s] volL=%RU32, volR=%RU32, fMute=%RTbool\n", pStream->szName, pVol->uLeft, pVol->uRight, pVol->fMuted));
2850
2851 AudioMixBufSetVolume(&pStream->Guest.MixBuf, pVol);
2852 AudioMixBufSetVolume(&pStream->Host.MixBuf, pVol);
2853
2854 return VINF_SUCCESS;
2855}
2856
2857/**
2858 * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamDestroy}
2859 */
2860static DECLCALLBACK(int) drvAudioStreamDestroy(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream)
2861{
2862 AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
2863 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
2864
2865 PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
2866
2867 int rc = RTCritSectEnter(&pThis->CritSect);
2868 AssertRC(rc);
2869
2870 LogRel2(("Audio: Destroying stream '%s'\n", pStream->szName));
2871
2872 LogFlowFunc(("[%s] cRefs=%RU32\n", pStream->szName, pStream->cRefs));
2873 if (pStream->cRefs > 1)
2874 rc = VERR_WRONG_ORDER;
2875
2876 if (RT_SUCCESS(rc))
2877 {
2878 rc = drvAudioStreamUninitInternal(pThis, pStream);
2879 if (RT_FAILURE(rc))
2880 LogRel(("Audio: Uninitializing stream '%s' failed with %Rrc\n", pStream->szName, rc));
2881 }
2882
2883 if (RT_SUCCESS(rc))
2884 {
2885 if (pStream->enmDir == PDMAUDIODIR_IN)
2886 {
2887 pThis->In.cStreamsFree++;
2888 }
2889 else /* Out */
2890 {
2891 pThis->Out.cStreamsFree++;
2892 }
2893
2894 RTListNodeRemove(&pStream->Node);
2895
2896 drvAudioStreamFree(pStream);
2897 pStream = NULL;
2898 }
2899
2900 int rc2 = RTCritSectLeave(&pThis->CritSect);
2901 if (RT_SUCCESS(rc))
2902 rc = rc2;
2903
2904 LogFlowFuncLeaveRC(rc);
2905 return rc;
2906}
2907
2908/**
2909 * Creates an audio stream on the backend side.
2910 *
2911 * @returns IPRT status code.
2912 * @param pThis Pointer to driver instance.
2913 * @param pStream Audio stream to create the backend side for.
2914 * @param pCfgReq Requested audio stream configuration to use for stream creation.
2915 * @param pCfgAcq Acquired audio stream configuration returned by the backend.
2916 */
2917static int drvAudioStreamCreateInternalBackend(PDRVAUDIO pThis,
2918 PPDMAUDIOSTREAM pStream, PPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
2919{
2920 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2921 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
2922 AssertPtrReturn(pCfgReq, VERR_INVALID_POINTER);
2923 AssertPtrReturn(pCfgAcq, VERR_INVALID_POINTER);
2924
2925 AssertMsg((pStream->fStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED) == 0,
2926 ("Stream '%s' already initialized in backend\n", pStream->szName));
2927
2928 /* Get the right configuration for the stream to be created. */
2929 PDRVAUDIOCFG pDrvCfg = pCfgReq->enmDir == PDMAUDIODIR_IN ? &pThis->In.Cfg : &pThis->Out.Cfg;
2930
2931 /* Fill in the tweakable parameters into the requested host configuration.
2932 * All parameters in principle can be changed and returned by the backend via the acquired configuration. */
2933
2934 /*
2935 * Period size
2936 */
2937 if (pDrvCfg->uPeriodSizeMs)
2938 pCfgReq->Backend.cfPeriod = DrvAudioHlpMilliToFrames(pDrvCfg->uPeriodSizeMs, &pCfgReq->Props);
2939 else /* Set default period size. */
2940 pCfgReq->Backend.cfPeriod = DrvAudioHlpMilliToFrames(20 /* ms */, &pCfgReq->Props);
2941
2942 LogRel2(("Audio: Using %s period size (%RU64ms, %RU32 frames) for stream '%s'\n",
2943 pDrvCfg->uPeriodSizeMs ? "custom" : "default", DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfPeriod, &pCfgReq->Props),
2944 pCfgReq->Backend.cfPeriod, pStream->szName));
2945
2946 /*
2947 * Buffer size
2948 */
2949 if (pDrvCfg->uBufferSizeMs)
2950 pCfgReq->Backend.cfBufferSize = DrvAudioHlpMilliToFrames(pDrvCfg->uBufferSizeMs, &pCfgReq->Props);
2951 else /* Set default buffer size. */
2952 pCfgReq->Backend.cfBufferSize = DrvAudioHlpMilliToFrames(100 /* ms */, &pCfgReq->Props);
2953
2954 LogRel2(("Audio: Using %s buffer size (%RU64ms, %RU32 frames) for stream '%s'\n",
2955 pDrvCfg->uBufferSizeMs ? "custom" : "default", DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfBufferSize, &pCfgReq->Props),
2956 pCfgReq->Backend.cfBufferSize, pStream->szName));
2957
2958 /*
2959 * Pre-buffering size
2960 */
2961 if (pDrvCfg->uPreBufSizeMs != UINT32_MAX)
2962 {
2963 if (!pDrvCfg->uPreBufSizeMs) /* Pre-buffering is set to disabled. */
2964 LogRel2(("Audio: Using custom pre-buffering (disabled) for stream '%s'\n", pStream->szName));
2965 pCfgReq->Backend.cfPreBuf = DrvAudioHlpMilliToFrames(pDrvCfg->uPreBufSizeMs, &pCfgReq->Props);
2966 }
2967 else /* Set default pre-buffering size. */
2968 pCfgReq->Backend.cfPreBuf = pCfgReq->Backend.cfPeriod * 2;
2969
2970 LogRel2(("Audio: Using %s pre-buffering size (%RU64ms, %RU32 frames) for stream '%s'\n",
2971 pDrvCfg->uPreBufSizeMs != UINT32_MAX ? "custom" : "default", DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfPreBuf, &pCfgReq->Props),
2972 pCfgReq->Backend.cfPreBuf, pStream->szName));
2973
2974 /*
2975 * Validate input.
2976 */
2977 if (pCfgReq->Backend.cfBufferSize < pCfgReq->Backend.cfPeriod)
2978 {
2979 LogRel(("Audio: Error for stream '%s': Buffer size (%RU64ms) must not be smaller than the period size (%RU64ms)\n",
2980 pStream->szName, DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfBufferSize, &pCfgReq->Props),
2981 DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfPeriod, &pCfgReq->Props)));
2982 return VERR_INVALID_PARAMETER;
2983 }
2984
2985 if ( pCfgReq->Backend.cfPreBuf != UINT32_MAX /* Custom pre-buffering set? */
2986 && pCfgReq->Backend.cfPreBuf)
2987 {
2988 if (pCfgReq->Backend.cfBufferSize <= pCfgReq->Backend.cfPreBuf)
2989 {
2990 LogRel(("Audio: Error for stream '%s': Buffering size (%RU64ms) must not be smaller as or equal to the pre-buffering size (%RU64ms)\n",
2991 pStream->szName, DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfPreBuf, &pCfgReq->Props),
2992 DrvAudioHlpFramesToMilli(pCfgReq->Backend.cfBufferSize, &pCfgReq->Props)));
2993 return VERR_INVALID_PARAMETER;
2994 }
2995 }
2996
2997 /* Make the acquired host configuration the requested host configuration initially,
2998 * in case the backend does not report back an acquired configuration. */
2999 int rc = DrvAudioHlpStreamCfgCopy(pCfgAcq, pCfgReq);
3000 if (RT_FAILURE(rc))
3001 {
3002 LogRel(("Audio: Creating stream '%s' with an invalid backend configuration not possible, skipping\n",
3003 pStream->szName));
3004 return rc;
3005 }
3006
3007 rc = pThis->pHostDrvAudio->pfnStreamCreate(pThis->pHostDrvAudio, pStream->pvBackend, pCfgReq, pCfgAcq);
3008 if (RT_FAILURE(rc))
3009 {
3010 if (rc == VERR_NOT_SUPPORTED)
3011 LogRel2(("Audio: Creating stream '%s' in backend not supported\n", pStream->szName));
3012 else if (rc == VERR_AUDIO_STREAM_COULD_NOT_CREATE)
3013 LogRel2(("Audio: Stream '%s' could not be created in backend because of missing hardware / drivers\n", pStream->szName));
3014 else
3015 LogRel(("Audio: Creating stream '%s' in backend failed with %Rrc\n", pStream->szName, rc));
3016
3017 return rc;
3018 }
3019
3020 /* Validate acquired configuration. */
3021 if (!DrvAudioHlpStreamCfgIsValid(pCfgAcq))
3022 {
3023 LogRel(("Audio: Creating stream '%s' returned an invalid backend configuration, skipping\n", pStream->szName));
3024 return VERR_INVALID_PARAMETER;
3025 }
3026
3027 /* Let the user know that the backend changed one of the values requested above. */
3028 if (pCfgAcq->Backend.cfBufferSize != pCfgReq->Backend.cfBufferSize)
3029 LogRel2(("Audio: Buffer size overwritten by backend for stream '%s' (now %RU64ms, %RU32 frames)\n",
3030 pStream->szName, DrvAudioHlpFramesToMilli(pCfgAcq->Backend.cfBufferSize, &pCfgAcq->Props), pCfgAcq->Backend.cfBufferSize));
3031
3032 if (pCfgAcq->Backend.cfPeriod != pCfgReq->Backend.cfPeriod)
3033 LogRel2(("Audio: Period size overwritten by backend for stream '%s' (now %RU64ms, %RU32 frames)\n",
3034 pStream->szName, DrvAudioHlpFramesToMilli(pCfgAcq->Backend.cfPeriod, &pCfgAcq->Props), pCfgAcq->Backend.cfPeriod));
3035
3036 if (pCfgAcq->Backend.cfPreBuf != pCfgReq->Backend.cfPreBuf)
3037 LogRel2(("Audio: Pre-buffering size overwritten by backend for stream '%s' (now %RU64ms, %RU32 frames)\n",
3038 pStream->szName, DrvAudioHlpFramesToMilli(pCfgAcq->Backend.cfPreBuf, &pCfgAcq->Props), pCfgAcq->Backend.cfPreBuf));
3039
3040 /* Sanity for detecting buggy backends. */
3041 AssertMsgReturn(pCfgAcq->Backend.cfPeriod < pCfgAcq->Backend.cfBufferSize,
3042 ("Acquired period size must be smaller than buffer size\n"),
3043 VERR_INVALID_PARAMETER);
3044 AssertMsgReturn(pCfgAcq->Backend.cfPreBuf < pCfgAcq->Backend.cfBufferSize,
3045 ("Acquired pre-buffering size must be smaller than buffer size -- this otherwise will lead to buffer overruns\n"),
3046 VERR_INVALID_PARAMETER);
3047
3048 pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAG_INITIALIZED;
3049
3050 return VINF_SUCCESS;
3051}
3052
3053/**
3054 * Calls the backend to give it the chance to destroy its part of the audio stream.
3055 *
3056 * @returns IPRT status code.
3057 * @param pThis Pointer to driver instance.
3058 * @param pStream Audio stream destruct backend for.
3059 */
3060static int drvAudioStreamDestroyInternalBackend(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream)
3061{
3062 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
3063 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
3064
3065 int rc = VINF_SUCCESS;
3066
3067#ifdef LOG_ENABLED
3068 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
3069 LogFunc(("[%s] fStatus=%s\n", pStream->szName, pszStreamSts));
3070#endif
3071
3072 if (pStream->pvBackend)
3073 {
3074 /* Check if the pointer to the host audio driver is still valid.
3075 * It can be NULL if we were called in drvAudioDestruct, for example. */
3076 if (pThis->pHostDrvAudio)
3077 rc = pThis->pHostDrvAudio->pfnStreamDestroy(pThis->pHostDrvAudio, pStream->pvBackend);
3078
3079 pStream->pvBackend = NULL;
3080 pStream->cbBackend = 0;
3081 }
3082
3083#ifdef LOG_ENABLED
3084 RTStrFree(pszStreamSts);
3085#endif
3086
3087 LogFlowFunc(("[%s] Returning %Rrc\n", pStream->szName, rc));
3088 return rc;
3089}
3090
3091/**
3092 * Uninitializes an audio stream.
3093 *
3094 * @returns IPRT status code.
3095 * @param pThis Pointer to driver instance.
3096 * @param pStream Pointer to audio stream to uninitialize.
3097 */
3098static int drvAudioStreamUninitInternal(PDRVAUDIO pThis, PPDMAUDIOSTREAM pStream)
3099{
3100 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
3101 AssertPtrReturn(pStream, VERR_INVALID_POINTER);
3102
3103 LogFlowFunc(("[%s] cRefs=%RU32\n", pStream->szName, pStream->cRefs));
3104
3105 if (pStream->cRefs > 1)
3106 return VERR_WRONG_ORDER;
3107
3108 int rc = drvAudioStreamControlInternal(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
3109 if (RT_SUCCESS(rc))
3110 rc = drvAudioStreamDestroyInternalBackend(pThis, pStream);
3111
3112 /* Destroy mixing buffers. */
3113 AudioMixBufDestroy(&pStream->Guest.MixBuf);
3114 AudioMixBufDestroy(&pStream->Host.MixBuf);
3115
3116 if (RT_SUCCESS(rc))
3117 {
3118 /* Reset status. */
3119 pStream->fStatus &= ~PDMAUDIOSTREAMSTS_FLAG_INITIALIZED;
3120
3121#ifdef LOG_ENABLED
3122 if (pStream->fStatus != PDMAUDIOSTREAMSTS_FLAG_NONE)
3123 {
3124 char *pszStreamSts = dbgAudioStreamStatusToStr(pStream->fStatus);
3125 LogFunc(("[%s] Warning: Still has %s set when uninitializing\n", pStream->szName, pszStreamSts));
3126 RTStrFree(pszStreamSts);
3127 }
3128#endif
3129 pStream->fStatus = PDMAUDIOSTREAMSTS_FLAG_NONE;
3130 }
3131
3132 if (pStream->enmDir == PDMAUDIODIR_IN)
3133 {
3134#ifdef VBOX_WITH_STATISTICS
3135 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->In.Stats.BytesElapsed);
3136 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->In.Stats.BytesTotalRead);
3137 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->In.Stats.FramesCaptured);
3138#endif
3139 if (pThis->In.Cfg.Dbg.fEnabled)
3140 {
3141 DrvAudioHlpFileDestroy(pStream->In.Dbg.pFileCaptureNonInterleaved);
3142 pStream->In.Dbg.pFileCaptureNonInterleaved = NULL;
3143
3144 DrvAudioHlpFileDestroy(pStream->In.Dbg.pFileStreamRead);
3145 pStream->In.Dbg.pFileStreamRead = NULL;
3146 }
3147 }
3148 else if (pStream->enmDir == PDMAUDIODIR_OUT)
3149 {
3150#ifdef VBOX_WITH_STATISTICS
3151 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->Out.Stats.BytesElapsed);
3152 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->Out.Stats.BytesTotalWritten);
3153 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pStream->Out.Stats.FramesPlayed);
3154#endif
3155 if (pThis->Out.Cfg.Dbg.fEnabled)
3156 {
3157 DrvAudioHlpFileDestroy(pStream->Out.Dbg.pFilePlayNonInterleaved);
3158 pStream->Out.Dbg.pFilePlayNonInterleaved = NULL;
3159
3160 DrvAudioHlpFileDestroy(pStream->Out.Dbg.pFileStreamWrite);
3161 pStream->Out.Dbg.pFileStreamWrite = NULL;
3162 }
3163 }
3164 else
3165 AssertFailed();
3166
3167 LogFlowFunc(("Returning %Rrc\n", rc));
3168 return rc;
3169}
3170
3171/**
3172 * Does the actual backend driver attaching and queries the backend's interface.
3173 *
3174 * @return VBox status code.
3175 * @param pThis Pointer to driver instance.
3176 * @param fFlags Attach flags; see PDMDrvHlpAttach().
3177 */
3178static int drvAudioDoAttachInternal(PDRVAUDIO pThis, uint32_t fFlags)
3179{
3180 Assert(pThis->pHostDrvAudio == NULL); /* No nested attaching. */
3181
3182 /*
3183 * Attach driver below and query its connector interface.
3184 */
3185 PPDMIBASE pDownBase;
3186 int rc = PDMDrvHlpAttach(pThis->pDrvIns, fFlags, &pDownBase);
3187 if (RT_SUCCESS(rc))
3188 {
3189 pThis->pHostDrvAudio = PDMIBASE_QUERY_INTERFACE(pDownBase, PDMIHOSTAUDIO);
3190 if (!pThis->pHostDrvAudio)
3191 {
3192 LogRel(("Audio: Failed to query interface for underlying host driver\n"));
3193 rc = PDMDRV_SET_ERROR(pThis->pDrvIns, VERR_PDM_MISSING_INTERFACE_BELOW,
3194 N_("Host audio backend missing or invalid"));
3195 }
3196 }
3197
3198 if (RT_SUCCESS(rc))
3199 {
3200 /*
3201 * If everything went well, initialize the lower driver.
3202 */
3203 AssertPtr(pThis->pCFGMNode);
3204 rc = drvAudioHostInit(pThis, pThis->pCFGMNode);
3205 }
3206
3207 LogFunc(("[%s] rc=%Rrc\n", pThis->szName, rc));
3208 return rc;
3209}
3210
3211
3212/********************************************************************/
3213
3214/**
3215 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
3216 */
3217static DECLCALLBACK(void *) drvAudioQueryInterface(PPDMIBASE pInterface, const char *pszIID)
3218{
3219 LogFlowFunc(("pInterface=%p, pszIID=%s\n", pInterface, pszIID));
3220
3221 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
3222 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3223
3224 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
3225 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIAUDIOCONNECTOR, &pThis->IAudioConnector);
3226
3227 return NULL;
3228}
3229
3230/**
3231 * Power Off notification.
3232 *
3233 * @param pDrvIns The driver instance data.
3234 */
3235static DECLCALLBACK(void) drvAudioPowerOff(PPDMDRVINS pDrvIns)
3236{
3237 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3238
3239 LogFlowFuncEnter();
3240
3241 if (!pThis->pHostDrvAudio) /* If not lower driver is configured, bail out. */
3242 return;
3243
3244 /* Just destroy the host stream on the backend side.
3245 * The rest will either be destructed by the device emulation or
3246 * in drvAudioDestruct(). */
3247 PPDMAUDIOSTREAM pStream;
3248 RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
3249 {
3250 drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
3251 drvAudioStreamDestroyInternalBackend(pThis, pStream);
3252 }
3253
3254 /*
3255 * Last call for the driver below us.
3256 * Let it know that we reached end of life.
3257 */
3258 if (pThis->pHostDrvAudio->pfnShutdown)
3259 pThis->pHostDrvAudio->pfnShutdown(pThis->pHostDrvAudio);
3260
3261 pThis->pHostDrvAudio = NULL;
3262
3263 LogFlowFuncLeave();
3264}
3265
3266/**
3267 * Constructs an audio driver instance.
3268 *
3269 * @copydoc FNPDMDRVCONSTRUCT
3270 */
3271static DECLCALLBACK(int) drvAudioConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
3272{
3273 LogFlowFunc(("pDrvIns=%#p, pCfgHandle=%#p, fFlags=%x\n", pDrvIns, pCfg, fFlags));
3274
3275 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3276 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
3277
3278 RTListInit(&pThis->lstStreams);
3279#ifdef VBOX_WITH_AUDIO_CALLBACKS
3280 RTListInit(&pThis->In.lstCB);
3281 RTListInit(&pThis->Out.lstCB);
3282#endif
3283
3284 /*
3285 * Init the static parts.
3286 */
3287 pThis->pDrvIns = pDrvIns;
3288 /* IBase. */
3289 pDrvIns->IBase.pfnQueryInterface = drvAudioQueryInterface;
3290 /* IAudioConnector. */
3291 pThis->IAudioConnector.pfnEnable = drvAudioEnable;
3292 pThis->IAudioConnector.pfnIsEnabled = drvAudioIsEnabled;
3293 pThis->IAudioConnector.pfnGetConfig = drvAudioGetConfig;
3294 pThis->IAudioConnector.pfnGetStatus = drvAudioGetStatus;
3295 pThis->IAudioConnector.pfnStreamCreate = drvAudioStreamCreate;
3296 pThis->IAudioConnector.pfnStreamDestroy = drvAudioStreamDestroy;
3297 pThis->IAudioConnector.pfnStreamRetain = drvAudioStreamRetain;
3298 pThis->IAudioConnector.pfnStreamRelease = drvAudioStreamRelease;
3299 pThis->IAudioConnector.pfnStreamControl = drvAudioStreamControl;
3300 pThis->IAudioConnector.pfnStreamRead = drvAudioStreamRead;
3301 pThis->IAudioConnector.pfnStreamWrite = drvAudioStreamWrite;
3302 pThis->IAudioConnector.pfnStreamIterate = drvAudioStreamIterate;
3303 pThis->IAudioConnector.pfnStreamGetReadable = drvAudioStreamGetReadable;
3304 pThis->IAudioConnector.pfnStreamGetWritable = drvAudioStreamGetWritable;
3305 pThis->IAudioConnector.pfnStreamGetStatus = drvAudioStreamGetStatus;
3306 pThis->IAudioConnector.pfnStreamSetVolume = drvAudioStreamSetVolume;
3307 pThis->IAudioConnector.pfnStreamPlay = drvAudioStreamPlay;
3308 pThis->IAudioConnector.pfnStreamCapture = drvAudioStreamCapture;
3309#ifdef VBOX_WITH_AUDIO_CALLBACKS
3310 pThis->IAudioConnector.pfnRegisterCallbacks = drvAudioRegisterCallbacks;
3311#endif
3312
3313 int rc = drvAudioInit(pDrvIns, pCfg);
3314 if (RT_SUCCESS(rc))
3315 {
3316#ifdef VBOX_WITH_STATISTICS
3317 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalStreamsActive, "TotalStreamsActive",
3318 STAMUNIT_COUNT, "Total active audio streams.");
3319 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalStreamsCreated, "TotalStreamsCreated",
3320 STAMUNIT_COUNT, "Total created audio streams.");
3321 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesRead, "TotalFramesRead",
3322 STAMUNIT_COUNT, "Total frames read by device emulation.");
3323 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesWritten, "TotalFramesWritten",
3324 STAMUNIT_COUNT, "Total frames written by device emulation ");
3325 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesMixedIn, "TotalFramesMixedIn",
3326 STAMUNIT_COUNT, "Total input frames mixed.");
3327 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesMixedOut, "TotalFramesMixedOut",
3328 STAMUNIT_COUNT, "Total output frames mixed.");
3329 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesLostIn, "TotalFramesLostIn",
3330 STAMUNIT_COUNT, "Total input frames lost.");
3331 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesLostOut, "TotalFramesLostOut",
3332 STAMUNIT_COUNT, "Total output frames lost.");
3333 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesOut, "TotalFramesOut",
3334 STAMUNIT_COUNT, "Total frames played by backend.");
3335 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalFramesIn, "TotalFramesIn",
3336 STAMUNIT_COUNT, "Total frames captured by backend.");
3337 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalBytesRead, "TotalBytesRead",
3338 STAMUNIT_BYTES, "Total bytes read.");
3339 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->Stats.TotalBytesWritten, "TotalBytesWritten",
3340 STAMUNIT_BYTES, "Total bytes written.");
3341
3342 PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, &pThis->Stats.DelayIn, "DelayIn",
3343 STAMUNIT_NS_PER_CALL, "Profiling of input data processing.");
3344 PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, &pThis->Stats.DelayOut, "DelayOut",
3345 STAMUNIT_NS_PER_CALL, "Profiling of output data processing.");
3346#endif
3347 }
3348
3349 rc = drvAudioDoAttachInternal(pThis, fFlags);
3350 if (RT_FAILURE(rc))
3351 {
3352 /* No lower attached driver (yet)? Not a failure, might get attached later at runtime, just skip. */
3353 if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
3354 rc = VINF_SUCCESS;
3355 }
3356
3357 LogFlowFuncLeaveRC(rc);
3358 return rc;
3359}
3360
3361/**
3362 * Destructs an audio driver instance.
3363 *
3364 * @copydoc FNPDMDRVDESTRUCT
3365 */
3366static DECLCALLBACK(void) drvAudioDestruct(PPDMDRVINS pDrvIns)
3367{
3368 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
3369 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3370
3371 LogFlowFuncEnter();
3372
3373 int rc2;
3374
3375 if (RTCritSectIsInitialized(&pThis->CritSect))
3376 {
3377 rc2 = RTCritSectEnter(&pThis->CritSect);
3378 AssertRC(rc2);
3379 }
3380
3381 /*
3382 * Note: No calls here to the driver below us anymore,
3383 * as PDM already has destroyed it.
3384 * If you need to call something from the host driver,
3385 * do this in drvAudioPowerOff() instead.
3386 */
3387
3388 /* Thus, NULL the pointer to the host audio driver first,
3389 * so that routines like drvAudioStreamDestroyInternal() don't call the driver(s) below us anymore. */
3390 pThis->pHostDrvAudio = NULL;
3391
3392 PPDMAUDIOSTREAM pStream, pStreamNext;
3393 RTListForEachSafe(&pThis->lstStreams, pStream, pStreamNext, PDMAUDIOSTREAM, Node)
3394 {
3395 rc2 = drvAudioStreamUninitInternal(pThis, pStream);
3396 if (RT_SUCCESS(rc2))
3397 {
3398 RTListNodeRemove(&pStream->Node);
3399
3400 drvAudioStreamFree(pStream);
3401 pStream = NULL;
3402 }
3403 }
3404
3405 /* Sanity. */
3406 Assert(RTListIsEmpty(&pThis->lstStreams));
3407
3408#ifdef VBOX_WITH_AUDIO_CALLBACKS
3409 /*
3410 * Destroy callbacks, if any.
3411 */
3412 PPDMAUDIOCBRECORD pCB, pCBNext;
3413 RTListForEachSafe(&pThis->In.lstCB, pCB, pCBNext, PDMAUDIOCBRECORD, Node)
3414 drvAudioCallbackDestroy(pCB);
3415
3416 RTListForEachSafe(&pThis->Out.lstCB, pCB, pCBNext, PDMAUDIOCBRECORD, Node)
3417 drvAudioCallbackDestroy(pCB);
3418#endif
3419
3420 if (RTCritSectIsInitialized(&pThis->CritSect))
3421 {
3422 rc2 = RTCritSectLeave(&pThis->CritSect);
3423 AssertRC(rc2);
3424
3425 rc2 = RTCritSectDelete(&pThis->CritSect);
3426 AssertRC(rc2);
3427 }
3428
3429#ifdef VBOX_WITH_STATISTICS
3430 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalStreamsActive);
3431 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalStreamsCreated);
3432 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesRead);
3433 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesWritten);
3434 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesMixedIn);
3435 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesMixedOut);
3436 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesLostIn);
3437 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesLostOut);
3438 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesOut);
3439 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalFramesIn);
3440 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalBytesRead);
3441 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.TotalBytesWritten);
3442 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.DelayIn);
3443 PDMDrvHlpSTAMDeregister(pThis->pDrvIns, &pThis->Stats.DelayOut);
3444#endif
3445
3446 LogFlowFuncLeave();
3447}
3448
3449/**
3450 * Suspend notification.
3451 *
3452 * @param pDrvIns The driver instance data.
3453 */
3454static DECLCALLBACK(void) drvAudioSuspend(PPDMDRVINS pDrvIns)
3455{
3456 drvAudioStateHandler(pDrvIns, PDMAUDIOSTREAMCMD_PAUSE);
3457}
3458
3459/**
3460 * Resume notification.
3461 *
3462 * @param pDrvIns The driver instance data.
3463 */
3464static DECLCALLBACK(void) drvAudioResume(PPDMDRVINS pDrvIns)
3465{
3466 drvAudioStateHandler(pDrvIns, PDMAUDIOSTREAMCMD_RESUME);
3467}
3468
3469/**
3470 * Attach notification.
3471 *
3472 * @param pDrvIns The driver instance data.
3473 * @param fFlags Attach flags.
3474 */
3475static DECLCALLBACK(int) drvAudioAttach(PPDMDRVINS pDrvIns, uint32_t fFlags)
3476{
3477 RT_NOREF(fFlags);
3478
3479 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
3480 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3481
3482 int rc2 = RTCritSectEnter(&pThis->CritSect);
3483 AssertRC(rc2);
3484
3485 LogFunc(("%s\n", pThis->szName));
3486
3487 int rc = drvAudioDoAttachInternal(pThis, fFlags);
3488
3489 rc2 = RTCritSectLeave(&pThis->CritSect);
3490 if (RT_SUCCESS(rc))
3491 rc = rc2;
3492
3493 return rc;
3494}
3495
3496/**
3497 * Detach notification.
3498 *
3499 * @param pDrvIns The driver instance data.
3500 * @param fFlags Detach flags.
3501 */
3502static DECLCALLBACK(void) drvAudioDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
3503{
3504 RT_NOREF(fFlags);
3505
3506 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
3507 PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
3508
3509 int rc2 = RTCritSectEnter(&pThis->CritSect);
3510 AssertRC(rc2);
3511
3512 pThis->pHostDrvAudio = NULL;
3513
3514 LogFunc(("%s\n", pThis->szName));
3515
3516 rc2 = RTCritSectLeave(&pThis->CritSect);
3517 AssertRC(rc2);
3518}
3519
3520/**
3521 * Audio driver registration record.
3522 */
3523const PDMDRVREG g_DrvAUDIO =
3524{
3525 /* u32Version */
3526 PDM_DRVREG_VERSION,
3527 /* szName */
3528 "AUDIO",
3529 /* szRCMod */
3530 "",
3531 /* szR0Mod */
3532 "",
3533 /* pszDescription */
3534 "Audio connector driver",
3535 /* fFlags */
3536 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
3537 /* fClass */
3538 PDM_DRVREG_CLASS_AUDIO,
3539 /* cMaxInstances */
3540 UINT32_MAX,
3541 /* cbInstance */
3542 sizeof(DRVAUDIO),
3543 /* pfnConstruct */
3544 drvAudioConstruct,
3545 /* pfnDestruct */
3546 drvAudioDestruct,
3547 /* pfnRelocate */
3548 NULL,
3549 /* pfnIOCtl */
3550 NULL,
3551 /* pfnPowerOn */
3552 NULL,
3553 /* pfnReset */
3554 NULL,
3555 /* pfnSuspend */
3556 drvAudioSuspend,
3557 /* pfnResume */
3558 drvAudioResume,
3559 /* pfnAttach */
3560 drvAudioAttach,
3561 /* pfnDetach */
3562 drvAudioDetach,
3563 /* pfnPowerOff */
3564 drvAudioPowerOff,
3565 /* pfnSoftReset */
3566 NULL,
3567 /* u32EndVersion */
3568 PDM_DRVREG_VERSION
3569};
3570
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette