Changeset 89485 in vbox for trunk/src/VBox

Timestamp:

Jun 3, 2021 1:04:26 PM (4 years ago)

Author:

vboxsync

Message:

DrvHostAudioDebug: Cleaned up function prefix and struct names. bugref:9890

File:

• trunk/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp (modified) (23 diffs)

trunk/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp

@@ -38 +38 @@
  * Debug host audio stream.
  */
-typedef struct DEBUGAUDIOSTREAM
+typedef struct DRVHSTAUDDEBUGSTREAM
 {
     /** Common part. */
@@ -50 +50 @@
         AUDIOTESTTONE       In;
     };
-} DEBUGAUDIOSTREAM;
+} DRVHSTAUDDEBUGSTREAM;
 /** Pointer to a debug host audio stream. */
-typedef DEBUGAUDIOSTREAM *PDEBUGAUDIOSTREAM;
+typedef DRVHSTAUDDEBUGSTREAM *PDRVHSTAUDDEBUGSTREAM;
 
 /**
@@ -58 +58 @@
  * @implements PDMIAUDIOCONNECTOR
  */
-typedef struct DRVHOSTDEBUGAUDIO
+typedef struct DRVHSTAUDDEBUG
 {
     /** Pointer to the driver instance structure. */
@@ -64 +64 @@
     /** Pointer to host audio interface. */
     PDMIHOSTAUDIO   IHostAudio;
-} DRVHOSTDEBUGAUDIO;
+} DRVHSTAUDDEBUG;
 /** Pointer to a debug host audio driver. */
-typedef DRVHOSTDEBUGAUDIO *PDRVHOSTDEBUGAUDIO;
+typedef DRVHSTAUDDEBUG *PDRVHSTAUDDEBUG;
 
 
@@ -72 +72 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnGetConfig}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_GetConfig(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDCFG pBackendCfg)
+static DECLCALLBACK(int) drvHstAudDebugHA_GetConfig(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDCFG pBackendCfg)
 {
     RT_NOREF(pInterface);
@@ -81 +81 @@
      */
     RTStrCopy(pBackendCfg->szName, sizeof(pBackendCfg->szName), "DebugAudio");
-    pBackendCfg->cbStream       = sizeof(DEBUGAUDIOSTREAM);
+    pBackendCfg->cbStream       = sizeof(DRVHSTAUDDEBUGSTREAM);
     pBackendCfg->fFlags         = 0;
     pBackendCfg->cMaxStreamsOut = 1; /* Output; writing to a file. */
@@ -93 +93 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnGetStatus}
  */
