Changeset 89014 in vbox for trunk

Timestamp:

May 12, 2021 2:33:19 PM (4 years ago)

Author:

vboxsync

Message:

Audio/ValKit: More work on test tone execution. bugref:10008

Location:

trunk/src/VBox

Files:

• Devices/Audio/AudioTest.cpp (modified) (1 diff)
• Devices/Audio/AudioTest.h (modified) (2 diffs)
• ValidationKit/utils/audio/vkat.cpp (modified) (20 diffs)

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

@@ -223 +223 @@
 
     pToneParams->msPrequel      = RTRandU32Ex(0, RT_MS_5SEC);
-    pToneParams->msDuration     = RTRandU32Ex(0, RT_MS_30SEC); /** @todo Probably a bit too long, but let's see. */
+    pToneParams->msDuration     = RTRandU32Ex(0, RT_MS_10SEC); /** @todo Probably a bit too long, but let's see. */
     pToneParams->msSequel       = RTRandU32Ex(0, RT_MS_5SEC);
     pToneParams->uVolumePercent = RTRandU32Ex(0, 100);

trunk/src/VBox/Devices/Audio/AudioTest.h

@@ -85 +85 @@
 
 /**
+ * Structure for keeping an audio test audio stream.
+ */
+typedef struct AUDIOTESTSTREAM
+{
+    /** Created flag to avoid double destruction in backends. */
+    bool                  fCreated;
+    /** Backend-specific stream data. */
+    PDMAUDIOBACKENDSTREAM Backend;
+} AUDIOTESTSTREAM;
+/** Pointer to audio test stream. */
+typedef AUDIOTESTSTREAM *PAUDIOTESTSTREAM;
+
+/**
  * Enumeration for the test set mode.
  */
@@ -98 +111 @@
     AUDIOTESTSETMODE_32BIT_HACK = 0x7fffffff
 } AUDIOTESTSETMODE;
+
+/**
+ * Enumeration to specify an audio test type.
+ */
+typedef enum AUDIOTESTTYPE
+{
+    /** Invalid test type, do not use. */
+    AUDIOTESTTYPE_INVALID = 0,
+    /** Play a test tone. */
+    AUDIOTESTTYPE_TESTTONE
+} AUDIOTESTTYPE;
+
+/**
+ * Audio test request data.
+ */
+typedef struct AUDIOTESTPARMS
+{
+    /** Specifies the test to run. */
+    uint32_t                idxTest;
+    /** How many iterations the test should be executed. */
+    uint32_t                cIterations;
+    /** Audio device to use. */
+    PDMAUDIOHOSTDEV         Dev;
+    /** How much to delay (wait, in ms) the test being executed. */
+    RTMSINTERVAL            msDelay;
+    /** The test direction.. */
+    PDMAUDIODIR             enmDir;
+    /** The test type. */
+    AUDIOTESTTYPE           enmType;
+    /** Union for test type-specific data. */
+    union
+    {
+        AUDIOTESTTONEPARMS  TestTone;
+    };
+} AUDIOTESTPARMS;
+/** Pointer to a test parameter structure. */
+typedef AUDIOTESTPARMS *PAUDIOTESTPARMS;
 
 /**

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

@@ -36 +36 @@
 #include <iprt/message.h>
 #include <iprt/process.h>
+#include <iprt/rand.h>
 #include <iprt/stream.h>
 #include <iprt/string.h>
@@ -68 +69 @@
 *   Structures and Typedefs                                                                                                      *
 *********************************************************************************************************************************/
-/**
- * Audio test request data.
- */
-typedef struct AUDIOTESTPARMS
-{
-    /** Specifies the test to run. */
-    uint32_t                idxTest;
-    /** How many iterations the test should be executed. */
-    uint32_t                cIterations;
-    /** Audio device to use. */
-    PDMAUDIOHOSTDEV         Dev;
-    /** How much to delay (wait, in ms) the test being executed. */
-    RTMSINTERVAL            msDelay;
-    /** The test type. */
-    PDMAUDIODIR             enmDir;
-    union
-    {
-        AUDIOTESTTONEPARMS  ToneParms;
-    };
-} AUDIOTESTPARMS;
-/** Pointer to a test parameter structure. */
-typedef AUDIOTESTPARMS *PAUDIOTESTPARMS;
 
 /**
@@ -125 +104 @@
     /** The current (last) audio device enumeration to use. */
     PDMAUDIOHOSTENUM      DevEnm;
-    PDMAUDIOBACKENDSTREAM aStreams[AUDIOTESTENV_MAX_STREAMS];
+    AUDIOTESTSTREAM       aStreams[AUDIOTESTENV_MAX_STREAMS];
     /** The audio test set to use. */
     AUDIOTESTSET          Set;
