Changeset 91088 in vbox

Timestamp:

Sep 2, 2021 11:53:54 AM (3 years ago)

Author:

vboxsync

Message:

Audio/Validation Kit: Implemented optional probing for backends (--probe-backends) when using the "enum" command. Needed for checking whether audio is available on the host (testboxes). ​bugref:10008

Location:

trunk/src/VBox/ValidationKit/utils/audio

Files:

• vkat.cpp (modified) (4 diffs)
• vkatCmdGeneric.cpp (modified) (6 diffs)
• vkatDriverStack.cpp (modified) (1 diff)
• vkatInternal.h (modified) (3 diffs)

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

@@ -70 +70 @@
 *********************************************************************************************************************************/
 /**
- * Backends.
+ * Backends description table.
  *
  * @note The first backend in the array is the default one for the platform.
  */
-struct
-{
-    /** The driver registration structure. */
-    PCPDMDRVREG pDrvReg;
-    /** The backend name.
-     * Aliases are implemented by having multiple entries for the same backend.  */
-    const char *pszName;
-} const g_aBackends[] =
+AUDIOTESTBACKENDDESC const g_aBackends[] =
 {
 #ifdef VBOX_WITH_AUDIO_PULSE
@@ -116 +109 @@
 };
 AssertCompile(sizeof(g_aBackends) > 0 /* port me */);
+/** Number of backends defined. */
+unsigned g_cBackends = RT_ELEMENTS(g_aBackends);
 
 /**
@@ -206 +201 @@
 static const RTGETOPTDEF g_aCmdVerifyOptions[] =
 {
-    { "--tag",              VKAT_VERIFY_OPT_TAG,          RTGETOPT_REQ_STRING  }
+    { "--tag",              VKAT_VERIFY_OPT_TAG,                RTGETOPT_REQ_STRING  }
 };
 
@@ -926 +921 @@
 
     AUDIOTESTDRVSTACK DrvStack;
-    for (size_t i = 0; i < RT_ELEMENTS(g_aBackends); i++)
-    {
-        if (fProbeBackends)
-        {
-            pDrvReg = g_aBackends[i].pDrvReg;
-            RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing for backend '%s' ...\n", g_aBackends[i].pszName);
-        }
+    if (fProbeBackends)
+        rc = audioTestDriverStackProbe(&DrvStack, pDrvReg,
+                                       true /* fEnabledIn */, true /* fEnabledOut */, fWithDrvAudio); /** @todo Make in/out configurable, too. */
+    else
         rc = audioTestDriverStackInitEx(&DrvStack, pDrvReg,
                                         true /* fEnabledIn */, true /* fEnabledOut */, fWithDrvAudio); /** @todo Make in/out configurable, too. */
-        if (RT_SUCCESS(rc))
-        {
-            if (fProbeBackends)
-                RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing backend '%s' successful\n", g_aBackends[i].pszName);
-            break;
-        }
-        if (fProbeBackends)
-        {
-            RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing backend '%s' failed with %Rrc, trying next one\n",
-                         g_aBackends[i].pszName, rc);
-            continue;
-        }
+    if (RT_FAILURE(rc))
         return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unable to init driver stack: %Rrc\n", rc);
-    }
-
-    if (RT_FAILURE(rc))
-        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Probing all backends failed, unable to continue\n");
 
     PPDMAUDIOHOSTDEV pDev;

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

@@ -41 +41 @@
 *********************************************************************************************************************************/
 
+
+
+/**
+ * Long option values for the 'enum' command.
+ */
+enum
+{
+    VKAT_ENUM_OPT_PROBE_BACKENDS = 900
+};
+
 /**
  * Options for 'enum'.
@@ -46 +56 @@
 static const RTGETOPTDEF g_aCmdEnumOptions[] =
 {
-    { "--backend",          'b',                          RTGETOPT_REQ_STRING  },
+    { "--backend",          'b',                                RTGETOPT_REQ_STRING  },
+    { "--probe-backends",    VKAT_ENUM_OPT_PROBE_BACKENDS,      RTGETOPT_REQ_NOTHING }
 };
 
@@ -55 +66 @@
     switch (pOpt->iShort)
     {
-        case 'b': return "The audio backend to use.";
+        case 'b':                               return "The audio backend to use.";
+        case VKAT_ENUM_OPT_PROBE_BACKENDS:      return "Specifies whether to probe all (available) backends until a working one is found\n"
+                                                       "    Default: false";
         default:  return NULL;
     }
 }
-
 
 /**
@@ -73 +85 @@
      */
     /* Option values: */
