VirtualBox

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

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

Audio: Preparing to move some of the DrvAudio.h stuff into PDM. bugref:9890
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.8 KB
Line 
1/* $Id: DrvAudio.h 88023 2021-03-08 18:01:15Z 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 /** Commonly used scratch buffer. */
146 void *pvScratchBuf;
147 /** Size (in bytes) of commonly used scratch buffer. */
148 size_t cbScratchBuf;
149#ifdef VBOX_WITH_STATISTICS
150 /** Statistics for the statistics manager (STAM). */
151 DRVAUDIOSTATS Stats;
152#endif
153 struct
154 {
155 /** Whether this driver's input streams are enabled or not.
156 * This flag overrides all the attached stream statuses. */
157 bool fEnabled;
158 /** Max. number of free input streams.
159 * UINT32_MAX for unlimited streams. */
160 uint32_t cStreamsFree;
161#ifdef VBOX_WITH_AUDIO_CALLBACKS
162 RTLISTANCHOR lstCB;
163#endif
164 /** The driver's input confguration (tweakable via CFGM). */
165 DRVAUDIOCFG Cfg;
166 } In;
167 struct
168 {
169 /** Whether this driver's output streams are enabled or not.
170 * This flag overrides all the attached stream statuses. */
171 bool fEnabled;
172 /** Max. number of free output streams.
173 * UINT32_MAX for unlimited streams. */
174 uint32_t cStreamsFree;
175#ifdef VBOX_WITH_AUDIO_CALLBACKS
176 RTLISTANCHOR lstCB;
177#endif
178 /** The driver's output confguration (tweakable via CFGM). */
179 DRVAUDIOCFG Cfg;
180 } Out;
181} DRVAUDIO, *PDRVAUDIO;
182
183/** Makes a PDRVAUDIO out of a PPDMIAUDIOCONNECTOR. */
184#define PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface) \
185 ( (PDRVAUDIO)((uintptr_t)pInterface - RT_UOFFSETOF(DRVAUDIO, IAudioConnector)) )
186
187/** @name Audio format helper methods.
188 * @{ */
189const char *DrvAudioHlpAudDirToStr(PDMAUDIODIR enmDir);
190const char *DrvAudioHlpAudFmtToStr(PDMAUDIOFMT enmFmt);
191bool PDMAudioFormatIsSigned(PDMAUDIOFMT enmFmt);
192uint8_t PDMAudioFormatGetBits(PDMAUDIOFMT enmFmt);
193/** @} */
194
195/** @name Audio calculation helper methods.
196 * @{ */
197uint32_t DrvAudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels);
198/** @} */
199
200/** @name Audio PCM properties helper methods.
201 * @{ */
202void PDMAudioPropsClearBuffer(PCPDMAUDIOPCMPROPS pProps, void *pvBuf, size_t cbBuf, uint32_t cFrames);
203uint32_t PDMAudioPropsGetBitrate(PCPDMAUDIOPCMPROPS pProps);
204uint32_t PDMAudioPropsFloorBytesToFrame(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
205bool PDMAudioPropsIsSizeAligned(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
206uint32_t PDMAudioPropsBytesPerFrame(PCPDMAUDIOPCMPROPS pProps);
207uint32_t PDMAudioPropsBytesToFrames(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
208uint64_t PDMAudioPropsBytesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
209uint64_t PDMAudioPropsBytesToMicro(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
210uint64_t PDMAudioPropsBytesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cb);
211uint32_t PDMAudioPropsFramesToBytes(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames);
212uint64_t PDMAudioPropsFramesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames);
213uint64_t PDMAudioPropsFramesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames);
214uint32_t PDMAudioPropsMilliToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs);
215uint32_t PDMAudioPropsNanoToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs);
216uint32_t PDMAudioPropsMilliToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs);
217uint32_t PDMAudioPropsNanoToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs);
218
219bool PDMAudioPropsAreEqual(PCPDMAUDIOPCMPROPS pPCMProps1, PCPDMAUDIOPCMPROPS pPCMProps2);
220void PDMAudioPropsLog(PCPDMAUDIOPCMPROPS pProps);
221
222bool DrvAudioHlpPcmPropsAreValid(PCPDMAUDIOPCMPROPS pProps);
223/** @} */
224
225/** @name Audio configuration helper methods.
226 * @{ */
227void PDMAudioStrmCfgInit(PPDMAUDIOSTREAMCFG pCfg);
228int PDMAudioStrmCfgInitWithProps(PPDMAUDIOSTREAMCFG pCfg, PCPDMAUDIOPCMPROPS pProps);
229bool PDMAudioStrmCfgMatchesProps(PCPDMAUDIOSTREAMCFG pCfg, PCPDMAUDIOPCMPROPS pProps);
230int PDMAudioStrmCfgCopy(PPDMAUDIOSTREAMCFG pDstCfg, PCPDMAUDIOSTREAMCFG pSrcCfg);
231PPDMAUDIOSTREAMCFG PDMAudioStrmCfgDup(PCPDMAUDIOSTREAMCFG pCfg);
232void PDMAudioStrmCfgFree(PPDMAUDIOSTREAMCFG pCfg);
233void PDMAudioStrmCfgLog(PCPDMAUDIOSTREAMCFG pCfg);
234
235bool DrvAudioHlpStreamCfgIsValid(PCPDMAUDIOSTREAMCFG pCfg);
236/** @} */
237
238/** @name Audio stream command helper methods.
239 * @{ */
240const char *DrvAudioHlpStreamCmdToStr(PDMAUDIOSTREAMCMD enmCmd);
241/** @} */
242
243/** @name Audio stream status helper methods.
244 * @{ */
245bool DrvAudioHlpStreamStatusCanRead(PDMAUDIOSTREAMSTS fStatus);
246bool DrvAudioHlpStreamStatusCanWrite(PDMAUDIOSTREAMSTS fStatus);
247bool DrvAudioHlpStreamStatusIsReady(PDMAUDIOSTREAMSTS fStatus);
248/** @} */
249
250/** @name Audio file (name) helper methods.
251 * @{ */
252int DrvAudioHlpFileNameSanitize(char *pszPath, size_t cbPath);
253int DrvAudioHlpFileNameGet(char *pszFile, size_t cchFile, const char *pszPath, const char *pszName, uint32_t uInstance,
254 PDMAUDIOFILETYPE enmType, uint32_t fFlags);
255/** @} */
256
257/** @name Audio device methods.
258 * @{ */
259PPDMAUDIODEVICE DrvAudioHlpDeviceAlloc(size_t cbData);
260void DrvAudioHlpDeviceFree(PPDMAUDIODEVICE pDev);
261PPDMAUDIODEVICE DrvAudioHlpDeviceDup(const PPDMAUDIODEVICE pDev, bool fCopyUserData);
262/** @} */
263
264/** @name Audio device enumartion methods.
265 * @{ */
266int DrvAudioHlpDeviceEnumInit(PPDMAUDIODEVICEENUM pDevEnm);
267void DrvAudioHlpDeviceEnumFree(PPDMAUDIODEVICEENUM pDevEnm);
268int DrvAudioHlpDeviceEnumAdd(PPDMAUDIODEVICEENUM pDevEnm, PPDMAUDIODEVICE pDev);
269int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm, PDMAUDIODIR enmUsage);
270int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm);
271PPDMAUDIODEVICEENUM DrvAudioHlpDeviceEnumDup(const PPDMAUDIODEVICEENUM pDevEnm);
272int DrvAudioHlpDeviceEnumCopy(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm);
273int DrvAudioHlpDeviceEnumCopyEx(PPDMAUDIODEVICEENUM pDstDevEnm, const PPDMAUDIODEVICEENUM pSrcDevEnm, PDMAUDIODIR enmUsage, bool fCopyUserData);
274PPDMAUDIODEVICE DrvAudioHlpDeviceEnumGetDefaultDevice(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmDir);
275uint16_t DrvAudioHlpDeviceEnumGetDeviceCount(const PPDMAUDIODEVICEENUM pDevEnm, PDMAUDIODIR enmUsage);
276void DrvAudioHlpDeviceEnumPrint(const char *pszDesc, const PPDMAUDIODEVICEENUM pDevEnm);
277/** @} */
278
279/** @name Audio string-ify methods.
280 * @{ */
281const char *DrvAudioHlpAudMixerCtlToStr(PDMAUDIOMIXERCTL enmMixerCtl);
282const char *DrvAudioHlpPlaybackDstToStr(const PDMAUDIOPLAYBACKDST enmPlaybackDst);
283const char *DrvAudioHlpRecSrcToStr(const PDMAUDIORECSRC enmRecSource);
284PDMAUDIOFMT DrvAudioHlpStrToAudFmt(const char *pszFmt);
285char *DrvAudioHlpAudDevFlagsToStrA(uint32_t fFlags);
286/** @} */
287
288/** @name Audio file methods.
289 * @{ */
290int DrvAudioHlpFileCreate(PDMAUDIOFILETYPE enmType, const char *pszFile, uint32_t fFlags, PPDMAUDIOFILE *ppFile);
291void DrvAudioHlpFileDestroy(PPDMAUDIOFILE pFile);
292int DrvAudioHlpFileOpen(PPDMAUDIOFILE pFile, uint32_t fOpen, PCPDMAUDIOPCMPROPS pProps);
293int DrvAudioHlpFileClose(PPDMAUDIOFILE pFile);
294int DrvAudioHlpFileDelete(PPDMAUDIOFILE pFile);
295size_t DrvAudioHlpFileGetDataSize(PPDMAUDIOFILE pFile);
296bool DrvAudioHlpFileIsOpen(PPDMAUDIOFILE pFile);
297int DrvAudioHlpFileWrite(PPDMAUDIOFILE pFile, const void *pvBuf, size_t cbBuf, uint32_t fFlags);
298/** @} */
299
300#define AUDIO_MAKE_FOURCC(c0, c1, c2, c3) RT_H2LE_U32_C(RT_MAKE_U32_FROM_U8(c0, c1, c2, c3))
301
302#endif /* !VBOX_INCLUDED_SRC_Audio_DrvAudio_h */
303
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