Changeset 90766 in vbox for trunk

Timestamp:

Aug 20, 2021 5:30:57 PM (3 years ago)

Author:

vboxsync

Message:

Audio/ValKit: Decoupled the driver stack from the test environment, so that two test environments can use the same driver stack -- needed for self-tests and also is a cleaner solution. bugref:10008

Location:

trunk/src/VBox/ValidationKit/utils/audio

Files:

• vkat.cpp (modified) (3 diffs)
• vkatCmdSelfTest.cpp (modified) (7 diffs)
• vkatCommon.cpp (modified) (12 diffs)
• vkatDriverStack.cpp (modified) (2 diffs)
• vkatInternal.h (modified) (5 diffs)

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

@@ -246 +246 @@
     if (strlen(pTstEnv->szDev))
     {
-        rc = audioTestDriverStackSetDevice(&pTstEnv->DrvStack, PDMAUDIODIR_OUT, pTstEnv->szDev);
+        rc = audioTestDriverStackSetDevice(pTstEnv->pDrvStack, PDMAUDIODIR_OUT, pTstEnv->szDev);
         if (RT_FAILURE(rc))
             return rc;
@@ -350 +350 @@
     if (strlen(pTstEnv->szDev))
     {
-        rc = audioTestDriverStackSetDevice(&pTstEnv->DrvStack, PDMAUDIODIR_IN, pTstEnv->szDev);
+        rc = audioTestDriverStackSetDevice(pTstEnv->pDrvStack, PDMAUDIODIR_IN, pTstEnv->szDev);
         if (RT_FAILURE(rc))
             return rc;
@@ -857 +857 @@
         return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No test mode (--mode) specified!\n");
 
-    /* For now all tests have the same test environment. */
-    rc = audioTestEnvInit(&TstEnv, pDrvReg, fWithDrvAudio);
+    AUDIOTESTDRVSTACK DrvStack;
+    rc = audioTestDriverStackInitEx(&DrvStack, pDrvReg,
+                                    true /* fEnabledIn */, true /* fEnabledOut */, fWithDrvAudio); /** @todo Make in/out configurable, too. */
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unable to init driver stack: %Rrc\n", rc);
+
+    PPDMAUDIOHOSTDEV pDev;
+    rc = audioTestDevicesEnumerateAndCheck(&DrvStack, TstEnv.szDev, &pDev);
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Enumerating device(s) failed: %Rrc\n", rc);
+
+    /* For now all tests have the same test environment and driver stack. */
+    rc = audioTestEnvInit(&TstEnv, &DrvStack);
     if (RT_SUCCESS(rc))
         rc = audioTestWorker(&TstEnv);
 
     audioTestEnvDestroy(&TstEnv);
+    audioTestDriverStackDelete(&DrvStack);
 
     if (RT_FAILURE(rc)) /* Let us know that something went wrong in case we forgot to mention it. */

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

@@ -77 +77 @@
                       2 /* 16-bit */, true  /* fSigned */, 2 /* cChannels */, 44100 /* uHz */);
 
-    rc = audioTestEnvInit(pTstEnvGst, pTstEnvGst->DrvStack.pDrvReg, pCtx->fWithDrvAudio);
+    rc = audioTestEnvInit(pTstEnvGst, &pCtx->DrvStack);
     if (RT_SUCCESS(rc))
     {
@@ -150 +150 @@
     /* else Step 1a later. */
 
+    RTThreadSleep(5000); /* Fudge: Wait until guest ATS is up. */
+
     if (RT_SUCCESS(rc))
     {
@@ -157 +159 @@
         pTstEnvHst->enmMode = AUDIOTESTMODE_HOST;
 
-        rc = audioTestEnvInit(pTstEnvHst, &g_DrvHostValidationKitAudio, true /* fWithDrvAudio */);
+        rc = audioTestEnvInit(pTstEnvHst, &pCtx->DrvStack);
         if (RT_SUCCESS(rc))
         {
@@ -260 +262 @@
     RT_ZERO(Ctx);
 
-    /* Go with the platform's default backend if nothing else is specified. */
-    Ctx.Guest.pDrvReg = AudioTestGetDefaultBackend();
-
     /* Argument processing loop: */
     int           rc;
@@ -292 +291 @@
 
             case 'b':
-                Ctx.Guest.pDrvReg = AudioTestFindBackendOpt(ValueUnion.psz);
-                if (Ctx.Guest.pDrvReg == NULL)
+                Ctx.pDrvReg = AudioTestFindBackendOpt(ValueUnion.psz);
+                if (Ctx.pDrvReg == NULL)
                     return RTEXITCODE_SYNTAX;
                 break;
@@ -320 +319 @@
     }
 
+    /* Go with the Validation Kit audio backend if nothing else is specified. */
+    if (Ctx.pDrvReg == NULL)
+        Ctx.pDrvReg = AudioTestFindBackendOpt("valkit");
+
+    /*
+     * In self-test mode the guest and the host side have to share the same driver stack,
+     * as we don't have any device emulation between the two sides.
+     *
+     * This is necessary to actually get the played/recorded audio to from/to the guest
+     * and host respectively.
+     *
+     * Choosing any other backend than the Validation Kit above *will* break this self-test!
+     */
+    rc = audioTestDriverStackInitEx(&Ctx.DrvStack, Ctx.pDrvReg,
+                                    true /* fEnabledIn */, true /* fEnabledOut */, Ctx.fWithDrvAudio);
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unable to init driver stack: %Rrc\n", rc);
+
     /*
      * Start testing.
@@ -328 +345 @@
     if (RT_FAILURE(rc2))
         RTTestFailed(g_hTest, "Self test failed with rc=%Rrc", rc2);
+
+    audioTestDriverStackDelete(&Ctx.DrvStack);
 
     /*

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

@@ -70 +70 @@
 static int audioTestStreamInit(PAUDIOTESTDRVSTACK pDrvStack, PAUDIOTESTSTREAM pStream, PDMAUDIODIR enmDir, PCPDMAUDIOPCMPROPS pProps, bool fWithMixer, uint32_t cMsBufferSize, uint32_t cMsPreBuffer, uint32_t cMsSchedulingHint);
 static int audioTestStreamDestroy(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream);
-static int audioTestDevicesEnumerateAndCheck(PAUDIOTESTENV pTstEnv, const char *pszDev, PPDMAUDIOHOSTDEV *ppDev);
 
 
@@ -81 +80 @@
  *
  * @returns VBox status code.
- * @param   pTstEnv             Test env to use for enumeration.
+ * @param   pDrvStack           Driver stack to use for enumeration.
  * @param   pszDev              Device name to search for. Can be NULL if the default device shall be used.
  * @param   ppDev               Where to return the pointer of the device enumeration of \a pTstEnv when a
  *                              specific device was found.
  */
-static int audioTestDevicesEnumerateAndCheck(PAUDIOTESTENV pTstEnv, const char *pszDev, PPDMAUDIOHOSTDEV *ppDev)
+int audioTestDevicesEnumerateAndCheck(PAUDIOTESTDRVSTACK pDrvStack, const char *pszDev, PPDMAUDIOHOSTDEV *ppDev)
 {
     RTTestSubF(g_hTest, "Enumerating audio devices and checking for device '%s'", pszDev && *pszDev ? pszDev : "<Default>");
 
-    if (!pTstEnv->DrvStack.pIHostAudio->pfnGetDevices)
+    if (!pDrvStack->pIHostAudio->pfnGetDevices)
     {
         RTTestSkipped(g_hTest, "Backend does not support device enumeration, skipping");
@@ -101 +100 @@
         *ppDev = NULL;
 
-    int rc = pTstEnv->DrvStack.pIHostAudio->pfnGetDevices(pTstEnv->DrvStack.pIHostAudio, &pTstEnv->DevEnum);
+    int rc = pDrvStack->pIHostAudio->pfnGetDevices(pDrvStack->pIHostAudio, &pDrvStack->DevEnum);
     if (RT_SUCCESS(rc))
     {
         PPDMAUDIOHOSTDEV pDev;
-        RTListForEach(&pTstEnv->DevEnum.LstDevices, pDev, PDMAUDIOHOSTDEV, ListEntry)
+        RTListForEach(&pDrvStack->DevEnum.LstDevices, pDev, PDMAUDIOHOSTDEV, ListEntry)
         {
             char szFlags[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN];
@@ -199 +198 @@
         /** @todo Anything else to do here, e.g. test if there are left over samples or some such? */
 
-        audioTestDriverStackStreamDestroy(&pTstEnv->DrvStack, pStream->pStream);
+        audioTestDriverStackStreamDestroy(pTstEnv->pDrvStack, pStream->pStream);
         pStream->pStream  = NULL;
         pStream->pBackend = NULL;
@@ -504 +503 @@
     const PAUDIOTESTSTREAM pTstStream = &pTstEnv->aStreams[0]; /** @todo Make this dynamic. */
 
-    int rc = audioTestStreamInit(&pTstEnv->DrvStack, pTstStream, PDMAUDIODIR_OUT, &pTstEnv->Props, false /* fWithMixer */,
+    int rc = audioTestStreamInit(pTstEnv->pDrvStack, pTstStream, PDMAUDIODIR_OUT, &pTstEnv->Props, false /* fWithMixer */,
                                  pTstEnv->cMsBufferSize, pTstEnv->cMsPreBuffer, pTstEnv->cMsSchedulingHint);
     if (RT_SUCCESS(rc))
@@ -545 +544 @@
     const PAUDIOTESTSTREAM pTstStream = &pTstEnv->aStreams[0]; /** @todo Make this dynamic. */
 
-    int rc = audioTestStreamInit(&pTstEnv->DrvStack, pTstStream, PDMAUDIODIR_IN, &pTstEnv->Props, false /* fWithMixer */,
+    int rc = audioTestStreamInit(pTstEnv->pDrvStack, pTstStream, PDMAUDIODIR_IN, &pTstEnv->Props, false /* fWithMixer */,
                                  pTstEnv->cMsBufferSize, pTstEnv->cMsPreBuffer, pTstEnv->cMsSchedulingHint);
     if (RT_SUCCESS(rc))
@@ -795 +794 @@
  * @param   fWithDrvAudio       Whether to include DrvAudio in the stack or not.
  */
-int audioTestEnvInit(PAUDIOTESTENV pTstEnv,
-                     PCPDMDRVREG pDrvReg, bool fWithDrvAudio)
+int audioTestEnvInit(PAUDIOTESTENV pTstEnv, PAUDIOTESTDRVSTACK pDrvStack)
 {
     int rc = VINF_SUCCESS;
+
+    pTstEnv->pDrvStack = pDrvStack;
 
     /*
@@ -821 +821 @@
     }
 
-    /* Go with the platform's default backend if nothing else is set. */
-    if (!pDrvReg)
-        pDrvReg = AudioTestGetDefaultBackend();
-
     RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Initializing environment for mode '%s'\n", pTstEnv->enmMode == AUDIOTESTMODE_HOST ? "host" : "guest");
-    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Using backend '%s'\n", pDrvReg->szName);
     RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Using tag '%s'\n", pTstEnv->szTag);
     RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Output directory is '%s'\n", pTstEnv->szPathOut);
@@ -837 +832 @@
     if (!pTstEnv->cMsSchedulingHint)
         pTstEnv->cMsSchedulingHint = UINT32_MAX;
-
-    PDMAudioHostEnumInit(&pTstEnv->DevEnum);
-
-    bool fUseDriverStack = false; /* Whether to init + use the audio driver stack or not. */
-
-    /* In regular testing mode only the guest mode needs initializing the driver stack. */
-    if (pTstEnv->enmMode == AUDIOTESTMODE_GUEST)
-        fUseDriverStack = true;
-
-    /* When running in self-test mode, the host mode also needs to initialize the stack in order to
-     * to run the Valdation Kit audio driver ATS (no "real" VBox involved). */
-    if (pTstEnv->enmMode == AUDIOTESTMODE_HOST && pTstEnv->fSelftest)
-        fUseDriverStack = true;
-
-    if (fUseDriverStack)
-    {
-        rc = audioTestDriverStackInitEx(&pTstEnv->DrvStack, pDrvReg,
-                                        true /* fEnabledIn */, true /* fEnabledOut */, fWithDrvAudio);
-        if (RT_FAILURE(rc))
-            return rc;
-
-        PPDMAUDIOHOSTDEV pDev;
-        rc = audioTestDevicesEnumerateAndCheck(pTstEnv, pTstEnv->szDev, &pDev);
-        if (RT_FAILURE(rc))
-            return rc;
-    }
 
     char szPathTemp[RTPATH_MAX];
@@ -983 +952 @@
     }
 
-    if (   RT_FAILURE(rc)
-        && fUseDriverStack)
-        audioTestDriverStackDelete(&pTstEnv->DrvStack);
-
     return rc;
 }
@@ -999 +964 @@
     if (!pTstEnv)
         return;
-
-    PDMAudioHostEnumDelete(&pTstEnv->DevEnum);
 
     for (unsigned i = 0; i < RT_ELEMENTS(pTstEnv->aStreams); i++)
@@ -1013 +976 @@
     RTDirRemove(pTstEnv->szPathOut);
 
-    audioTestDriverStackDelete(&pTstEnv->DrvStack);
+    pTstEnv->pDrvStack = NULL;
 }
 

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

@@ -486 +486 @@
     pDrvStack->pDrvAudioIns     = NULL;
     pDrvStack->pIAudioConnector = NULL;
+
+    PDMAudioHostEnumDelete(&pDrvStack->DevEnum);
 }
 
@@ -505 +507 @@
     RT_ZERO(*pDrvStack);
     pDrvStack->pDrvReg = pDrvReg;
+
+    PDMAudioHostEnumInit(&pDrvStack->DevEnum);
 
     if (!fWithDrvAudio)

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

@@ -72 +72 @@
     /** This is NULL if we don't use DrvAudio. */
     PPDMIAUDIOCONNECTOR     pIAudioConnector;
+
+    /** The current (last) audio device enumeration to use. */
+    PDMAUDIOHOSTENUM        DevEnum;
 } AUDIOTESTDRVSTACK;
 /** Pointer to an audio driver stack. */
@@ -222 +225 @@
     /** Scheduling hint (in ms). */
     RTMSINTERVAL            cMsSchedulingHint;
-    /** The audio test driver stack. */
-    AUDIOTESTDRVSTACK       DrvStack;
-    /** The current (last) audio device enumeration to use. */
-    PDMAUDIOHOSTENUM        DevEnum;
+    /** Pointer to audio test driver stack to use. */
+    PAUDIOTESTDRVSTACK      pDrvStack;
     /** Audio stream. */
     AUDIOTESTSTREAM         aStreams[AUDIOTESTENV_MAX_STREAMS];
@@ -282 +283 @@
     /** Whether to use DrvAudio in the driver stack or not. */
     bool             fWithDrvAudio;
+    AUDIOTESTDRVSTACK DrvStack;
+    /** Audio driver to use.
+     *  Defaults to the platform's default driver. */
+    PCPDMDRVREG      pDrvReg;
     struct
     {
         AUDIOTESTENV TstEnv;
-        /** Audio driver to use.
-         *  Defaults to the platform's default driver. */
-        PCPDMDRVREG  pDrvReg;
         /** Where to bind the address of the guest ATS instance to.
          *  Defaults to localhost (127.0.0.1) if empty. */
@@ -443 +445 @@
 int         audioTestDeviceOpen(PPDMAUDIOHOSTDEV pDev);
 int         audioTestDeviceClose(PPDMAUDIOHOSTDEV pDev);
+
+int         audioTestDevicesEnumerateAndCheck(PAUDIOTESTDRVSTACK pDrvStack, const char *pszDev, PPDMAUDIOHOSTDEV *ppDev);
 /** @}  */
 
@@ -453 +457 @@
 /** @name Test environment handling
  * @{ */
-int         audioTestEnvInit(PAUDIOTESTENV pTstEnv, PCPDMDRVREG pDrvReg, bool fWithDrvAudio);
+int         audioTestEnvInit(PAUDIOTESTENV pTstEnv, PAUDIOTESTDRVSTACK pDrvStack);
 void        audioTestEnvDestroy(PAUDIOTESTENV pTstEnv);
 int         audioTestEnvPrologue(PAUDIOTESTENV pTstEnv, bool fPack, char *pszPackFile, size_t cbPackFile);