VirtualBox

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

Last change on this file since 73156 was 73059, checked in by vboxsync, 7 years ago

Build fix.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 45.2 KB
Line 
1/* $Id: DrvAudioCommon.cpp 73059 2018-07-11 10:16:05Z 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 samples.
123 *
124 * @return IPRT status code.
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 cSamples Number of audio samples to clear in the buffer.
129 */
130void DrvAudioHlpClearBuf(const PPDMAUDIOPCMPROPS pPCMProps, void *pvBuf, size_t cbBuf, uint32_t cSamples)
131{
132 AssertPtrReturnVoid(pPCMProps);
133 AssertPtrReturnVoid(pvBuf);
134
135 if (!cbBuf || !cSamples)
136 return;
137
138 Assert(pPCMProps->cBits);
139 size_t cbToClear = cSamples * (pPCMProps->cBits / 8 /* Bytes */);
140 Assert(cbBuf >= cbToClear);
141
142 if (cbBuf < cbToClear)
143 cbToClear = cbBuf;
144
145 Log2Func(("pPCMProps=%p, pvBuf=%p, cSamples=%RU32, fSigned=%RTbool, cBits=%RU8\n",
146 pPCMProps, pvBuf, cSamples, pPCMProps->fSigned, pPCMProps->cBits));
147
148 if (pPCMProps->fSigned)
149 {
150 RT_BZERO(pvBuf, cbToClear);
151 }
152 else
153 {
154 switch (pPCMProps->cBits)
155 {
156 case 8:
157 {
158 memset(pvBuf, 0x80, cbToClear);
159 break;
160 }
161
162 case 16:
163 {
164 uint16_t *p = (uint16_t *)pvBuf;
165 int16_t s = INT16_MAX;
166
167 if (pPCMProps->fSwapEndian)
168 s = RT_BSWAP_U16(s);
169
170 for (uint32_t i = 0; i < cSamples; i++)
171 p[i] = s;
172
173 break;
174 }
175
176 case 32:
177 {
178 uint32_t *p = (uint32_t *)pvBuf;
179 int32_t s = INT32_MAX;
180
181 if (pPCMProps->fSwapEndian)
182 s = RT_BSWAP_U32(s);
183
184 for (uint32_t i = 0; i < cSamples; i++)
185 p[i] = s;
186
187 break;
188 }
189
190 default:
191 {
192 AssertMsgFailed(("Invalid bits: %RU8\n", pPCMProps->cBits));
193 break;
194 }
195 }
196 }
197}
198
199/**
200 * Returns an unique file name for this given audio connector instance.
201 *
202 * @return Allocated file name. Must be free'd using RTStrFree().
203 * @param uInstance Driver / device instance.
204 * @param pszPath Path name of the file to delete. The path must exist.
205 * @param pszSuffix File name suffix to use.
206 */
207char *DrvAudioDbgGetFileNameA(uint8_t uInstance, const char *pszPath, const char *pszSuffix)
208{
209 char szFileName[64];
210 RTStrPrintf(szFileName, sizeof(szFileName), "drvAudio%RU8-%s", uInstance, pszSuffix);
211
212 char szFilePath[RTPATH_MAX];
213 int rc2 = RTStrCopy(szFilePath, sizeof(szFilePath), pszPath);
214 AssertRC(rc2);
215 rc2 = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
216 AssertRC(rc2);
217
218 return RTStrDup(szFilePath);
219}
220
221/**
222 * Allocates an audio device.
223 *
224 * @returns Newly allocated audio device, or NULL if failed.
225 * @param cbData How much additional data (in bytes) should be allocated to provide
226 * a (backend) specific area to store additional data.
227 * Optional, can be 0.
228 */
229PPDMAUDIODEVICE DrvAudioHlpDeviceAlloc(size_t cbData)
230{
231 PPDMAUDIODEVICE pDev = (PPDMAUDIODEVICE)RTMemAllocZ(sizeof(PDMAUDIODEVICE));
232 if (!pDev)
233 return NULL;
234
235 if (cbData)
236 {
237 pDev->pvData = RTMemAllocZ(cbData);
238 if (!pDev->pvData)
239 {
240 RTMemFree(pDev);
241 return NULL;
242 }
243 }
244
245 pDev->cbData = cbData;
246
247 pDev->cMaxInputChannels = 0;
248 pDev->cMaxOutputChannels = 0;
249
250 return pDev;
251}
252
253/**
254 * Frees an audio device.
255 *
256 * @param pDev Device to free.
257 */
258void DrvAudioHlpDeviceFree(PPDMAUDIODEVICE pDev)
259{
260 if (!pDev)
261 return;
262
263 Assert(pDev->cRefCount == 0);
264
265 if (pDev->pvData)
266 {
267 Assert(pDev->cbData);
268
269 RTMemFree(pDev->pvData);
270 pDev->pvData = NULL;
271 }
272
273 RTMemFree(pDev);
274 pDev = NULL;
275}
276
277/**
278 * Duplicates an audio device entry.
279 *
280 * @returns Duplicated audio device entry on success, or NULL on failure.
281 * @param pDev Audio device entry to duplicate.
282 * @param fCopyUserData Whether to also copy the user data portion or not.
283 */
284PPDMAUDIODEVICE DrvAudioHlpDeviceDup(const PPDMAUDIODEVICE pDev, bool fCopyUserData)
285{
286 AssertPtrReturn(pDev, NULL);
287
288 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceAlloc(fCopyUserData ? pDev->cbData : 0);
289 if (pDevDup)
290 {
291 memcpy(pDevDup, pDev, sizeof(PDMAUDIODEVICE));
292
293 if ( fCopyUserData
294 && pDevDup->cbData)
295 {
296 memcpy(pDevDup->pvData, pDev->pvData, pDevDup->cbData);
297 }
298 else
299 {
300 pDevDup->cbData = 0;
301 pDevDup->pvData = NULL;
302 }
303 }
304
305 return pDevDup;
306}
307
308/**
309 * Initializes an audio device enumeration structure.
310 *
311 * @returns IPRT status code.
312 * @param pDevEnm Device enumeration to initialize.
313 */
314int DrvAudioHlpDeviceEnumInit(PPDMAUDIODEVICEENUM pDevEnm)
315{
316 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
317
318 RTListInit(&pDevEnm->lstDevices);
319 pDevEnm->cDevices = 0;
320
321 return VINF_SUCCESS;
322}
323
324/**
325 * Frees audio device enumeration data.
326 *
327 * @param pDevEnm Device enumeration to destroy.
328 */
329void DrvAudioHlpDeviceEnumFree(PPDMAUDIODEVICEENUM pDevEnm)
330{
331 if (!pDevEnm)
332 return;
333
334 PPDMAUDIODEVICE pDev, pDevNext;
335 RTListForEachSafe(&pDevEnm->lstDevices, pDev, pDevNext, PDMAUDIODEVICE, Node)
336 {
337 RTListNodeRemove(&pDev->Node);
338
339 DrvAudioHlpDeviceFree(pDev);
340
341 pDevEnm->cDevices--;
342 }
343
344 /* Sanity. */
345 Assert(RTListIsEmpty(&pDevEnm->lstDevices));
346 Assert(pDevEnm->cDevices == 0);
347}
348
349/**
350 * Adds an audio device to a device enumeration.
351 *
352 * @return IPRT status code.
353 * @param pDevEnm Device enumeration to add device to.
354 * @param pDev Device to add. The pointer will be owned by the device enumeration then.
355 */
356int DrvAudioHlpDeviceEnumAdd(PPDMAUDIODEVICEENUM pDevEnm, PPDMAUDIODEVICE pDev)
357{
358 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
359 AssertPtrReturn(pDev, VERR_INVALID_POINTER);
360
361 RTListAppend(&pDevEnm->lstDevices, &pDev->Node);
362 pDevEnm->cDevices++;
363
364 return VINF_SUCCESS;
365}
366
367/**
368 * Duplicates a device enumeration.
369 *
370 * @returns Duplicated device enumeration, or NULL on failure.
371 * Must be free'd with DrvAudioHlpDeviceEnumFree().
372 * @param pDevEnm Device enumeration to duplicate.
373 */
374PPDMAUDIODEVICEENUM DrvAudioHlpDeviceEnumDup(const PPDMAUDIODEVICEENUM pDevEnm)
375{
376 AssertPtrReturn(pDevEnm, NULL);
377
378 PPDMAUDIODEVICEENUM pDevEnmDup = (PPDMAUDIODEVICEENUM)RTMemAlloc(sizeof(PDMAUDIODEVICEENUM));
379 if (!pDevEnmDup)
380 return NULL;
381
382 int rc2 = DrvAudioHlpDeviceEnumInit(pDevEnmDup);
383 AssertRC(rc2);
384
385 PPDMAUDIODEVICE pDev;
386 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
387 {
388 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceDup(pDev, true /* fCopyUserData */);
389 if (!pDevDup)
390 {
391 rc2 = VERR_NO_MEMORY;
392 break;
393 }
394
395 rc2 = DrvAudioHlpDeviceEnumAdd(pDevEnmDup, pDevDup);
396 if (RT_FAILURE(rc2))
397 {
398 DrvAudioHlpDeviceFree(pDevDup);
399 break;
400 }
401 }
402
403 if (RT_FAILURE(rc2))
404 {
405 DrvAudioHlpDeviceEnumFree(pDevEnmDup);
406 pDevEnmDup = NULL;
407 }
408
409 return pDevEnmDup;
410}
411
412/**
413 * Copies device enumeration entries from the source to the destination enumeration.
414 *
415 * @returns IPRT status code.
416 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
417 * @param pSrcDevEnm Source enumeration to use.
418 * @param enmUsage Which entries to copy. Specify PDMAUDIODIR_ANY to copy all entries.
419 * @param fCopyUserData Whether to also copy the user data portion or not.
420 */
421int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm,
422 PDMAUDIODIR enmUsage, bool fCopyUserData)
423{
424 AssertPtrReturn(pDstDevEnm, VERR_INVALID_POINTER);
425 AssertPtrReturn(pSrcDevEnm, VERR_INVALID_POINTER);
426
427 int rc = VINF_SUCCESS;
428
429 PPDMAUDIODEVICE pSrcDev;
430 RTListForEach(&pSrcDevEnm->lstDevices, pSrcDev, PDMAUDIODEVICE, Node)
431 {
432 if ( enmUsage != PDMAUDIODIR_ANY
433 && enmUsage != pSrcDev->enmUsage)
434 {
435 continue;
436 }
437
438 PPDMAUDIODEVICE pDstDev = DrvAudioHlpDeviceDup(pSrcDev, fCopyUserData);
439 if (!pDstDev)
440 {
441 rc = VERR_NO_MEMORY;
442 break;
443 }
444
445 rc = DrvAudioHlpDeviceEnumAdd(pDstDevEnm, pDstDev);
446 if (RT_FAILURE(rc))
447 break;
448 }
449
450 return rc;
451}
452
453/**
454 * Copies all device enumeration entries from the source to the destination enumeration.
455 *
456 * Note: Does *not* copy the user-specific data assigned to a device enumeration entry.
457 * To do so, use DrvAudioHlpDeviceEnumCopyEx().
458 *
459 * @returns IPRT status code.
460 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
461 * @param pSrcDevEnm Source enumeration to use.
462 */
463int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm)
464{
465 return DrvAudioHlpDeviceEnumCopyEx(pDstDevEnm, pSrcDevEnm, PDMAUDIODIR_ANY, false /* fCopyUserData */);
466}
467
468/**
469 * Returns the default device of a given device enumeration.
470 * This assumes that only one default device per usage is set.
471 *
472 * @returns Default device if found, or NULL if none found.
473 * @param pDevEnm Device enumeration to get default device for.
474 * @param enmUsage Usage to get default device for.
475 */
476PPDMAUDIODEVICE DrvAudioHlpDeviceEnumGetDefaultDevice(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage)
477{
478 AssertPtrReturn(pDevEnm, NULL);
479
480 PPDMAUDIODEVICE pDev;
481 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
482 {
483 if (enmUsage != PDMAUDIODIR_ANY)
484 {
485 if (enmUsage != pDev->enmUsage) /* Wrong usage? Skip. */
486 continue;
487 }
488
489 if (pDev->fFlags & PDMAUDIODEV_FLAGS_DEFAULT)
490 return pDev;
491 }
492
493 return NULL;
494}
495
496/**
497 * Logs an audio device enumeration.
498 *
499 * @param pszDesc Logging description.
500 * @param pDevEnm Device enumeration to log.
501 */
502void DrvAudioHlpDeviceEnumPrint(const char *pszDesc, const PPDMAUDIODEVICEENUM pDevEnm)
503{
504 AssertPtrReturnVoid(pszDesc);
505 AssertPtrReturnVoid(pDevEnm);
506
507 LogFunc(("%s: %RU16 devices\n", pszDesc, pDevEnm->cDevices));
508
509 PPDMAUDIODEVICE pDev;
510 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
511 {
512 char *pszFlags = DrvAudioHlpAudDevFlagsToStrA(pDev->fFlags);
513
514 LogFunc(("Device '%s':\n", pDev->szName));
515 LogFunc(("\tUsage = %s\n", DrvAudioHlpAudDirToStr(pDev->enmUsage)));
516 LogFunc(("\tFlags = %s\n", pszFlags ? pszFlags : "<NONE>"));
517 LogFunc(("\tInput channels = %RU8\n", pDev->cMaxInputChannels));
518 LogFunc(("\tOutput channels = %RU8\n", pDev->cMaxOutputChannels));
519 LogFunc(("\tData = %p (%zu bytes)\n", pDev->pvData, pDev->cbData));
520
521 if (pszFlags)
522 RTStrFree(pszFlags);
523 }
524}
525
526/**
527 * Converts an audio direction to a string.
528 *
529 * @returns Stringified audio direction, or "Unknown", if not found.
530 * @param enmDir Audio direction to convert.
531 */
532const char *DrvAudioHlpAudDirToStr(PDMAUDIODIR enmDir)
533{
534 switch (enmDir)
535 {
536 case PDMAUDIODIR_UNKNOWN: return "Unknown";
537 case PDMAUDIODIR_IN: return "Input";
538 case PDMAUDIODIR_OUT: return "Output";
539 case PDMAUDIODIR_ANY: return "Duplex";
540 default: break;
541 }
542
543 AssertMsgFailed(("Invalid audio direction %ld\n", enmDir));
544 return "Unknown";
545}
546
547/**
548 * Converts an audio mixer control to a string.
549 *
550 * @returns Stringified audio mixer control or "Unknown", if not found.
551 * @param enmMixerCtl Audio mixer control to convert.
552 */
553const char *DrvAudioHlpAudMixerCtlToStr(PDMAUDIOMIXERCTL enmMixerCtl)
554{
555 switch (enmMixerCtl)
556 {
557 case PDMAUDIOMIXERCTL_VOLUME_MASTER: return "Master Volume";
558 case PDMAUDIOMIXERCTL_FRONT: return "Front";
559 case PDMAUDIOMIXERCTL_CENTER_LFE: return "Center / LFE";
560 case PDMAUDIOMIXERCTL_REAR: return "Rear";
561 case PDMAUDIOMIXERCTL_LINE_IN: return "Line-In";
562 case PDMAUDIOMIXERCTL_MIC_IN: return "Microphone-In";
563 default: break;
564 }
565
566 AssertMsgFailed(("Invalid mixer control %ld\n", enmMixerCtl));
567 return "Unknown";
568}
569
570/**
571 * Converts an audio device flags to a string.
572 *
573 * @returns Stringified audio flags. Must be free'd with RTStrFree().
574 * NULL if no flags set.
575 * @param fFlags Audio flags to convert.
576 */
577char *DrvAudioHlpAudDevFlagsToStrA(PDMAUDIODEVFLAG fFlags)
578{
579#define APPEND_FLAG_TO_STR(_aFlag) \
580 if (fFlags & PDMAUDIODEV_FLAGS_##_aFlag) \
581 { \
582 if (pszFlags) \
583 { \
584 rc2 = RTStrAAppend(&pszFlags, " "); \
585 if (RT_FAILURE(rc2)) \
586 break; \
587 } \
588 \
589 rc2 = RTStrAAppend(&pszFlags, #_aFlag); \
590 if (RT_FAILURE(rc2)) \
591 break; \
592 } \
593
594 char *pszFlags = NULL;
595 int rc2 = VINF_SUCCESS;
596
597 do
598 {
599 APPEND_FLAG_TO_STR(DEFAULT);
600 APPEND_FLAG_TO_STR(HOTPLUG);
601 APPEND_FLAG_TO_STR(BUGGY);
602 APPEND_FLAG_TO_STR(IGNORE);
603 APPEND_FLAG_TO_STR(LOCKED);
604 APPEND_FLAG_TO_STR(DEAD);
605
606 } while (0);
607
608 if (!pszFlags)
609 rc2 = RTStrAAppend(&pszFlags, "NONE");
610
611 if ( RT_FAILURE(rc2)
612 && pszFlags)
613 {
614 RTStrFree(pszFlags);
615 pszFlags = NULL;
616 }
617
618#undef APPEND_FLAG_TO_STR
619
620 return pszFlags;
621}
622
623/**
624 * Converts a playback destination enumeration to a string.
625 *
626 * @returns Stringified playback destination, or "Unknown", if not found.
627 * @param enmPlaybackDst Playback destination to convert.
628 */
629const char *DrvAudioHlpPlaybackDstToStr(const PDMAUDIOPLAYBACKDEST enmPlaybackDst)
630{
631 switch (enmPlaybackDst)
632 {
633 case PDMAUDIOPLAYBACKDEST_UNKNOWN: return "Unknown";
634 case PDMAUDIOPLAYBACKDEST_FRONT: return "Front";
635 case PDMAUDIOPLAYBACKDEST_CENTER_LFE: return "Center / LFE";
636 case PDMAUDIOPLAYBACKDEST_REAR: return "Rear";
637 default:
638 break;
639 }
640
641 AssertMsgFailed(("Invalid playback destination %ld\n", enmPlaybackDst));
642 return "Unknown";
643}
644
645/**
646 * Converts a recording source enumeration to a string.
647 *
648 * @returns Stringified recording source, or "Unknown", if not found.
649 * @param enmRecSrc Recording source to convert.
650 */
651const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSOURCE enmRecSrc)
652{
653 switch (enmRecSrc)
654 {
655 case PDMAUDIORECSOURCE_UNKNOWN: return "Unknown";
656 case PDMAUDIORECSOURCE_MIC: return "Microphone In";
657 case PDMAUDIORECSOURCE_CD: return "CD";
658 case PDMAUDIORECSOURCE_VIDEO: return "Video";
659 case PDMAUDIORECSOURCE_AUX: return "AUX";
660 case PDMAUDIORECSOURCE_LINE: return "Line In";
661 case PDMAUDIORECSOURCE_PHONE: return "Phone";
662 default:
663 break;
664 }
665
666 AssertMsgFailed(("Invalid recording source %ld\n", enmRecSrc));
667 return "Unknown";
668}
669
670/**
671 * Returns wether the given audio format has signed bits or not.
672 *
673 * @return IPRT status code.
674 * @return bool @c true for signed bits, @c false for unsigned.
675 * @param enmFmt Audio format to retrieve value for.
676 */
677bool DrvAudioHlpAudFmtIsSigned(PDMAUDIOFMT enmFmt)
678{
679 switch (enmFmt)
680 {
681 case PDMAUDIOFMT_S8:
682 case PDMAUDIOFMT_S16:
683 case PDMAUDIOFMT_S32:
684 return true;
685
686 case PDMAUDIOFMT_U8:
687 case PDMAUDIOFMT_U16:
688 case PDMAUDIOFMT_U32:
689 return false;
690
691 default:
692 break;
693 }
694
695 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
696 return false;
697}
698
699/**
700 * Returns the bits of a given audio format.
701 *
702 * @return IPRT status code.
703 * @return uint8_t Bits of audio format.
704 * @param enmFmt Audio format to retrieve value for.
705 */
706uint8_t DrvAudioHlpAudFmtToBits(PDMAUDIOFMT enmFmt)
707{
708 switch (enmFmt)
709 {
710 case PDMAUDIOFMT_S8:
711 case PDMAUDIOFMT_U8:
712 return 8;
713
714 case PDMAUDIOFMT_U16:
715 case PDMAUDIOFMT_S16:
716 return 16;
717
718 case PDMAUDIOFMT_U32:
719 case PDMAUDIOFMT_S32:
720 return 32;
721
722 default:
723 break;
724 }
725
726 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
727 return 0;
728}
729
730/**
731 * Converts an audio format to a string.
732 *
733 * @returns Stringified audio format, or "Unknown", if not found.
734 * @param enmFmt Audio format to convert.
735 */
736const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt)
737{
738 switch (enmFmt)
739 {
740 case PDMAUDIOFMT_U8:
741 return "U8";
742
743 case PDMAUDIOFMT_U16:
744 return "U16";
745
746 case PDMAUDIOFMT_U32:
747 return "U32";
748
749 case PDMAUDIOFMT_S8:
750 return "S8";
751
752 case PDMAUDIOFMT_S16:
753 return "S16";
754
755 case PDMAUDIOFMT_S32:
756 return "S32";
757
758 default:
759 break;
760 }
761
762 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
763 return "Unknown";
764}
765
766/**
767 * Converts a given string to an audio format.
768 *
769 * @returns Audio format for the given string, or PDMAUDIOFMT_INVALID if not found.
770 * @param pszFmt String to convert to an audio format.
771 */
772PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt)
773{
774 AssertPtrReturn(pszFmt, PDMAUDIOFMT_INVALID);
775
776 if (!RTStrICmp(pszFmt, "u8"))
777 return PDMAUDIOFMT_U8;
778 else if (!RTStrICmp(pszFmt, "u16"))
779 return PDMAUDIOFMT_U16;
780 else if (!RTStrICmp(pszFmt, "u32"))
781 return PDMAUDIOFMT_U32;
782 else if (!RTStrICmp(pszFmt, "s8"))
783 return PDMAUDIOFMT_S8;
784 else if (!RTStrICmp(pszFmt, "s16"))
785 return PDMAUDIOFMT_S16;
786 else if (!RTStrICmp(pszFmt, "s32"))
787 return PDMAUDIOFMT_S32;
788
789 AssertMsgFailed(("Invalid audio format '%s'\n", pszFmt));
790 return PDMAUDIOFMT_INVALID;
791}
792
793/**
794 * Checks whether two given PCM properties are equal.
795 *
796 * @returns @c true if equal, @c false if not.
797 * @param pProps1 First properties to compare.
798 * @param pProps2 Second properties to compare.
799 */
800bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps1, const PPDMAUDIOPCMPROPS pProps2)
801{
802 AssertPtrReturn(pProps1, false);
803 AssertPtrReturn(pProps2, false);
804
805 if (pProps1 == pProps2) /* If the pointers match, take a shortcut. */
806 return true;
807
808 return pProps1->uHz == pProps2->uHz
809 && pProps1->cChannels == pProps2->cChannels
810 && pProps1->cBits == pProps2->cBits
811 && pProps1->fSigned == pProps2->fSigned
812 && pProps1->fSwapEndian == pProps2->fSwapEndian;
813}
814
815/**
816 * Checks whether given PCM properties are valid or not.
817 *
818 * Returns @c true if properties are valid, @c false if not.
819 * @param pProps PCM properties to check.
820 */
821bool DrvAudioHlpPCMPropsAreValid(const PPDMAUDIOPCMPROPS pProps)
822{
823 AssertPtrReturn(pProps, false);
824
825 /* Minimum 1 channel (mono), maximum 7.1 (= 8) channels. */
826 bool fValid = ( pProps->cChannels >= 1
827 && pProps->cChannels <= 8);
828
829 if (fValid)
830 {
831 switch (pProps->cBits)
832 {
833 case 8:
834 case 16:
835 /** @todo Do we need support for 24-bit samples? */
836 case 32:
837 break;
838 default:
839 fValid = false;
840 break;
841 }
842 }
843
844 if (!fValid)
845 return false;
846
847 fValid &= pProps->uHz > 0;
848 fValid &= pProps->cShift == PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(pProps->cBits, pProps->cChannels);
849 fValid &= pProps->fSwapEndian == false; /** @todo Handling Big Endian audio data is not supported yet. */
850
851 return fValid;
852}
853
854/**
855 * Checks whether the given PCM properties are equal with the given
856 * stream configuration.
857 *
858 * @returns @c true if equal, @c false if not.
859 * @param pProps PCM properties to compare.
860 * @param pCfg Stream configuration to compare.
861 */
862bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps, const PPDMAUDIOSTREAMCFG pCfg)
863{
864 AssertPtrReturn(pProps, false);
865 AssertPtrReturn(pCfg, false);
866
867 return DrvAudioHlpPCMPropsAreEqual(pProps, &pCfg->Props);
868}
869
870/**
871 * Prints PCM properties to the debug log.
872 *
873 * @param pProps Stream configuration to log.
874 */
875void DrvAudioHlpPCMPropsPrint(const PPDMAUDIOPCMPROPS pProps)
876{
877 AssertPtrReturnVoid(pProps);
878
879 Log(("uHz=%RU32, cChannels=%RU8, cBits=%RU8%s",
880 pProps->uHz, pProps->cChannels, pProps->cBits, pProps->fSigned ? "S" : "U"));
881}
882
883/**
884 * Converts PCM properties to a audio stream configuration.
885 *
886 * @return IPRT status code.
887 * @param pProps Pointer to PCM properties to convert.
888 * @param pCfg Pointer to audio stream configuration to store result into.
889 */
890int DrvAudioHlpPCMPropsToStreamCfg(const PPDMAUDIOPCMPROPS pProps, PPDMAUDIOSTREAMCFG pCfg)
891{
892 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
893 AssertPtrReturn(pCfg, VERR_INVALID_POINTER);
894
895 memcpy(&pCfg->Props, pProps, sizeof(PDMAUDIOPCMPROPS));
896 return VINF_SUCCESS;
897}
898
899/**
900 * Checks whether a given stream configuration is valid or not.
901 *
902 * Returns @c true if configuration is valid, @c false if not.
903 * @param pCfg Stream configuration to check.
904 */
905bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg)
906{
907 AssertPtrReturn(pCfg, false);
908
909 bool fValid = ( pCfg->enmDir == PDMAUDIODIR_IN
910 || pCfg->enmDir == PDMAUDIODIR_OUT);
911
912 fValid &= ( pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED
913 || pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
914
915 if (fValid)
916 fValid = DrvAudioHlpPCMPropsAreValid(&pCfg->Props);
917
918 return fValid;
919}
920
921/**
922 * Frees an allocated audio stream configuration.
923 *
924 * @param pCfg Audio stream configuration to free.
925 */
926void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg)
927{
928 if (pCfg)
929 {
930 RTMemFree(pCfg);
931 pCfg = NULL;
932 }
933}
934
935/**
936 * Copies a source stream configuration to a destination stream configuration.
937 *
938 * @returns IPRT status code.
939 * @param pDstCfg Destination stream configuration to copy source to.
940 * @param pSrcCfg Source stream configuration to copy to destination.
941 */
942int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg)
943{
944 AssertPtrReturn(pDstCfg, VERR_INVALID_POINTER);
945 AssertPtrReturn(pSrcCfg, VERR_INVALID_POINTER);
946
947#ifdef VBOX_STRICT
948 if (!DrvAudioHlpStreamCfgIsValid(pSrcCfg))
949 {
950 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pSrcCfg->szName, pSrcCfg));
951 return VERR_INVALID_PARAMETER;
952 }
953#endif
954
955 memcpy(pDstCfg, pSrcCfg, sizeof(PDMAUDIOSTREAMCFG));
956
957 return VINF_SUCCESS;
958}
959
960/**
961 * Duplicates an audio stream configuration.
962 * Must be free'd with DrvAudioHlpStreamCfgFree().
963 *
964 * @return Duplicates audio stream configuration on success, or NULL on failure.
965 * @param pCfg Audio stream configuration to duplicate.
966 */
967PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg)
968{
969 AssertPtrReturn(pCfg, NULL);
970
971 PPDMAUDIOSTREAMCFG pDst = (PPDMAUDIOSTREAMCFG)RTMemAllocZ(sizeof(PDMAUDIOSTREAMCFG));
972 if (!pDst)
973 return NULL;
974
975 int rc2 = DrvAudioHlpStreamCfgCopy(pDst, pCfg);
976 if (RT_FAILURE(rc2))
977 {
978 DrvAudioHlpStreamCfgFree(pDst);
979 pDst = NULL;
980 }
981
982 AssertPtr(pDst);
983 return pDst;
984}
985
986/**
987 * Prints an audio stream configuration to the debug log.
988 *
989 * @param pCfg Stream configuration to log.
990 */
991void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg)
992{
993 if (!pCfg)
994 return;
995
996 LogFunc(("szName=%s, enmDir=%RU32 (uHz=%RU32, cBits=%RU8%s, cChannels=%RU8)\n",
997 pCfg->szName, pCfg->enmDir,
998 pCfg->Props.uHz, pCfg->Props.cBits, pCfg->Props.fSigned ? "S" : "U", pCfg->Props.cChannels));
999}
1000
1001/**
1002 * Converts a stream command to a string.
1003 *
1004 * @returns Stringified stream command, or "Unknown", if not found.
1005 * @param enmCmd Stream command to convert.
1006 */
1007const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd)
1008{
1009 switch (enmCmd)
1010 {
1011 case PDMAUDIOSTREAMCMD_UNKNOWN: return "Unknown";
1012 case PDMAUDIOSTREAMCMD_ENABLE: return "Enable";
1013 case PDMAUDIOSTREAMCMD_DISABLE: return "Disable";
1014 case PDMAUDIOSTREAMCMD_PAUSE: return "Pause";
1015 case PDMAUDIOSTREAMCMD_RESUME: return "Resume";
1016 default: break;
1017 }
1018
1019 AssertMsgFailed(("Invalid stream command %ld\n", enmCmd));
1020 return "Unknown";
1021}
1022
1023/**
1024 * Calculates the audio bit rate of the given bits per sample, the Hz and the number
1025 * of audio channels.
1026 *
1027 * Divide the result by 8 to get the byte rate.
1028 *
1029 * @returns The calculated bit rate.
1030 * @param cBits Number of bits per sample.
1031 * @param uHz Hz (Hertz) rate.
1032 * @param cChannels Number of audio channels.
1033 */
1034uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels)
1035{
1036 return (cBits * uHz * cChannels);
1037}
1038
1039/**
1040 * Calculates the audio bit rate out of a given audio stream configuration.
1041 *
1042 * Divide the result by 8 to get the byte rate.
1043 *
1044 * @returns The calculated bit rate.
1045 * @param pProps PCM properties to calculate bitrate for.
1046 *
1047 * @remark
1048 */
1049uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps)
1050{
1051 return DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels);
1052}
1053
1054/**
1055 * Returns the time (in ms) for given byte amount and PCM properties.
1056 *
1057 * @return uint64_t Calculated time (in ms).
1058 * @param pProps PCM properties to calculate amount of bytes for.
1059 * @param cbBytes Amount of bytes to calculate time for.
1060 */
1061uint64_t DrvAudioHlpBytesToMs(const PPDMAUDIOPCMPROPS pProps, size_t cbBytes)
1062{
1063 AssertPtrReturn(pProps, 0);
1064
1065 if (!cbBytes)
1066 return 0;
1067
1068 const float dbBytesPerMs = ((pProps->cBits / 8) * pProps->cChannels * pProps->uHz) / 1000;
1069 Assert(dbBytesPerMs >= 0.0f);
1070 if (!dbBytesPerMs) /* Prevent division by zero. */
1071 return 0;
1072
1073 return cbBytes / dbBytesPerMs;
1074}
1075
1076/**
1077 * Returns the time (in ms) for given audio frames amount and PCM properties.
1078 *
1079 * @return float Calculated time (in ms).
1080 * @param pProps PCM properties to calculate time (in ms) for.
1081 * @param cFrames Amount of audio frames to calculate time for.
1082 */
1083float DrvAudioHlpFramesToMs(const PPDMAUDIOPCMPROPS pProps, size_t cFrames)
1084{
1085 AssertPtrReturn(pProps, 0);
1086
1087 if (!cFrames)
1088 return 0;
1089
1090 if (!pProps->uHz) /* Prevent division by zero. */
1091 return 0;
1092
1093 return float(cFrames / (pProps->uHz / 1000 /* ms */));
1094}
1095
1096/**
1097 * Returns the amount of bytes for a given time (in ms) and PCM properties.
1098 *
1099 * @return uint32_t Calculated amount of bytes.
1100 * @param pProps PCM properties to calculate amount of bytes for.
1101 * @param uMs Time (in ms) to calculate amount of bytes for.
1102 */
1103uint32_t DrvAudioHlpMsToBytes(const PPDMAUDIOPCMPROPS pProps, uint32_t uMs)
1104{
1105 AssertPtrReturn(pProps, 0);
1106
1107 if (!uMs)
1108 return 0;
1109
1110 return float(((pProps->cBits / 8) * pProps->cChannels * pProps->uHz) / 1000) * uMs;
1111}
1112
1113/**
1114 * Returns the amount of audio for a given time (in ms) and PCM properties.
1115 *
1116 * @return uint32_t Calculated amount of audio frames.
1117 * @param pProps PCM properties to calculate amount of bytes for.
1118 * @param uMs Time (in ms) to calculate amount of bytes for.
1119 */
1120uint32_t DrvAudioHlpMsToFrames(const PPDMAUDIOPCMPROPS pProps, uint32_t uMs)
1121{
1122 AssertPtrReturn(pProps, 0);
1123
1124 const uint32_t cbFrame = (pProps->cBits / 8) * pProps->cChannels;
1125 if (!cbFrame) /* Prevent division by zero. */
1126 return 0;
1127
1128 return DrvAudioHlpMsToBytes(pProps, uMs) / cbFrame;
1129}
1130
1131/**
1132 * Sanitizes the file name component so that unsupported characters
1133 * will be replaced by an underscore ("_").
1134 *
1135 * @return IPRT status code.
1136 * @param pszPath Path to sanitize.
1137 * @param cbPath Size (in bytes) of path to sanitize.
1138 */
1139int DrvAudioHlpSanitizeFileName(char *pszPath, size_t cbPath)
1140{
1141 RT_NOREF(cbPath);
1142 int rc = VINF_SUCCESS;
1143#ifdef RT_OS_WINDOWS
1144 /* Filter out characters not allowed on Windows platforms, put in by
1145 RTTimeSpecToString(). */
1146 /** @todo Use something like RTPathSanitize() if available later some time. */
1147 static RTUNICP const s_uszValidRangePairs[] =
1148 {
1149 ' ', ' ',
1150 '(', ')',
1151 '-', '.',
1152 '0', '9',
1153 'A', 'Z',
1154 'a', 'z',
1155 '_', '_',
1156 0xa0, 0xd7af,
1157 '\0'
1158 };
1159 ssize_t cReplaced = RTStrPurgeComplementSet(pszPath, s_uszValidRangePairs, '_' /* Replacement */);
1160 if (cReplaced < 0)
1161 rc = VERR_INVALID_UTF8_ENCODING;
1162#else
1163 RT_NOREF(pszPath);
1164#endif
1165 return rc;
1166}
1167
1168/**
1169 * Constructs an unique file name, based on the given path and the audio file type.
1170 *
1171 * @returns IPRT status code.
1172 * @param pszFile Where to store the constructed file name.
1173 * @param cchFile Size (in characters) of the file name buffer.
1174 * @param pszPath Base path to use.
1175 * @param pszName A name for better identifying the file.
1176 * @param uInstance Device / driver instance which is using this file.
1177 * @param enmType Audio file type to construct file name for.
1178 * @param fFlags File naming flags.
1179 */
1180int DrvAudioHlpGetFileName(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName,
1181 uint32_t uInstance, PDMAUDIOFILETYPE enmType, PDMAUDIOFILENAMEFLAGS fFlags)
1182{
1183 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1184 AssertReturn(cchFile, VERR_INVALID_PARAMETER);
1185 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1186 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1187 /** @todo Validate fFlags. */
1188
1189 int rc;
1190
1191 do
1192 {
1193 char szFilePath[RTPATH_MAX + 1];
1194 RTStrPrintf2(szFilePath, sizeof(szFilePath), "%s", pszPath);
1195
1196 /* Create it when necessary. */
1197 if (!RTDirExists(szFilePath))
1198 {
1199 rc = RTDirCreateFullPath(szFilePath, RTFS_UNIX_IRWXU);
1200 if (RT_FAILURE(rc))
1201 break;
1202 }
1203
1204 char szFileName[RTPATH_MAX + 1];
1205 szFileName[0] = '\0';
1206
1207 if (fFlags & PDMAUDIOFILENAME_FLAG_TS)
1208 {
1209 RTTIMESPEC time;
1210 if (!RTTimeSpecToString(RTTimeNow(&time), szFileName, sizeof(szFileName)))
1211 {
1212 rc = VERR_BUFFER_OVERFLOW;
1213 break;
1214 }
1215
1216 rc = DrvAudioHlpSanitizeFileName(szFileName, sizeof(szFileName));
1217 if (RT_FAILURE(rc))
1218 break;
1219
1220 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1221 if (RT_FAILURE(rc))
1222 break;
1223 }
1224
1225 rc = RTStrCat(szFileName, sizeof(szFileName), pszName);
1226 if (RT_FAILURE(rc))
1227 break;
1228
1229 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1230 if (RT_FAILURE(rc))
1231 break;
1232
1233 char szInst[16];
1234 RTStrPrintf2(szInst, sizeof(szInst), "%RU32", uInstance);
1235 rc = RTStrCat(szFileName, sizeof(szFileName), szInst);
1236 if (RT_FAILURE(rc))
1237 break;
1238
1239 switch (enmType)
1240 {
1241 case PDMAUDIOFILETYPE_RAW:
1242 rc = RTStrCat(szFileName, sizeof(szFileName), ".pcm");
1243 break;
1244
1245 case PDMAUDIOFILETYPE_WAV:
1246 rc = RTStrCat(szFileName, sizeof(szFileName), ".wav");
1247 break;
1248
1249 default:
1250 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1251 break;
1252 }
1253
1254 if (RT_FAILURE(rc))
1255 break;
1256
1257 rc = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
1258 if (RT_FAILURE(rc))
1259 break;
1260
1261 RTStrPrintf2(pszFile, cchFile, "%s", szFilePath);
1262
1263 } while (0);
1264
1265 LogFlowFuncLeaveRC(rc);
1266 return rc;
1267}
1268
1269/**
1270 * Creates an audio file.
1271 *
1272 * @returns IPRT status code.
1273 * @param enmType Audio file type to open / create.
1274 * @param pszFile File path of file to open or create.
1275 * @param fFlags Audio file flags.
1276 * @param ppFile Where to store the created audio file handle.
1277 * Needs to be destroyed with DrvAudioHlpFileDestroy().
1278 */
1279int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, PDMAUDIOFILEFLAGS fFlags, PPDMAUDIOFILE *ppFile)
1280{
1281 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1282 /** @todo Validate fFlags. */
1283
1284 PPDMAUDIOFILE pFile = (PPDMAUDIOFILE)RTMemAlloc(sizeof(PDMAUDIOFILE));
1285 if (!pFile)
1286 return VERR_NO_MEMORY;
1287
1288 int rc = VINF_SUCCESS;
1289
1290 switch (enmType)
1291 {
1292 case PDMAUDIOFILETYPE_RAW:
1293 case PDMAUDIOFILETYPE_WAV:
1294 pFile->enmType = enmType;
1295 break;
1296
1297 default:
1298 rc = VERR_INVALID_PARAMETER;
1299 break;
1300 }
1301
1302 if (RT_SUCCESS(rc))
1303 {
1304 RTStrPrintf(pFile->szName, RT_ELEMENTS(pFile->szName), "%s", pszFile);
1305 pFile->hFile = NIL_RTFILE;
1306 pFile->fFlags = fFlags;
1307 pFile->pvData = NULL;
1308 pFile->cbData = 0;
1309 }
1310
1311 if (RT_FAILURE(rc))
1312 {
1313 RTMemFree(pFile);
1314 pFile = NULL;
1315 }
1316 else
1317 *ppFile = pFile;
1318
1319 return rc;
1320}
1321
1322/**
1323 * Destroys a formerly created audio file.
1324 *
1325 * @param pFile Audio file (object) to destroy.
1326 */
1327void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile)
1328{
1329 if (!pFile)
1330 return;
1331
1332 DrvAudioHlpFileClose(pFile);
1333
1334 RTMemFree(pFile);
1335 pFile = NULL;
1336}
1337
1338/**
1339 * Opens or creates an audio file.
1340 *
1341 * @returns IPRT status code.
1342 * @param pFile Pointer to audio file handle to use.
1343 * @param fOpen Open flags.
1344 * Use PDMAUDIOFILE_DEFAULT_OPEN_FLAGS for the default open flags.
1345 * @param pProps PCM properties to use.
1346 */
1347int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps)
1348{
1349 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1350 /** @todo Validate fOpen flags. */
1351 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
1352
1353 int rc;
1354
1355 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1356 {
1357 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1358 }
1359 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1360 {
1361 Assert(pProps->cChannels);
1362 Assert(pProps->uHz);
1363 Assert(pProps->cBits);
1364
1365 pFile->pvData = (PAUDIOWAVFILEDATA)RTMemAllocZ(sizeof(AUDIOWAVFILEDATA));
1366 if (pFile->pvData)
1367 {
1368 pFile->cbData = sizeof(PAUDIOWAVFILEDATA);
1369
1370 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1371 AssertPtr(pData);
1372
1373 /* Header. */
1374 pData->Hdr.u32RIFF = AUDIO_MAKE_FOURCC('R','I','F','F');
1375 pData->Hdr.u32Size = 36;
1376 pData->Hdr.u32WAVE = AUDIO_MAKE_FOURCC('W','A','V','E');
1377
1378 pData->Hdr.u32Fmt = AUDIO_MAKE_FOURCC('f','m','t',' ');
1379 pData->Hdr.u32Size1 = 16; /* Means PCM. */
1380 pData->Hdr.u16AudioFormat = 1; /* PCM, linear quantization. */
1381 pData->Hdr.u16NumChannels = pProps->cChannels;
1382 pData->Hdr.u32SampleRate = pProps->uHz;
1383 pData->Hdr.u32ByteRate = DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels) / 8;
1384 pData->Hdr.u16BlockAlign = pProps->cChannels * pProps->cBits / 8;
1385 pData->Hdr.u16BitsPerSample = pProps->cBits;
1386
1387 /* Data chunk. */
1388 pData->Hdr.u32ID2 = AUDIO_MAKE_FOURCC('d','a','t','a');
1389 pData->Hdr.u32Size2 = 0;
1390
1391 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1392 if (RT_SUCCESS(rc))
1393 {
1394 rc = RTFileWrite(pFile->hFile, &pData->Hdr, sizeof(pData->Hdr), NULL);
1395 if (RT_FAILURE(rc))
1396 {
1397 RTFileClose(pFile->hFile);
1398 pFile->hFile = NIL_RTFILE;
1399 }
1400 }
1401
1402 if (RT_FAILURE(rc))
1403 {
1404 RTMemFree(pFile->pvData);
1405 pFile->pvData = NULL;
1406 pFile->cbData = 0;
1407 }
1408 }
1409 else
1410 rc = VERR_NO_MEMORY;
1411 }
1412 else
1413 rc = VERR_INVALID_PARAMETER;
1414
1415 if (RT_SUCCESS(rc))
1416 {
1417 LogRel2(("Audio: Opened file '%s'\n", pFile->szName));
1418 }
1419 else
1420 LogRel(("Audio: Failed opening file '%s', rc=%Rrc\n", pFile->szName, rc));
1421
1422 return rc;
1423}
1424
1425/**
1426 * Closes an audio file.
1427 *
1428 * @returns IPRT status code.
1429 * @param pFile Audio file handle to close.
1430 */
1431int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile)
1432{
1433 if (!pFile)
1434 return VINF_SUCCESS;
1435
1436 size_t cbSize = DrvAudioHlpFileGetDataSize(pFile);
1437
1438 int rc = VINF_SUCCESS;
1439
1440 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1441 {
1442 if (RTFileIsValid(pFile->hFile))
1443 rc = RTFileClose(pFile->hFile);
1444 }
1445 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1446 {
1447 if (RTFileIsValid(pFile->hFile))
1448 {
1449 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1450 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1451 {
1452 /* Update the header with the current data size. */
1453 RTFileWriteAt(pFile->hFile, 0, &pData->Hdr, sizeof(pData->Hdr), NULL);
1454 }
1455
1456 rc = RTFileClose(pFile->hFile);
1457 }
1458
1459 if (pFile->pvData)
1460 {
1461 RTMemFree(pFile->pvData);
1462 pFile->pvData = NULL;
1463 }
1464 }
1465 else
1466 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1467
1468 if ( RT_SUCCESS(rc)
1469 && !cbSize
1470 && !(pFile->fFlags & PDMAUDIOFILE_FLAG_KEEP_IF_EMPTY))
1471 {
1472 rc = DrvAudioHlpFileDelete(pFile);
1473 }
1474
1475 pFile->cbData = 0;
1476
1477 if (RT_SUCCESS(rc))
1478 {
1479 pFile->hFile = NIL_RTFILE;
1480 LogRel2(("Audio: Closed file '%s' (%zu bytes)\n", pFile->szName, cbSize));
1481 }
1482 else
1483 LogRel(("Audio: Failed closing file '%s', rc=%Rrc\n", pFile->szName, rc));
1484
1485 return rc;
1486}
1487
1488/**
1489 * Deletes an audio file.
1490 *
1491 * @returns IPRT status code.
1492 * @param pFile Audio file handle to delete.
1493 */
1494int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile)
1495{
1496 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1497
1498 int rc = RTFileDelete(pFile->szName);
1499 if (RT_SUCCESS(rc))
1500 {
1501 LogRel2(("Audio: Deleted file '%s'\n", pFile->szName));
1502 }
1503 else if (rc == VERR_FILE_NOT_FOUND) /* Don't bitch if the file is not around (anymore). */
1504 rc = VINF_SUCCESS;
1505
1506 if (RT_FAILURE(rc))
1507 LogRel(("Audio: Failed deleting file '%s', rc=%Rrc\n", pFile->szName, rc));
1508
1509 return rc;
1510}
1511
1512/**
1513 * Returns the raw audio data size of an audio file.
1514 *
1515 * Note: This does *not* include file headers and other data which does
1516 * not belong to the actual PCM audio data.
1517 *
1518 * @returns Size (in bytes) of the raw PCM audio data.
1519 * @param pFile Audio file handle to retrieve the audio data size for.
1520 */
1521size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile)
1522{
1523 AssertPtrReturn(pFile, 0);
1524
1525 size_t cbSize = 0;
1526
1527 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1528 {
1529 cbSize = RTFileTell(pFile->hFile);
1530 }
1531 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1532 {
1533 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1534 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1535 cbSize = pData->Hdr.u32Size2;
1536 }
1537
1538 return cbSize;
1539}
1540
1541/**
1542 * Returns whether the given audio file is open and in use or not.
1543 *
1544 * @return bool True if open, false if not.
1545 * @param pFile Audio file handle to check open status for.
1546 */
1547bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile)
1548{
1549 if (!pFile)
1550 return false;
1551
1552 return RTFileIsValid(pFile->hFile);
1553}
1554
1555/**
1556 * Write PCM data to a wave (.WAV) file.
1557 *
1558 * @returns IPRT status code.
1559 * @param pFile Audio file handle to write PCM data to.
1560 * @param pvBuf Audio data to write.
1561 * @param cbBuf Size (in bytes) of audio data to write.
1562 * @param fFlags Additional write flags. Not being used at the moment and must be 0.
1563 */
1564int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags)
1565{
1566 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1567 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1568
1569 AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER); /** @todo fFlags are currently not implemented. */
1570
1571 if (!cbBuf)
1572 return VINF_SUCCESS;
1573
1574 AssertReturn(RTFileIsValid(pFile->hFile), VERR_WRONG_ORDER);
1575
1576 int rc;
1577
1578 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1579 {
1580 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1581 }
1582 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1583 {
1584 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1585 AssertPtr(pData);
1586
1587 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1588 if (RT_SUCCESS(rc))
1589 {
1590 pData->Hdr.u32Size += (uint32_t)cbBuf;
1591 pData->Hdr.u32Size2 += (uint32_t)cbBuf;
1592 }
1593 }
1594 else
1595 rc = VERR_NOT_SUPPORTED;
1596
1597 return rc;
1598}
1599
Note: See TracBrowser for help on using the repository browser.

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