VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/DrvAudio.h@ 87861

Last change on this file since 87861 was 87861, checked in by vboxsync, 4 years ago

Audio: Unified debug .WAV path file generation so that all data lands at the same place.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.7 KB
Line 
1/* $Id: DrvAudio.h 87861 2021-02-24 15:04:02Z vboxsync $ */
2/** @file
3 * Intermediate audio driver header.
4 */
5
6/*
7 * Copyright (C) 2006-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef VBOX_INCLUDED_SRC_Audio_DrvAudio_h
19#define VBOX_INCLUDED_SRC_Audio_DrvAudio_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include <limits.h>
25
26#include <iprt/circbuf.h>
27#include <iprt/critsect.h>
28#include <iprt/file.h>
29#include <iprt/path.h>
30
31#include <VBox/vmm/pdmdev.h>
32#include <VBox/vmm/pdm.h>
33#include <VBox/vmm/pdmaudioifs.h>
34
35typedef enum
36{
37 AUD_OPT_INT,
38 AUD_OPT_FMT,
39 AUD_OPT_STR,
40 AUD_OPT_BOOL
41} audio_option_tag_e;
42
43typedef struct audio_option
44{
45 const char *name;
46 audio_option_tag_e tag;
47 void *valp;
48 const char *descr;
49 int *overridenp;
50 int overriden;
51} audio_option;
52
53#ifdef VBOX_WITH_STATISTICS
54/**
55 * Structure for keeping stream statistics for the
56 * statistic manager (STAM).
57 */
58typedef struct DRVAUDIOSTATS
59{
60 STAMCOUNTER TotalStreamsActive;
61 STAMCOUNTER TotalStreamsCreated;
62 STAMCOUNTER TotalFramesRead;
63 STAMCOUNTER TotalFramesWritten;
64 STAMCOUNTER TotalFramesMixedIn;
65 STAMCOUNTER TotalFramesMixedOut;
66 STAMCOUNTER TotalFramesLostIn;
67 STAMCOUNTER TotalFramesLostOut;
68 STAMCOUNTER TotalFramesOut;
69 STAMCOUNTER TotalFramesIn;
70 STAMCOUNTER TotalBytesRead;
71 STAMCOUNTER TotalBytesWritten;
72 /** How much delay (in ms) for input processing. */
73 STAMPROFILEADV DelayIn;
74 /** How much delay (in ms) for output processing. */
75 STAMPROFILEADV DelayOut;
76} DRVAUDIOSTATS, *PDRVAUDIOSTATS;
77#endif
78
79/**
80 * Audio driver configuration data, tweakable via CFGM.
81 */
82typedef struct DRVAUDIOCFG
83{
84 /** PCM properties to use. */
85 PDMAUDIOPCMPROPS Props;
86 /** Whether using signed sample data or not.
87 * Needed in order to know whether there is a custom value set in CFGM or not.
88 * By default set to UINT8_MAX if not set to a custom value. */
89 uint8_t uSigned;
90 /** Whether swapping endianess of sample data or not.
91 * Needed in order to know whether there is a custom value set in CFGM or not.
92 * By default set to UINT8_MAX if not set to a custom value. */
93 uint8_t uSwapEndian;
94 /** Configures the period size (in ms).
95 * This value reflects the time in between each hardware interrupt on the
96 * backend (host) side. */
97 uint32_t uPeriodSizeMs;
98 /** Configures the (ring) buffer size (in ms). Often is a multiple of uPeriodMs. */
99 uint32_t uBufferSizeMs;
100 /** Configures the pre-buffering size (in ms).
101 * Time needed in buffer before the stream becomes active (pre buffering).
102 * The bigger this value is, the more latency for the stream will occur.
103 * Set to 0 to disable pre-buffering completely.
104 * By default set to UINT32_MAX if not set to a custom value. */
105 uint32_t uPreBufSizeMs;
106 /** The driver's debugging configuration. */
107 struct
108 {
109 /** Whether audio debugging is enabled or not. */
110 bool fEnabled;
111 /** Where to store the debugging files. */
112 char szPathOut[RTPATH_MAX];
113 } Dbg;
114} DRVAUDIOCFG, *PDRVAUDIOCFG;
115
116/**
117 * Audio driver instance data.
118 *
119 * @implements PDMIAUDIOCONNECTOR
120 */
121typedef struct DRVAUDIO
122{
123 /** Friendly name of the driver. */
124 char szName[64];
125 /** Critical section for serializing access. */
126 RTCRITSECT CritSect;
127 /** Shutdown indicator. */
128 bool fTerminate;
129 /** Our audio connector interface. */
130 PDMIAUDIOCONNECTOR IAudioConnector;
131 /** Pointer to the driver instance. */
132 PPDMDRVINS pDrvIns;
133 /** Pointer to audio driver below us. */
134 PPDMIHOSTAUDIO pHostDrvAudio;
135 /** Pointer to CFGM configuration node of this driver. */
136 PCFGMNODE pCFGMNode;
137 /** List of audio streams. */
138 RTLISTANCHOR lstStreams;
139#ifdef VBOX_WITH_AUDIO_ENUM
140 /** Flag indicating to perform an (re-)enumeration of the host audio devices. */
141 bool fEnumerateDevices;
142#endif
143 /** Audio configuration settings retrieved from the backend. */
144 PDMAUDIOBACKENDCFG BackendCfg;
145#ifdef VBOX_WITH_STATISTICS
146 /** Statistics for the statistics manager (STAM). */
147 DRVAUDIOSTATS Stats;
148#endif
149 struct
150 {
151 /** Whether this driver's input streams are enabled or not.
152 * This flag overrides all the attached stream statuses. */
153 bool fEnabled;
154 /** Max. number of free input streams.
155 * UINT32_MAX for unlimited streams. */
156 uint32_t cStreamsFree;
157#ifdef VBOX_WITH_AUDIO_CALLBACKS
158 RTLISTANCHOR lstCB;
159#endif
160 /** The driver's input confguration (tweakable via CFGM). */
161 DRVAUDIOCFG Cfg;
162 } In;
163 struct
164 {
165 /** Whether this driver's output streams are enabled or not.
166 * This flag overrides all the attached stream statuses. */
167 bool fEnabled;
168 /** Max. number of free output streams.
169 * UINT32_MAX for unlimited streams. */
170 uint32_t cStreamsFree;
171#ifdef VBOX_WITH_AUDIO_CALLBACKS
172 RTLISTANCHOR lstCB;
173#endif
174 /** The driver's output confguration (tweakable via CFGM). */
175 DRVAUDIOCFG Cfg;
176 } Out;
177} DRVAUDIO, *PDRVAUDIO;
178
179/** Makes a PDRVAUDIO out of a PPDMIAUDIOCONNECTOR. */
180#define PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface) \
181 ( (PDRVAUDIO)((uintptr_t)pInterface - RT_UOFFSETOF(DRVAUDIO, IAudioConnector)) )
182
183/** @name Audio format helper methods.
184 * @{ */
185const char *DrvAudioHlpAudDirToStr(PDMAUDIODIR enmDir);
186const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt);
187bool DrvAudioHlpAudFmtIsSigned(PDMAUDIOFMT enmFmt);
188uint8_t DrvAudioHlpAudFmtToBits(PDMAUDIOFMT enmFmt);
189/** @} */
190
191/** @name Audio calculation helper methods.
192 * @{ */
193void DrvAudioHlpClearBuf(const PPDMAUDIOPCMPROPS pPCMProps, void *pvBuf, size_t cbBuf, uint32_t cFrames);
194uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels);
195uint32_t DrvAudioHlpCalcBitrate(const PPDMAUDIOPCMPROPS pProps);
196uint32_t DrvAudioHlpBytesAlign(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps);
197bool DrvAudioHlpBytesIsAligned(uint32_t cbSize, const PPDMAUDIOPCMPROPS pProps);
198uint32_t DrvAudioHlpBytesToFrames(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps);
199uint64_t DrvAudioHlpBytesToMilli(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps);
200uint64_t DrvAudioHlpBytesToMicro(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps);
201uint64_t DrvAudioHlpBytesToNano(uint32_t cbBytes, const PPDMAUDIOPCMPROPS pProps);
202uint32_t DrvAudioHlpFramesToBytes(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps);
203uint64_t DrvAudioHlpFramesToMilli(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps);
204uint64_t DrvAudioHlpFramesToNano(uint32_t cFrames, const PPDMAUDIOPCMPROPS pProps);
205uint32_t DrvAudioHlpMilliToBytes(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps);
206uint32_t DrvAudioHlpNanoToBytes(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps);
207uint32_t DrvAudioHlpMilliToFrames(uint64_t uMs, const PPDMAUDIOPCMPROPS pProps);
208uint32_t DrvAudioHlpNanoToFrames(uint64_t uNs, const PPDMAUDIOPCMPROPS pProps);
209/** @} */
210
211/** @name Audio PCM properties helper methods.
212 * @{ */
213bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pPCMProps1, const PPDMAUDIOPCMPROPS pPCMProps2);
214bool DrvAudioHlpPCMPropsAreEqual(const PPDMAUDIOPCMPROPS pPCMProps, const PPDMAUDIOSTREAMCFG pCfg);
215bool DrvAudioHlpPCMPropsAreValid(const PPDMAUDIOPCMPROPS pProps);
216uint32_t DrvAudioHlpPCMPropsBytesPerFrame(const PPDMAUDIOPCMPROPS pProps);
217void DrvAudioHlpPCMPropsPrint(const PPDMAUDIOPCMPROPS pProps);
218int DrvAudioHlpPCMPropsToStreamCfg(const PPDMAUDIOPCMPROPS pPCMProps, PPDMAUDIOSTREAMCFG pCfg);
219/** @} */
220
221/** @name Audio configuration helper methods.
222 * @{ */
223void DrvAudioHlpStreamCfgInit(PPDMAUDIOSTREAMCFG pCfg);
224bool DrvAudioHlpStreamCfgIsValid(const PPDMAUDIOSTREAMCFG pCfg);
225int DrvAudioHlpStreamCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, const PPDMAUDIOSTREAMCFG pSrcCfg);
226PPDMAUDIOSTREAMCFG DrvAudioHlpStreamCfgDup(const PPDMAUDIOSTREAMCFG pCfg);
227void DrvAudioHlpStreamCfgFree(PPDMAUDIOSTREAMCFG pCfg);
228void DrvAudioHlpStreamCfgPrint(const PPDMAUDIOSTREAMCFG pCfg);
229/** @} */
230
231/** @name Audio stream command helper methods.
232 * @{ */
233const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd);
234/** @} */
235
236/** @name Audio stream status helper methods.
237 * @{ */
238bool DrvAudioHlpStreamStatusCanRead(PDMAUDIOSTREAMSTS fStatus);
239bool DrvAudioHlpStreamStatusCanWrite(PDMAUDIOSTREAMSTS fStatus);
240bool DrvAudioHlpStreamStatusIsReady(PDMAUDIOSTREAMSTS fStatus);
241/** @} */
242
243/** @name Audio file (name) helper methods.
244 * @{ */
245int DrvAudioHlpFileNameSanitize(char *pszPath, size_t cbPath);
246int DrvAudioHlpFileNameGet(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName, uint32_t uInstance,
247 PDMAUDIOFILETYPE enmType, uint32_t fFlags);
248/** @} */
249
250/** @name Audio device methods.
251 * @{ */
252PPDMAUDIODEVICE DrvAudioHlpDeviceAlloc(size_t cbData);
253void DrvAudioHlpDeviceFree(PPDMAUDIODEVICE pDev);
254PPDMAUDIODEVICE DrvAudioHlpDeviceDup(const PPDMAUDIODEVICE pDev, bool fCopyUserData);
255/** @} */
256
257/** @name Audio device enumartion methods.
258 * @{ */
259int DrvAudioHlpDeviceEnumInit(PPDMAUDIODEVICEENUM pDevEnm);
260void DrvAudioHlpDeviceEnumFree(PPDMAUDIODEVICEENUM pDevEnm);
261int DrvAudioHlpDeviceEnumAdd(PPDMAUDIODEVICEENUM pDevEnm, PPDMAUDIODEVICE pDev);
262int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm, PDMAUDIODIR enmUsage);
263int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm);
264PPDMAUDIODEVICEENUM DrvAudioHlpDeviceEnumDup(const PPDMAUDIODEVICEENUM pDevEnm);
265int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm);
266int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm, PDMAUDIODIR enmUsage, bool fCopyUserData);
267PPDMAUDIODEVICE DrvAudioHlpDeviceEnumGetDefaultDevice(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmDir);
268uint16_t DrvAudioHlpDeviceEnumGetDeviceCount(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage);
269void DrvAudioHlpDeviceEnumPrint(const char *pszDesc, const PPDMAUDIODEVICEENUM pDevEnm);
270/** @} */
271
272/** @name Audio string-ify methods.
273 * @{ */
274const char *DrvAudioHlpAudMixerCtlToStr(PDMAUDIOMIXERCTL enmMixerCtl);
275const char *DrvAudioHlpPlaybackDstToStr(const PDMAUDIOPLAYBACKDST enmPlaybackDst);
276const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSRC enmRecSource);
277PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt);
278char *DrvAudioHlpAudDevFlagsToStrA(uint32_t fFlags);
279/** @} */
280
281/** @name Audio file methods.
282 * @{ */
283int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, uint32_t fFlags, PPDMAUDIOFILE *ppFile);
284void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile);
285int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, const PPDMAUDIOPCMPROPS pProps);
286int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile);
287int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile);
288size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile);
289bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile);
290int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags);
291/** @} */
292
293#define AUDIO_MAKE_FOURCC(c0, c1, c2, c3) RT_H2LE_U32_C(RT_MAKE_U32_FROM_U8(c0, c1, c2, c3))
294
295#endif /* !VBOX_INCLUDED_SRC_Audio_DrvAudio_h */
296
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