VirtualBox

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

Last change on this file since 65919 was 65738, checked in by vboxsync, 8 years ago

DrvAudio: Added DrvAudioHlpPCMPropsPrint().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 37.1 KB
Line 
1/* $Id: DrvAudioCommon.cpp 65738 2017-02-10 16:11:40Z vboxsync $ */
2/** @file
3 * Intermedia audio driver, common routines. These are also used
4 * in the drivers which are bound to Main, e.g. the VRDE or the
5 * video audio recording drivers.
6 */
7
8/*
9 * Copyright (C) 2006-2016 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 * --------------------------------------------------------------------
19 *
20 * This code is based on: audio_template.h from QEMU AUDIO subsystem.
21 *
22 * QEMU Audio subsystem header
23 *
24 * Copyright (c) 2005 Vassili Karpov (malc)
25 *
26 * Permission is hereby granted, free of charge, to any person obtaining a copy
27 * of this software and associated documentation files (the "Software"), to deal
28 * in the Software without restriction, including without limitation the rights
29 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
30 * copies of the Software, and to permit persons to whom the Software is
31 * furnished to do so, subject to the following conditions:
32 *
33 * The above copyright notice and this permission notice shall be included in
34 * all copies or substantial portions of the Software.
35 *
36 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
37 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
38 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
39 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
40 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
41 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
42 * THE SOFTWARE.
43 */
44#include <iprt/alloc.h>
45#include <iprt/asm-math.h>
46#include <iprt/assert.h>
47#include <iprt/dir.h>
48#include <iprt/file.h>
49#include <iprt/string.h>
50#include <iprt/uuid.h>
51
52#define LOG_GROUP LOG_GROUP_DRV_AUDIO
53#include <VBox/log.h>
54
55#include <VBox/err.h>
56#include <VBox/vmm/pdmdev.h>
57#include <VBox/vmm/pdm.h>
58#include <VBox/vmm/mm.h>
59
60#include <ctype.h>
61#include <stdlib.h>
62
63#include "DrvAudio.h"
64#include "AudioMixBuffer.h"
65
66#pragma pack(1)
67/**
68 * Structure for building up a .WAV file header.
69 */
70typedef struct AUDIOWAVFILEHDR
71{
72 uint32_t u32RIFF;
73 uint32_t u32Size;
74 uint32_t u32WAVE;
75
76 uint32_t u32Fmt;
77 uint32_t u32Size1;
78 uint16_t u16AudioFormat;
79 uint16_t u16NumChannels;
80 uint32_t u32SampleRate;
81 uint32_t u32ByteRate;
82 uint16_t u16BlockAlign;
83 uint16_t u16BitsPerSample;
84
85 uint32_t u32ID2;
86 uint32_t u32Size2;
87} AUDIOWAVFILEHDR, *PAUDIOWAVFILEHDR;
88#pragma pack()
89
90/**
91 * Structure for keeeping the internal .WAV file data
92 */
93typedef struct AUDIOWAVFILEDATA
94{
95 /** The file header/footer. */
96 AUDIOWAVFILEHDR Hdr;
97} AUDIOWAVFILEDATA, *PAUDIOWAVFILEDATA;
98
99/**
100 * Retrieves the matching PDMAUDIOFMT for given bits + signing flag.
101 *
102 * @return IPRT status code.
103 * @return PDMAUDIOFMT Resulting audio format or PDMAUDIOFMT_INVALID if invalid.
104 * @param cBits Bits to retrieve audio format for.
105 * @param fSigned Signed flag for bits to retrieve audio format for.
106 */
107PDMAUDIOFMT DrvAudioAudFmtBitsToAudFmt(uint8_t cBits, bool fSigned)
108{
109 if (fSigned)
110 {
111 switch (cBits)
112 {
113 case 8: return PDMAUDIOFMT_S8;
114 case 16: return PDMAUDIOFMT_S16;
115 case 32: return PDMAUDIOFMT_S32;
116 default: break;
117 }
118 }
119 else
120 {
121 switch (cBits)
122 {
123 case 8: return PDMAUDIOFMT_U8;
124 case 16: return PDMAUDIOFMT_U16;
125 case 32: return PDMAUDIOFMT_U32;
126 default: break;
127 }
128 }
129
130 AssertMsgFailed(("Bogus audio bits %RU8\n", cBits));
131 return PDMAUDIOFMT_INVALID;
132}
133
134/**
135 * Clears a sample buffer by the given amount of audio samples.
136 *
137 * @return IPRT status code.
138 * @param pPCMProps PCM properties to use for the buffer to clear.
139 * @param pvBuf Buffer to clear.
140 * @param cbBuf Size (in bytes) of the buffer.
141 * @param cSamples Number of audio samples to clear in the buffer.
142 */
143void DrvAudioHlpClearBuf(const PPDMAUDIOPCMPROPS pPCMProps, void *pvBuf, size_t cbBuf, uint32_t cSamples)
144{
145 AssertPtrReturnVoid(pPCMProps);
146 AssertPtrReturnVoid(pvBuf);
147
148 if (!cbBuf || !cSamples)
149 return;
150
151 Assert(pPCMProps->cBits);
152 size_t cbToClear = cSamples * (pPCMProps->cBits / 8 /* Bytes */);
153 Assert(cbBuf >= cbToClear);
154
155 if (cbBuf < cbToClear)
156 cbToClear = cbBuf;
157
158 Log2Func(("pPCMProps=%p, pvBuf=%p, cSamples=%RU32, fSigned=%RTbool, cBits=%RU8\n",
159 pPCMProps, pvBuf, cSamples, pPCMProps->fSigned, pPCMProps->cBits));
160
161 if (pPCMProps->fSigned)
162 {
163 RT_BZERO(pvBuf, cbToClear);
164 }
165 else
166 {
167 switch (pPCMProps->cBits)
168 {
169 case 8:
170 {
171 memset(pvBuf, 0x80, cbToClear);
172 break;
173 }
174
175 case 16:
176 {
177 uint16_t *p = (uint16_t *)pvBuf;
178 int16_t s = INT16_MAX;
179
180 if (pPCMProps->fSwapEndian)
181 s = RT_BSWAP_U16(s);
182
183 for (uint32_t i = 0; i < cSamples; i++)
184 p[i] = s;
185
186 break;
187 }
188
189 case 32:
190 {
191 uint32_t *p = (uint32_t *)pvBuf;
192 int32_t s = INT32_MAX;
193
194 if (pPCMProps->fSwapEndian)
195 s = RT_BSWAP_U32(s);
196
197 for (uint32_t i = 0; i < cSamples; i++)
198 p[i] = s;
199
200 break;
201 }
202
203 default:
204 {
205 AssertMsgFailed(("Invalid bits: %RU8\n", pPCMProps->cBits));
206 break;
207 }
208 }
209 }
210}
211
212/**
213 * Allocates an audio device.
214 *
215 * @returns Newly allocated audio device, or NULL if failed.
216 * @param cbData How much additional data (in bytes) should be allocated to provide
217 * a (backend) specific area to store additional data.
218 * Optional, can be 0.
219 */
220PPDMAUDIODEVICE DrvAudioHlpDeviceAlloc(size_t cbData)
221{
222 PPDMAUDIODEVICE pDev = (PPDMAUDIODEVICE)RTMemAllocZ(sizeof(PDMAUDIODEVICE));
223 if (!pDev)
224 return NULL;
225
226 if (cbData)
227 {
228 pDev->pvData = RTMemAllocZ(cbData);
229 if (!pDev->pvData)
230 {
231 RTMemFree(pDev);
232 return NULL;
233 }
234 }
235
236 pDev->cbData = cbData;
237
238 pDev->cMaxInputChannels = 0;
239 pDev->cMaxOutputChannels = 0;
240
241 return pDev;
242}
243
244/**
245 * Frees an audio device.
246 *
247 * @param pDev Device to free.
248 */
249void DrvAudioHlpDeviceFree(PPDMAUDIODEVICE pDev)
250{
251 if (!pDev)
252 return;
253
254 Assert(pDev->cRefCount == 0);
255
256 if (pDev->pvData)
257 {
258 Assert(pDev->cbData);
259
260 RTMemFree(pDev->pvData);
261 pDev->pvData = NULL;
262 }
263
264 RTMemFree(pDev);
265 pDev = NULL;
266}
267
268/**
269 * Duplicates an audio device entry.
270 *
271 * @returns Duplicated audio device entry on success, or NULL on failure.
272 * @param pDev Audio device entry to duplicate.
273 * @param fCopyUserData Whether to also copy the user data portion or not.
274 */
275PPDMAUDIODEVICE DrvAudioHlpDeviceDup(const PPDMAUDIODEVICE pDev, bool fCopyUserData)
276{
277 AssertPtrReturn(pDev, NULL);
278
279 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceAlloc(fCopyUserData ? pDev->cbData : 0);
280 if (pDevDup)
281 {
282 memcpy(pDevDup, pDev, sizeof(PDMAUDIODEVICE));
283
284 if ( fCopyUserData
285 && pDevDup->cbData)
286 {
287 memcpy(pDevDup->pvData, pDev->pvData, pDevDup->cbData);
288 }
289 else
290 {
291 pDevDup->cbData = 0;
292 pDevDup->pvData = NULL;
293 }
294 }
295
296 return pDevDup;
297}
298
299/**
300 * Initializes an audio device enumeration structure.
301 *
302 * @returns IPRT status code.
303 * @param pDevEnm Device enumeration to initialize.
304 */
305int DrvAudioHlpDeviceEnumInit(PPDMAUDIODEVICEENUM pDevEnm)
306{
307 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
308
309 RTListInit(&pDevEnm->lstDevices);
310 pDevEnm->cDevices = 0;
311
312 return VINF_SUCCESS;
313}
314
315/**
316 * Frees audio device enumeration data.
317 *
318 * @param pDevEnm Device enumeration to destroy.
319 */
320void DrvAudioHlpDeviceEnumFree(PPDMAUDIODEVICEENUM pDevEnm)
321{
322 if (!pDevEnm)
323 return;
324
325 PPDMAUDIODEVICE pDev, pDevNext;
326 RTListForEachSafe(&pDevEnm->lstDevices, pDev, pDevNext, PDMAUDIODEVICE, Node)
327 {
328 RTListNodeRemove(&pDev->Node);
329
330 DrvAudioHlpDeviceFree(pDev);
331
332 pDevEnm->cDevices--;
333 }
334
335 /* Sanity. */
336 Assert(RTListIsEmpty(&pDevEnm->lstDevices));
337 Assert(pDevEnm->cDevices == 0);
338}
339
340/**
341 * Adds an audio device to a device enumeration.
342 *
343 * @return IPRT status code.
344 * @param pDevEnm Device enumeration to add device to.
345 * @param pDev Device to add. The pointer will be owned by the device enumeration then.
346 */
347int DrvAudioHlpDeviceEnumAdd(PPDMAUDIODEVICEENUM pDevEnm, PPDMAUDIODEVICE pDev)
348{
349 AssertPtrReturn(pDevEnm, VERR_INVALID_POINTER);
350 AssertPtrReturn(pDev, VERR_INVALID_POINTER);
351
352 RTListAppend(&pDevEnm->lstDevices, &pDev->Node);
353 pDevEnm->cDevices++;
354
355 return VINF_SUCCESS;
356}
357
358/**
359 * Duplicates a device enumeration.
360 *
361 * @returns Duplicated device enumeration, or NULL on failure.
362 * Must be free'd with DrvAudioHlpDeviceEnumFree().
363 * @param pDevEnm Device enumeration to duplicate.
364 */
365PPDMAUDIODEVICEENUM DrvAudioHlpDeviceEnumDup(const PPDMAUDIODEVICEENUM pDevEnm)
366{
367 AssertPtrReturn(pDevEnm, NULL);
368
369 PPDMAUDIODEVICEENUM pDevEnmDup = (PPDMAUDIODEVICEENUM)RTMemAlloc(sizeof(PDMAUDIODEVICEENUM));
370 if (!pDevEnmDup)
371 return NULL;
372
373 int rc2 = DrvAudioHlpDeviceEnumInit(pDevEnmDup);
374 AssertRC(rc2);
375
376 PPDMAUDIODEVICE pDev;
377 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
378 {
379 PPDMAUDIODEVICE pDevDup = DrvAudioHlpDeviceDup(pDev, true /* fCopyUserData */);
380 if (!pDevDup)
381 {
382 rc2 = VERR_NO_MEMORY;
383 break;
384 }
385
386 rc2 = DrvAudioHlpDeviceEnumAdd(pDevEnmDup, pDevDup);
387 if (RT_FAILURE(rc2))
388 {
389 DrvAudioHlpDeviceFree(pDevDup);
390 break;
391 }
392 }
393
394 if (RT_FAILURE(rc2))
395 {
396 DrvAudioHlpDeviceEnumFree(pDevEnmDup);
397 pDevEnmDup = NULL;
398 }
399
400 return pDevEnmDup;
401}
402
403/**
404 * Copies device enumeration entries from the source to the destination enumeration.
405 *
406 * @returns IPRT status code.
407 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
408 * @param pSrcDevEnm Source enumeration to use.
409 * @param enmUsage Which entries to copy. Specify PDMAUDIODIR_ANY to copy all entries.
410 * @param fCopyUserData Whether to also copy the user data portion or not.
411 */
412int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm,
413 PDMAUDIODIR enmUsage, bool fCopyUserData)
414{
415 AssertPtrReturn(pDstDevEnm, VERR_INVALID_POINTER);
416 AssertPtrReturn(pSrcDevEnm, VERR_INVALID_POINTER);
417
418 int rc = VINF_SUCCESS;
419
420 PPDMAUDIODEVICE pSrcDev;
421 RTListForEach(&pSrcDevEnm->lstDevices, pSrcDev, PDMAUDIODEVICE, Node)
422 {
423 if ( enmUsage != PDMAUDIODIR_ANY
424 && enmUsage != pSrcDev->enmUsage)
425 {
426 continue;
427 }
428
429 PPDMAUDIODEVICE pDstDev = DrvAudioHlpDeviceDup(pSrcDev, fCopyUserData);
430 if (!pDstDev)
431 {
432 rc = VERR_NO_MEMORY;
433 break;
434 }
435
436 rc = DrvAudioHlpDeviceEnumAdd(pDstDevEnm, pDstDev);
437 if (RT_FAILURE(rc))
438 break;
439 }
440
441 return rc;
442}
443
444/**
445 * Copies all device enumeration entries from the source to the destination enumeration.
446 *
447 * Note: Does *not* copy the user-specific data assigned to a device enumeration entry.
448 * To do so, use DrvAudioHlpDeviceEnumCopyEx().
449 *
450 * @returns IPRT status code.
451 * @param pDstDevEnm Destination enumeration to store enumeration entries into.
452 * @param pSrcDevEnm Source enumeration to use.
453 */
454int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm)
455{
456 return DrvAudioHlpDeviceEnumCopyEx(pDstDevEnm, pSrcDevEnm, PDMAUDIODIR_ANY, false /* fCopyUserData */);
457}
458
459/**
460 * Returns the default device of a given device enumeration.
461 * This assumes that only one default device per usage is set.
462 *
463 * @returns Default device if found, or NULL if none found.
464 * @param pDevEnm Device enumeration to get default device for.
465 * @param enmUsage Usage to get default device for.
466 */
467PPDMAUDIODEVICE DrvAudioHlpDeviceEnumGetDefaultDevice(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage)
468{
469 AssertPtrReturn(pDevEnm, NULL);
470
471 PPDMAUDIODEVICE pDev;
472 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
473 {
474 if (enmUsage != PDMAUDIODIR_ANY)
475 {
476 if (enmUsage != pDev->enmUsage) /* Wrong usage? Skip. */
477 continue;
478 }
479
480 if (pDev->fFlags & PDMAUDIODEV_FLAGS_DEFAULT)
481 return pDev;
482 }
483
484 return NULL;
485}
486
487/**
488 * Logs an audio device enumeration.
489 *
490 * @param pszDesc Logging description.
491 * @param pDevEnm Device enumeration to log.
492 */
493void DrvAudioHlpDeviceEnumPrint(const char *pszDesc, const PPDMAUDIODEVICEENUM pDevEnm)
494{
495 AssertPtrReturnVoid(pszDesc);
496 AssertPtrReturnVoid(pDevEnm);
497
498 LogFunc(("%s: %RU16 devices\n", pszDesc, pDevEnm->cDevices));
499
500 PPDMAUDIODEVICE pDev;
501 RTListForEach(&pDevEnm->lstDevices, pDev, PDMAUDIODEVICE, Node)
502 {
503 char *pszFlags = DrvAudioHlpAudDevFlagsToStrA(pDev->fFlags);
504
505 LogFunc(("Device '%s':\n", pDev->szName));
506 LogFunc(("\tUsage = %s\n", DrvAudioHlpAudDirToStr(pDev->enmUsage)));
507 LogFunc(("\tFlags = %s\n", pszFlags ? pszFlags : "<NONE>"));
508 LogFunc(("\tInput channels = %RU8\n", pDev->cMaxInputChannels));
509 LogFunc(("\tOutput channels = %RU8\n", pDev->cMaxOutputChannels));
510 LogFunc(("\tData = %p (%zu bytes)\n", pDev->pvData, pDev->cbData));
511
512 if (pszFlags)
513 RTStrFree(pszFlags);
514 }
515}
516
517/**
518 * Converts an audio direction to a string.
519 *
520 * @returns Stringified audio direction, or "Unknown", if not found.
521 * @param enmDir Audio direction to convert.
522 */
523const char *DrvAudioHlpAudDirToStr(PDMAUDIODIR enmDir)
524{
525 switch (enmDir)
526 {
527 case PDMAUDIODIR_UNKNOWN: return "Unknown";
528 case PDMAUDIODIR_IN: return "Input";
529 case PDMAUDIODIR_OUT: return "Output";
530 case PDMAUDIODIR_ANY: return "Duplex";
531 default: break;
532 }
533
534 AssertMsgFailed(("Invalid audio direction %ld\n", enmDir));
535 return "Unknown";
536}
537
538/**
539 * Converts an audio mixer control to a string.
540 *
541 * @returns Stringified audio mixer control or "Unknown", if not found.
542 * @param enmMixerCtl Audio mixer control to convert.
543 */
544const char *DrvAudioHlpAudMixerCtlToStr(PDMAUDIOMIXERCTL enmMixerCtl)
545{
546 switch (enmMixerCtl)
547 {
548 case PDMAUDIOMIXERCTL_VOLUME_MASTER: return "Master Volume";
549 case PDMAUDIOMIXERCTL_FRONT: return "Front";
550 case PDMAUDIOMIXERCTL_CENTER_LFE: return "Center / LFE";
551 case PDMAUDIOMIXERCTL_REAR: return "Rear";
552 case PDMAUDIOMIXERCTL_LINE_IN: return "Line-In";
553 case PDMAUDIOMIXERCTL_MIC_IN: return "Microphone-In";
554 default: break;
555 }
556
557 AssertMsgFailed(("Invalid mixer control %ld\n", enmMixerCtl));
558 return "Unknown";
559}
560
561/**
562 * Converts an audio device flags to a string.
563 *
564 * @returns Stringified audio flags. Must be free'd with RTStrFree().
565 * NULL if no flags set.
566 * @param fFlags Audio flags to convert.
567 */
568char *DrvAudioHlpAudDevFlagsToStrA(PDMAUDIODEVFLAG fFlags)
569{
570#define APPEND_FLAG_TO_STR(_aFlag) \
571 if (fFlags & PDMAUDIODEV_FLAGS_##_aFlag) \
572 { \
573 if (pszFlags) \
574 { \
575 rc2 = RTStrAAppend(&pszFlags, " "); \
576 if (RT_FAILURE(rc2)) \
577 break; \
578 } \
579 \
580 rc2 = RTStrAAppend(&pszFlags, #_aFlag); \
581 if (RT_FAILURE(rc2)) \
582 break; \
583 } \
584
585 char *pszFlags = NULL;
586 int rc2 = VINF_SUCCESS;
587
588 do
589 {
590 APPEND_FLAG_TO_STR(DEFAULT);
591 APPEND_FLAG_TO_STR(HOTPLUG);
592 APPEND_FLAG_TO_STR(BUGGY);
593 APPEND_FLAG_TO_STR(IGNORE);
594 APPEND_FLAG_TO_STR(LOCKED);
595 APPEND_FLAG_TO_STR(DEAD);
596
597 } while (0);
598
599 if (!pszFlags)
600 rc2 = RTStrAAppend(&pszFlags, "NONE");
601
602 if ( RT_FAILURE(rc2)
603 && pszFlags)
604 {
605 RTStrFree(pszFlags);
606 pszFlags = NULL;
607 }
608
609#undef APPEND_FLAG_TO_STR
610
611 return pszFlags;
612}
613
614/**
615 * Converts a recording source enumeration to a string.
616 *
617 * @returns Stringified recording source, or "Unknown", if not found.
618 * @param enmRecSrc Recording source to convert.
619 */
620const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSOURCE enmRecSrc)
621{
622 switch (enmRecSrc)
623 {
624 case PDMAUDIORECSOURCE_UNKNOWN: return "Unknown";
625 case PDMAUDIORECSOURCE_MIC: return "Microphone In";
626 case PDMAUDIORECSOURCE_CD: return "CD";
627 case PDMAUDIORECSOURCE_VIDEO: return "Video";
628 case PDMAUDIORECSOURCE_AUX: return "AUX";
629 case PDMAUDIORECSOURCE_LINE: return "Line In";
630 case PDMAUDIORECSOURCE_PHONE: return "Phone";
631 default:
632 break;
633 }
634
635 AssertMsgFailed(("Invalid recording source %ld\n", enmRecSrc));
636 return "Unknown";
637}
638
639/**
640 * Returns wether the given audio format has signed bits or not.
641 *
642 * @return IPRT status code.
643 * @return bool @c true for signed bits, @c false for unsigned.
644 * @param enmFmt Audio format to retrieve value for.
645 */
646bool DrvAudioHlpAudFmtIsSigned(PDMAUDIOFMT enmFmt)
647{
648 switch (enmFmt)
649 {
650 case PDMAUDIOFMT_S8:
651 case PDMAUDIOFMT_S16:
652 case PDMAUDIOFMT_S32:
653 return true;
654
655 case PDMAUDIOFMT_U8:
656 case PDMAUDIOFMT_U16:
657 case PDMAUDIOFMT_U32:
658 return false;
659
660 default:
661 break;
662 }
663
664 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
665 return false;
666}
667
668/**
669 * Returns the bits of a given audio format.
670 *
671 * @return IPRT status code.
672 * @return uint8_t Bits of audio format.
673 * @param enmFmt Audio format to retrieve value for.
674 */
675uint8_t DrvAudioHlpAudFmtToBits(PDMAUDIOFMT enmFmt)
676{
677 switch (enmFmt)
678 {
679 case PDMAUDIOFMT_S8:
680 case PDMAUDIOFMT_U8:
681 return 8;
682
683 case PDMAUDIOFMT_U16:
684 case PDMAUDIOFMT_S16:
685 return 16;
686
687 case PDMAUDIOFMT_U32:
688 case PDMAUDIOFMT_S32:
689 return 32;
690
691 default:
692 break;
693 }
694
695 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
696 return 0;
697}
698
699/**
700 * Converts an audio format to a string.
701 *
702 * @returns Stringified audio format, or "Unknown", if not found.
703 * @param enmFmt Audio format to convert.
704 */
705const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt)
706{
707 switch (enmFmt)
708 {
709 case PDMAUDIOFMT_U8:
710 return "U8";
711
712 case PDMAUDIOFMT_U16:
713 return "U16";
714
715 case PDMAUDIOFMT_U32:
716 return "U32";
717
718 case PDMAUDIOFMT_S8:
719 return "S8";
720
721 case PDMAUDIOFMT_S16:
722 return "S16";
723
724 case PDMAUDIOFMT_S32:
725 return "S32";
726
727 default:
728 break;
729 }
730
731 AssertMsgFailed(("Bogus audio format %ld\n", enmFmt));
732 return "Unknown";
733}
734
735/**
736 * Converts a given string to an audio format.
737 *
738 * @returns Audio format for the given string, or PDMAUDIOFMT_INVALID if not found.
739 * @param pszFmt String to convert to an audio format.
740 */
741PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt)
742{
743 AssertPtrReturn(pszFmt, PDMAUDIOFMT_INVALID);
744
745 if (!RTStrICmp(pszFmt, "u8"))
746 return PDMAUDIOFMT_U8;
747 else if (!RTStrICmp(pszFmt, "u16"))
748 return PDMAUDIOFMT_U16;
749 else if (!RTStrICmp(pszFmt, "u32"))
750 return PDMAUDIOFMT_U32;
751 else if (!RTStrICmp(pszFmt, "s8"))
752 return PDMAUDIOFMT_S8;
753 else if (!RTStrICmp(pszFmt, "s16"))
754 return PDMAUDIOFMT_S16;
755 else if (!RTStrICmp(pszFmt, "s32"))
756 return PDMAUDIOFMT_S32;
757
758 AssertMsgFailed(("Invalid audio format '%s'\n", pszFmt));
759 return PDMAUDIOFMT_INVALID;
760}
761
762/**
763 * Checks whether two given PCM properties are equal.
764 *
765 * @returns @c true if equal, @c false if not.
766 * @param pProps1 First properties to compare.
767 * @param pProps2 Second properties to compare.
768 */
769bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps1, const PPDMAUDIOPCMPROPS pProps2)
770{
771 AssertPtrReturn(pProps1, false);
772 AssertPtrReturn(pProps2, false);
773
774 if (pProps1 == pProps2) /* If the pointers match, take a shortcut. */
775 return true;
776
777 return pProps1->uHz == pProps2->uHz
778 && pProps1->cChannels == pProps2->cChannels
779 && pProps1->cBits == pProps2->cBits
780 && pProps1->fSigned == pProps2->fSigned
781 && pProps1->fSwapEndian == pProps2->fSwapEndian;
782}
783
784/**
785 * Checks whether given PCM properties are valid or not.
786 *
787 * Returns @c true if properties are valid, @c false if not.
788 * @param pProps PCM properties to check.
789 *
790 * @remarks Does *not* support surround (> 2 channels) yet! This is intentional, as
791 * we consider surround support as experimental / not enabled by default for now.
792 */
793bool DrvAudioHlpPCMPropsAreValid(const PPDMAUDIOPCMPROPS pProps)
794{
795 AssertPtrReturn(pProps, false);
796
797 bool fValid = ( pProps->cChannels == 1
798 || pProps->cChannels == 2); /* Either stereo (2) or mono (1), per stream. */
799
800 if (fValid)
801 {
802 switch (pProps->cBits)
803 {
804 case 8:
805 case 16:
806 /** @todo Do we need support for 24-bit samples? */
807 case 32:
808 break;
809 default:
810 fValid = false;
811 break;
812 }
813 }
814
815 if (!fValid)
816 return false;
817
818 fValid &= pProps->uHz > 0;
819 fValid &= pProps->cShift == PDMAUDIOPCMPROPS_MAKE_SHIFT_PARMS(pProps->cBits, pProps->cChannels);
820
821 fValid &= pProps->fSwapEndian == false; /** @todo Handling Big Endian audio data is not supported yet. */
822
823 return fValid;
824}
825
826/**
827 * Checks whether the given PCM properties are equal with the given
828 * stream configuration.
829 *
830 * @returns @c true if equal, @c false if not.
831 * @param pProps PCM properties to compare.
832 * @param pCfg Stream configuration to compare.
833 */
834bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pProps, const PPDMAUDIOSTREAMCFG pCfg)
835{
836 AssertPtrReturn(pProps, false);
837 AssertPtrReturn(pCfg, false);
838
839 return DrvAudioHlpPCMPropsAreEqual(pProps, &pCfg->Props);
840}
841
842/**
843 * Prints PCM properties to the debug log.
844 *
845 * @param pProps Stream configuration to log.
846 */
847void DrvAudioHlpPCMPropsPrint(const PPDMAUDIOPCMPROPS pProps)
848{
849 AssertPtrReturnVoid(pProps);
850
851 Log(("uHz=%RU32, cChannels=%RU8, cBits=%RU8%s",
852 pProps->uHz, pProps->cChannels, pProps->cBits, pProps->fSigned ? "S" : "U"));
853}
854
855/**
856 * Converts PCM properties to a audio stream configuration.
857 *
858 * @return IPRT status code.
859 * @param pProps Pointer to PCM properties to convert.
860 * @param pCfg Pointer to audio stream configuration to store result into.
861 */
862int DrvAudioHlpPCMPropsToStreamCfg(const PPDMAUDIOPCMPROPS pProps, PPDMAUDIOSTREAMCFG pCfg)
863{
864 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
865 AssertPtrReturn(pCfg, VERR_INVALID_POINTER);
866
867 memcpy(&pCfg->Props, pProps, sizeof(PDMAUDIOPCMPROPS));
868 return VINF_SUCCESS;
869}
870
871/**
872 * Checks whether a given stream configuration is valid or not.
873 *
874 * Returns @c true if configuration is valid, @c false if not.
875 * @param pCfg Stream configuration to check.
876 *
877 * @remarks Does *not* support surround (> 2 channels) yet! This is intentional, as
878 * we consider surround support as experimental / not enabled by default for now.
879 */
880bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg)
881{
882 AssertPtrReturn(pCfg, false);
883
884 bool fValid = ( pCfg->enmDir == PDMAUDIODIR_IN
885 || pCfg->enmDir == PDMAUDIODIR_OUT);
886
887 if (fValid)
888 fValid = DrvAudioHlpPCMPropsAreValid(&pCfg->Props);
889
890 return fValid;
891}
892
893/**
894 * Frees an allocated audio stream configuration.
895 *
896 * @param pCfg Audio stream configuration to free.
897 */
898void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg)
899{
900 if (pCfg)
901 {
902 RTMemFree(pCfg);
903 pCfg = NULL;
904 }
905}
906
907/**
908 * Copies a source stream configuration to a destination stream configuration.
909 *
910 * @returns IPRT status code.
911 * @param pDstCfg Destination stream configuration to copy source to.
912 * @param pSrcCfg Source stream configuration to copy to destination.
913 */
914int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg)
915{
916 AssertPtrReturn(pDstCfg, VERR_INVALID_POINTER);
917 AssertPtrReturn(pSrcCfg, VERR_INVALID_POINTER);
918
919#ifdef VBOX_STRICT
920 if (!DrvAudioHlpStreamCfgIsValid(pSrcCfg))
921 {
922 AssertMsgFailed(("Stream config '%s' (%p) is invalid\n", pSrcCfg->szName, pSrcCfg));
923 return VERR_INVALID_PARAMETER;
924 }
925#endif
926
927 memcpy(pDstCfg, pSrcCfg, sizeof(PDMAUDIOSTREAMCFG));
928
929 return VINF_SUCCESS;
930}
931
932/**
933 * Duplicates an audio stream configuration.
934 * Must be free'd with DrvAudioHlpStreamCfgFree().
935 *
936 * @return Duplicates audio stream configuration on success, or NULL on failure.
937 * @param pCfg Audio stream configuration to duplicate.
938 */
939PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg)
940{
941 AssertPtrReturn(pCfg, NULL);
942
943 PPDMAUDIOSTREAMCFG pDst = (PPDMAUDIOSTREAMCFG)RTMemAllocZ(sizeof(PDMAUDIOSTREAMCFG));
944 if (!pDst)
945 return NULL;
946
947 int rc2 = DrvAudioHlpStreamCfgCopy(pDst, pCfg);
948 if (RT_FAILURE(rc2))
949 {
950 DrvAudioHlpStreamCfgFree(pDst);
951 pDst = NULL;
952 }
953
954 AssertPtr(pDst);
955 return pDst;
956}
957
958/**
959 * Prints an audio stream configuration to the debug log.
960 *
961 * @param pCfg Stream configuration to log.
962 */
963void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg)
964{
965 AssertPtrReturnVoid(pCfg);
966
967 LogFlowFunc(("uHz=%RU32, cChannels=%RU8, cBits=%RU8%s",
968 pCfg->Props.uHz, pCfg->Props.cChannels, pCfg->Props.cBits, pCfg->Props.fSigned ? "S" : "U"));
969}
970
971/**
972 * Converts a stream command to a string.
973 *
974 * @returns Stringified stream command, or "Unknown", if not found.
975 * @param enmCmd Stream command to convert.
976 */
977const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd)
978{
979 switch (enmCmd)
980 {
981 case PDMAUDIOSTREAMCMD_UNKNOWN: return "Unknown";
982 case PDMAUDIOSTREAMCMD_ENABLE: return "Enable";
983 case PDMAUDIOSTREAMCMD_DISABLE: return "Disable";
984 case PDMAUDIOSTREAMCMD_PAUSE: return "Pause";
985 case PDMAUDIOSTREAMCMD_RESUME: return "Resume";
986 default: break;
987 }
988
989 AssertMsgFailed(("Invalid stream command %ld\n", enmCmd));
990 return "Unknown";
991}
992
993/**
994 * Calculates the audio bit rate of the given bits per sample, the Hz and the number
995 * of audio channels.
996 *
997 * Divide the result by 8 to get the byte rate.
998 *
999 * @returns The calculated bit rate.
1000 * @param cBits Number of bits per sample.
1001 * @param uHz Hz (Hertz) rate.
1002 * @param cChannels Number of audio channels.
1003 */
1004uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels)
1005{
1006 return (cBits * uHz * cChannels);
1007}
1008
1009/**
1010 * Calculates the audio bit rate out of a given audio stream configuration.
1011 *
1012 * Divide the result by 8 to get the byte rate.
1013 *
1014 * @returns The calculated bit rate.
1015 * @param pProps PCM properties to calculate bitrate for.
1016 *
1017 * @remark
1018 */
1019uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps)
1020{
1021 return DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels);
1022}
1023
1024/**
1025 * Sanitizes the file name component so that unsupported characters
1026 * will be replaced by an underscore ("_").
1027 *
1028 * @return IPRT status code.
1029 * @param pszPath Path to sanitize.
1030 * @param cbPath Size (in bytes) of path to sanitize.
1031 */
1032int DrvAudioHlpSanitizeFileName(char *pszPath, size_t cbPath)
1033{
1034 RT_NOREF(cbPath);
1035 int rc = VINF_SUCCESS;
1036#ifdef RT_OS_WINDOWS
1037 /* Filter out characters not allowed on Windows platforms, put in by
1038 RTTimeSpecToString(). */
1039 /** @todo Use something like RTPathSanitize() if available later some time. */
1040 static RTUNICP const s_uszValidRangePairs[] =
1041 {
1042 ' ', ' ',
1043 '(', ')',
1044 '-', '.',
1045 '0', '9',
1046 'A', 'Z',
1047 'a', 'z',
1048 '_', '_',
1049 0xa0, 0xd7af,
1050 '\0'
1051 };
1052 ssize_t cReplaced = RTStrPurgeComplementSet(pszPath, s_uszValidRangePairs, '_' /* Replacement */);
1053 if (cReplaced < 0)
1054 rc = VERR_INVALID_UTF8_ENCODING;
1055#else
1056 RT_NOREF(pszPath);
1057#endif
1058 return rc;
1059}
1060
1061/**
1062 * Constructs an unique file name, based on the given path and the audio file type.
1063 *
1064 * @returns IPRT status code.
1065 * @param pszFile Where to store the constructed file name.
1066 * @param cchFile Size (in characters) of the file name buffer.
1067 * @param pszPath Base path to use.
1068 * @param pszName A name for better identifying the file. Optional.
1069 * @param enmType Audio file type to construct file name for.
1070 */
1071int DrvAudioHlpGetFileName(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName, PDMAUDIOFILETYPE enmType)
1072{
1073 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1074 AssertReturn(cchFile, VERR_INVALID_PARAMETER);
1075 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1076 /* pszName is optional. */
1077
1078 int rc;
1079
1080 do
1081 {
1082 char szFilePath[RTPATH_MAX];
1083 RTStrPrintf(szFilePath, sizeof(szFilePath), "%s", pszPath);
1084
1085 /* Create it when necessary. */
1086 if (!RTDirExists(szFilePath))
1087 {
1088 rc = RTDirCreateFullPath(szFilePath, RTFS_UNIX_IRWXU);
1089 if (RT_FAILURE(rc))
1090 break;
1091 }
1092
1093 /* The actually drop directory consist of the current time stamp and a
1094 * unique number when necessary. */
1095 char pszTime[64];
1096 RTTIMESPEC time;
1097 if (!RTTimeSpecToString(RTTimeNow(&time), pszTime, sizeof(pszTime)))
1098 {
1099 rc = VERR_BUFFER_OVERFLOW;
1100 break;
1101 }
1102
1103 rc = DrvAudioHlpSanitizeFileName(pszTime, sizeof(pszTime));
1104 if (RT_FAILURE(rc))
1105 break;
1106
1107 rc = RTPathAppend(szFilePath, sizeof(szFilePath), pszTime);
1108 if (RT_FAILURE(rc))
1109 break;
1110
1111 if (pszName) /* Optional name given? */
1112 {
1113 rc = RTStrCat(szFilePath, sizeof(szFilePath), "-");
1114 if (RT_FAILURE(rc))
1115 break;
1116
1117 rc = RTStrCat(szFilePath, sizeof(szFilePath), pszName);
1118 if (RT_FAILURE(rc))
1119 break;
1120 }
1121
1122 switch (enmType)
1123 {
1124 case PDMAUDIOFILETYPE_WAV:
1125 rc = RTStrCat(szFilePath, sizeof(szFilePath), ".wav");
1126 break;
1127
1128 default:
1129 AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
1130 }
1131
1132 if (RT_FAILURE(rc))
1133 break;
1134
1135 RTStrPrintf(pszFile, cchFile, "%s", szFilePath);
1136
1137 } while (0);
1138
1139 LogFlowFuncLeaveRC(rc);
1140 return rc;
1141}
1142
1143/**
1144 * Opens or creates a wave (.WAV) file.
1145 *
1146 * @returns IPRT status code.
1147 * @param pFile Pointer to audio file handle to use.
1148 * @param pszFile File path of file to open or create.
1149 * @param fOpen Open flags.
1150 * @param pProps PCM properties to use.
1151 * @param fFlags Audio file flags.
1152 */
1153int DrvAudioHlpWAVFileOpen(PPDMAUDIOFILE pFile, const char *pszFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps,
1154 PDMAUDIOFILEFLAGS fFlags)
1155{
1156 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1157 AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1158 /** @todo Validate fOpen flags. */
1159 AssertPtrReturn(pProps, VERR_INVALID_POINTER);
1160 RT_NOREF(fFlags); /** @todo Validate fFlags flags. */
1161
1162 Assert(pProps->cChannels);
1163 Assert(pProps->uHz);
1164 Assert(pProps->cBits);
1165
1166 pFile->pvData = (PAUDIOWAVFILEDATA)RTMemAllocZ(sizeof(AUDIOWAVFILEDATA));
1167 if (!pFile->pvData)
1168 return VERR_NO_MEMORY;
1169 pFile->cbData = sizeof(PAUDIOWAVFILEDATA);
1170
1171 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1172 AssertPtr(pData);
1173
1174 /* Header. */
1175 pData->Hdr.u32RIFF = AUDIO_MAKE_FOURCC('R','I','F','F');
1176 pData->Hdr.u32Size = 36;
1177 pData->Hdr.u32WAVE = AUDIO_MAKE_FOURCC('W','A','V','E');
1178
1179 pData->Hdr.u32Fmt = AUDIO_MAKE_FOURCC('f','m','t',' ');
1180 pData->Hdr.u32Size1 = 16; /* Means PCM. */
1181 pData->Hdr.u16AudioFormat = 1; /* PCM, linear quantization. */
1182 pData->Hdr.u16NumChannels = pProps->cChannels;
1183 pData->Hdr.u32SampleRate = pProps->uHz;
1184 pData->Hdr.u32ByteRate = DrvAudioHlpCalcBitrate(pProps->cBits, pProps->uHz, pProps->cChannels) / 8;
1185 pData->Hdr.u16BlockAlign = pProps->cChannels * pProps->cBits / 8;
1186 pData->Hdr.u16BitsPerSample = pProps->cBits;
1187
1188 /* Data chunk. */
1189 pData->Hdr.u32ID2 = AUDIO_MAKE_FOURCC('d','a','t','a');
1190 pData->Hdr.u32Size2 = 0;
1191
1192 int rc = RTFileOpen(&pFile->hFile, pszFile, fOpen);
1193 if (RT_SUCCESS(rc))
1194 {
1195 rc = RTFileWrite(pFile->hFile, &pData->Hdr, sizeof(pData->Hdr), NULL);
1196 if (RT_FAILURE(rc))
1197 {
1198 RTFileClose(pFile->hFile);
1199 pFile->hFile = NIL_RTFILE;
1200 }
1201 }
1202
1203 if (RT_SUCCESS(rc))
1204 {
1205 pFile->enmType = PDMAUDIOFILETYPE_WAV;
1206
1207 RTStrPrintf(pFile->szName, RT_ELEMENTS(pFile->szName), "%s", pszFile);
1208 }
1209 else
1210 {
1211 RTMemFree(pFile->pvData);
1212 pFile->pvData = NULL;
1213 pFile->cbData = 0;
1214 }
1215
1216 return rc;
1217}
1218
1219/**
1220 * Closes a wave (.WAV) audio file.
1221 *
1222 * @returns IPRT status code.
1223 * @param pFile Audio file handle to close.
1224 */
1225int DrvAudioHlpWAVFileClose(PPDMAUDIOFILE pFile)
1226{
1227 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1228
1229 Assert(pFile->enmType == PDMAUDIOFILETYPE_WAV);
1230
1231 if (pFile->hFile != NIL_RTFILE)
1232 {
1233 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1234 AssertPtr(pData);
1235
1236 /* Update the header with the current data size. */
1237 RTFileWriteAt(pFile->hFile, 0, &pData->Hdr, sizeof(pData->Hdr), NULL);
1238
1239 RTFileClose(pFile->hFile);
1240 pFile->hFile = NIL_RTFILE;
1241 }
1242
1243 if (pFile->pvData)
1244 {
1245 RTMemFree(pFile->pvData);
1246 pFile->pvData = NULL;
1247 }
1248
1249 pFile->cbData = 0;
1250 pFile->enmType = PDMAUDIOFILETYPE_UNKNOWN;
1251
1252 return VINF_SUCCESS;
1253}
1254
1255/**
1256 * Returns the raw PCM audio data size of a wave file.
1257 * This does *not* include file headers and other data which does
1258 * not belong to the actual PCM audio data.
1259 *
1260 * @returns Size (in bytes) of the raw PCM audio data.
1261 * @param pFile Audio file handle to retrieve the audio data size for.
1262 */
1263size_t DrvAudioHlpWAVFileGetDataSize(PPDMAUDIOFILE pFile)
1264{
1265 AssertPtrReturn(pFile, 0);
1266
1267 Assert(pFile->enmType == PDMAUDIOFILETYPE_WAV);
1268
1269 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1270 AssertPtr(pData);
1271
1272 return pData->Hdr.u32Size2;
1273}
1274
1275/**
1276 * Write PCM data to a wave (.WAV) file.
1277 *
1278 * @returns IPRT status code.
1279 * @param pFile Audio file handle to write PCM data to.
1280 * @param pvBuf Audio data to write.
1281 * @param cbBuf Size (in bytes) of audio data to write.
1282 * @param fFlags Additional write flags. Not being used at the moment and must be 0.
1283 */
1284int DrvAudioHlpWAVFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags)
1285{
1286 AssertPtrReturn(pFile, VERR_INVALID_POINTER);
1287 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
1288
1289 AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER); /** @todo fFlags are currently not implemented. */
1290
1291 Assert(pFile->enmType == PDMAUDIOFILETYPE_WAV);
1292
1293 if (!cbBuf)
1294 return VINF_SUCCESS;
1295
1296 PAUDIOWAVFILEDATA pData = (PAUDIOWAVFILEDATA)pFile->pvData;
1297 AssertPtr(pData);
1298
1299 int rc = RTFileWrite(pFile->hFile, pvBuf, cbBuf, NULL);
1300 if (RT_SUCCESS(rc))
1301 {
1302 pData->Hdr.u32Size += (uint32_t)cbBuf;
1303 pData->Hdr.u32Size2 += (uint32_t)cbBuf;
1304 }
1305
1306 return rc;
1307}
1308
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