VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/DrvAudioCommon.cpp@ 76860

Last change on this file since 76860 was 76860, checked in by vboxsync, 6 years ago

Audio/DrvAudioCommon: Assertion for DrvAudioHlpStreamCfgInit().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 54.8 KB
Line 
1/* $Id: DrvAudioCommon.cpp 76860 2019-01-17 13:54:19Z vboxsync $ */
2/** @file
3 * Intermedia audio driver, common routines.
4 *
5 * These are also used in the drivers which are bound to Main, e.g. the VRDE
6 * or the video audio recording drivers.
7 */
8
9/*
10 * Copyright (C) 2006-2019 Oracle Corporation
11 *
12 * This file is part of VirtualBox Open Source Edition (OSE), as
13 * available from http://www.virtualbox.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
22/*********************************************************************************************************************************
23* Header Files *
24*********************************************************************************************************************************/
25#include <iprt/alloc.h>
26#include <iprt/asm-math.h>
27#include <iprt/assert.h>
28#include <iprt/dir.h>
29#include <iprt/file.h>
30#include <iprt/string.h>
31#include <iprt/uuid.h>
32
33#define LOG_GROUP LOG_GROUP_DRV_AUDIO
34#include <VBox/log.h>
35
36#include <VBox/err.h>
37#include <VBox/vmm/pdmdev.h>
38#include <VBox/vmm/pdm.h>
39#include <VBox/vmm/mm.h>
40
41#include <ctype.h>
42#include <stdlib.h>
43
44#include "DrvAudio.h"
45#include "AudioMixBuffer.h"
46
47
48/*********************************************************************************************************************************
49* Structures and Typedefs *
50*********************************************************************************************************************************/
51/**
52 * Structure for building up a .WAV file header.
53 */
54typedef struct AUDIOWAVFILEHDR
55{
56 uint32_t u32RIFF;
57 uint32_t u32Size;
58 uint32_t u32WAVE;
59
60 uint32_t u32Fmt;
61 uint32_t u32Size1;
62 uint16_t u16AudioFormat;
63 uint16_t u16NumChannels;
64 uint32_t u32SampleRate;
65 uint32_t u32ByteRate;
66 uint16_t u16BlockAlign;
67 uint16_t u16BitsPerSample;
68
69 uint32_t u32ID2;
70 uint32_t u32Size2;
71} AUDIOWAVFILEHDR, *PAUDIOWAVFILEHDR;
72AssertCompileSize(AUDIOWAVFILEHDR, 11*4);
73
74/**
75 * Structure for keeeping the internal .WAV file data
76 */
77typedef struct AUDIOWAVFILEDATA
78{
79 /** The file header/footer. */
80 AUDIOWAVFILEHDR Hdr;
81} AUDIOWAVFILEDATA, *PAUDIOWAVFILEDATA;
82
83
84
85
86/**
87 * Retrieves the matching PDMAUDIOFMT for given bits + signing flag.
88 *
89 * @return IPRT status code.
90 * @return PDMAUDIOFMT Resulting audio format or PDMAUDIOFMT_INVALID if invalid.
91 * @param cBits Bits to retrieve audio format for.
92 * @param fSigned Signed flag for bits to retrieve audio format for.
93 */
94PDMAUDIOFMT DrvAudioAudFmtBitsToAudFmt(uint8_t cBits, bool fSigned)
95{
96 if (fSigned)
97 {
98 switch (cBits)
99 {
100 case 8: return PDMAUDIOFMT_S8;
101 case 16: return PDMAUDIOFMT_S16;
102 case 32: return PDMAUDIOFMT_S32;
103 default: break;
104 }
105 }
106 else
107 {
108 switch (cBits)
109 {
110 case 8: return PDMAUDIOFMT_U8;
111 case 16: return PDMAUDIOFMT_U16;
112 case 32: return PDMAUDIOFMT_U32;
113 default: break;
114 }
115 }
116
117 AssertMsgFailed(("Bogus audio bits %RU8\n", cBits));
118 return PDMAUDIOFMT_INVALID;
119}
120
121/**
122 * Clears a sample buffer by the given amount of audio frames with silence (according to the format
123 * given by the PCM properties).
124 *
125 * @param pPCMProps PCM properties to use for the buffer to clear.
126 * @param pvBuf Buffer to clear.
127 * @param cbBuf Size (in bytes) of the buffer.
128 * @param cFrames Number of audio frames to clear in the buffer.
129 */
130void DrvAudioHlpClearBuf(const PPDMAUDIOPCMPROPS pPCMProps, void *pvBuf, size_t cbBuf, uint32_t cFrames)
131{
132 AssertPtrReturnVoid(pPCMProps);
133 AssertPtrReturnVoid(pvBuf);
134
135 if (!cbBuf || !cFrames)
136 return;
137
138 Assert(pPCMProps->cBytes);
139 size_t cbToClear = DrvAudioHlpFramesToBytes(cFrames, pPCMProps);
140 Assert(cbBuf >= cbToClear);
141
142 if (cbBuf < cbToClear)
143 cbToClear = cbBuf;
144
145 Log2Func(("pPCMProps=%p, pvBuf=%p, cFrames=%RU32, fSigned=%RTbool, cBytes=%RU8\n",
146 pPCMProps, pvBuf, cFrames, pPCMProps->fSigned, pPCMProps->cBytes));
147
148 Assert(pPCMProps->fSwapEndian == false); /** @todo Swapping Endianness is not supported yet. */
149
150 if (pPCMProps->fSigned)
151 {
152 RT_BZERO(pvBuf, cbToClear);
153 }
154 else /* Unsigned formats. */
155 {
156 switch (pPCMProps->cBytes)
157 {
158 case 1: /* 8 bit */
159 {
160 memset(pvBuf, 0x80, cbToClear);
161 break;
162 }
163
164 case 2: /* 16 bit */
165 {
166 uint16_t *p = (uint16_t *)pvBuf;
167 uint16_t s = 0x0080;
168
169 for (uint32_t i = 0; i < DrvAudioHlpBytesToFrames((uint32_t)cbToClear, pPCMProps); i++)
170 p[i] = s;
171
172 break;
173 }
174
175 /** @todo Add 24 bit? */
176
177 case 4: /* 32 bit */
178 {
179 uint32_t *p = (uint32_t *)pvBuf;
180 uint32_t s = 0x00000080;
181
182 for (uint32_t i = 0; i < DrvAudioHlpBytesToFrames((uint32_t)cbToClear, pPCMProps); i++)
183 p[i] = s;
184
185 break;
186 }
187
188 default:
189 {
190 AssertMsgFailed(("Invalid bytes per sample: %RU8\n", pPCMProps->cBytes));
191 break;
192 }
193 }
194 }
195}
196
197/**
198 * Returns an unique file name for this given audio connector instance.
199 *
200 * @return Allocated file name. Must be free'd using RTStrFree().
201 * @param uInstance Driver / device instance.
202 * @param pszPath Path name of the file to delete. The path must exist.
203 * @param pszSuffix File name suffix to use.
204 */
205char *DrvAudioDbgGetFileNameA(uint8_t uInstance, const char *pszPath, const char *pszSuffix)
206{
207 char szFileName[64];
208 RTStrPrintf(szFileName, sizeof(szFileName), "drvAudio%RU8-%s", uInstance, pszSuffix);
209
210 char szFilePath[RTPATH_MAX];
211 int rc2 = RTStrCopy(szFilePath, sizeof(szFilePath), pszPath);
212 AssertRC(rc2);
213 rc2 = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
214 AssertRC(rc2);
215
216 return RTStrDup(szFilePath);
217}
218
219/**
220 * Allocates an audio device.
221 *
222 * @returns Newly allocated audio device, or NULL if failed.
223 * @param cbData How much additional data (in bytes) should be allocated to provide
224 * a (backend) specific area to store additional data.
225 * Optional, can be 0.
226 */
227PPDMAUDIODEVICE DrvAudioHlpDeviceAlloc(size_t cbData)
228{
229 PPDMAUDIODEVICE pDev = (PPDMAUDIODEVICE)RTMemAllocZ(sizeof(PDMAUDIODEVICE));
230 if (!pDev)
231 return NULL;
232
233 if (cbData)
234 {
235 pDev->pvData = RTMemAllocZ(cbData);
236 if (!pDev->pvData)
237 {
238 RTMemFree(pDev);
239 return NULL;
240 }
241 }
242
243 pDev->cbData = cbData;
244
245 pDev->cMaxInputChannels = 0;
246 pDev->cMaxOutputChannels = 0;
247
248 return pDev;
249}
250
251/**
252 * Frees an audio device.
253 *
254 * @param pDev Device to free.
255 */
256void DrvAudioHlpDeviceFree(PPDMAUDIODEVICE pDev)
257{
258 if (!pDev)
259 return;
260
261 Assert(pDev->cRefCount == 0);
262
263 if (pDev->pvData)
264 {
265 Assert(pDev->cbData);
266
267 RTMemFree(pDev->pvData);
268 pDev->pvData = NULL;
269 }
270
271 RTMemFree(pDev);
272 pDev = NULL;
273}
274
275/**
276 * Duplicates an audio device entry.
277 *
278 * @returns Duplicated audio device entry on success, or NULL on failure.
279 * @param pDev Audio device entry to duplicate.
280 * @param fCopyUserData Whether to also copy the user data portion or not.
281 */
282PPDMAUDIODEVICE DrvAudioHlpDeviceDup(const PPDMAUDIODEVICE pDev, bool fCopyUserData)
283{
284 AssertPtrReturn(pDev, NULL);
285
286 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceAlloc(fCopyUserData ? pDev->cbData : 0);
287 if (pDevDup)
288 {
289 memcpy(pDevDup, pDev, sizeof(PDMAUDIODEVICE));
290
291 if ( fCopyUserData
292 && pDevDup->cbData)
293 {
294 memcpy(pDevDup->pvData, pDev->pvData, pDevDup->cbData);
295 }
296 else
297 {
298 pDevDup->cbData = 0;
299 pDevDup->pvData = NULL;
300 }
301 }
302
303 return pDevDup;
304}
305
306/**
307 * Initializes an audio device enumeration structure.
308 *
309 * @returns IPRT status code.
310 * @param pDevEnm Device enumeration to initialize.
311 */
312int DrvAudioHlpDeviceEnumInit(PPDMAUDIODEVICEENUM pDevEnm)
313{
314 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
315
316 RTListInit(&pDevEnm->lstDevices);
317 pDevEnm->cDevices = 0;
318
319 return VINF_SUCCESS;
320}
321
322/**
323 * Frees audio device enumeration data.
324 *
325 * @param pDevEnm Device enumeration to destroy.
326 */
327void DrvAudioHlpDeviceEnumFree(PPDMAUDIODEVICEENUM pDevEnm)
328{
329 if (!pDevEnm)
330 return;
331
332 PPDMAUDIODEVICE pDev, pDevNext;
333 RTListForEachSafe(&pDevEnm->lstDevices, pDev, pDevNext, PDMAUDIODEVICE, Node)
334 {
335 RTListNodeRemove(&pDev->Node);
336
337 DrvAudioHlpDeviceFree(pDev);
338
339 pDevEnm->cDevices--;
340 }
341
342 /* Sanity. */
343 Assert(RTListIsEmpty(&pDevEnm->lstDevices));
344 Assert(pDevEnm->cDevices == 0);
345}
346
347/**
348 * Adds an audio device to a device enumeration.
349 *
350 * @return IPRT status code.
351 * @param pDevEnm Device enumeration to add device to.
352 * @param pDev Device to add. The pointer will be owned by the device enumeration then.
353 */
354int DrvAudioHlpDeviceEnumAdd(PPDMAUDIODEVICEENUM pDevEnm, PPDMAUDIODEVICE pDev)
355{
356 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
357 AssertPtrReturn(pDev, VERR_INVALID_POINTER);
358
359 RTListAppend(&pDevEnm->lstDevices, &pDev->Node);
360 pDevEnm->cDevices++;
361
362 return VINF_SUCCESS;
363}
364
365/**
366 * Duplicates a device enumeration.
367 *
368 * @returns Duplicated device enumeration, or NULL on failure.
369 * Must be free'd with DrvAudioHlpDeviceEnumFree().
370 * @param pDevEnm Device enumeration to duplicate.
371 */
372PPDMAUDIODEVICEENUM DrvAudioHlpDeviceEnumDup(const PPDMAUDIODEVICEENUM pDevEnm)
373{
374 AssertPtrReturn(pDevEnm, NULL);
375
376 PPDMAUDIODEVICEENUM pDevEnmDup = (PPDMAUDIODEVICEENUM)RTMemAlloc(sizeof(PDMAUDIODEVICEENUM));
377 if (!pDevEnmDup)
378 return NULL;
379
380 int rc2 = DrvAudioHlpDeviceEnumInit(pDevEnmDup);
381 AssertRC(rc2);
382
383 PPDMAUDIODEVICE pDev;
384 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
385 {
386 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceDup(pDev, true /* fCopyUserData */);
387 if (!pDevDup)
388 {
389 rc2 = VERR_NO_MEMORY;
390 break;
391 }
392
393 rc2 = DrvAudioHlpDeviceEnumAdd(pDevEnmDup, pDevDup);
394 if (RT_FAILURE(rc2))
395 {
396 DrvAudioHlpDeviceFree(pDevDup);
397 break;
398 }
399 }
400
401 if (RT_FAILURE(rc2))
402 {
403 DrvAudioHlpDeviceEnumFree(pDevEnmDup);
404 pDevEnmDup = NULL;
405 }
406
407 return pDevEnmDup;
408}
409
410/**
411 * Copies device enumeration entries from the source to the destination enumeration.
412 *
413 * @returns IPRT status code.
414 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
415 * @param pSrcDevEnm Source enumeration to use.
416 * @param enmUsage Which entries to copy. Specify PDMAUDIODIR_ANY to copy all entries.
417 * @param fCopyUserData Whether to also copy the user data portion or not.
418 */
419int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm,
420 PDMAUDIODIR enmUsage, bool fCopyUserData)
421{
422 AssertPtrReturn(pDstDevEnm, VERR_INVALID_POINTER);
423 AssertPtrReturn(pSrcDevEnm, VERR_INVALID_POINTER);
424
425 int rc = VINF_SUCCESS;
426
427 PPDMAUDIODEVICE pSrcDev;
428 RTListForEach(&pSrcDevEnm->lstDevices, pSrcDev, PDMAUDIODEVICE, Node)
429 {
430 if ( enmUsage != PDMAUDIODIR_ANY
431 && enmUsage != pSrcDev->enmUsage)
432 {
433 continue;
434 }
435
436 PPDMAUDIODEVICE pDstDev = DrvAudioHlpDeviceDup(pSrcDev, fCopyUserData);
437 if (!pDstDev)
438 {
439 rc = VERR_NO_MEMORY;
440 break;
441 }
442
443 rc = DrvAudioHlpDeviceEnumAdd(pDstDevEnm, pDstDev);
444 if (RT_FAILURE(rc))
445 break;
446 }
447
448 return rc;
449}
450
451/**
452 * Copies all device enumeration entries from the source to the destination enumeration.
453 *
454 * Note: Does *not* copy the user-specific data assigned to a device enumeration entry.
455 * To do so, use DrvAudioHlpDeviceEnumCopyEx().
456 *
457 * @returns IPRT status code.
458 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
459 * @param pSrcDevEnm Source enumeration to use.
460 */
461int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm)
462{
463 return DrvAudioHlpDeviceEnumCopyEx(pDstDevEnm, pSrcDevEnm, PDMAUDIODIR_ANY, false /* fCopyUserData */);
464}
465
466/**
467 * Returns the default device of a given device enumeration.
468 * This assumes that only one default device per usage is set.
469 *
470 * @returns Default device if found, or NULL if none found.
471 * @param pDevEnm Device enumeration to get default device for.
472 * @param enmUsage Usage to get default device for.
473 */
474PPDMAUDIODEVICE DrvAudioHlpDeviceEnumGetDefaultDevice(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage)
475{
476 AssertPtrReturn(pDevEnm, NULL);
477
478 PPDMAUDIODEVICE pDev;
479 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
480 {
481 if (enmUsage != PDMAUDIODIR_ANY)
482 {
483 if (enmUsage != pDev->enmUsage) /* Wrong usage? Skip. */
484 continue;
485 }
486
487 if (pDev->fFlags & PDMAUDIODEV_FLAGS_DEFAULT)
488 return pDev;
489 }
490
491 return NULL;
492}
493
494/**
495 * Returns the number of enumerated devices of a given device enumeration.
496 *
497 * @returns Number of devices if found, or 0 if none found.
498 * @param pDevEnm Device enumeration to get default device for.
499 * @param enmUsage Usage to get default device for.
500 */
501uint16_t DrvAudioHlpDeviceEnumGetDeviceCount(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage)
502{
503 AssertPtrReturn(pDevEnm, 0);
504
505 if (enmUsage == PDMAUDIODIR_ANY)
506 return pDevEnm->cDevices;
507
508 uint32_t cDevs = 0;
509
510 PPDMAUDIODEVICE pDev;
511 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
512 {
513 if (enmUsage == pDev->enmUsage)
514 cDevs++;
515 }
516
517 return cDevs;
518}
519
520/**
521 * Logs an audio device enumeration.
522 *
523 * @param pszDesc Logging description.
524 * @param pDevEnm Device enumeration to log.
525 */
526void DrvAudioHlpDeviceEnumPrint(const char *pszDesc, const PPDMAUDIODEVICEENUM pDevEnm)
527{
528 AssertPtrReturnVoid(pszDesc);
529 AssertPtrReturnVoid(pDevEnm);
530
531 LogFunc(("%s: %RU16 devices\n", pszDesc, pDevEnm->cDevices));
532
533 PPDMAUDIODEVICE pDev;
534 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
535 {
536 char *pszFlags = DrvAudioHlpAudDevFlagsToStrA(pDev->fFlags);
537
538 LogFunc(("Device '%s':\n", pDev->szName));
539 LogFunc(("\tUsage = %s\n", DrvAudioHlpAudDirToStr(pDev->enmUsage)));
540 LogFunc(("\tFlags = %s\n", pszFlags ? pszFlags : "<NONE>"));
541 LogFunc(("\tInput channels = %RU8\n", pDev->cMaxInputChannels));
542 LogFunc(("\tOutput channels = %RU8\n", pDev->cMaxOutputChannels));
543 LogFunc(("\tData = %p (%zu bytes)\n", pDev->pvData, pDev->cbData));
544
545 if (pszFlags)
546 RTStrFree(pszFlags);
547 }
548}
549
550/**
551 * Converts an audio direction to a string.
552 *
553 * @returns Stringified audio direction, or "Unknown", if not found.
554 * @param enmDir Audio direction to convert.
555 */
556const char *DrvAudioHlpAudDirToStr(PDMAUDIODIR enmDir)
557{
558 switch (enmDir)
559 {
560 case PDMAUDIODIR_UNKNOWN: return "Unknown";
561 case PDMAUDIODIR_IN: return "Input";
562 case PDMAUDIODIR_OUT: return "Output";
563 case PDMAUDIODIR_ANY: return "Duplex";
564 default: break;
565 }
566
567 AssertMsgFailed(("Invalid audio direction %ld\n", enmDir));
568 return "Unknown";
569}
570
571/**
572 * Converts an audio mixer control to a string.
573 *
574 * @returns Stringified audio mixer control or "Unknown", if not found.
575 * @param enmMixerCtl Audio mixer control to convert.
576 */
577const char *DrvAudioHlpAudMixerCtlToStr(PDMAUDIOMIXERCTL enmMixerCtl)
578{
579 switch (enmMixerCtl)
580 {
581 case PDMAUDIOMIXERCTL_VOLUME_MASTER: return "Master Volume";
582 case PDMAUDIOMIXERCTL_FRONT: return "Front";
583 case PDMAUDIOMIXERCTL_CENTER_LFE: return "Center / LFE";
584 case PDMAUDIOMIXERCTL_REAR: return "Rear";
585 case PDMAUDIOMIXERCTL_LINE_IN: return "Line-In";
586 case PDMAUDIOMIXERCTL_MIC_IN: return "Microphone-In";
587 default: break;
588 }
589
590 AssertMsgFailed(("Invalid mixer control %ld\n", enmMixerCtl));
591 return "Unknown";
592}
593
594/**
595 * Converts an audio device flags to a string.
596 *
597 * @returns Stringified audio flags. Must be free'd with RTStrFree().
598 * NULL if no flags set.
599 * @param fFlags Audio flags to convert.
600 */
601char *DrvAudioHlpAudDevFlagsToStrA(PDMAUDIODEVFLAG fFlags)
602{
603#define APPEND_FLAG_TO_STR(_aFlag) \
604 if (fFlags & PDMAUDIODEV_FLAGS_##_aFlag) \
605 { \
606 if (pszFlags) \
607 { \
608 rc2 = RTStrAAppend(&pszFlags, " "); \
609 if (RT_FAILURE(rc2)) \
610 break; \
611 } \
612 \
613 rc2 = RTStrAAppend(&pszFlags, #_aFlag); \
614 if (RT_FAILURE(rc2)) \
615 break; \
616 } \
617
618 char *pszFlags = NULL;
619 int rc2 = VINF_SUCCESS;
620
621 do
622 {
623 APPEND_FLAG_TO_STR(DEFAULT);
624 APPEND_FLAG_TO_STR(HOTPLUG);
625 APPEND_FLAG_TO_STR(BUGGY);
626 APPEND_FLAG_TO_STR(IGNORE);
627 APPEND_FLAG_TO_STR(LOCKED);
628 APPEND_FLAG_TO_STR(DEAD);
629
630 } while (0);
631
632 if (!pszFlags)
633 rc2 = RTStrAAppend(&pszFlags, "NONE");
634
635 if ( RT_FAILURE(rc2)
636 && pszFlags)
637 {
638 RTStrFree(pszFlags);
639 pszFlags = NULL;
640 }
641
642#undef APPEND_FLAG_TO_STR
643
644 return pszFlags;
645}
646
647/**
648 * Converts a playback destination enumeration to a string.
649 *
650 * @returns Stringified playback destination, or "Unknown", if not found.
651 * @param enmPlaybackDst Playback destination to convert.
652 */
653const char *DrvAudioHlpPlaybackDstToStr(const PDMAUDIOPLAYBACKDEST enmPlaybackDst)
654{
655 switch (enmPlaybackDst)
656 {
657 case PDMAUDIOPLAYBACKDEST_UNKNOWN: return "Unknown";
658 case PDMAUDIOPLAYBACKDEST_FRONT: return "Front";
659 case PDMAUDIOPLAYBACKDEST_CENTER_LFE: return "Center / LFE";
660 case PDMAUDIOPLAYBACKDEST_REAR: return "Rear";
661 default:
662 break;
663 }
664
665 AssertMsgFailed(("Invalid playback destination %ld\n", enmPlaybackDst));
666 return "Unknown";
667}
668
669/**
670 * Converts a recording source enumeration to a string.
671 *
672 * @returns Stringified recording source, or "Unknown", if not found.
673 * @param enmRecSrc Recording source to convert.
674 */
675const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSOURCE enmRecSrc)
676{
677 switch (enmRecSrc)
678 {
679 case PDMAUDIORECSOURCE_UNKNOWN: return "Unknown";
680 case PDMAUDIORECSOURCE_MIC: return "Microphone In";
681 case PDMAUDIORECSOURCE_CD: return "CD";
682 case PDMAUDIORECSOURCE_VIDEO: return "Video";
683 case PDMAUDIORECSOURCE_AUX: return "AUX";
684 case PDMAUDIORECSOURCE_LINE: return "Line In";
685 case PDMAUDIORECSOURCE_PHONE: return "Phone";
686 default:
687 break;
688 }
689
690 AssertMsgFailed(("Invalid recording source %ld\n", enmRecSrc));
691 return "Unknown";
692}
693
694/**
695 * Returns wether the given audio format has signed bits or not.
696 *
697 * @return IPRT status code.
698 * @return bool @c true for signed bits, @c false for unsigned.
699 * @param enmFmt Audio format to retrieve value for.
700 */
701bool DrvAudioHlpAudFmtIsSigned(PDMAUDIOFMT enmFmt)
702{
703 switch (enmFmt)
704 {
705 case PDMAUDIOFMT_S8:
706 case PDMAUDIOFMT_S16:
707 case PDMAUDIOFMT_S32:
708 return true;
709
710 case PDMAUDIOFMT_U8:
711 case PDMAUDIOFMT_U16:
712 case PDMAUDIOFMT_U32:
713 return false;
714
715 default:
716 break;
717 }
718
719 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
720 return false;
721}
722
723/**
724 * Returns the bits of a given audio format.
725 *
726 * @return IPRT status code.
727 * @return uint8_t Bits of audio format.
728 * @param enmFmt Audio format to retrieve value for.
729 */
730uint8_t DrvAudioHlpAudFmtToBits(PDMAUDIOFMT enmFmt)
731{
732 switch (enmFmt)
733 {
734 case PDMAUDIOFMT_S8:
735 case PDMAUDIOFMT_U8:
736 return 8;
737
738 case PDMAUDIOFMT_U16:
739 case PDMAUDIOFMT_S16:
740 return 16;
741
742 case PDMAUDIOFMT_U32:
743 case PDMAUDIOFMT_S32:
744 return 32;
745
746 default:
747 break;
748 }
749
750 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
751 return 0;
752}
753
754/**
755 * Converts an audio format to a string.
756 *
757 * @returns Stringified audio format, or "Unknown", if not found.
758 * @param enmFmt Audio format to convert.
759 */
760const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt)
761{
762 switch (enmFmt)
763 {
764 case PDMAUDIOFMT_U8:
765 return "U8";
766
767 case PDMAUDIOFMT_U16:
768 return "U16";
769
770 case PDMAUDIOFMT_U32:
771 return "U32";
772
773 case PDMAUDIOFMT_S8:
774 return "S8";
775
776 case PDMAUDIOFMT_S16:
777 return "S16";
778
779 case PDMAUDIOFMT_S32:
780 return "S32";
781
782 default:
783 break;
784 }
785
786 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
787 return "Unknown";
788}
789
790/**
791 * Converts a given string to an audio format.
792 *
793 * @returns Audio format for the given string, or PDMAUDIOFMT_INVALID if not found.
794 * @param pszFmt String to convert to an audio format.
795 */
796PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt)
797{
798 AssertPtrReturn(pszFmt, PDMAUDIOFMT_INVALID);
799
800 if (!RTStrICmp(pszFmt, "u8"))
801 return PDMAUDIOFMT_U8;
802 else if (!RTStrICmp(pszFmt, "u16"))
803 return PDMAUDIOFMT_U16;
804 else if (!RTStrICmp(pszFmt, "u32"))
805 return PDMAUDIOFMT_U32;
806 else if (!RTStrICmp(pszFmt, "s8"))
807 return PDMAUDIOFMT_S8;
808 else if (!RTStrICmp(pszFmt, "s16"))
809 return PDMAUDIOFMT_S16;
810 else if (!RTStrICmp(pszFmt, "s32"))
811 return PDMAUDIOFMT_S32;
812
813 AssertMsgFailed(("Invalid audio format '%s'\n", pszFmt));
814 return PDMAUDIOFMT_INVALID;
815}
816
817/**
818 * Checks whether two given PCM properties are equal.
819 *
820 * @returns @c true if equal, @c false if not.
821 * @param pProps1 First properties to compare.
822 * @param pProps2 Second properties to compare.
823 */
824bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps1, const PPDMAUDIOPCMPROPS pProps2)
825{
826 AssertPtrReturn(pProps1, false);
827 AssertPtrReturn(pProps2, false);
828
829 if (pProps1 == pProps2) /* If the pointers match, take a shortcut. */
830 return true;
831
832 return pProps1->uHz == pProps2->uHz
833 && pProps1->cChannels == pProps2->cChannels
834 && pProps1->cBytes == pProps2->cBytes
835 && pProps1->fSigned == pProps2->fSigned
836 && pProps1->fSwapEndian == pProps2->fSwapEndian;
837}
838
839/**
840 * Checks whether given PCM properties are valid or not.
841 *
842 * Returns @c true if properties are valid, @c false if not.
843 * @param pProps PCM properties to check.
844 */
845bool DrvAudioHlpPCMPropsAreValid(const PPDMAUDIOPCMPROPS pProps)
846{
847 AssertPtrReturn(pProps, false);
848
849 /* Minimum 1 channel (mono), maximum 7.1 (= 8) channels. */
850 bool fValid = ( pProps->cChannels >= 1
851 && pProps->cChannels <= 8);
852
853 if (fValid)
854 {
855 switch (pProps->cBytes)
856 {
857 case 1: /* 8 bit */
858 if (pProps->fSigned)
859 fValid = false;
860 break;
861 case 2: /* 16 bit */
862 if (!pProps->fSigned)
863 fValid = false;
864 break;
865 /** @todo Do we need support for 24 bit samples? */
866 case 4: /* 32 bit */
867 if (!pProps->fSigned)
868 fValid = false;
869 break;
870 default:
871 fValid = false;
872 break;
873 }
874 }
875
876 if (!fValid)
877 return false;
878
879 fValid &= pProps->uHz > 0;
880 fValid &= pProps->cShift == PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(pProps->cBytes, pProps->cChannels);
881 fValid &= pProps->fSwapEndian == false; /** @todo Handling Big Endian audio data is not supported yet. */
882
883 return fValid;
884}
885
886/**
887 * Checks whether the given PCM properties are equal with the given
888 * stream configuration.
889 *
890 * @returns @c true if equal, @c false if not.
891 * @param pProps PCM properties to compare.
892 * @param pCfg Stream configuration to compare.
893 */
894bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps, const PPDMAUDIOSTREAMCFG pCfg)
895{
896 AssertPtrReturn(pProps, false);
897 AssertPtrReturn(pCfg, false);
898
899 return DrvAudioHlpPCMPropsAreEqual(pProps, &pCfg->Props);
900}
901
902/**
903 * Returns the bytes per frame for given PCM properties.
904 *
905 * @return Bytes per (audio) frame.
906 * @param pProps PCM properties to retrieve bytes per frame for.
907 */
908uint32_t DrvAudioHlpPCMPropsBytesPerFrame(const PPDMAUDIOPCMPROPS pProps)
909{
910 return PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
911}
912
913/**
914 * Prints PCM properties to the debug log.
915 *
916 * @param pProps Stream configuration to log.
917 */
918void DrvAudioHlpPCMPropsPrint(const PPDMAUDIOPCMPROPS pProps)
919{
920 AssertPtrReturnVoid(pProps);
921
922 Log(("uHz=%RU32, cChannels=%RU8, cBits=%RU8%s",
923 pProps->uHz, pProps->cChannels, pProps->cBytes * 8, pProps->fSigned ? "S" : "U"));
924}
925
926/**
927 * Converts PCM properties to a audio stream configuration.
928 *
929 * @return IPRT status code.
930 * @param pProps PCM properties to convert.
931 * @param pCfg Stream configuration to store result into.
932 */
933int DrvAudioHlpPCMPropsToStreamCfg(const PPDMAUDIOPCMPROPS pProps, PPDMAUDIOSTREAMCFG pCfg)
934{
935 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
936 AssertPtrReturn(pCfg, VERR_INVALID_POINTER);
937
938 DrvAudioHlpStreamCfgInit(pCfg);
939
940 memcpy(&pCfg->Props, pProps, sizeof(PDMAUDIOPCMPROPS));
941 return VINF_SUCCESS;
942}
943
944/**
945 * Initializes a stream configuration with its default values.
946 *
947 * @param pCfg Stream configuration to initialize.
948 */
949void DrvAudioHlpStreamCfgInit(PPDMAUDIOSTREAMCFG pCfg)
950{
951 AssertPtrReturnVoid(pCfg);
952
953 RT_BZERO(pCfg, sizeof(PDMAUDIOSTREAMCFG));
954
955 pCfg->Backend.cfPreBuf = UINT32_MAX; /* Explicitly set to "undefined". */
956}
957
958/**
959 * Checks whether a given stream configuration is valid or not.
960 *
961 * Returns @c true if configuration is valid, @c false if not.
962 * @param pCfg Stream configuration to check.
963 */
964bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg)
965{
966 AssertPtrReturn(pCfg, false);
967
968 bool fValid = ( pCfg->enmDir == PDMAUDIODIR_IN
969 || pCfg->enmDir == PDMAUDIODIR_OUT);
970
971 fValid &= ( pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED
972 || pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
973
974 if (fValid)
975 fValid = DrvAudioHlpPCMPropsAreValid(&pCfg->Props);
976
977 return fValid;
978}
979
980/**
981 * Frees an allocated audio stream configuration.
982 *
983 * @param pCfg Audio stream configuration to free.
984 */
985void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg)
986{
987 if (pCfg)
988 {
989 RTMemFree(pCfg);
990 pCfg = NULL;
991 }
992}
993
994/**
995 * Copies a source stream configuration to a destination stream configuration.
996 *
997 * @returns IPRT status code.
998 * @param pDstCfg Destination stream configuration to copy source to.
999 * @param pSrcCfg Source stream configuration to copy to destination.
1000 */
1001int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg)
1002{
1003 AssertPtrReturn(pDstCfg, VERR_INVALID_POINTER);
1004 AssertPtrReturn(pSrcCfg, VERR_INVALID_POINTER);
1005
1006#ifdef VBOX_STRICT
1007 if (!DrvAudioHlpStreamCfgIsValid(pSrcCfg))
1008 {
1009 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pSrcCfg->szName, pSrcCfg));
1010 return VERR_INVALID_PARAMETER;
1011 }
1012#endif
1013
1014 memcpy(pDstCfg, pSrcCfg, sizeof(PDMAUDIOSTREAMCFG));
1015
1016 return VINF_SUCCESS;
1017}
1018
1019/**
1020 * Duplicates an audio stream configuration.
1021 * Must be free'd with DrvAudioHlpStreamCfgFree().
1022 *
1023 * @return Duplicates audio stream configuration on success, or NULL on failure.
1024 * @param pCfg Audio stream configuration to duplicate.
1025 */
1026PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg)
1027{
1028 AssertPtrReturn(pCfg, NULL);
1029
1030#ifdef VBOX_STRICT
1031 if (!DrvAudioHlpStreamCfgIsValid(pCfg))
1032 {
1033 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pCfg->szName, pCfg));
1034 return NULL;
1035 }
1036#endif
1037
1038 PPDMAUDIOSTREAMCFG pDst = (PPDMAUDIOSTREAMCFG)RTMemAllocZ(sizeof(PDMAUDIOSTREAMCFG));
1039 if (!pDst)
1040 return NULL;
1041
1042 int rc2 = DrvAudioHlpStreamCfgCopy(pDst, pCfg);
1043 if (RT_FAILURE(rc2))
1044 {
1045 DrvAudioHlpStreamCfgFree(pDst);
1046 pDst = NULL;
1047 }
1048
1049 AssertPtr(pDst);
1050 return pDst;
1051}
1052
1053/**
1054 * Prints an audio stream configuration to the debug log.
1055 *
1056 * @param pCfg Stream configuration to log.
1057 */
1058void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg)
1059{
1060 if (!pCfg)
1061 return;
1062
1063 LogFunc(("szName=%s, enmDir=%RU32 (uHz=%RU32, cBits=%RU8%s, cChannels=%RU8)\n",
1064 pCfg->szName, pCfg->enmDir,
1065 pCfg->Props.uHz, pCfg->Props.cBytes * 8, pCfg->Props.fSigned ? "S" : "U", pCfg->Props.cChannels));
1066}
1067
1068/**
1069 * Converts a stream command to a string.
1070 *
1071 * @returns Stringified stream command, or "Unknown", if not found.
1072 * @param enmCmd Stream command to convert.
1073 */
1074const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd)
1075{
1076 switch (enmCmd)
1077 {
1078 case PDMAUDIOSTREAMCMD_UNKNOWN: return "Unknown";
1079 case PDMAUDIOSTREAMCMD_ENABLE: return "Enable";
1080 case PDMAUDIOSTREAMCMD_DISABLE: return "Disable";
1081 case PDMAUDIOSTREAMCMD_PAUSE: return "Pause";
1082 case PDMAUDIOSTREAMCMD_RESUME: return "Resume";
1083 case PDMAUDIOSTREAMCMD_DRAIN: return "Drain";
1084 case PDMAUDIOSTREAMCMD_DROP: return "Drop";
1085 default: break;
1086 }
1087
1088 AssertMsgFailed(("Invalid stream command %ld\n", enmCmd));
1089 return "Unknown";
1090}
1091
1092/**
1093 * Returns @c true if the given stream status indicates a can-be-read-from stream,
1094 * @c false if not.
1095 *
1096 * @returns @c true if ready to be read from, @c if not.
1097 * @param enmStatus Stream status to evaluate.
1098 */
1099bool DrvAudioHlpStreamStatusCanRead(PDMAUDIOSTREAMSTS enmStatus)
1100{
1101 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1102
1103 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1104 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1105 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
1106 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1107}
1108
1109/**
1110 * Returns @c true if the given stream status indicates a can-be-written-to stream,
1111 * @c false if not.
1112 *
1113 * @returns @c true if ready to be written to, @c if not.
1114 * @param enmStatus Stream status to evaluate.
1115 */
1116bool DrvAudioHlpStreamStatusCanWrite(PDMAUDIOSTREAMSTS enmStatus)
1117{
1118 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1119
1120 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1121 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1122 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
1123 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE)
1124 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1125}
1126
1127/**
1128 * Returns @c true if the given stream status indicates a ready-to-operate stream,
1129 * @c false if not.
1130 *
1131 * @returns @c true if ready to operate, @c if not.
1132 * @param enmStatus Stream status to evaluate.
1133 */
1134bool DrvAudioHlpStreamStatusIsReady(PDMAUDIOSTREAMSTS enmStatus)
1135{
1136 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1137
1138 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1139 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1140 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1141}
1142
1143/**
1144 * Calculates the audio bit rate of the given bits per sample, the Hz and the number
1145 * of audio channels.
1146 *
1147 * Divide the result by 8 to get the byte rate.
1148 *
1149 * @returns The calculated bit rate.
1150 * @param cBits Number of bits per sample.
1151 * @param uHz Hz (Hertz) rate.
1152 * @param cChannels Number of audio channels.
1153 */
1154uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels)
1155{
1156 return (cBits * uHz * cChannels);
1157}
1158
1159/**
1160 * Calculates the audio bit rate out of a given audio stream configuration.
1161 *
1162 * Divide the result by 8 to get the byte rate.
1163 *
1164 * @returns The calculated bit rate.
1165 * @param pProps PCM properties to calculate bitrate for.
1166 *
1167 * @remark
1168 */
1169uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps)
1170{
1171 return DrvAudioHlpCalcBitrate(pProps->cBytes * 8, pProps->uHz, pProps->cChannels);
1172}
1173
1174/**
1175 * Aligns the given byte amount to the given PCM properties and returns the aligned
1176 * size.
1177 *
1178 * @return Aligned size (in bytes).
1179 * @param cbSize Size (in bytes) to align.
1180 * @param pProps PCM properties to align size to.
1181 */
1182uint32_t DrvAudioHlpBytesAlign(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps)
1183{
1184 AssertPtrReturn(pProps, 0);
1185
1186 if (!cbSize)
1187 return 0;
1188
1189 return PDMAUDIOPCMPROPS_B2F(pProps, cbSize) * PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1190}
1191
1192/**
1193 * Returns if the the given size is properly aligned to the given PCM properties.
1194 *
1195 * @return @c true if properly aligned, @c false if not.
1196 * @param cbSize Size (in bytes) to check alignment for.
1197 * @param pProps PCM properties to use for checking the alignment.
1198 */
1199bool DrvAudioHlpBytesIsAligned(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps)
1200{
1201 AssertPtrReturn(pProps, 0);
1202
1203 if (!cbSize)
1204 return true;
1205
1206 return (cbSize % PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) == 0);
1207}
1208
1209/**
1210 * Returns the bytes per second for given PCM properties.
1211 *
1212 * @returns Bytes per second.
1213 * @param pProps PCM properties to retrieve size for.
1214 */
1215DECLINLINE(uint64_t) drvAudioHlpBytesPerSec(const PPDMAUDIOPCMPROPS pProps)
1216{
1217 return PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) * pProps->uHz;
1218}
1219
1220/**
1221 * Returns the number of audio frames for a given amount of bytes.
1222 *
1223 * @return Calculated audio frames for given bytes.
1224 * @param cbBytes Bytes to convert to audio frames.
1225 * @param pProps PCM properties to calulate frames for.
1226 */
1227uint32_t DrvAudioHlpBytesToFrames(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1228{
1229 AssertPtrReturn(pProps, 0);
1230
1231 return PDMAUDIOPCMPROPS_B2F(pProps, cbBytes);
1232}
1233
1234/**
1235 * Returns the time (in ms) for given byte amount and PCM properties.
1236 *
1237 * @return uint64_t Calculated time (in ms).
1238 * @param cbBytes Amount of bytes to calculate time for.
1239 * @param pProps PCM properties to calculate amount of bytes for.
1240 */
1241uint64_t DrvAudioHlpBytesToMilli(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1242{
1243 AssertPtrReturn(pProps, 0);
1244
1245 if (!cbBytes)
1246 return 0;
1247
1248 const double dbBytesPerMs = (double)drvAudioHlpBytesPerSec(pProps) / (double)RT_MS_1SEC;
1249 Assert(dbBytesPerMs >= 0.0f);
1250 if (!dbBytesPerMs) /* Prevent division by zero. */
1251 return 0;
1252
1253 return (double)cbBytes / (double)dbBytesPerMs;
1254}
1255
1256/**
1257 * Returns the time (in ns) for given byte amount and PCM properties.
1258 *
1259 * @return uint64_t Calculated time (in ns).
1260 * @param cbBytes Amount of bytes to calculate time for.
1261 * @param pProps PCM properties to calculate amount of bytes for.
1262 */
1263uint64_t DrvAudioHlpBytesToNano(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1264{
1265 AssertPtrReturn(pProps, 0);
1266
1267 if (!cbBytes)
1268 return 0;
1269
1270 const double dbBytesPerMs = (PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) * pProps->uHz) / RT_NS_1SEC;
1271 Assert(dbBytesPerMs >= 0.0f);
1272 if (!dbBytesPerMs) /* Prevent division by zero. */
1273 return 0;
1274
1275 return cbBytes / dbBytesPerMs;
1276}
1277
1278/**
1279 * Returns the bytes for a given audio frames amount and PCM properties.
1280 *
1281 * @return Calculated bytes for given audio frames.
1282 * @param cFrames Amount of audio frames to calculate bytes for.
1283 * @param pProps PCM properties to calculate bytes for.
1284 */
1285uint32_t DrvAudioHlpFramesToBytes(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1286{
1287 AssertPtrReturn(pProps, 0);
1288
1289 if (!cFrames)
1290 return 0;
1291
1292 return cFrames * PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1293}
1294
1295/**
1296 * Returns the time (in ms) for given audio frames amount and PCM properties.
1297 *
1298 * @return uint64_t Calculated time (in ms).
1299 * @param cFrames Amount of audio frames to calculate time for.
1300 * @param pProps PCM properties to calculate time (in ms) for.
1301 */
1302uint64_t DrvAudioHlpFramesToMilli(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1303{
1304 AssertPtrReturn(pProps, 0);
1305
1306 if (!cFrames)
1307 return 0;
1308
1309 if (!pProps->uHz) /* Prevent division by zero. */
1310 return 0;
1311
1312 return cFrames / ((double)pProps->uHz / (double)RT_MS_1SEC);
1313}
1314
1315/**
1316 * Returns the time (in ns) for given audio frames amount and PCM properties.
1317 *
1318 * @return uint64_t Calculated time (in ns).
1319 * @param cFrames Amount of audio frames to calculate time for.
1320 * @param pProps PCM properties to calculate time (in ns) for.
1321 */
1322uint64_t DrvAudioHlpFramesToNano(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1323{
1324 AssertPtrReturn(pProps, 0);
1325
1326 if (!cFrames)
1327 return 0;
1328
1329 if (!pProps->uHz) /* Prevent division by zero. */
1330 return 0;
1331
1332 return cFrames / ((double)pProps->uHz / (double)RT_NS_1SEC);
1333}
1334
1335/**
1336 * Returns the amount of bytes for a given time (in ms) and PCM properties.
1337 *
1338 * Note: The result will return an amount of bytes which is aligned to the audio frame size.
1339 *
1340 * @return uint32_t Calculated amount of bytes.
1341 * @param uMs Time (in ms) to calculate amount of bytes for.
1342 * @param pProps PCM properties to calculate amount of bytes for.
1343 */
1344uint32_t DrvAudioHlpMilliToBytes(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps)
1345{
1346 AssertPtrReturn(pProps, 0);
1347
1348 if (!uMs)
1349 return 0;
1350
1351 const uint32_t uBytesPerFrame = DrvAudioHlpPCMPropsBytesPerFrame(pProps);
1352
1353 uint32_t uBytes = ((double)drvAudioHlpBytesPerSec(pProps) / (double)RT_MS_1SEC) * uMs;
1354 if (uBytes % uBytesPerFrame) /* Any remainder? Make the returned bytes an integral number to the given frames. */
1355 uBytes = uBytes + (uBytesPerFrame - uBytes % uBytesPerFrame);
1356
1357 Assert(uBytes % uBytesPerFrame == 0); /* Paranoia. */
1358
1359 return uBytes;
1360}
1361
1362/**
1363 * Returns the amount of bytes for a given time (in ns) and PCM properties.
1364 *
1365 * Note: The result will return an amount of bytes which is aligned to the audio frame size.
1366 *
1367 * @return uint32_t Calculated amount of bytes.
1368 * @param uNs Time (in ns) to calculate amount of bytes for.
1369 * @param pProps PCM properties to calculate amount of bytes for.
1370 */
1371uint32_t DrvAudioHlpNanoToBytes(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps)
1372{
1373 AssertPtrReturn(pProps, 0);
1374
1375 if (!uNs)
1376 return 0;
1377
1378 const uint32_t uBytesPerFrame = DrvAudioHlpPCMPropsBytesPerFrame(pProps);
1379
1380 uint32_t uBytes = ((double)drvAudioHlpBytesPerSec(pProps) / (double)RT_NS_1SEC) * uNs;
1381 if (uBytes % uBytesPerFrame) /* Any remainder? Make the returned bytes an integral number to the given frames. */
1382 uBytes = uBytes + (uBytesPerFrame - uBytes % uBytesPerFrame);
1383
1384 Assert(uBytes % uBytesPerFrame == 0); /* Paranoia. */
1385
1386 return uBytes;
1387}
1388
1389/**
1390 * Returns the amount of audio frames for a given time (in ms) and PCM properties.
1391 *
1392 * @return uint32_t Calculated amount of audio frames.
1393 * @param uMs Time (in ms) to calculate amount of frames for.
1394 * @param pProps PCM properties to calculate amount of frames for.
1395 */
1396uint32_t DrvAudioHlpMilliToFrames(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps)
1397{
1398 AssertPtrReturn(pProps, 0);
1399
1400 const uint32_t cbFrame = PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1401 if (!cbFrame) /* Prevent division by zero. */
1402 return 0;
1403
1404 return DrvAudioHlpMilliToBytes(uMs, pProps) / cbFrame;
1405}
1406
1407/**
1408 * Returns the amount of audio frames for a given time (in ns) and PCM properties.
1409 *
1410 * @return uint32_t Calculated amount of audio frames.
1411 * @param uNs Time (in ns) to calculate amount of frames for.
1412 * @param pProps PCM properties to calculate amount of frames for.
1413 */
1414uint32_t DrvAudioHlpNanoToFrames(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps)
1415{
1416 AssertPtrReturn(pProps, 0);
1417
1418 const uint32_t cbFrame = PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1419 if (!cbFrame) /* Prevent division by zero. */
1420 return 0;
1421
1422 return DrvAudioHlpNanoToBytes(uNs, pProps) / cbFrame;
1423}
1424
1425/**
1426 * Sanitizes the file name component so that unsupported characters
1427 * will be replaced by an underscore ("_").
1428 *
1429 * @return IPRT status code.
1430 * @param pszPath Path to sanitize.
1431 * @param cbPath Size (in bytes) of path to sanitize.
1432 */
1433int DrvAudioHlpFileNameSanitize(char *pszPath, size_t cbPath)
1434{
1435 RT_NOREF(cbPath);
1436 int rc = VINF_SUCCESS;
1437#ifdef RT_OS_WINDOWS
1438 /* Filter out characters not allowed on Windows platforms, put in by
1439 RTTimeSpecToString(). */
1440 /** @todo Use something like RTPathSanitize() if available later some time. */
1441 static RTUNICP const s_uszValidRangePairs[] =
1442 {
1443 ' ', ' ',
1444 '(', ')',
1445 '-', '.',
1446 '0', '9',
1447 'A', 'Z',
1448 'a', 'z',
1449 '_', '_',
1450 0xa0, 0xd7af,
1451 '\0'
1452 };
1453 ssize_t cReplaced = RTStrPurgeComplementSet(pszPath, s_uszValidRangePairs, '_' /* Replacement */);
1454 if (cReplaced < 0)
1455 rc = VERR_INVALID_UTF8_ENCODING;
1456#else
1457 RT_NOREF(pszPath);
1458#endif
1459 return rc;
1460}
1461
1462/**
1463 * Constructs an unique file name, based on the given path and the audio file type.
1464 *
1465 * @returns IPRT status code.
1466 * @param pszFile Where to store the constructed file name.
1467 * @param cchFile Size (in characters) of the file name buffer.
1468 * @param pszPath Base path to use.
1469 * @param pszName A name for better identifying the file.
1470 * @param uInstance Device / driver instance which is using this file.
1471 * @param enmType Audio file type to construct file name for.
1472 * @param fFlags File naming flags.
1473 */
1474int DrvAudioHlpFileNameGet(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName,
1475 uint32_t uInstance, PDMAUDIOFILETYPE enmType, PDMAUDIOFILENAMEFLAGS fFlags)
1476{
1477 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1478 AssertReturn(cchFile, VERR_INVALID_PARAMETER);
1479 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1480 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1481 /** @todo Validate fFlags. */
1482
1483 int rc;
1484
1485 do
1486 {
1487 char szFilePath[RTPATH_MAX + 1];
1488 RTStrPrintf2(szFilePath, sizeof(szFilePath), "%s", pszPath);
1489
1490 /* Create it when necessary. */
1491 if (!RTDirExists(szFilePath))
1492 {
1493 rc = RTDirCreateFullPath(szFilePath, RTFS_UNIX_IRWXU);
1494 if (RT_FAILURE(rc))
1495 break;
1496 }
1497
1498 char szFileName[RTPATH_MAX + 1];
1499 szFileName[0] = '\0';
1500
1501 if (fFlags & PDMAUDIOFILENAME_FLAG_TS)
1502 {
1503 RTTIMESPEC time;
1504 if (!RTTimeSpecToString(RTTimeNow(&time), szFileName, sizeof(szFileName)))
1505 {
1506 rc = VERR_BUFFER_OVERFLOW;
1507 break;
1508 }
1509
1510 rc = DrvAudioHlpFileNameSanitize(szFileName, sizeof(szFileName));
1511 if (RT_FAILURE(rc))
1512 break;
1513
1514 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1515 if (RT_FAILURE(rc))
1516 break;
1517 }
1518
1519 rc = RTStrCat(szFileName, sizeof(szFileName), pszName);
1520 if (RT_FAILURE(rc))
1521 break;
1522
1523 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1524 if (RT_FAILURE(rc))
1525 break;
1526
1527 char szInst[16];
1528 RTStrPrintf2(szInst, sizeof(szInst), "%RU32", uInstance);
1529 rc = RTStrCat(szFileName, sizeof(szFileName), szInst);
1530 if (RT_FAILURE(rc))
1531 break;
1532
1533 switch (enmType)
1534 {
1535 case PDMAUDIOFILETYPE_RAW:
1536 rc = RTStrCat(szFileName, sizeof(szFileName), ".pcm");
1537 break;
1538
1539 case PDMAUDIOFILETYPE_WAV:
1540 rc = RTStrCat(szFileName, sizeof(szFileName), ".wav");
1541 break;
1542
1543 default:
1544 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1545 break;
1546 }
1547
1548 if (RT_FAILURE(rc))
1549 break;
1550
1551 rc = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
1552 if (RT_FAILURE(rc))
1553 break;
1554
1555 RTStrPrintf2(pszFile, cchFile, "%s", szFilePath);
1556
1557 } while (0);
1558
1559 LogFlowFuncLeaveRC(rc);
1560 return rc;
1561}
1562
1563/**
1564 * Creates an audio file.
1565 *
1566 * @returns IPRT status code.
1567 * @param enmType Audio file type to open / create.
1568 * @param pszFile File path of file to open or create.
1569 * @param fFlags Audio file flags.
1570 * @param ppFile Where to store the created audio file handle.
1571 * Needs to be destroyed with DrvAudioHlpFileDestroy().
1572 */
1573int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, PDMAUDIOFILEFLAGS fFlags, PPDMAUDIOFILE *ppFile)
1574{
1575 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1576 /** @todo Validate fFlags. */
1577
1578 PPDMAUDIOFILE pFile = (PPDMAUDIOFILE)RTMemAlloc(sizeof(PDMAUDIOFILE));
1579 if (!pFile)
1580 return VERR_NO_MEMORY;
1581
1582 int rc = VINF_SUCCESS;
1583
1584 switch (enmType)
1585 {
1586 case PDMAUDIOFILETYPE_RAW:
1587 case PDMAUDIOFILETYPE_WAV:
1588 pFile->enmType = enmType;
1589 break;
1590
1591 default:
1592 rc = VERR_INVALID_PARAMETER;
1593 break;
1594 }
1595
1596 if (RT_SUCCESS(rc))
1597 {
1598 RTStrPrintf(pFile->szName, RT_ELEMENTS(pFile->szName), "%s", pszFile);
1599 pFile->hFile = NIL_RTFILE;
1600 pFile->fFlags = fFlags;
1601 pFile->pvData = NULL;
1602 pFile->cbData = 0;
1603 }
1604
1605 if (RT_FAILURE(rc))
1606 {
1607 RTMemFree(pFile);
1608 pFile = NULL;
1609 }
1610 else
1611 *ppFile = pFile;
1612
1613 return rc;
1614}
1615
1616/**
1617 * Destroys a formerly created audio file.
1618 *
1619 * @param pFile Audio file (object) to destroy.
1620 */
1621void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile)
1622{
1623 if (!pFile)
1624 return;
1625
1626 DrvAudioHlpFileClose(pFile);
1627
1628 RTMemFree(pFile);
1629 pFile = NULL;
1630}
1631
1632/**
1633 * Opens or creates an audio file.
1634 *
1635 * @returns IPRT status code.
1636 * @param pFile Pointer to audio file handle to use.
1637 * @param fOpen Open flags.
1638 * Use PDMAUDIOFILE_DEFAULT_OPEN_FLAGS for the default open flags.
1639 * @param pProps PCM properties to use.
1640 */
1641int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps)
1642{
1643 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1644 /** @todo Validate fOpen flags. */
1645 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
1646
1647 int rc;
1648
1649 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1650 {
1651 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1652 }
1653 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1654 {
1655 Assert(pProps->cChannels);
1656 Assert(pProps->uHz);
1657 Assert(pProps->cBytes);
1658
1659 pFile->pvData = (PAUDIOWAVFILEDATA)RTMemAllocZ(sizeof(AUDIOWAVFILEDATA));
1660 if (pFile->pvData)
1661 {
1662 pFile->cbData = sizeof(PAUDIOWAVFILEDATA);
1663
1664 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1665 AssertPtr(pData);
1666
1667 /* Header. */
1668 pData->Hdr.u32RIFF = AUDIO_MAKE_FOURCC('R','I','F','F');
1669 pData->Hdr.u32Size = 36;
1670 pData->Hdr.u32WAVE = AUDIO_MAKE_FOURCC('W','A','V','E');
1671
1672 pData->Hdr.u32Fmt = AUDIO_MAKE_FOURCC('f','m','t',' ');
1673 pData->Hdr.u32Size1 = 16; /* Means PCM. */
1674 pData->Hdr.u16AudioFormat = 1; /* PCM, linear quantization. */
1675 pData->Hdr.u16NumChannels = pProps->cChannels;
1676 pData->Hdr.u32SampleRate = pProps->uHz;
1677 pData->Hdr.u32ByteRate = DrvAudioHlpCalcBitrate(pProps) / 8;
1678 pData->Hdr.u16BlockAlign = pProps->cChannels * pProps->cBytes;
1679 pData->Hdr.u16BitsPerSample = pProps->cBytes * 8;
1680
1681 /* Data chunk. */
1682 pData->Hdr.u32ID2 = AUDIO_MAKE_FOURCC('d','a','t','a');
1683 pData->Hdr.u32Size2 = 0;
1684
1685 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1686 if (RT_SUCCESS(rc))
1687 {
1688 rc = RTFileWrite(pFile->hFile, &pData->Hdr, sizeof(pData->Hdr), NULL);
1689 if (RT_FAILURE(rc))
1690 {
1691 RTFileClose(pFile->hFile);
1692 pFile->hFile = NIL_RTFILE;
1693 }
1694 }
1695
1696 if (RT_FAILURE(rc))
1697 {
1698 RTMemFree(pFile->pvData);
1699 pFile->pvData = NULL;
1700 pFile->cbData = 0;
1701 }
1702 }
1703 else
1704 rc = VERR_NO_MEMORY;
1705 }
1706 else
1707 rc = VERR_INVALID_PARAMETER;
1708
1709 if (RT_SUCCESS(rc))
1710 {
1711 LogRel2(("Audio: Opened file '%s'\n", pFile->szName));
1712 }
1713 else
1714 LogRel(("Audio: Failed opening file '%s', rc=%Rrc\n", pFile->szName, rc));
1715
1716 return rc;
1717}
1718
1719/**
1720 * Closes an audio file.
1721 *
1722 * @returns IPRT status code.
1723 * @param pFile Audio file handle to close.
1724 */
1725int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile)
1726{
1727 if (!pFile)
1728 return VINF_SUCCESS;
1729
1730 size_t cbSize = DrvAudioHlpFileGetDataSize(pFile);
1731
1732 int rc = VINF_SUCCESS;
1733
1734 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1735 {
1736 if (RTFileIsValid(pFile->hFile))
1737 rc = RTFileClose(pFile->hFile);
1738 }
1739 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1740 {
1741 if (RTFileIsValid(pFile->hFile))
1742 {
1743 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1744 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1745 {
1746 /* Update the header with the current data size. */
1747 RTFileWriteAt(pFile->hFile, 0, &pData->Hdr, sizeof(pData->Hdr), NULL);
1748 }
1749
1750 rc = RTFileClose(pFile->hFile);
1751 }
1752
1753 if (pFile->pvData)
1754 {
1755 RTMemFree(pFile->pvData);
1756 pFile->pvData = NULL;
1757 }
1758 }
1759 else
1760 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1761
1762 if ( RT_SUCCESS(rc)
1763 && !cbSize
1764 && !(pFile->fFlags & PDMAUDIOFILE_FLAG_KEEP_IF_EMPTY))
1765 {
1766 rc = DrvAudioHlpFileDelete(pFile);
1767 }
1768
1769 pFile->cbData = 0;
1770
1771 if (RT_SUCCESS(rc))
1772 {
1773 pFile->hFile = NIL_RTFILE;
1774 LogRel2(("Audio: Closed file '%s' (%zu bytes)\n", pFile->szName, cbSize));
1775 }
1776 else
1777 LogRel(("Audio: Failed closing file '%s', rc=%Rrc\n", pFile->szName, rc));
1778
1779 return rc;
1780}
1781
1782/**
1783 * Deletes an audio file.
1784 *
1785 * @returns IPRT status code.
1786 * @param pFile Audio file handle to delete.
1787 */
1788int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile)
1789{
1790 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1791
1792 int rc = RTFileDelete(pFile->szName);
1793 if (RT_SUCCESS(rc))
1794 {
1795 LogRel2(("Audio: Deleted file '%s'\n", pFile->szName));
1796 }
1797 else if (rc == VERR_FILE_NOT_FOUND) /* Don't bitch if the file is not around (anymore). */
1798 rc = VINF_SUCCESS;
1799
1800 if (RT_FAILURE(rc))
1801 LogRel(("Audio: Failed deleting file '%s', rc=%Rrc\n", pFile->szName, rc));
1802
1803 return rc;
1804}
1805
1806/**
1807 * Returns the raw audio data size of an audio file.
1808 *
1809 * Note: This does *not* include file headers and other data which does
1810 * not belong to the actual PCM audio data.
1811 *
1812 * @returns Size (in bytes) of the raw PCM audio data.
1813 * @param pFile Audio file handle to retrieve the audio data size for.
1814 */
1815size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile)
1816{
1817 AssertPtrReturn(pFile, 0);
1818
1819 size_t cbSize = 0;
1820
1821 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1822 {
1823 cbSize = RTFileTell(pFile->hFile);
1824 }
1825 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1826 {
1827 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1828 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1829 cbSize = pData->Hdr.u32Size2;
1830 }
1831
1832 return cbSize;
1833}
1834
1835/**
1836 * Returns whether the given audio file is open and in use or not.
1837 *
1838 * @return bool True if open, false if not.
1839 * @param pFile Audio file handle to check open status for.
1840 */
1841bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile)
1842{
1843 if (!pFile)
1844 return false;
1845
1846 return RTFileIsValid(pFile->hFile);
1847}
1848
1849/**
1850 * Write PCM data to a wave (.WAV) file.
1851 *
1852 * @returns IPRT status code.
1853 * @param pFile Audio file handle to write PCM data to.
1854 * @param pvBuf Audio data to write.
1855 * @param cbBuf Size (in bytes) of audio data to write.
1856 * @param fFlags Additional write flags. Not being used at the moment and must be 0.
1857 */
1858int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags)
1859{
1860 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1861 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1862
1863 AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER); /** @todo fFlags are currently not implemented. */
1864
1865 if (!cbBuf)
1866 return VINF_SUCCESS;
1867
1868 AssertReturn(RTFileIsValid(pFile->hFile), VERR_WRONG_ORDER);
1869
1870 int rc;
1871
1872 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1873 {
1874 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1875 }
1876 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1877 {
1878 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1879 AssertPtr(pData);
1880
1881 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1882 if (RT_SUCCESS(rc))
1883 {
1884 pData->Hdr.u32Size += (uint32_t)cbBuf;
1885 pData->Hdr.u32Size2 += (uint32_t)cbBuf;
1886 }
1887 }
1888 else
1889 rc = VERR_NOT_SUPPORTED;
1890
1891 return rc;
1892}
1893
Note: See TracBrowser for help on using the repository browser.

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