@@ -156 +135 @@
 *********************************************************************************************************************************/
 static int audioTestCombineParms(PAUDIOTESTPARMS pBaseParms, PAUDIOTESTPARMS pOverrideParms);
-static int audioTestPlayTone(PAUDIOTESTENV pTstEnv, PPDMAUDIOBACKENDSTREAM pStream, PAUDIOTESTTONEPARMS pParms);
-
+static int audioTestPlayTone(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PAUDIOTESTTONEPARMS pParms);
+static int audioTestStreamDestroy(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream);
 
 /*********************************************************************************************************************************
@@ -234 +213 @@
 
 /*********************************************************************************************************************************
-*   Test callbacks                                                                                                               *
-*********************************************************************************************************************************/
-
-/**
- * Setup callback for playing an output tone.
- *
- * @copydoc FNAUDIOTESTSETUP
- */
-static DECLCALLBACK(int) audioTestPlayToneSetup(PAUDIOTESTENV pTstEnv, PAUDIOTESTDESC pTstDesc, PAUDIOTESTPARMS pTstParmsAcq, void **ppvCtx)
-{
-    RT_NOREF(pTstEnv, pTstDesc, ppvCtx);
-
-    PDMAudioPropsInit(&pTstParmsAcq->ToneParms.Props, 16 /* bit */ / 8, true /* fSigned */, 2 /* Channels */, 44100 /* Hz */);
-
-    AudioTestToneParamsInitRandom(&pTstParmsAcq->ToneParms, &pTstParmsAcq->ToneParms.Props);
-
-    return VINF_SUCCESS;
-}
-
-static DECLCALLBACK(int) audioTestPlayToneExec(PAUDIOTESTENV pTstEnv, void *pvCtx, PAUDIOTESTPARMS pTstParms)
-{
-    RT_NOREF(pvCtx);
-
-    return audioTestPlayTone(pTstEnv, &pTstEnv->aStreams[0], &pTstParms->ToneParms);
-}
-
-static DECLCALLBACK(int) audioTestPlayToneDestroy(PAUDIOTESTENV pTstEnv, void *pvCtx)
-{
-    RT_NOREF(pTstEnv, pvCtx);
-
-    return VINF_SUCCESS;
-}
-
-
-/*********************************************************************************************************************************
 *   Implementation                                                                                                               *
 *********************************************************************************************************************************/
@@ -302 +246 @@
     PDMAudioHostEnumDelete(&pTstEnv->DevEnm);
 
+    for (unsigned i = 0; i < RT_ELEMENTS(pTstEnv->aStreams); i++)
+    {
+        int rc2 = audioTestStreamDestroy(pTstEnv, &pTstEnv->aStreams[i]);
+        if (RT_FAILURE(rc2))
+            RTTestFailed(g_hTest, "Stream destruction for stream #%u failed with %Rrc\n", i, rc2);
+    }
+
     AudioTestSetDestroy(&pTstEnv->Set);
 }
@@ -329 +280 @@
     return;
 }
-
-static AUDIOTESTDESC g_aTests[] =
-{
-    /* pszTest      fExcluded      pfnSetup */
-    { "PlayTone",   false,         audioTestPlayToneSetup,       audioTestPlayToneExec,      audioTestPlayToneDestroy }
-};
-
 
 /**
@@ -550 +494 @@
 }
 
-static int audioTestPlayTone(PAUDIOTESTENV pTstEnv, PPDMAUDIOBACKENDSTREAM pStream, PAUDIOTESTTONEPARMS pParms)
-{
-    PDMAUDIOSTREAMCFG CfgReq;
+static int audioTestStreamCreate(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PPDMAUDIOSTREAMCFG pCfg)
+{
     PDMAUDIOSTREAMCFG CfgAcq;
 
-    int rc = PDMAudioStrmCfgInitWithProps(&CfgReq, &pParms->Props);
+    int rc = PDMAudioStrmCfgCopy(&CfgAcq, pCfg);
     AssertRC(rc); /* Cannot fail. */
 
-    CfgReq.enmDir      = PDMAUDIODIR_OUT;
-    CfgReq.u.enmDst    = PDMAUDIOPLAYBACKDST_FRONT;
-    CfgReq.enmLayout   = PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED;
-
-    rc = PDMAudioStrmCfgCopy(&CfgAcq, &CfgReq);
-    AssertRC(rc); /* Ditto. */
-
-    rc = pTstEnv->pDrvAudio->pfnStreamCreate(pTstEnv->pDrvAudio, pStream, &CfgReq, &CfgAcq);
+    rc = pTstEnv->pDrvAudio->pfnStreamCreate(pTstEnv->pDrvAudio, &pStream->Backend, pCfg, &CfgAcq);
     if (RT_FAILURE(rc))
         return rc;
