Changeset 91452 in vbox for trunk/src/VBox/ValidationKit/utils

Timestamp:

Sep 29, 2021 9:31:46 AM (3 years ago)

Author:

vboxsync

Message:

Audio/Validation Kit: Moved playback options into an own struct AUDIOTESTPLAYOPTS, as the functions calls already were too big. ​bugref:10008

File:

• trunk/src/VBox/ValidationKit/utils/audio/vkatCmdGeneric.cpp (modified) (22 diffs)

trunk/src/VBox/ValidationKit/utils/audio/vkatCmdGeneric.cpp

@@ -191 +191 @@
 *   Command: play                                                                                                                *
 *********************************************************************************************************************************/
+
+/**
+ * Structure holding additional playback options.
+ */
+typedef struct AUDIOTESTPLAYOPTS
+{
+    /** Whether to use the audio connector or not. */
+    bool             fWithDrvAudio;
+    /** Whether to use a mixing buffer or not. */
+    bool             fWithMixer;
+    /** Buffer size (in ms). */
+    uint32_t         cMsBufferSize;
+    /** Pre-buffering size (in ms). */
+    uint32_t         cMsPreBuffer;
+    /** Scheduling (in ms). */
+    uint32_t         cMsSchedulingHint;
+    /** Audio vlume to use (in percent). */
+    uint8_t          uVolumePercent;
+    /** PCM audio properties to use. */
+    PDMAUDIOPCMPROPS Props;
+} AUDIOTESTPLAYOPTS;
+/** Pointer to additional playback options. */
+typedef AUDIOTESTPLAYOPTS *PAUDIOTESTPLAYOPTS;
 
 /**
@@ -277 +300 @@
 }
 
-
 /**
  * Worker for audioTestCmdPlayHandler that plays one file.
  */
