VirtualBox

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

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

Audio/DrvAudioCommon.cpp: Implemented DrvAudioHlpMsToBytes().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 42.6 KB
Line 
1/* $Id: DrvAudioCommon.cpp 70972 2018-02-12 12:47:16Z 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 recording source enumeration to a string.
625 *
626 * @returns Stringified recording source, or "Unknown", if not found.
627 * @param enmRecSrc Recording source to convert.
628 */
629const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSOURCE enmRecSrc)
630{
631 switch (enmRecSrc)
632 {
633 case PDMAUDIORECSOURCE_UNKNOWN: return "Unknown";
634 case PDMAUDIORECSOURCE_MIC: return "Microphone In";
635 case PDMAUDIORECSOURCE_CD: return "CD";
636 case PDMAUDIORECSOURCE_VIDEO: return "Video";
637 case PDMAUDIORECSOURCE_AUX: return "AUX";
638 case PDMAUDIORECSOURCE_LINE: return "Line In";
639 case PDMAUDIORECSOURCE_PHONE: return "Phone";
640 default:
641 break;
642 }
643
644 AssertMsgFailed(("Invalid recording source %ld\n", enmRecSrc));
645 return "Unknown";
646}
647
648/**
649 * Returns wether the given audio format has signed bits or not.
650 *
651 * @return IPRT status code.
652 * @return bool @c true for signed bits, @c false for unsigned.
653 * @param enmFmt Audio format to retrieve value for.
654 */
655bool DrvAudioHlpAudFmtIsSigned(PDMAUDIOFMT enmFmt)
656{
657 switch (enmFmt)
658 {
659 case PDMAUDIOFMT_S8:
660 case PDMAUDIOFMT_S16:
661 case PDMAUDIOFMT_S32:
662 return true;
663
664 case PDMAUDIOFMT_U8:
665 case PDMAUDIOFMT_U16:
666 case PDMAUDIOFMT_U32:
667 return false;
668
669 default:
670 break;
671 }
672
673 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
674 return false;
675}
676
677/**
678 * Returns the bits of a given audio format.
679 *
680 * @return IPRT status code.
681 * @return uint8_t Bits of audio format.
682 * @param enmFmt Audio format to retrieve value for.
683 */
684uint8_t DrvAudioHlpAudFmtToBits(PDMAUDIOFMT enmFmt)
685{
686 switch (enmFmt)
687 {
688 case PDMAUDIOFMT_S8:
689 case PDMAUDIOFMT_U8:
690 return 8;
691
692 case PDMAUDIOFMT_U16:
693 case PDMAUDIOFMT_S16:
694 return 16;
695
696 case PDMAUDIOFMT_U32:
697 case PDMAUDIOFMT_S32:
698 return 32;
699
700 default:
701 break;
702 }
703
704 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
705 return 0;
706}
707
708/**
709 * Converts an audio format to a string.
710 *
711 * @returns Stringified audio format, or "Unknown", if not found.
712 * @param enmFmt Audio format to convert.
713 */
714const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt)
715{
716 switch (enmFmt)
717 {
718 case PDMAUDIOFMT_U8:
719 return "U8";
720
721 case PDMAUDIOFMT_U16:
722 return "U16";
723
724 case PDMAUDIOFMT_U32:
725 return "U32";
726
727 case PDMAUDIOFMT_S8:
728 return "S8";
729
730 case PDMAUDIOFMT_S16:
731 return "S16";
732
733 case PDMAUDIOFMT_S32:
734 return "S32";
735
736 default:
737 break;
738 }
739
740 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
741 return "Unknown";
742}
743
744/**
745 * Converts a given string to an audio format.
746 *
747 * @returns Audio format for the given string, or PDMAUDIOFMT_INVALID if not found.
748 * @param pszFmt String to convert to an audio format.
749 */
750PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt)
751{
752 AssertPtrReturn(pszFmt, PDMAUDIOFMT_INVALID);
753
754 if (!RTStrICmp(pszFmt, "u8"))
755 return PDMAUDIOFMT_U8;
756 else if (!RTStrICmp(pszFmt, "u16"))
757 return PDMAUDIOFMT_U16;
758 else if (!RTStrICmp(pszFmt, "u32"))
759 return PDMAUDIOFMT_U32;
760 else if (!RTStrICmp(pszFmt, "s8"))
761 return PDMAUDIOFMT_S8;
762 else if (!RTStrICmp(pszFmt, "s16"))
763 return PDMAUDIOFMT_S16;
764 else if (!RTStrICmp(pszFmt, "s32"))
765 return PDMAUDIOFMT_S32;
766
767 AssertMsgFailed(("Invalid audio format '%s'\n", pszFmt));
768 return PDMAUDIOFMT_INVALID;
769}
770
771/**
772 * Checks whether two given PCM properties are equal.
773 *
774 * @returns @c true if equal, @c false if not.
775 * @param pProps1 First properties to compare.
776 * @param pProps2 Second properties to compare.
777 */
778bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps1, const PPDMAUDIOPCMPROPS pProps2)
779{
780 AssertPtrReturn(pProps1, false);
781 AssertPtrReturn(pProps2, false);
782
783 if (pProps1 == pProps2) /* If the pointers match, take a shortcut. */
784 return true;
785
786 return pProps1->uHz == pProps2->uHz
787 && pProps1->cChannels == pProps2->cChannels
788 && pProps1->cBits == pProps2->cBits
789 && pProps1->fSigned == pProps2->fSigned
790 && pProps1->fSwapEndian == pProps2->fSwapEndian;
791}
792
793/**
794 * Checks whether given PCM properties are valid or not.
795 *
796 * Returns @c true if properties are valid, @c false if not.
797 * @param pProps PCM properties to check.
798 */
799bool DrvAudioHlpPCMPropsAreValid(const PPDMAUDIOPCMPROPS pProps)
800{
801 AssertPtrReturn(pProps, false);
802
803 /* Minimum 1 channel (mono), maximum 7.1 (= 8) channels. */
804 bool fValid = ( pProps->cChannels >= 1
805 && pProps->cChannels <= 8);
806
807 if (fValid)
808 {
809 switch (pProps->cBits)
810 {
811 case 8:
812 case 16:
813 /** @todo Do we need support for 24-bit samples? */
814 case 32:
815 break;
816 default:
817 fValid = false;
818 break;
819 }
820 }
821
822 if (!fValid)
823 return false;
824
825 fValid &= pProps->uHz > 0;
826 fValid &= pProps->cShift == PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(pProps->cBits, pProps->cChannels);
827 fValid &= pProps->fSwapEndian == false; /** @todo Handling Big Endian audio data is not supported yet. */
828
829 return fValid;
830}
831
832/**
833 * Checks whether the given PCM properties are equal with the given
834 * stream configuration.
835 *
836 * @returns @c true if equal, @c false if not.
837 * @param pProps PCM properties to compare.
838 * @param pCfg Stream configuration to compare.
839 */
840bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps, const PPDMAUDIOSTREAMCFG pCfg)
841{
842 AssertPtrReturn(pProps, false);
843 AssertPtrReturn(pCfg, false);
844
845 return DrvAudioHlpPCMPropsAreEqual(pProps, &pCfg->Props);
846}
847
848/**
849 * Prints PCM properties to the debug log.
850 *
851 * @param pProps Stream configuration to log.
852 */
853void DrvAudioHlpPCMPropsPrint(const PPDMAUDIOPCMPROPS pProps)
854{
855 AssertPtrReturnVoid(pProps);
856
857 Log(("uHz=%RU32, cChannels=%RU8, cBits=%RU8%s",
858 pProps->uHz, pProps->cChannels, pProps->cBits, pProps->fSigned ? "S" : "U"));
859}
860
861/**
862 * Converts PCM properties to a audio stream configuration.
863 *
864 * @return IPRT status code.
865 * @param pProps Pointer to PCM properties to convert.
866 * @param pCfg Pointer to audio stream configuration to store result into.
867 */
868int DrvAudioHlpPCMPropsToStreamCfg(const PPDMAUDIOPCMPROPS pProps, PPDMAUDIOSTREAMCFG pCfg)
869{
870 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
871 AssertPtrReturn(pCfg, VERR_INVALID_POINTER);
872
873 memcpy(&pCfg->Props, pProps, sizeof(PDMAUDIOPCMPROPS));
874 return VINF_SUCCESS;
875}
876
877/**
878 * Checks whether a given stream configuration is valid or not.
879 *
880 * Returns @c true if configuration is valid, @c false if not.
881 * @param pCfg Stream configuration to check.
882 */
883bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg)
884{
885 AssertPtrReturn(pCfg, false);
886
887 bool fValid = ( pCfg->enmDir == PDMAUDIODIR_IN
888 || pCfg->enmDir == PDMAUDIODIR_OUT);
889
890 fValid &= ( pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED
891 || pCfg->enmLayout == PDMAUDIOSTREAMLAYOUT_RAW);
892
893 if (fValid)
894 fValid = DrvAudioHlpPCMPropsAreValid(&pCfg->Props);
895
896 return fValid;
897}
898
899/**
900 * Frees an allocated audio stream configuration.
901 *
902 * @param pCfg Audio stream configuration to free.
903 */
904void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg)
905{
906 if (pCfg)
907 {
908 RTMemFree(pCfg);
909 pCfg = NULL;
910 }
911}
912
913/**
914 * Copies a source stream configuration to a destination stream configuration.
915 *
916 * @returns IPRT status code.
917 * @param pDstCfg Destination stream configuration to copy source to.
918 * @param pSrcCfg Source stream configuration to copy to destination.
919 */
920int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg)
921{
922 AssertPtrReturn(pDstCfg, VERR_INVALID_POINTER);
923 AssertPtrReturn(pSrcCfg, VERR_INVALID_POINTER);
924
925#ifdef VBOX_STRICT
926 if (!DrvAudioHlpStreamCfgIsValid(pSrcCfg))
927 {
928 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pSrcCfg->szName, pSrcCfg));
929 return VERR_INVALID_PARAMETER;
930 }
931#endif
932
933 memcpy(pDstCfg, pSrcCfg, sizeof(PDMAUDIOSTREAMCFG));
934
935 return VINF_SUCCESS;
936}
937
938/**
939 * Duplicates an audio stream configuration.
940 * Must be free'd with DrvAudioHlpStreamCfgFree().
941 *
942 * @return Duplicates audio stream configuration on success, or NULL on failure.
943 * @param pCfg Audio stream configuration to duplicate.
944 */
945PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg)
946{
947 AssertPtrReturn(pCfg, NULL);
948
949 PPDMAUDIOSTREAMCFG pDst = (PPDMAUDIOSTREAMCFG)RTMemAllocZ(sizeof(PDMAUDIOSTREAMCFG));
950 if (!pDst)
951 return NULL;
952
953 int rc2 = DrvAudioHlpStreamCfgCopy(pDst, pCfg);
954 if (RT_FAILURE(rc2))
955 {
956 DrvAudioHlpStreamCfgFree(pDst);
957 pDst = NULL;
958 }
959
960 AssertPtr(pDst);
961 return pDst;
962}
963
964/**
965 * Prints an audio stream configuration to the debug log.
966 *
967 * @param pCfg Stream configuration to log.
968 */
969void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg)
970{
971 if (!pCfg)
972 return;
973
974 LogFunc(("szName=%s, enmDir=%RU32 (uHz=%RU32, cBits=%RU8%s, cChannels=%RU8)\n",
975 pCfg->szName, pCfg->enmDir,
976 pCfg->Props.uHz, pCfg->Props.cBits, pCfg->Props.fSigned ? "S" : "U", pCfg->Props.cChannels));
977}
978
979/**
980 * Converts a stream command to a string.
981 *
982 * @returns Stringified stream command, or "Unknown", if not found.
983 * @param enmCmd Stream command to convert.
984 */
985const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd)
986{
987 switch (enmCmd)
988 {
989 case PDMAUDIOSTREAMCMD_UNKNOWN: return "Unknown";
990 case PDMAUDIOSTREAMCMD_ENABLE: return "Enable";
991 case PDMAUDIOSTREAMCMD_DISABLE: return "Disable";
992 case PDMAUDIOSTREAMCMD_PAUSE: return "Pause";
993 case PDMAUDIOSTREAMCMD_RESUME: return "Resume";
994 default: break;
995 }
996
997 AssertMsgFailed(("Invalid stream command %ld\n", enmCmd));
998 return "Unknown";
999}
1000
1001/**
1002 * Calculates the audio bit rate of the given bits per sample, the Hz and the number
1003 * of audio channels.
1004 *
1005 * Divide the result by 8 to get the byte rate.
1006 *
1007 * @returns The calculated bit rate.
1008 * @param cBits Number of bits per sample.
1009 * @param uHz Hz (Hertz) rate.
1010 * @param cChannels Number of audio channels.
1011 */
1012uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels)
1013{
1014 return (cBits * uHz * cChannels);
1015}
1016
1017/**
1018 * Calculates the audio bit rate out of a given audio stream configuration.
1019 *
1020 * Divide the result by 8 to get the byte rate.
1021 *
1022 * @returns The calculated bit rate.
1023 * @param pProps PCM properties to calculate bitrate for.
1024 *
1025 * @remark
1026 */
1027uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps)
1028{
1029 return DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels);
1030}
1031
1032/**
1033 * Returns the amount of bytes for a given time (in ms) and PCM properties.
1034 *
1035 * @return uint32_t Calculated amount of bytes.
1036 * @param pProps PCM properties to calculate amount of bytes for.
1037 * @param uMs Time (in ms) to calculate amount of bytes for.
1038 */
1039uint32_t DrvAudioHlpMsToBytes(const PPDMAUDIOPCMPROPS pProps, uint32_t uMs)
1040{
1041 AssertPtrReturn(pProps, 0);
1042
1043 if (!uMs)
1044 return 0;
1045
1046 return float(((pProps->cBits / 8) * pProps->cChannels * pProps->uHz) / 1000) * uMs;
1047}
1048
1049/**
1050 * Sanitizes the file name component so that unsupported characters
1051 * will be replaced by an underscore ("_").
1052 *
1053 * @return IPRT status code.
1054 * @param pszPath Path to sanitize.
1055 * @param cbPath Size (in bytes) of path to sanitize.
1056 */
1057int DrvAudioHlpSanitizeFileName(char *pszPath, size_t cbPath)
1058{
1059 RT_NOREF(cbPath);
1060 int rc = VINF_SUCCESS;
1061#ifdef RT_OS_WINDOWS
1062 /* Filter out characters not allowed on Windows platforms, put in by
1063 RTTimeSpecToString(). */
1064 /** @todo Use something like RTPathSanitize() if available later some time. */
1065 static RTUNICP const s_uszValidRangePairs[] =
1066 {
1067 ' ', ' ',
1068 '(', ')',
1069 '-', '.',
1070 '0', '9',
1071 'A', 'Z',
1072 'a', 'z',
1073 '_', '_',
1074 0xa0, 0xd7af,
1075 '\0'
1076 };
1077 ssize_t cReplaced = RTStrPurgeComplementSet(pszPath, s_uszValidRangePairs, '_' /* Replacement */);
1078 if (cReplaced < 0)
1079 rc = VERR_INVALID_UTF8_ENCODING;
1080#else
1081 RT_NOREF(pszPath);
1082#endif
1083 return rc;
1084}
1085
1086/**
1087 * Constructs an unique file name, based on the given path and the audio file type.
1088 *
1089 * @returns IPRT status code.
1090 * @param pszFile Where to store the constructed file name.
1091 * @param cchFile Size (in characters) of the file name buffer.
1092 * @param pszPath Base path to use.
1093 * @param pszName A name for better identifying the file.
1094 * @param uInstance Device / driver instance which is using this file.
1095 * @param enmType Audio file type to construct file name for.
1096 * @param fFlags File naming flags.
1097 */
1098int DrvAudioHlpGetFileName(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName,
1099 uint32_t uInstance, PDMAUDIOFILETYPE enmType, PDMAUDIOFILENAMEFLAGS fFlags)
1100{
1101 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1102 AssertReturn(cchFile, VERR_INVALID_PARAMETER);
1103 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1104 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1105 /** @todo Validate fFlags. */
1106
1107 int rc;
1108
1109 do
1110 {
1111 char szFilePath[RTPATH_MAX + 1];
1112 RTStrPrintf2(szFilePath, sizeof(szFilePath), "%s", pszPath);
1113
1114 /* Create it when necessary. */
1115 if (!RTDirExists(szFilePath))
1116 {
1117 rc = RTDirCreateFullPath(szFilePath, RTFS_UNIX_IRWXU);
1118 if (RT_FAILURE(rc))
1119 break;
1120 }
1121
1122 char szFileName[RTPATH_MAX + 1];
1123 szFileName[0] = '\0';
1124
1125 if (fFlags & PDMAUDIOFILENAME_FLAG_TS)
1126 {
1127 RTTIMESPEC time;
1128 if (!RTTimeSpecToString(RTTimeNow(&time), szFileName, sizeof(szFileName)))
1129 {
1130 rc = VERR_BUFFER_OVERFLOW;
1131 break;
1132 }
1133
1134 rc = DrvAudioHlpSanitizeFileName(szFileName, sizeof(szFileName));
1135 if (RT_FAILURE(rc))
1136 break;
1137
1138 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1139 if (RT_FAILURE(rc))
1140 break;
1141 }
1142
1143 rc = RTStrCat(szFileName, sizeof(szFileName), pszName);
1144 if (RT_FAILURE(rc))
1145 break;
1146
1147 rc = RTStrCat(szFileName, sizeof(szFileName), "-");
1148 if (RT_FAILURE(rc))
1149 break;
1150
1151 char szInst[16];
1152 RTStrPrintf2(szInst, sizeof(szInst), "%RU32", uInstance);
1153 rc = RTStrCat(szFileName, sizeof(szFileName), szInst);
1154 if (RT_FAILURE(rc))
1155 break;
1156
1157 switch (enmType)
1158 {
1159 case PDMAUDIOFILETYPE_RAW:
1160 rc = RTStrCat(szFileName, sizeof(szFileName), ".pcm");
1161 break;
1162
1163 case PDMAUDIOFILETYPE_WAV:
1164 rc = RTStrCat(szFileName, sizeof(szFileName), ".wav");
1165 break;
1166
1167 default:
1168 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1169 break;
1170 }
1171
1172 if (RT_FAILURE(rc))
1173 break;
1174
1175 rc = RTPathAppend(szFilePath, sizeof(szFilePath), szFileName);
1176 if (RT_FAILURE(rc))
1177 break;
1178
1179 RTStrPrintf2(pszFile, cchFile, "%s", szFilePath);
1180
1181 } while (0);
1182
1183 LogFlowFuncLeaveRC(rc);
1184 return rc;
1185}
1186
1187/**
1188 * Creates an audio file.
1189 *
1190 * @returns IPRT status code.
1191 * @param enmType Audio file type to open / create.
1192 * @param pszFile File path of file to open or create.
1193 * @param fFlags Audio file flags.
1194 * @param ppFile Where to store the created audio file handle.
1195 * Needs to be destroyed with DrvAudioHlpFileDestroy().
1196 */
1197int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, PDMAUDIOFILEFLAGS fFlags, PPDMAUDIOFILE *ppFile)
1198{
1199 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1200 /** @todo Validate fFlags. */
1201
1202 PPDMAUDIOFILE pFile = (PPDMAUDIOFILE)RTMemAlloc(sizeof(PDMAUDIOFILE));
1203 if (!pFile)
1204 return VERR_NO_MEMORY;
1205
1206 int rc = VINF_SUCCESS;
1207
1208 switch (enmType)
1209 {
1210 case PDMAUDIOFILETYPE_RAW:
1211 case PDMAUDIOFILETYPE_WAV:
1212 pFile->enmType = enmType;
1213 break;
1214
1215 default:
1216 rc = VERR_INVALID_PARAMETER;
1217 break;
1218 }
1219
1220 if (RT_SUCCESS(rc))
1221 {
1222 RTStrPrintf(pFile->szName, RT_ELEMENTS(pFile->szName), "%s", pszFile);
1223 pFile->fFlags = fFlags;
1224 pFile->pvData = NULL;
1225 pFile->cbData = 0;
1226 }
1227
1228 if (RT_FAILURE(rc))
1229 {
1230 RTMemFree(pFile);
1231 pFile = NULL;
1232 }
1233 else
1234 *ppFile = pFile;
1235
1236 return rc;
1237}
1238
1239/**
1240 * Destroys a formerly created audio file.
1241 *
1242 * @param pFile Audio file (object) to destroy.
1243 */
1244void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile)
1245{
1246 if (!pFile)
1247 return;
1248
1249 DrvAudioHlpFileClose(pFile);
1250
1251 RTMemFree(pFile);
1252 pFile = NULL;
1253}
1254
1255/**
1256 * Opens or creates an audio file.
1257 *
1258 * @returns IPRT status code.
1259 * @param pFile Pointer to audio file handle to use.
1260 * @param fOpen Open flags.
1261 * Use PDMAUDIOFILE_DEFAULT_OPEN_FLAGS for the default open flags.
1262 * @param pProps PCM properties to use.
1263 */
1264int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps)
1265{
1266 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1267 /** @todo Validate fOpen flags. */
1268 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
1269
1270 int rc;
1271
1272 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1273 {
1274 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1275 }
1276 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1277 {
1278 Assert(pProps->cChannels);
1279 Assert(pProps->uHz);
1280 Assert(pProps->cBits);
1281
1282 pFile->pvData = (PAUDIOWAVFILEDATA)RTMemAllocZ(sizeof(AUDIOWAVFILEDATA));
1283 if (pFile->pvData)
1284 {
1285 pFile->cbData = sizeof(PAUDIOWAVFILEDATA);
1286
1287 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1288 AssertPtr(pData);
1289
1290 /* Header. */
1291 pData->Hdr.u32RIFF = AUDIO_MAKE_FOURCC('R','I','F','F');
1292 pData->Hdr.u32Size = 36;
1293 pData->Hdr.u32WAVE = AUDIO_MAKE_FOURCC('W','A','V','E');
1294
1295 pData->Hdr.u32Fmt = AUDIO_MAKE_FOURCC('f','m','t',' ');
1296 pData->Hdr.u32Size1 = 16; /* Means PCM. */
1297 pData->Hdr.u16AudioFormat = 1; /* PCM, linear quantization. */
1298 pData->Hdr.u16NumChannels = pProps->cChannels;
1299 pData->Hdr.u32SampleRate = pProps->uHz;
1300 pData->Hdr.u32ByteRate = DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels) / 8;
1301 pData->Hdr.u16BlockAlign = pProps->cChannels * pProps->cBits / 8;
1302 pData->Hdr.u16BitsPerSample = pProps->cBits;
1303
1304 /* Data chunk. */
1305 pData->Hdr.u32ID2 = AUDIO_MAKE_FOURCC('d','a','t','a');
1306 pData->Hdr.u32Size2 = 0;
1307
1308 rc = RTFileOpen(&pFile->hFile, pFile->szName, fOpen);
1309 if (RT_SUCCESS(rc))
1310 {
1311 rc = RTFileWrite(pFile->hFile, &pData->Hdr, sizeof(pData->Hdr), NULL);
1312 if (RT_FAILURE(rc))
1313 {
1314 RTFileClose(pFile->hFile);
1315 pFile->hFile = NIL_RTFILE;
1316 }
1317 }
1318
1319 if (RT_FAILURE(rc))
1320 {
1321 RTMemFree(pFile->pvData);
1322 pFile->pvData = NULL;
1323 pFile->cbData = 0;
1324 }
1325 }
1326 else
1327 rc = VERR_NO_MEMORY;
1328 }
1329 else
1330 rc = VERR_INVALID_PARAMETER;
1331
1332 if (RT_SUCCESS(rc))
1333 {
1334 LogRel2(("Audio: Opened file '%s'\n", pFile->szName));
1335 }
1336 else
1337 LogRel(("Audio: Failed opening file '%s', rc=%Rrc\n", pFile->szName, rc));
1338
1339 return rc;
1340}
1341
1342/**
1343 * Closes an audio file.
1344 *
1345 * @returns IPRT status code.
1346 * @param pFile Audio file handle to close.
1347 */
1348int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile)
1349{
1350 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1351
1352 size_t cbSize = DrvAudioHlpFileGetDataSize(pFile);
1353
1354 int rc = VINF_SUCCESS;
1355
1356 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1357 {
1358 if (RTFileIsValid(pFile->hFile))
1359 rc = RTFileClose(pFile->hFile);
1360 }
1361 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1362 {
1363 if (RTFileIsValid(pFile->hFile))
1364 {
1365 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1366 if (pData) /* The .WAV file data only is valid when a file actually has been created. */
1367 {
1368 /* Update the header with the current data size. */
1369 RTFileWriteAt(pFile->hFile, 0, &pData->Hdr, sizeof(pData->Hdr), NULL);
1370 }
1371
1372 rc = RTFileClose(pFile->hFile);
1373 }
1374
1375 if (pFile->pvData)
1376 {
1377 RTMemFree(pFile->pvData);
1378 pFile->pvData = NULL;
1379 }
1380 }
1381 else
1382 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1383
1384 if ( RT_SUCCESS(rc)
1385 && !cbSize
1386 && !(pFile->fFlags & PDMAUDIOFILE_FLAG_KEEP_IF_EMPTY))
1387 {
1388 rc = DrvAudioHlpFileDelete(pFile);
1389 }
1390
1391 pFile->cbData = 0;
1392
1393 if (RT_SUCCESS(rc))
1394 {
1395 pFile->hFile = NIL_RTFILE;
1396 LogRel2(("Audio: Closed file '%s' (%zu bytes)\n", pFile->szName, cbSize));
1397 }
1398 else
1399 LogRel(("Audio: Failed closing file '%s', rc=%Rrc\n", pFile->szName, rc));
1400
1401 return rc;
1402}
1403
1404/**
1405 * Deletes an audio file.
1406 *
1407 * @returns IPRT status code.
1408 * @param pFile Audio file handle to delete.
1409 */
1410int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile)
1411{
1412 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1413
1414 int rc = RTFileDelete(pFile->szName);
1415 if (RT_SUCCESS(rc))
1416 {
1417 LogRel2(("Audio: Deleted file '%s'\n", pFile->szName));
1418 }
1419 else if (rc == VERR_FILE_NOT_FOUND) /* Don't bitch if the file is not around (anymore). */
1420 rc = VINF_SUCCESS;
1421
1422 if (RT_FAILURE(rc))
1423 LogRel(("Audio: Failed deleting file '%s', rc=%Rrc\n", pFile->szName, rc));
1424
1425 return rc;
1426}
1427
1428/**
1429 * Returns the raw audio data size of an audio file.
1430 *
1431 * Note: This does *not* include file headers and other data which does
1432 * not belong to the actual PCM audio data.
1433 *
1434 * @returns Size (in bytes) of the raw PCM audio data.
1435 * @param pFile Audio file handle to retrieve the audio data size for.
1436 */
1437size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile)
1438{
1439 AssertPtrReturn(pFile, 0);
1440
1441 size_t cbSize = 0;
1442
1443 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1444 {
1445 cbSize = RTFileTell(pFile->hFile);
1446 }
1447 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
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 cbSize = pData->Hdr.u32Size2;
1452 }
1453
1454 return cbSize;
1455}
1456
1457/**
1458 * Returns whether the given audio file is open and in use or not.
1459 *
1460 * @return bool True if open, false if not.
1461 * @param pFile Audio file handle to check open status for.
1462 */
1463bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile)
1464{
1465 if (!pFile)
1466 return false;
1467
1468 return RTFileIsValid(pFile->hFile);
1469}
1470
1471/**
1472 * Write PCM data to a wave (.WAV) file.
1473 *
1474 * @returns IPRT status code.
1475 * @param pFile Audio file handle to write PCM data to.
1476 * @param pvBuf Audio data to write.
1477 * @param cbBuf Size (in bytes) of audio data to write.
1478 * @param fFlags Additional write flags. Not being used at the moment and must be 0.
1479 */
1480int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags)
1481{
1482 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1483 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1484
1485 AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER); /** @todo fFlags are currently not implemented. */
1486
1487 if (!cbBuf)
1488 return VINF_SUCCESS;
1489
1490 AssertReturn(RTFileIsValid(pFile->hFile), VERR_WRONG_ORDER);
1491
1492 int rc;
1493
1494 if (pFile->enmType == PDMAUDIOFILETYPE_RAW)
1495 {
1496 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1497 }
1498 else if (pFile->enmType == PDMAUDIOFILETYPE_WAV)
1499 {
1500 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1501 AssertPtr(pData);
1502
1503 rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1504 if (RT_SUCCESS(rc))
1505 {
1506 pData->Hdr.u32Size += (uint32_t)cbBuf;
1507 pData->Hdr.u32Size2 += (uint32_t)cbBuf;
1508 }
1509 }
1510 else
1511 rc = VERR_NOT_SUPPORTED;
1512
1513 return rc;
1514}
1515
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