@@ -571 +507 @@
     /* Do the async init in a synchronous way for now here. */
     if (rc == VINF_AUDIO_STREAM_ASYNC_INIT_NEEDED)
-        rc = pTstEnv->pDrvAudio->pfnStreamInitAsync(pTstEnv->pDrvAudio, pStream, false /* fDestroyed */);
-
+        rc = pTstEnv->pDrvAudio->pfnStreamInitAsync(pTstEnv->pDrvAudio, &pStream->Backend, false /* fDestroyed */);
+
+    if (RT_SUCCESS(rc))
+        pStream->fCreated = true;
+
+    return rc;
+}
+
+static int audioTestStreamDestroy(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream)
+{
+    if (!pStream)
+        return VINF_SUCCESS;
+
+  if (!pStream->fCreated)
+        return VINF_SUCCESS;
+
+    /** @todo Anything else to do here, e.g. test if there are left over samples or some such? */
+
+    int rc = pTstEnv->pDrvAudio->pfnStreamDestroy(pTstEnv->pDrvAudio, &pStream->Backend);
+    if (RT_SUCCESS(rc))
+        RT_BZERO(pStream, sizeof(PDMAUDIOBACKENDSTREAM));
+
+    return rc;
+}
+
+static int audioTestCreateStreamDefaultOut(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PPDMAUDIOPCMPROPS pProps)
+{
+    PDMAUDIOSTREAMCFG Cfg;
+    int rc = PDMAudioStrmCfgInitWithProps(&Cfg, pProps);
+    AssertRC(rc); /* Cannot fail. */
+
+    Cfg.enmDir      = PDMAUDIODIR_OUT;
+    Cfg.u.enmDst    = PDMAUDIOPLAYBACKDST_FRONT;
+    Cfg.enmLayout   = PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED;
+
+    return audioTestStreamCreate(pTstEnv, pStream, &Cfg);
+}
+
+static int audioTestPlayTone(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PAUDIOTESTTONEPARMS pParms)
+{
     AUDIOTESTTONE TstTone;
     AudioTestToneInitRandom(&TstTone, &pParms->Props);
 
-    PDMHOSTAUDIOSTREAMSTATE enmState = pTstEnv->pDrvAudio->pfnStreamGetState(pTstEnv->pDrvAudio, pStream);
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Playing test tone (freq %RU16, %RU32ms)\n", TstTone.rdFreqHz, pParms->msDuration);
+
+    int rc;
+
+    PDMHOSTAUDIOSTREAMSTATE enmState = pTstEnv->pDrvAudio->pfnStreamGetState(pTstEnv->pDrvAudio, &pStream->Backend);
     if (enmState == PDMHOSTAUDIOSTREAMSTATE_OKAY)
     {
@@ -583 +561 @@
 
         const uint64_t tsStartMs     = RTTimeMilliTS();
-        const unsigned cSchedulingMs = 10;
-        const uint32_t cbPerMs       = PDMAudioPropsMilliToBytes(&CfgAcq.Props, cSchedulingMs);
+        const uint16_t cSchedulingMs = RTRandU32Ex(10, 80); /* Chose a random scheduling (in ms). */
+        const uint32_t cbPerMs       = PDMAudioPropsMilliToBytes(&pParms->Props, cSchedulingMs);
 
         do
@@ -592 +570 @@
             {
                 uint32_t cbWritten;
-                rc = pTstEnv->pDrvAudio->pfnStreamPlay(pTstEnv->pDrvAudio, pStream, abBuf, cbBuf, &cbWritten);
+                rc = pTstEnv->pDrvAudio->pfnStreamPlay(pTstEnv->pDrvAudio, &pStream->Backend, abBuf, cbBuf, &cbWritten);
             }
 
@@ -602 +580 @@
         } while (RT_SUCCESS(rc));
     }
-
-    int rc2 = pTstEnv->pDrvAudio->pfnStreamDestroy(pTstEnv->pDrvAudio, pStream);
-    if (RT_SUCCESS(rc))
-        rc = rc2;
-
-    return VINF_SUCCESS;
+    else
+        rc = VERR_AUDIO_STREAM_NOT_READY;
+
+    return rc;
 }
 
@@ -626 +602 @@
     return VERR_NOT_IMPLEMENTED;
 }