-static RTEXITCODE audioTestPlayOne(const char *pszFile, PCPDMDRVREG pDrvReg, const char *pszDevId, uint32_t cMsBufferSize,
-                                   uint32_t cMsPreBuffer, uint32_t cMsSchedulingHint,
-                                   uint8_t cChannels, uint8_t cbSample, uint32_t uHz, uint8_t uVolumePercent,
-                                   bool fWithDrvAudio, bool fWithMixer)
+static RTEXITCODE audioTestPlayOne(const char *pszFile, PCPDMDRVREG pDrvReg, const char *pszDevId,
+                                   PAUDIOTESTPLAYOPTS pOpts)
 {
     char szTmp[128];
@@ -312 +332 @@
     RTEXITCODE          rcExit = RTEXITCODE_FAILURE;
     AUDIOTESTDRVSTACK   DrvStack;
-    rc = audioTestDriverStackInit(&DrvStack, pDrvReg, fWithDrvAudio);
+    rc = audioTestDriverStackInit(&DrvStack, pDrvReg, pOpts->fWithDrvAudio);
     if (RT_SUCCESS(rc))
     {
@@ -324 +344 @@
              * Open a stream for the output.
              */
+            uint8_t const cChannels = PDMAudioPropsChannels(&pOpts->Props);
+
             PDMAUDIOPCMPROPS ReqProps = WaveFile.Props;
             if (cChannels != 0 && PDMAudioPropsChannels(&ReqProps) != cChannels)
                 PDMAudioPropsSetChannels(&ReqProps, cChannels);
+
+            uint8_t const cbSample = PDMAudioPropsSampleSize(&pOpts->Props);
             if (cbSample != 0)
                 PDMAudioPropsSetSampleSize(&ReqProps, cbSample);
+
+            uint32_t const uHz = PDMAudioPropsHz(&pOpts->Props);
             if (uHz != 0)
                 ReqProps.uHz = uHz;
@@ -334 +360 @@
             PDMAUDIOSTREAMCFG CfgAcq;
             PPDMAUDIOSTREAM   pStream  = NULL;
-            rc = audioTestDriverStackStreamCreateOutput(&DrvStack, &ReqProps, cMsBufferSize,
-                                                        cMsPreBuffer, cMsSchedulingHint, &pStream, &CfgAcq);
+            rc = audioTestDriverStackStreamCreateOutput(&DrvStack, &ReqProps, pOpts->cMsBufferSize,
+                                                        pOpts->cMsPreBuffer, pOpts->cMsSchedulingHint, &pStream, &CfgAcq);
             if (RT_SUCCESS(rc))
             {
@@ -342 +368 @@
                  * output parameters doesn't match.
                  */
-                if (   !fWithMixer
+                if (   !pOpts->fWithMixer
                     && (   !PDMAudioPropsAreEqual(&WaveFile.Props, &pStream->Cfg.Props)
-                        || uVolumePercent != 100)
+                        || pOpts->uVolumePercent != 100)
                    )
                 {
                     RTMsgInfo("Enabling the mixer buffer.\n");
-                    fWithMixer = true;
+                    pOpts->fWithMixer = true;
                 }
 
@@ -356 +382 @@
                  */
                 AUDIOTESTDRVMIXSTREAM Mix;
-                rc = AudioTestMixStreamInit(&Mix, &DrvStack, pStream, fWithMixer ? &WaveFile.Props : NULL, 100 /*ms*/);
+                rc = AudioTestMixStreamInit(&Mix, &DrvStack, pStream, pOpts->fWithMixer ? &WaveFile.Props : NULL, 100 /*ms*/);
                 if (RT_SUCCESS(rc))
                 {
@@ -362 +388 @@
                         RTMsgInfo("Stream: %s cbBackend=%#RX32%s\n",
                                   PDMAudioPropsToString(&pStream->Cfg.Props, szTmp, sizeof(szTmp)),
-                                  pStream->cbBackend, fWithMixer ? " mixed" : "");
-
-                    if (fWithMixer)
-                        AudioTestMixStreamSetVolume(&Mix, uVolumePercent);
+                                  pStream->cbBackend, pOpts->fWithMixer ? " mixed" : "");
+
+                    if (pOpts->fWithMixer)
+                        AudioTestMixStreamSetVolume(&Mix, pOpts->uVolumePercent);
 
                     /*
@@ -400 +426 @@
  */
 static RTEXITCODE audioTestPlayTestToneOne(PAUDIOTESTTONEPARMS pToneParms,
-                                           PCPDMDRVREG pDrvReg, const char *pszDevId, uint32_t cMsBufferSize,
-                                           uint32_t cMsPreBuffer, uint32_t cMsSchedulingHint,
-                                           uint8_t cChannels, uint8_t cbSample, uint32_t uHz,
-                                           bool fWithDrvAudio, bool fWithMixer)
+                                           PCPDMDRVREG pDrvReg, const char *pszDevId,
+                                           PAUDIOTESTPLAYOPTS pOpts)
 {
     char szTmp[128];
@@ -415 +439 @@
     RTEXITCODE          rcExit = RTEXITCODE_FAILURE;
     AUDIOTESTDRVSTACK   DrvStack;
-    int rc = audioTestDriverStackInit(&DrvStack, pDrvReg, fWithDrvAudio);
+    int rc = audioTestDriverStackInit(&DrvStack, pDrvReg, pOpts->fWithDrvAudio);
     if (RT_SUCCESS(rc))
     {
@@ -427 +451 @@
              * Open a stream for the output.
              */
+            uint8_t const cChannels = PDMAudioPropsChannels(&pOpts->Props);
+
             PDMAUDIOPCMPROPS ReqProps = pToneParms->Props;
             if (cChannels != 0 && PDMAudioPropsChannels(&ReqProps) != cChannels)
                 PDMAudioPropsSetChannels(&ReqProps, cChannels);
+
+            uint8_t const cbSample = PDMAudioPropsSampleSize(&pOpts->Props);
             if (cbSample != 0)
                 PDMAudioPropsSetSampleSize(&ReqProps, cbSample);
+
+            uint32_t const uHz = PDMAudioPropsHz(&pOpts->Props);
             if (uHz != 0)
                 ReqProps.uHz = uHz;
 
-            rc = audioTestDriverStackStreamCreateOutput(&DrvStack, &ReqProps, cMsBufferSize,
-                                                        cMsPreBuffer, cMsSchedulingHint, &TstStream.pStream, &TstStream.Cfg);
+            rc = audioTestDriverStackStreamCreateOutput(&DrvStack, &ReqProps, pOpts->cMsBufferSize,
+                                                        pOpts->cMsPreBuffer, pOpts->cMsSchedulingHint, &TstStream.pStream, &TstStream.Cfg);
             if (RT_SUCCESS(rc))
             {
@@ -443 +473 @@
                  * output parameters doesn't match.
                  */
-                if (   !fWithMixer
+                if (   !pOpts->fWithMixer
                     && (   !PDMAudioPropsAreEqual(&pToneParms->Props, &TstStream.pStream->Cfg.Props)
                         || pToneParms->uVolumePercent != 100)
@@ -449 +479 @@
                 {
                     RTMsgInfo("Enabling the mixer buffer.\n");
-                    fWithMixer = true;
+                    pOpts->fWithMixer = true;
                 }
 
@@ -456 +486 @@
                  * is false, otherwise it's doing mixing, resampling and recoding.
                  */
-                rc = AudioTestMixStreamInit(&TstStream.Mix, &DrvStack, TstStream.pStream, fWithMixer ? &pToneParms->Props : NULL, 100 /*ms*/);
+                rc = AudioTestMixStreamInit(&TstStream.Mix, &DrvStack, TstStream.pStream,
+                                            pOpts->fWithMixer ? &pToneParms->Props : NULL, 100 /*ms*/);
                 if (RT_SUCCESS(rc))
                 {
@@ -462 +493 @@
                         RTMsgInfo("Stream: %s cbBackend=%#RX32%s\n",
                                   PDMAudioPropsToString(&TstStream.pStream->Cfg.Props, szTmp, sizeof(szTmp)),
-                                  TstStream.pStream->cbBackend, fWithMixer ? " mixed" : "");
+                                  TstStream.pStream->cbBackend, pOpts->fWithMixer ? " mixed" : "");
 
                     /*
@@ -470 +501 @@
                     if (RT_SUCCESS(rc))
                     {
-                        if (fWithMixer)
+                        if (pOpts->fWithMixer)
                             AudioTestMixStreamSetVolume(&TstStream.Mix, pToneParms->uVolumePercent);
 
@@ -556 +587 @@
     /* Option values: */
     PCPDMDRVREG pDrvReg             = AudioTestGetDefaultBackend();
-    uint32_t    cMsBufferSize       = UINT32_MAX;
-    uint32_t    cMsPreBuffer        = UINT32_MAX;
-    uint32_t    cMsSchedulingHint   = UINT32_MAX;
     const char *pszDevId            = NULL;
-    bool        fWithDrvAudio       = false;
-    bool        fWithMixer          = false;
     uint32_t    cTestTones          = 0;
     uint8_t     cbSample            = 0;
     uint8_t     cChannels           = 0;
     uint32_t    uHz                 = 0;
-    uint8_t     uVolumePercent      = 100; /* Use maximum volume by default. */
+
+    AUDIOTESTPLAYOPTS PlayOpts;
+    RT_ZERO(PlayOpts);
+
+    PlayOpts.uVolumePercent = 100; /* Use maximum volume by default. */
 
     /* Argument processing loop: */
@@ -586 +616 @@
 
             case 'd':
-                fWithDrvAudio = true;
+                PlayOpts.fWithDrvAudio = true;
                 break;
 
@@ -594 +624 @@
 
             case 'm':
-                fWithMixer = true;
+                PlayOpts.fWithMixer = true;
                 break;
 
@@ -610 +640 @@
 
             case VKAT_PLAY_OPT_VOL:
-                uVolumePercent = ValueUnion.u8;
-                if (uVolumePercent > 100)
+                PlayOpts.uVolumePercent = ValueUnion.u8;
+                if (PlayOpts.uVolumePercent > 100)
                     return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid volume (0-100)");
                 break;
@@ -620 +650 @@
                     return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Playing test tones (-t) cannot be combined with playing files");
 
-                RTEXITCODE rcExit = audioTestPlayOne(ValueUnion.psz, pDrvReg, pszDevId, cMsBufferSize, cMsPreBuffer,
-                                                     cMsSchedulingHint, cChannels, cbSample, uHz, uVolumePercent,
-                                                     fWithDrvAudio, fWithMixer);
+                /* Use some sane defaults if no PCM props are set by the user. */
+                PDMAudioPropsInit(&PlayOpts.Props,
+                                  cbSample  ? cbSample  : 2 /* 16-bit */, true /* fSigned */,
+                                  cChannels ? cChannels : 2 /* Stereo */, uHz ? uHz : 44100);
+
+                RTEXITCODE rcExit = audioTestPlayOne(ValueUnion.psz, pDrvReg, pszDevId, &PlayOpts);
                 if (rcExit != RTEXITCODE_SUCCESS)
                     return rcExit;
@@ -653 +686 @@
 #endif
         ToneParms.msSequel       = 0;   /** @todo Implement analyzing this first! */
-        ToneParms.uVolumePercent = uVolumePercent;
-
-        RTEXITCODE rcExit = audioTestPlayTestToneOne(&ToneParms, pDrvReg, pszDevId, cMsBufferSize, cMsPreBuffer,
-                                                     cMsSchedulingHint, cChannels, cbSample, uHz, fWithDrvAudio, fWithMixer);
+        ToneParms.uVolumePercent = PlayOpts.uVolumePercent;
+
+        RTEXITCODE rcExit = audioTestPlayTestToneOne(&ToneParms, pDrvReg, pszDevId, &PlayOpts);
         if (rcExit != RTEXITCODE_SUCCESS)
             return rcExit;