VirtualBox

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

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

Audio/DrvAudioHlp: Implemented DrvAudioHlpDeviceEnumGetDeviceCount().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 53.5 KB
Line 
1/* $Id: DrvAudioCommon.cpp 74006 2018-08-31 17:23:27Z 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-2018 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 Pointer to PCM properties to convert.
931 * @param pCfg Pointer to audio 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 memcpy(&pCfg->Props, pProps, sizeof(PDMAUDIOPCMPROPS));
939 return VINF_SUCCESS;
940}
941
942/**
943 * Checks whether a given stream configuration is valid or not.
944 *
945 * Returns @c true if configuration is valid, @c false if not.
946 * @param pCfg Stream configuration to check.
947 */
948bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg)
949{
950 AssertPtrReturn(pCfg, false);
951
952 bool fValid = ( pCfg->enmDir == PDMAUDIODIR_IN
953 || pCfg->enmDir == PDMAUDIODIR_OUT);
954
955 fValid &= ( pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED
956 || pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
957
958 if (fValid)
959 fValid = DrvAudioHlpPCMPropsAreValid(&pCfg->Props);
960
961 return fValid;
962}
963
964/**
965 * Frees an allocated audio stream configuration.
966 *
967 * @param pCfg Audio stream configuration to free.
968 */
969void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg)
970{
971 if (pCfg)
972 {
973 RTMemFree(pCfg);
974 pCfg = NULL;
975 }
976}
977
978/**
979 * Copies a source stream configuration to a destination stream configuration.
980 *
981 * @returns IPRT status code.
982 * @param pDstCfg Destination stream configuration to copy source to.
983 * @param pSrcCfg Source stream configuration to copy to destination.
984 */
985int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg)
986{
987 AssertPtrReturn(pDstCfg, VERR_INVALID_POINTER);
988 AssertPtrReturn(pSrcCfg, VERR_INVALID_POINTER);
989
990#ifdef VBOX_STRICT
991 if (!DrvAudioHlpStreamCfgIsValid(pSrcCfg))
992 {
993 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pSrcCfg->szName, pSrcCfg));
994 return VERR_INVALID_PARAMETER;
995 }
996#endif
997
998 memcpy(pDstCfg, pSrcCfg, sizeof(PDMAUDIOSTREAMCFG));
999
1000 return VINF_SUCCESS;
1001}
1002
1003/**
1004 * Duplicates an audio stream configuration.
1005 * Must be free'd with DrvAudioHlpStreamCfgFree().
1006 *
1007 * @return Duplicates audio stream configuration on success, or NULL on failure.
1008 * @param pCfg Audio stream configuration to duplicate.
1009 */
1010PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg)
1011{
1012 AssertPtrReturn(pCfg, NULL);
1013
1014#ifdef VBOX_STRICT
1015 if (!DrvAudioHlpStreamCfgIsValid(pCfg))
1016 {
1017 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pCfg->szName, pCfg));
1018 return NULL;
1019 }
1020#endif
1021
1022 PPDMAUDIOSTREAMCFG pDst = (PPDMAUDIOSTREAMCFG)RTMemAllocZ(sizeof(PDMAUDIOSTREAMCFG));
1023 if (!pDst)
1024 return NULL;
1025
1026 int rc2 = DrvAudioHlpStreamCfgCopy(pDst, pCfg);
1027 if (RT_FAILURE(rc2))
1028 {
1029 DrvAudioHlpStreamCfgFree(pDst);
1030 pDst = NULL;
1031 }
1032
1033 AssertPtr(pDst);
1034 return pDst;
1035}
1036
1037/**
1038 * Prints an audio stream configuration to the debug log.
1039 *
1040 * @param pCfg Stream configuration to log.
1041 */
1042void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg)
1043{
1044 if (!pCfg)
1045 return;
1046
1047 LogFunc(("szName=%s, enmDir=%RU32 (uHz=%RU32, cBits=%RU8%s, cChannels=%RU8)\n",
1048 pCfg->szName, pCfg->enmDir,
1049 pCfg->Props.uHz, pCfg->Props.cBytes * 8, pCfg->Props.fSigned ? "S" : "U", pCfg->Props.cChannels));
1050}
1051
1052/**
1053 * Converts a stream command to a string.
1054 *
1055 * @returns Stringified stream command, or "Unknown", if not found.
1056 * @param enmCmd Stream command to convert.
1057 */
1058const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd)
1059{
1060 switch (enmCmd)
1061 {
1062 case PDMAUDIOSTREAMCMD_UNKNOWN: return "Unknown";
1063 case PDMAUDIOSTREAMCMD_ENABLE: return "Enable";
1064 case PDMAUDIOSTREAMCMD_DISABLE: return "Disable";
1065 case PDMAUDIOSTREAMCMD_PAUSE: return "Pause";
1066 case PDMAUDIOSTREAMCMD_RESUME: return "Resume";
1067 case PDMAUDIOSTREAMCMD_DRAIN: return "Drain";
1068 case PDMAUDIOSTREAMCMD_DROP: return "Drop";
1069 default: break;
1070 }
1071
1072 AssertMsgFailed(("Invalid stream command %ld\n", enmCmd));
1073 return "Unknown";
1074}
1075
1076/**
1077 * Returns @c true if the given stream status indicates a can-be-read-from stream,
1078 * @c false if not.
1079 *
1080 * @returns @c true if ready to be read from, @c if not.
1081 * @param enmStatus Stream status to evaluate.
1082 */
1083bool DrvAudioHlpStreamStatusCanRead(PDMAUDIOSTREAMSTS enmStatus)
1084{
1085 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1086
1087 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1088 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1089 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
1090 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1091}
1092
1093/**
1094 * Returns @c true if the given stream status indicates a can-be-written-to stream,
1095 * @c false if not.
1096 *
1097 * @returns @c true if ready to be written to, @c if not.
1098 * @param enmStatus Stream status to evaluate.
1099 */
1100bool DrvAudioHlpStreamStatusCanWrite(PDMAUDIOSTREAMSTS enmStatus)
1101{
1102 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1103
1104 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1105 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1106 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PAUSED)
1107 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_DISABLE)
1108 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1109}
1110
1111/**
1112 * Returns @c true if the given stream status indicates a ready-to-operate stream,
1113 * @c false if not.
1114 *
1115 * @returns @c true if ready to operate, @c if not.
1116 * @param enmStatus Stream status to evaluate.
1117 */
1118bool DrvAudioHlpStreamStatusIsReady(PDMAUDIOSTREAMSTS enmStatus)
1119{
1120 AssertReturn(enmStatus & PDMAUDIOSTREAMSTS_VALID_MASK, false);
1121
1122 return enmStatus & PDMAUDIOSTREAMSTS_FLAG_INITIALIZED
1123 && enmStatus & PDMAUDIOSTREAMSTS_FLAG_ENABLED
1124 && !(enmStatus & PDMAUDIOSTREAMSTS_FLAG_PENDING_REINIT);
1125}
1126
1127/**
1128 * Calculates the audio bit rate of the given bits per sample, the Hz and the number
1129 * of audio channels.
1130 *
1131 * Divide the result by 8 to get the byte rate.
1132 *
1133 * @returns The calculated bit rate.
1134 * @param cBits Number of bits per sample.
1135 * @param uHz Hz (Hertz) rate.
1136 * @param cChannels Number of audio channels.
1137 */
1138uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels)
1139{
1140 return (cBits * uHz * cChannels);
1141}
1142
1143/**
1144 * Calculates the audio bit rate out of a given audio stream configuration.
1145 *
1146 * Divide the result by 8 to get the byte rate.
1147 *
1148 * @returns The calculated bit rate.
1149 * @param pProps PCM properties to calculate bitrate for.
1150 *
1151 * @remark
1152 */
1153uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps)
1154{
1155 return DrvAudioHlpCalcBitrate(pProps->cBytes * 8, pProps->uHz, pProps->cChannels);
1156}
1157
1158/**
1159 * Aligns the given byte amount to the given PCM properties and returns the aligned
1160 * size.
1161 *
1162 * @return Aligned size (in bytes).
1163 * @param cbSize Size (in bytes) to align.
1164 * @param pProps PCM properties to align size to.
1165 */
1166uint32_t DrvAudioHlpBytesAlign(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps)
1167{
1168 AssertPtrReturn(pProps, 0);
1169
1170 if (!cbSize)
1171 return 0;
1172
1173 return PDMAUDIOPCMPROPS_B2F(pProps, cbSize) * PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1174}
1175
1176/**
1177 * Returns if the the given size is properly aligned to the given PCM properties.
1178 *
1179 * @return @c true if properly aligned, @c false if not.
1180 * @param cbSize Size (in bytes) to check alignment for.
1181 * @param pProps PCM properties to use for checking the alignment.
1182 */
1183bool DrvAudioHlpBytesIsAligned(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps)
1184{
1185 AssertPtrReturn(pProps, 0);
1186
1187 if (!cbSize)
1188 return true;
1189
1190 return (cbSize % PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) == 0);
1191}
1192
1193/**
1194 * Returns the bytes per second for given PCM properties.
1195 *
1196 * @returns Bytes per second.
1197 * @param pProps PCM properties to retrieve size for.
1198 */
1199DECLINLINE(uint64_t) drvAudioHlpBytesPerSec(const PPDMAUDIOPCMPROPS pProps)
1200{
1201 return PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) * pProps->uHz;
1202}
1203
1204/**
1205 * Returns the number of audio frames for a given amount of bytes.
1206 *
1207 * @return Calculated audio frames for given bytes.
1208 * @param cbBytes Bytes to convert to audio frames.
1209 * @param pProps PCM properties to calulate frames for.
1210 */
1211uint32_t DrvAudioHlpBytesToFrames(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1212{
1213 AssertPtrReturn(pProps, 0);
1214
1215 return PDMAUDIOPCMPROPS_B2F(pProps, cbBytes);
1216}
1217
1218/**
1219 * Returns the time (in ms) for given byte amount and PCM properties.
1220 *
1221 * @return uint64_t Calculated time (in ms).
1222 * @param cbBytes Amount of bytes to calculate time for.
1223 * @param pProps PCM properties to calculate amount of bytes for.
1224 */
1225uint64_t DrvAudioHlpBytesToMilli(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1226{
1227 AssertPtrReturn(pProps, 0);
1228
1229 if (!cbBytes)
1230 return 0;
1231
1232 const double dbBytesPerMs = (double)drvAudioHlpBytesPerSec(pProps) / (double)RT_MS_1SEC;
1233 Assert(dbBytesPerMs >= 0.0f);
1234 if (!dbBytesPerMs) /* Prevent division by zero. */
1235 return 0;
1236
1237 return (double)cbBytes / (double)dbBytesPerMs;
1238}
1239
1240/**
1241 * Returns the time (in ns) for given byte amount and PCM properties.
1242 *
1243 * @return uint64_t Calculated time (in ns).
1244 * @param cbBytes Amount of bytes to calculate time for.
1245 * @param pProps PCM properties to calculate amount of bytes for.
1246 */
1247uint64_t DrvAudioHlpBytesToNano(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps)
1248{
1249 AssertPtrReturn(pProps, 0);
1250
1251 if (!cbBytes)
1252 return 0;
1253
1254 const double dbBytesPerMs = (PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */) * pProps->uHz) / RT_NS_1SEC;
1255 Assert(dbBytesPerMs >= 0.0f);
1256 if (!dbBytesPerMs) /* Prevent division by zero. */
1257 return 0;
1258
1259 return cbBytes / dbBytesPerMs;
1260}
1261
1262/**
1263 * Returns the bytes for a given audio frames amount and PCM properties.
1264 *
1265 * @return Calculated bytes for given audio frames.
1266 * @param cFrames Amount of audio frames to calculate bytes for.
1267 * @param pProps PCM properties to calculate bytes for.
1268 */
1269uint32_t DrvAudioHlpFramesToBytes(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1270{
1271 AssertPtrReturn(pProps, 0);
1272
1273 if (!cFrames)
1274 return 0;
1275
1276 return cFrames * PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1277}
1278
1279/**
1280 * Returns the time (in ms) for given audio frames amount and PCM properties.
1281 *
1282 * @return uint64_t Calculated time (in ms).
1283 * @param cFrames Amount of audio frames to calculate time for.
1284 * @param pProps PCM properties to calculate time (in ms) for.
1285 */
1286uint64_t DrvAudioHlpFramesToMilli(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1287{
1288 AssertPtrReturn(pProps, 0);
1289
1290 if (!cFrames)
1291 return 0;
1292
1293 if (!pProps->uHz) /* Prevent division by zero. */
1294 return 0;
1295
1296 return cFrames / ((double)pProps->uHz / (double)RT_MS_1SEC);
1297}
1298
1299/**
1300 * Returns the time (in ns) for given audio frames amount and PCM properties.
1301 *
1302 * @return uint64_t Calculated time (in ns).
1303 * @param cFrames Amount of audio frames to calculate time for.
1304 * @param pProps PCM properties to calculate time (in ns) for.
1305 */
1306uint64_t DrvAudioHlpFramesToNano(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps)
1307{
1308 AssertPtrReturn(pProps, 0);
1309
1310 if (!cFrames)
1311 return 0;
1312
1313 if (!pProps->uHz) /* Prevent division by zero. */
1314 return 0;
1315
1316 return cFrames / ((double)pProps->uHz / (double)RT_NS_1SEC);
1317}
1318
1319/**
1320 * Returns the amount of bytes for a given time (in ms) and PCM properties.
1321 *
1322 * @return uint32_t Calculated amount of bytes.
1323 * @param uMs Time (in ms) to calculate amount of bytes for.
1324 * @param pProps PCM properties to calculate amount of bytes for.
1325 */
1326uint32_t DrvAudioHlpMilliToBytes(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps)
1327{
1328 AssertPtrReturn(pProps, 0);
1329
1330 if (!uMs)
1331 return 0;
1332
1333 return ((double)drvAudioHlpBytesPerSec(pProps) / (double)RT_MS_1SEC) * uMs;
1334}
1335
1336/**
1337 * Returns the amount of bytes for a given time (in ns) and PCM properties.
1338 *
1339 * @return uint32_t Calculated amount of bytes.
1340 * @param uNs Time (in ns) to calculate amount of bytes for.
1341 * @param pProps PCM properties to calculate amount of bytes for.
1342 */
1343uint32_t DrvAudioHlpNanoToBytes(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps)
1344{
1345 AssertPtrReturn(pProps, 0);
1346
1347 if (!uNs)
1348 return 0;
1349
1350 return ((double)drvAudioHlpBytesPerSec(pProps) / (double)RT_NS_1SEC) * uNs;
1351}
1352
1353/**
1354 * Returns the amount of audio frames for a given time (in ms) and PCM properties.
1355 *
1356 * @return uint32_t Calculated amount of audio frames.
1357 * @param uMs Time (in ms) to calculate amount of frames for.
1358 * @param pProps PCM properties to calculate amount of frames for.
1359 */
1360uint32_t DrvAudioHlpMilliToFrames(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps)
1361{
1362 AssertPtrReturn(pProps, 0);
1363
1364 const uint32_t cbFrame = PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1365 if (!cbFrame) /* Prevent division by zero. */
1366 return 0;
1367
1368 return DrvAudioHlpMilliToBytes(uMs, pProps) / cbFrame;
1369}
1370
1371/**
1372 * Returns the amount of audio frames for a given time (in ns) and PCM properties.
1373 *
1374 * @return uint32_t Calculated amount of audio frames.
1375 * @param uNs Time (in ns) to calculate amount of frames for.
1376 * @param pProps PCM properties to calculate amount of frames for.
1377 */
1378uint32_t DrvAudioHlpNanoToFrames(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps)
1379{
1380 AssertPtrReturn(pProps, 0);
1381
1382 const uint32_t cbFrame = PDMAUDIOPCMPROPS_F2B(pProps, 1 /* Frame */);
1383 if (!cbFrame) /* Prevent division by zero. */
1384 return 0;
1385
1386 return DrvAudioHlpNanoToBytes(uNs, pProps) / cbFrame;
1387}
1388
1389/**
1390 * Sanitizes the file name component so that unsupported characters
1391 * will be replaced by an underscore ("_").
1392 *
1393 * @return IPRT status code.
1394 * @param pszPath Path to sanitize.
1395 * @param cbPath Size (in bytes) of path to sanitize.
1396 */
1397int DrvAudioHlpFileNameSanitize(char *pszPath, size_t cbPath)
1398{
1399 RT_NOREF(cbPath);
1400 int rc = VINF_SUCCESS;
1401#ifdef RT_OS_WINDOWS
1402 /* Filter out characters not allowed on Windows platforms, put in by
1403 RTTimeSpecToString(). */
1404 /** @todo Use something like RTPathSanitize() if available later some time. */
1405 static RTUNICP const s_uszValidRangePairs[] =
1406 {
1407 ' ', ' ',
1408 '(', ')',
1409 '-', '.',
1410 '0', '9',
1411 'A', 'Z',
1412 'a', 'z',
1413 '_', '_',
1414 0xa0, 0xd7af,
1415 '\0'
1416 };
1417 ssize_t cReplaced = RTStrPurgeComplementSet(pszPath, s_uszValidRangePairs, '_' /* Replacement */);
1418 if (cReplaced < 0)
1419 rc = VERR_INVALID_UTF8_ENCODING;
1420#else
1421 RT_NOREF(pszPath);
1422#endif
1423 return rc;
1424}
1425
1426/**
1427 * Constructs an unique file name, based on the given path and the audio file type.
1428 *
1429 * @returns IPRT status code.
1430 * @param pszFile Where to store the constructed file name.
1431 * @param cchFile Size (in characters) of the file name buffer.
1432 * @param pszPath Base path to use.
1433 * @param pszName A name for better identifying the file.
1434 * @param uInstance Device / driver instance which is using this file.
1435 * @param enmType Audio file type to construct file name for.
1436 * @param fFlags File naming flags.
1437 */
1438int DrvAudioHlpFileNameGet(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName,
1439 uint32_t uInstance, PDMAUDIOFILETYPE enmType, PDMAUDIOFILENAMEFLAGS fFlags)
1440{
1441 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1442 AssertReturn(cchFile, VERR_INVALID_PARAMETER);
1443 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1444 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1445 /** @todo Validate fFlags. */
1446
1447 int rc;
1448
1449 do
1450 {
1451 char szFilePath[RTPATH_MAX + 1];
1452 RTStrPrintf2(szFilePath, sizeof(szFilePath), "%s", pszPath);
1453
1454 /* Create it when necessary. */
1455 if (!RTDirExists(szFilePath))
1456 {
1457 rc = RTDirCreateFullPath(szFilePath, RTFS_UNIX_IRWXU);
1458 if (RT_FAILURE(rc))
1459 break;
1460 }
1461
1462 char szFileName[RTPATH_MAX + 1];
1463 szFileName[0] = '\0';
1464
1465 if (fFlags & PDMAUDIOFILENAME_FLAG_TS)
1466 {
1467 RTTIMESPEC time;
1468 if (!RTTimeSpecToString(RTTimeNow(&time), szFileName, sizeof(szFileName)))
1469 {
1470 rc = VERR_BUFFER_OVERFLOW;
1471 break;
1472 }
1473
1474 rc = DrvAudioHlpFileNameSanitize(szFileName, sizeof(szFileName));
1475 if (RT_FAILURE(rc))
1476 break;
1477
1478 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1479 if (RT_FAILURE(rc))
1480 break;
1481 }
1482
1483 rc = RTStrCat(szFileName, sizeof(szFileName), pszName);
1484 if (RT_FAILURE(rc))
1485 break;
1486
1487 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1488 if (RT_FAILURE(rc))
1489 break;
1490
1491 char szInst[16];
1492 RTStrPrintf2(szInst, sizeof(szInst), "%RU32", uInstance);
1493 rc = RTStrCat(szFileName, sizeof(szFileName), szInst);
1494 if (RT_FAILURE(rc))
1495 break;
1496
1497 switch (enmType)
1498 {
1499 case PDMAUDIOFILETYPE_RAW:
1500 rc = RTStrCat(szFileName, sizeof(szFileName), ".pcm");
1501 break;
1502
1503 case PDMAUDIOFILETYPE_WAV:
1504 rc = RTStrCat(szFileName, sizeof(szFileName), ".wav");
1505 break;
1506
1507 default:
1508 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1509 break;
1510 }
1511
1512 if (RT_FAILURE(rc))
1513 break;
1514
1515 rc = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
1516 if (RT_FAILURE(rc))
1517 break;
1518
1519 RTStrPrintf2(pszFile, cchFile, "%s", szFilePath);
1520
1521 } while (0);
1522
1523 LogFlowFuncLeaveRC(rc);
1524 return rc;
1525}
1526
1527/**
1528 * Creates an audio file.
1529 *
1530 * @returns IPRT status code.
1531 * @param enmType Audio file type to open / create.
1532 * @param pszFile File path of file to open or create.
1533 * @param fFlags Audio file flags.
1534 * @param ppFile Where to store the created audio file handle.
1535 * Needs to be destroyed with DrvAudioHlpFileDestroy().
1536 */
1537int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, PDMAUDIOFILEFLAGS fFlags, PPDMAUDIOFILE *ppFile)
1538{
1539 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1540 /** @todo Validate fFlags. */
1541
1542 PPDMAUDIOFILE pFile = (PPDMAUDIOFILE)RTMemAlloc(sizeof(PDMAUDIOFILE));
1543 if (!pFile)
1544 return VERR_NO_MEMORY;
1545
1546 int rc = VINF_SUCCESS;
1547
1548 switch (enmType)
1549 {
1550 case PDMAUDIOFILETYPE_RAW:
1551 case PDMAUDIOFILETYPE_WAV:
1552 pFile->enmType = enmType;
1553 break;
1554
1555 default:
1556 rc = VERR_INVALID_PARAMETER;
1557 break;
1558 }
1559
1560 if (RT_SUCCESS(rc))
1561 {
1562 RTStrPrintf(pFile->szName, RT_ELEMENTS(pFile->szName), "%s", pszFile);
1563 pFile->hFile = NIL_RTFILE;
1564 pFile->fFlags = fFlags;
1565 pFile->pvData = NULL;
1566 pFile->cbData = 0;
1567 }
1568
1569 if (RT_FAILURE(rc))
1570 {
1571 RTMemFree(pFile);
1572 pFile = NULL;
1573 }
1574 else
1575 *ppFile = pFile;
1576
1577 return rc;
1578}
1579
1580/**
1581 * Destroys a formerly created audio file.
1582 *
1583 * @param pFile Audio file (object) to destroy.
1584 */
1585void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile)
1586{
1587 if (!pFile)
1588 return;
1589
1590 DrvAudioHlpFileClose(pFile);
1591
1592 RTMemFree(pFile);
1593 pFile = NULL;
1594}
1595
1596/**
1597 * Opens or creates an audio file.
1598 *
1599 * @returns IPRT status code.
1600 * @param pFile Pointer to audio file handle to use.
1601 * @param fOpen Open flags.
1602 * Use PDMAUDIOFILE_DEFAULT_OPEN_FLAGS for the default open flags.
1603 * @param pProps PCM properties to use.
1604 */
1605int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps)
1606{
1607 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1608 /** @todo Validate fOpen flags. */
1609 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
1610
1611 int rc;
1612
1613 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1614 {
1615 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1616 }
1617 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1618 {
1619 Assert(pProps->cChannels);
1620 Assert(pProps->uHz);
1621 Assert(pProps->cBytes);
1622
1623 pFile->pvData = (PAUDIOWAVFILEDATA)RTMemAllocZ(sizeof(AUDIOWAVFILEDATA));
1624 if (pFile->pvData)
1625 {
1626 pFile->cbData = sizeof(PAUDIOWAVFILEDATA);
1627
1628 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1629 AssertPtr(pData);
1630
1631 /* Header. */
1632 pData->Hdr.u32RIFF = AUDIO_MAKE_FOURCC('R','I','F','F');
1633 pData->Hdr.u32Size = 36;
1634 pData->Hdr.u32WAVE = AUDIO_MAKE_FOURCC('W','A','V','E');
1635
1636 pData->Hdr.u32Fmt = AUDIO_MAKE_FOURCC('f','m','t',' ');
1637 pData->Hdr.u32Size1 = 16; /* Means PCM. */
1638 pData->Hdr.u16AudioFormat = 1; /* PCM, linear quantization. */
1639 pData->Hdr.u16NumChannels = pProps->cChannels;
1640 pData->Hdr.u32SampleRate = pProps->uHz;
1641 pData->Hdr.u32ByteRate = DrvAudioHlpCalcBitrate(pProps) / 8;
1642 pData->Hdr.u16BlockAlign = pProps->cChannels * pProps->cBytes;
1643 pData->Hdr.u16BitsPerSample = pProps->cBytes * 8;
1644
1645 /* Data chunk. */
1646 pData->Hdr.u32ID2 = AUDIO_MAKE_FOURCC('d','a','t','a');
1647 pData->Hdr.u32Size2 = 0;
1648
1649 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1650 if (RT_SUCCESS(rc))
1651 {
1652 rc = RTFileWrite(pFile->hFile, &pData->Hdr, sizeof(pData->Hdr), NULL);
1653 if (RT_FAILURE(rc))
1654 {
1655 RTFileClose(pFile->hFile);
1656 pFile->hFile = NIL_RTFILE;
1657 }
1658 }
1659
1660 if (RT_FAILURE(rc))
1661 {
1662 RTMemFree(pFile->pvData);
1663 pFile->pvData = NULL;
1664 pFile->cbData = 0;
1665 }
1666 }
1667 else
1668 rc = VERR_NO_MEMORY;
1669 }
1670 else
1671 rc = VERR_INVALID_PARAMETER;
1672
1673 if (RT_SUCCESS(rc))
1674 {
1675 LogRel2(("Audio: Opened file '%s'\n", pFile->szName));
1676 }
1677 else
1678 LogRel(("Audio: Failed opening file '%s', rc=%Rrc\n", pFile->szName, rc));
1679
1680 return rc;
1681}
1682
1683/**
1684 * Closes an audio file.
1685 *
1686 * @returns IPRT status code.
1687 * @param pFile Audio file handle to close.
1688 */
1689int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile)
1690{
1691 if (!pFile)
1692 return VINF_SUCCESS;
1693
1694 size_t cbSize = DrvAudioHlpFileGetDataSize(pFile);
1695
1696 int rc = VINF_SUCCESS;
1697
1698 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1699 {
1700 if (RTFileIsValid(pFile->hFile))
1701 rc = RTFileClose(pFile->hFile);
1702 }
1703 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1704 {
1705 if (RTFileIsValid(pFile->hFile))
1706 {
1707 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1708 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1709 {
1710 /* Update the header with the current data size. */
1711 RTFileWriteAt(pFile->hFile, 0, &pData->Hdr, sizeof(pData->Hdr), NULL);
1712 }
1713
1714 rc = RTFileClose(pFile->hFile);
1715 }
1716
1717 if (pFile->pvData)
1718 {
1719 RTMemFree(pFile->pvData);
1720 pFile->pvData = NULL;
1721 }
1722 }
1723 else
1724 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1725
1726 if ( RT_SUCCESS(rc)
1727 && !cbSize
1728 && !(pFile->fFlags & PDMAUDIOFILE_FLAG_KEEP_IF_EMPTY))
1729 {
1730 rc = DrvAudioHlpFileDelete(pFile);
1731 }
1732
1733 pFile->cbData = 0;
1734
1735 if (RT_SUCCESS(rc))
1736 {
1737 pFile->hFile = NIL_RTFILE;
1738 LogRel2(("Audio: Closed file '%s' (%zu bytes)\n", pFile->szName, cbSize));
1739 }
1740 else
1741 LogRel(("Audio: Failed closing file '%s', rc=%Rrc\n", pFile->szName, rc));
1742
1743 return rc;
1744}
1745
1746/**
1747 * Deletes an audio file.
1748 *
1749 * @returns IPRT status code.
1750 * @param pFile Audio file handle to delete.
1751 */
1752int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile)
1753{
1754 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1755
1756 int rc = RTFileDelete(pFile->szName);
1757 if (RT_SUCCESS(rc))
1758 {
1759 LogRel2(("Audio: Deleted file '%s'\n", pFile->szName));
1760 }
1761 else if (rc == VERR_FILE_NOT_FOUND) /* Don't bitch if the file is not around (anymore). */
1762 rc = VINF_SUCCESS;
1763
1764 if (RT_FAILURE(rc))
1765 LogRel(("Audio: Failed deleting file '%s', rc=%Rrc\n", pFile->szName, rc));
1766
1767 return rc;
1768}
1769
1770/**
1771 * Returns the raw audio data size of an audio file.
1772 *
1773 * Note: This does *not* include file headers and other data which does
1774 * not belong to the actual PCM audio data.
1775 *
1776 * @returns Size (in bytes) of the raw PCM audio data.
1777 * @param pFile Audio file handle to retrieve the audio data size for.
1778 */
1779size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile)
1780{
1781 AssertPtrReturn(pFile, 0);
1782
1783 size_t cbSize = 0;
1784
1785 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1786 {
1787 cbSize = RTFileTell(pFile->hFile);
1788 }
1789 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1790 {
1791 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1792 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1793 cbSize = pData->Hdr.u32Size2;
1794 }
1795
1796 return cbSize;
1797}
1798
1799/**
1800 * Returns whether the given audio file is open and in use or not.
1801 *
1802 * @return bool True if open, false if not.
1803 * @param pFile Audio file handle to check open status for.
1804 */
1805bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile)
1806{
1807 if (!pFile)
1808 return false;
1809
1810 return RTFileIsValid(pFile->hFile);
1811}
1812
1813/**
1814 * Write PCM data to a wave (.WAV) file.
1815 *
1816 * @returns IPRT status code.
1817 * @param pFile Audio file handle to write PCM data to.
1818 * @param pvBuf Audio data to write.
1819 * @param cbBuf Size (in bytes) of audio data to write.
1820 * @param fFlags Additional write flags. Not being used at the moment and must be 0.
1821 */
1822int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags)
1823{
1824 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1825 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1826
1827 AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER); /** @todo fFlags are currently not implemented. */
1828
1829 if (!cbBuf)
1830 return VINF_SUCCESS;
1831
1832 AssertReturn(RTFileIsValid(pFile->hFile), VERR_WRONG_ORDER);
1833
1834 int rc;
1835
1836 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1837 {
1838 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1839 }
1840 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1841 {
1842 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1843 AssertPtr(pData);
1844
1845 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1846 if (RT_SUCCESS(rc))
1847 {
1848 pData->Hdr.u32Size += (uint32_t)cbBuf;
1849 pData->Hdr.u32Size2 += (uint32_t)cbBuf;
1850 }
1851 }
1852 else
1853 rc = VERR_NOT_SUPPORTED;
1854
1855 return rc;
1856}
1857
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