-    PCPDMDRVREG pDrvReg = AudioTestGetDefaultBackend();
+    PCPDMDRVREG pDrvReg        = AudioTestGetDefaultBackend();
+    bool        fProbeBackends = false;
 
     /* Argument processing loop: */
@@ -88 +101 @@
                 break;
 
+            case VKAT_ENUM_OPT_PROBE_BACKENDS:
+                fProbeBackends = ValueUnion.f;
+                break;
+
             AUDIO_TEST_COMMON_OPTION_CASES(ValueUnion);
 
@@ -95 +112 @@
     }
 
+    int rc;
+
+    AUDIOTESTDRVSTACK DrvStack;
+    if (fProbeBackends)
+        rc = audioTestDriverStackProbe(&DrvStack, pDrvReg,
+                                       true /* fEnabledIn */, true /* fEnabledOut */, false /* fWithDrvAudio */);
+    else
+        rc = audioTestDriverStackInitEx(&DrvStack, pDrvReg,
+                                        true /* fEnabledIn */, true /* fEnabledOut */, false /* fWithDrvAudio */);
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unable to init driver stack: %Rrc\n", rc);
+
     /*
      * Do the enumeration.
      */
-    RTEXITCODE          rcExit = RTEXITCODE_FAILURE;
-    AUDIOTESTDRVSTACK   DrvStack;
-    int rc = audioTestDriverStackInit(&DrvStack, pDrvReg, false /*fWithDrvAudio*/);
-    if (RT_SUCCESS(rc))
-    {
-        if (DrvStack.pIHostAudio->pfnGetDevices)
+    RTEXITCODE rcExit = RTEXITCODE_FAILURE;
+
+    if (DrvStack.pIHostAudio->pfnGetDevices)
+    {
+        PDMAUDIOHOSTENUM Enum;
+        rc = DrvStack.pIHostAudio->pfnGetDevices(DrvStack.pIHostAudio, &Enum);
+        if (RT_SUCCESS(rc))
         {
-            PDMAUDIOHOSTENUM Enum;
-            rc = DrvStack.pIHostAudio->pfnGetDevices(DrvStack.pIHostAudio, &Enum);
-            if (RT_SUCCESS(rc))
+            RTPrintf("Found %u device%s\n", Enum.cDevices, Enum.cDevices != 1 ? "s" : "");
+
+            PPDMAUDIOHOSTDEV pHostDev;
+            RTListForEach(&Enum.LstDevices, pHostDev, PDMAUDIOHOSTDEV, ListEntry)
             {
-                RTPrintf("Found %u device%s\n", Enum.cDevices, Enum.cDevices != 1 ? "s" : "");
-
-                PPDMAUDIOHOSTDEV pHostDev;
-                RTListForEach(&Enum.LstDevices, pHostDev, PDMAUDIOHOSTDEV, ListEntry)
-                {
-                    RTPrintf("\nDevice \"%s\":\n", pHostDev->pszName);
-
-                    char szFlags[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN];
-                    if (pHostDev->cMaxInputChannels && !pHostDev->cMaxOutputChannels && pHostDev->enmUsage == PDMAUDIODIR_IN)
-                        RTPrintf("    Input:  max %u channels (%s)\n",
-                                 pHostDev->cMaxInputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
-                    else if (!pHostDev->cMaxInputChannels && pHostDev->cMaxOutputChannels && pHostDev->enmUsage == PDMAUDIODIR_OUT)
-                        RTPrintf("    Output: max %u channels (%s)\n",
-                                 pHostDev->cMaxOutputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
-                    else
-                        RTPrintf("    %s: max %u output channels, max %u input channels (%s)\n",
-                                 PDMAudioDirGetName(pHostDev->enmUsage), pHostDev->cMaxOutputChannels,
-                                 pHostDev->cMaxInputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
-
-                    if (pHostDev->pszId && *pHostDev->pszId)
-                        RTPrintf("    ID:     \"%s\"\n", pHostDev->pszId);
-                }
-
-                PDMAudioHostEnumDelete(&Enum);
+                RTPrintf("\nDevice \"%s\":\n", pHostDev->pszName);
+
+                char szFlags[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN];
+                if (pHostDev->cMaxInputChannels && !pHostDev->cMaxOutputChannels && pHostDev->enmUsage == PDMAUDIODIR_IN)
+                    RTPrintf("    Input:  max %u channels (%s)\n",
+                             pHostDev->cMaxInputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
+                else if (!pHostDev->cMaxInputChannels && pHostDev->cMaxOutputChannels && pHostDev->enmUsage == PDMAUDIODIR_OUT)
+                    RTPrintf("    Output: max %u channels (%s)\n",
+                             pHostDev->cMaxOutputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
+                else
+                    RTPrintf("    %s: max %u output channels, max %u input channels (%s)\n",
+                             PDMAudioDirGetName(pHostDev->enmUsage), pHostDev->cMaxOutputChannels,
+                             pHostDev->cMaxInputChannels, PDMAudioHostDevFlagsToString(szFlags, pHostDev->fFlags));
+
+                if (pHostDev->pszId && *pHostDev->pszId)
+                    RTPrintf("    ID:     \"%s\"\n", pHostDev->pszId);
             }
-            else
-                rcExit = RTMsgErrorExitFailure("Enumeration failed: %Rrc\n", rc);
+
+            PDMAudioHostEnumDelete(&Enum);
         }
         else
-            rcExit = RTMsgErrorExitFailure("Enumeration not supported by backend '%s'\n", pDrvReg->szName);
-        audioTestDriverStackDelete(&DrvStack);
+            rcExit = RTMsgErrorExitFailure("Enumeration failed: %Rrc\n", rc);
     }
     else
-        rcExit = RTMsgErrorExitFailure("Driver stack construction failed: %Rrc", rc);
+        rcExit = RTMsgErrorExitFailure("Enumeration not supported by backend '%s'\n", pDrvReg->szName);
+    audioTestDriverStackDelete(&DrvStack);
+
     return RTEXITCODE_SUCCESS;
 }

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

@@ -588 +588 @@
 }
 
+/**
+ * Initializes a driver stack by probing all backends in the order of appearance
+ * in the backends description table.
+ *
+ * @returns VBox status code.
+ * @param   pDrvStack       The driver stack to initialize.
+ * @param   pDrvReg         The backend driver to use.
+ * @param   fEnabledIn      Whether input is enabled or not on creation time.
+ * @param   fEnabledOut     Whether output is enabled or not on creation time.
+ * @param   fWithDrvAudio   Whether to include DrvAudio in the stack or not.
+ */
+int audioTestDriverStackProbe(PAUDIOTESTDRVSTACK pDrvStack, PCPDMDRVREG pDrvReg, bool fEnabledIn, bool fEnabledOut, bool fWithDrvAudio)
+{
+    int rc;
+
+    for (size_t i = 0; i < g_cBackends; i++)
+    {
+        pDrvReg = g_aBackends[i].pDrvReg;
+        RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing for backend '%s' ...\n", g_aBackends[i].pszName);
+
+        rc = audioTestDriverStackInitEx(pDrvStack, pDrvReg, fEnabledIn, fEnabledOut, fWithDrvAudio); /** @todo Make in/out configurable, too. */
+        if (RT_SUCCESS(rc))
+        {
+            RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing backend '%s' successful\n", g_aBackends[i].pszName);
+            return rc;
+        }
+
+        RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing backend '%s' failed with %Rrc, trying next one\n",
+                     g_aBackends[i].pszName, rc);
+        continue;
+    }
+
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Probing all backends failed\n");
+    return rc;
+}
 
 /**

trunk/src/VBox/ValidationKit/utils/audio/vkatInternal.h

@@ -292 +292 @@
 
 /**
+ * Backend description.
+ */
+typedef struct AUDIOTESTBACKENDDESC
+{
+    /** The driver registration structure. */
+    PCPDMDRVREG pDrvReg;
+    /** The backend name.
+     * Aliases are implemented by having multiple entries for the same backend.  */
+    const char *pszName;
+} AUDIOTESTBACKENDDESC;
+
+/**
  * VKAT command table entry.
  */
@@ -348 +360 @@
 extern unsigned         g_cTests;
 
+extern AUDIOTESTBACKENDDESC const g_aBackends[];
+extern unsigned                   g_cBackends;
+
 
 /*********************************************************************************************************************************
@@ -365 +380 @@
 int         audioTestDriverStackInitEx(PAUDIOTESTDRVSTACK pDrvStack, PCPDMDRVREG pDrvReg, bool fEnabledIn, bool fEnabledOut, bool fWithDrvAudio);
 int         audioTestDriverStackInit(PAUDIOTESTDRVSTACK pDrvStack, PCPDMDRVREG pDrvReg, bool fWithDrvAudio);
+int         audioTestDriverStackProbe(PAUDIOTESTDRVSTACK pDrvStack, PCPDMDRVREG pDrvReg, bool fEnabledIn, bool fEnabledOut, bool fWithDrvAudio);
 int         audioTestDriverStackSetDevice(PAUDIOTESTDRVSTACK pDrvStack, PDMAUDIODIR enmDir, const char *pszDevId);
 /** @}  */