+
+
+/*********************************************************************************************************************************
+*   Test callbacks                                                                                                               *
+*********************************************************************************************************************************/
+
+/**
+ * @copydoc FNAUDIOTESTSETUP
+ */
+static DECLCALLBACK(int) audioTestPlayToneSetup(PAUDIOTESTENV pTstEnv, PAUDIOTESTDESC pTstDesc, PAUDIOTESTPARMS pTstParmsAcq, void **ppvCtx)
+{
+    RT_NOREF(pTstEnv, pTstDesc, ppvCtx);
+
+    PDMAudioPropsInit(&pTstParmsAcq->TestTone.Props, 16 /* bit */ / 8, true /* fSigned */, 2 /* Channels */, 44100 /* Hz */);
+
+    pTstParmsAcq->cIterations = RTRandU32Ex(1, 10);
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * @copydoc FNAUDIOTESTEXEC
+ */
+static DECLCALLBACK(int) audioTestPlayToneExec(PAUDIOTESTENV pTstEnv, void *pvCtx, PAUDIOTESTPARMS pTstParms)
+{
+    RT_NOREF(pvCtx);
+
+    int rc;
+
+    PAUDIOTESTSTREAM pStream = &pTstEnv->aStreams[0];
+
+    for (uint32_t i = 0; i < pTstParms->cIterations; i++)
+    {
+        AudioTestToneParamsInitRandom(&pTstParms->TestTone, &pTstParms->TestTone.Props);
+        rc = audioTestCreateStreamDefaultOut(pTstEnv, pStream, &pTstParms->TestTone.Props);
+        if (RT_SUCCESS(rc))
+            rc = audioTestPlayTone(pTstEnv, pStream, &pTstParms->TestTone);
+
+        int rc2 = audioTestStreamDestroy(pTstEnv, pStream);
+        if (RT_SUCCESS(rc))
+            rc = rc2;
+    }
+
+    return rc;
+}
+
+/**
+ * @copydoc FNAUDIOTESTDESTROY
+ */
+static DECLCALLBACK(int) audioTestPlayToneDestroy(PAUDIOTESTENV pTstEnv, void *pvCtx)
+{
+    RT_NOREF(pTstEnv, pvCtx);
+
+    return VINF_SUCCESS;
+}
+
+
+/*********************************************************************************************************************************
+*   Test execution                                                                                                               *
+*********************************************************************************************************************************/
+
+static AUDIOTESTDESC g_aTests[] =
+{
+    /* pszTest      fExcluded      pfnSetup */
+    { "PlayTone",   false,         audioTestPlayToneSetup,       audioTestPlayToneExec,      audioTestPlayToneDestroy }
+};
 
 /**
@@ -660 +702 @@
         rc = pTstDesc->pfnSetup(pTstEnv, pTstDesc, &TstParms, &pvCtx);
         if (RT_FAILURE(rc))
+        {
+            RTTestFailed(g_hTest, "Test setup failed\n");
             return rc;
+        }
     }
 
     audioTestCombineParms(&TstParms, pOverrideParms);
+
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Test #%u: %RU32 iterations\n", uSeq, TstParms.cIterations);
 
     if (strlen(TstParms.Dev.szName)) /** @todo Refine this check. */
@@ -678 +725 @@
         if (RT_SUCCESS(rc))
             rc = rc2;
+
+        if (RT_FAILURE(rc2))
+            RTTestFailed(g_hTest, "Test destruction failed\n");
     }
 
@@ -836 +886 @@
             case VKAT_TEST_OPT_PCM_BIT:
             {
-                TstCust.ToneParms.Props.cbSampleX = ValueUnion.u8 / 8 /* bit */;
+                TstCust.TestTone.Props.cbSampleX = ValueUnion.u8 / 8 /* bit */;
                 break;
             }
@@ -842 +892 @@
             case VKAT_TEST_OPT_PCM_CHAN:
             {
-                TstCust.ToneParms.Props.cChannelsX = ValueUnion.u8;
+                TstCust.TestTone.Props.cChannelsX = ValueUnion.u8;
                 break;
             }
@@ -848 +898 @@
             case VKAT_TEST_OPT_PCM_HZ:
             {
-                TstCust.ToneParms.Props.uHz = ValueUnion.u32;
+                TstCust.TestTone.Props.uHz = ValueUnion.u32;
                 break;
             }
@@ -854 +904 @@
             case VKAT_TEST_OPT_PCM_SIGNED:
             {
-                TstCust.ToneParms.Props.fSigned = ValueUnion.f;
+                TstCust.TestTone.Props.fSigned = ValueUnion.f;
                 break;
             }
@@ -866 +916 @@
             case VKAT_TEST_OPT_VOL:
             {
-                TstCust.ToneParms.uVolumePercent = ValueUnion.u8;
+                TstCust.TestTone.uVolumePercent = ValueUnion.u8;
                 break;
             }