-static DECLCALLBACK(PDMAUDIOBACKENDSTS) drvHostDebugAudioHA_GetStatus(PPDMIHOSTAUDIO pInterface, PDMAUDIODIR enmDir)
+static DECLCALLBACK(PDMAUDIOBACKENDSTS) drvHstAudDebugHA_GetStatus(PPDMIHOSTAUDIO pInterface, PDMAUDIODIR enmDir)
 {
     RT_NOREF(pInterface, enmDir);
@@ -103 +103 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCreate}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamCreate(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamCreate(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
                                                           PPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
 {
-    PDRVHOSTDEBUGAUDIO pDrv       = RT_FROM_MEMBER(pInterface, DRVHOSTDEBUGAUDIO, IHostAudio);
-    PDEBUGAUDIOSTREAM  pStreamDbg = (PDEBUGAUDIOSTREAM)pStream;
+    PDRVHSTAUDDEBUG         pThis      = RT_FROM_MEMBER(pInterface, DRVHSTAUDDEBUG, IHostAudio);
+    PDRVHSTAUDDEBUGSTREAM   pStreamDbg = (PDRVHSTAUDDEBUGSTREAM)pStream;
     AssertPtrReturn(pStreamDbg, VERR_INVALID_POINTER);
     AssertPtrReturn(pCfgReq, VERR_INVALID_POINTER);
@@ -119 +119 @@
     int rc = AudioHlpFileCreateAndOpenEx(&pStreamDbg->pFile, AUDIOHLPFILETYPE_WAV, NULL /*use temp dir*/,
                                          pCfgReq->enmDir == PDMAUDIODIR_IN ? "DebugAudioIn" : "DebugAudioOut",
-                                         pDrv->pDrvIns->iInstance, AUDIOHLPFILENAME_FLAGS_NONE, AUDIOHLPFILE_FLAGS_NONE,
+                                         pThis->pDrvIns->iInstance, AUDIOHLPFILENAME_FLAGS_NONE, AUDIOHLPFILE_FLAGS_NONE,
                                          &pCfgReq->Props, RTFILE_O_WRITE | RTFILE_O_DENY_WRITE | RTFILE_O_CREATE_REPLACE);
     if (RT_FAILURE(rc))
@@ -132 +132 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamDestroy}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamDestroy(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
-                                                           bool fImmediate)
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamDestroy(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
+                                                        bool fImmediate)
 {
     RT_NOREF(pInterface, fImmediate);
-    PDEBUGAUDIOSTREAM pStreamDbg = (PDEBUGAUDIOSTREAM)pStream;
+    PDRVHSTAUDDEBUGSTREAM pStreamDbg = (PDRVHSTAUDDEBUGSTREAM)pStream;
     AssertPtrReturn(pStreamDbg, VERR_INVALID_POINTER);
 
@@ -152 +152 @@
  * @ interface_method_impl{PDMIHOSTAUDIO,pfnStreamEnable}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamControlStub(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamControlStub(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
 {
     RT_NOREF(pInterface, pStream);
@@ -162 +162 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamControl}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamControl(PPDMIHOSTAUDIO pInterface,
-                                                           PPDMAUDIOBACKENDSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamControl(PPDMIHOSTAUDIO pInterface,
+                                                        PPDMAUDIOBACKENDSTREAM pStream, PDMAUDIOSTREAMCMD enmStreamCmd)
 {
     /** @todo r=bird: I'd like to get rid of this pfnStreamControl method,
@@ -172 +172 @@
     {
         case PDMAUDIOSTREAMCMD_ENABLE:
-            return drvHostDebugAudioHA_StreamControlStub(pInterface, pStream);
+            return drvHstAudDebugHA_StreamControlStub(pInterface, pStream);
         case PDMAUDIOSTREAMCMD_DISABLE:
-            return drvHostDebugAudioHA_StreamControlStub(pInterface, pStream);
+            return drvHstAudDebugHA_StreamControlStub(pInterface, pStream);
         case PDMAUDIOSTREAMCMD_PAUSE:
-            return drvHostDebugAudioHA_StreamControlStub(pInterface, pStream);
+            return drvHstAudDebugHA_StreamControlStub(pInterface, pStream);
         case PDMAUDIOSTREAMCMD_RESUME:
-            return drvHostDebugAudioHA_StreamControlStub(pInterface, pStream);
+            return drvHstAudDebugHA_StreamControlStub(pInterface, pStream);
         case PDMAUDIOSTREAMCMD_DRAIN:
-            return drvHostDebugAudioHA_StreamControlStub(pInterface, pStream);
+            return drvHstAudDebugHA_StreamControlStub(pInterface, pStream);
 
         case PDMAUDIOSTREAMCMD_END:
@@ -195 +195 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetReadable}
  */
-static DECLCALLBACK(uint32_t) drvHostDebugAudioHA_StreamGetReadable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
-{
-    RT_NOREF(pInterface);
-    PDEBUGAUDIOSTREAM pStreamDbg = (PDEBUGAUDIOSTREAM)pStream;
+static DECLCALLBACK(uint32_t) drvHstAudDebugHA_StreamGetReadable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
+{
+    RT_NOREF(pInterface);
+    PDRVHSTAUDDEBUGSTREAM pStreamDbg = (PDRVHSTAUDDEBUGSTREAM)pStream;
 
     return PDMAudioPropsMilliToBytes(&pStreamDbg->Cfg.Props, 10 /*ms*/);
@@ -207 +207 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetWritable}
  */
-static DECLCALLBACK(uint32_t) drvHostDebugAudioHA_StreamGetWritable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
+static DECLCALLBACK(uint32_t) drvHstAudDebugHA_StreamGetWritable(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
 {
     RT_NOREF(pInterface, pStream);
@@ -217 +217 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetPending}
  */
-static DECLCALLBACK(uint32_t) drvHostDebugAudioHA_StreamGetPending(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
+static DECLCALLBACK(uint32_t) drvHstAudDebugHA_StreamGetPending(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream)
 {
     RT_NOREF(pInterface, pStream);
@@ -227 +227 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamGetState}
  */
-static DECLCALLBACK(PDMHOSTAUDIOSTREAMSTATE) drvHostDebugAudioHA_StreamGetState(PPDMIHOSTAUDIO pInterface,
-                                                                                PPDMAUDIOBACKENDSTREAM pStream)
+static DECLCALLBACK(PDMHOSTAUDIOSTREAMSTATE) drvHstAudDebugHA_StreamGetState(PPDMIHOSTAUDIO pInterface,
+                                                                             PPDMAUDIOBACKENDSTREAM pStream)
 {
     RT_NOREF(pInterface);
@@ -239 +239 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamPlay}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamPlay(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamPlay(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
                                                         const void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
 {
     RT_NOREF(pInterface);
-    PDEBUGAUDIOSTREAM pStreamDbg = (PDEBUGAUDIOSTREAM)pStream;
+    PDRVHSTAUDDEBUGSTREAM pStreamDbg = (PDRVHSTAUDDEBUGSTREAM)pStream;
 
     int rc = AudioHlpFileWrite(pStreamDbg->pFile, pvBuf, cbBuf, 0 /* fFlags */);
@@ -257 +257 @@
  * @interface_method_impl{PDMIHOSTAUDIO,pfnStreamCapture}
  */
-static DECLCALLBACK(int) drvHostDebugAudioHA_StreamCapture(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
-                                                           void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead)
-{
-    RT_NOREF(pInterface);
-    PDEBUGAUDIOSTREAM pStreamDbg = (PDEBUGAUDIOSTREAM)pStream;
+static DECLCALLBACK(int) drvHstAudDebugHA_StreamCapture(PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
+                                                        void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead)
+{
+    RT_NOREF(pInterface);
+    PDRVHSTAUDDEBUGSTREAM pStreamDbg = (PDRVHSTAUDDEBUGSTREAM)pStream;
 /** @todo rate limit this?  */
 
@@ -286 +286 @@
  * @interface_method_impl{PDMIBASE,pfnQueryInterface}
  */
-static DECLCALLBACK(void *) drvHostDebugAudioQueryInterface(PPDMIBASE pInterface, const char *pszIID)
-{
-    PPDMDRVINS         pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
-    PDRVHOSTDEBUGAUDIO pThis   = PDMINS_2_DATA(pDrvIns, PDRVHOSTDEBUGAUDIO);
+static DECLCALLBACK(void *) drvHstAudDebugQueryInterface(PPDMIBASE pInterface, const char *pszIID)
+{
+    PPDMDRVINS      pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
+    PDRVHSTAUDDEBUG pThis   = PDMINS_2_DATA(pDrvIns, PDRVHSTAUDDEBUG);
 
     PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
@@ -302 +302 @@
  * @copydoc FNPDMDRVCONSTRUCT
  */
-static DECLCALLBACK(int) drvHostDebugAudioConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
+static DECLCALLBACK(int) drvHstAudDebugConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
 {
     RT_NOREF(pCfg, fFlags);
     PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
-    PDRVHOSTDEBUGAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTDEBUGAUDIO);
+    PDRVHSTAUDDEBUG pThis = PDMINS_2_DATA(pDrvIns, PDRVHSTAUDDEBUG);
     LogRel(("Audio: Initializing DEBUG driver\n"));
 
@@ -314 +314 @@
     pThis->pDrvIns                   = pDrvIns;
     /* IBase */
-    pDrvIns->IBase.pfnQueryInterface = drvHostDebugAudioQueryInterface;
+    pDrvIns->IBase.pfnQueryInterface = drvHstAudDebugQueryInterface;
     /* IHostAudio */
-    pThis->IHostAudio.pfnGetConfig                  = drvHostDebugAudioHA_GetConfig;
+    pThis->IHostAudio.pfnGetConfig                  = drvHstAudDebugHA_GetConfig;
     pThis->IHostAudio.pfnGetDevices                 = NULL;
     pThis->IHostAudio.pfnSetDevice                  = NULL;
-    pThis->IHostAudio.pfnGetStatus                  = drvHostDebugAudioHA_GetStatus;
+    pThis->IHostAudio.pfnGetStatus                  = drvHstAudDebugHA_GetStatus;
     pThis->IHostAudio.pfnDoOnWorkerThread           = NULL;
     pThis->IHostAudio.pfnStreamConfigHint           = NULL;
-    pThis->IHostAudio.pfnStreamCreate               = drvHostDebugAudioHA_StreamCreate;
+    pThis->IHostAudio.pfnStreamCreate               = drvHstAudDebugHA_StreamCreate;
     pThis->IHostAudio.pfnStreamInitAsync            = NULL;
-    pThis->IHostAudio.pfnStreamDestroy              = drvHostDebugAudioHA_StreamDestroy;
+    pThis->IHostAudio.pfnStreamDestroy              = drvHstAudDebugHA_StreamDestroy;
     pThis->IHostAudio.pfnStreamNotifyDeviceChanged  = NULL;
-    pThis->IHostAudio.pfnStreamControl              = drvHostDebugAudioHA_StreamControl;
-    pThis->IHostAudio.pfnStreamGetReadable          = drvHostDebugAudioHA_StreamGetReadable;
-    pThis->IHostAudio.pfnStreamGetWritable          = drvHostDebugAudioHA_StreamGetWritable;
-    pThis->IHostAudio.pfnStreamGetPending           = drvHostDebugAudioHA_StreamGetPending;
-    pThis->IHostAudio.pfnStreamGetState             = drvHostDebugAudioHA_StreamGetState;
-    pThis->IHostAudio.pfnStreamPlay                 = drvHostDebugAudioHA_StreamPlay;
-    pThis->IHostAudio.pfnStreamCapture              = drvHostDebugAudioHA_StreamCapture;
+    pThis->IHostAudio.pfnStreamControl              = drvHstAudDebugHA_StreamControl;
+    pThis->IHostAudio.pfnStreamGetReadable          = drvHstAudDebugHA_StreamGetReadable;
+    pThis->IHostAudio.pfnStreamGetWritable          = drvHstAudDebugHA_StreamGetWritable;
+    pThis->IHostAudio.pfnStreamGetPending           = drvHstAudDebugHA_StreamGetPending;
+    pThis->IHostAudio.pfnStreamGetState             = drvHstAudDebugHA_StreamGetState;
+    pThis->IHostAudio.pfnStreamPlay                 = drvHstAudDebugHA_StreamPlay;
+    pThis->IHostAudio.pfnStreamCapture              = drvHstAudDebugHA_StreamCapture;
 
 #ifdef VBOX_AUDIO_DEBUG_DUMP_PCM_DATA_PATH
@@ -363 +363 @@
     ~0U,
     /* cbInstance */
-    sizeof(DRVHOSTDEBUGAUDIO),
+    sizeof(DRVHSTAUDDEBUG),
     /* pfnConstruct */
-    drvHostDebugAudioConstruct,
+    drvHstAudDebugConstruct,
     /* pfnDestruct */
     NULL,