Changeset 89463 in vbox for trunk/src/VBox/Devices

Timestamp:

Jun 2, 2021 11:03:47 AM (4 years ago)

Author:

vboxsync

Message:

Audio/ValKit: More code for the Validation Kit audio driver. bugref:10008

Location:

trunk/src/VBox/Devices/Audio

Files:

• AudioTest.cpp (modified) (1 diff)
• AudioTest.h (modified) (1 diff)
• DrvHostAudioValidationKit.cpp (modified) (10 diffs)

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

@@ -1055 +1055 @@
  * @param   cbBuf               Size (in bytes) of \a pvBuf to write.
  */
-int AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, void *pvBuf, size_t cbBuf)
+int AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, const void *pvBuf, size_t cbBuf)
 {
     /** @todo Generalize this function more once we have more object types. */

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

@@ -366 +366 @@
 
 int    AudioTestSetObjCreateAndRegister(PAUDIOTESTSET pSet, const char *pszName, PAUDIOTESTOBJ *ppObj);
-int    AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, void *pvBuf, size_t cbBuf);
+int    AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, const void *pvBuf, size_t cbBuf);
 int    AudioTestSetObjAddMetadataStr(PAUDIOTESTOBJ pObj, const char *pszFormat, ...);
 int    AudioTestSetObjClose(PAUDIOTESTOBJ pObj);

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

@@ -58 +58 @@
 typedef struct VALKITTESTTONEDATA
 {
-    /** How many bytes to write. */
-    uint64_t           cbToWrite;
-    /** How many bytes already written. */
-    uint64_t           cbWritten;
+    union
+    {
+        struct
+        {
+            /** How many bytes to write. */
+            uint64_t           cbToWrite;
+            /** How many bytes already written. */
+            uint64_t           cbWritten;
+        } Rec;
+        struct
+        {
+            /** How many bytes to read. */
+            uint64_t           cbToRead;
+            /** How many bytes already read. */
+            uint64_t           cbRead;
+        } Play;
+    } u;
     /** The test tone instance to use. */
     AUDIOTESTTONE      Tone;
@@ -75 +88 @@
     /** The list node. */
     RTLISTNODE             Node;
+    /** Current test set entry to process. */
+    PAUDIOTESTENTRY        pEntry;
+    /** Current test object to process. */
+    PAUDIOTESTOBJ          pObj;
     /** Stream configuration to use for this test. */
     PDMAUDIOSTREAMCFG      StreamCfg;
@@ -98 +115 @@
     /** Pointer to host audio interface. */
     PDMIHOSTAUDIO       IHostAudio;
+    /** Current test set being handled. */
+    AUDIOTESTSET        Set;
     /** Number of tests in \a lstTestsRec. */
     uint32_t            cTestsRec;
     /** List keeping the recording tests (FIFO). */
     RTLISTANCHOR        lstTestsRec;
-    /** Pointer to current recording test being processed. */
-    PVALKITTESTDATA     pTestRecCur;
+    /** Number of tests in \a lstTestsPlay. */
+    uint32_t            cTestsPlay;
+    /** List keeping the recording tests (FIFO). */
+    RTLISTANCHOR        lstTestsPlay;
+    /** Pointer to current test being processed. */
+    PVALKITTESTDATA     pTestCur;
     /** Critical section for serializing access across threads. */
     RTCRITSECT          CritSect;
@@ -113 +136 @@
 
 
-/**
- * Note: Called within server (client serving) thread.
- */
-static DECLCALLBACK(int) drvHostValKitAudioSvcTonePlayCallback(void const *pvUser, PAUDIOTESTTONEPARMS pToneParms)
+
+static void drvHostValKiUnregisterTest(PVALKITTESTDATA pTst)
+{
+    RTListNodeRemove(&pTst->Node);
+
+    AudioTestSetObjClose(pTst->pObj);
+    pTst->pObj = NULL;
+    AudioTestSetTestDone(pTst->pEntry);
+    pTst->pEntry = NULL;
+
+    RTMemFree(pTst);
+    pTst = NULL;
+}
+
+static void drvHostValKiUnregisterRecTest(PDRVHOSTVALKITAUDIO pThis, PVALKITTESTDATA pTst)
+{
+    drvHostValKiUnregisterTest(pTst);
+
+    Assert(pThis->cTestsRec);
+    pThis->cTestsRec--;
+}
+
+static void drvHostValKiUnregisterPlayTest(PDRVHOSTVALKITAUDIO pThis, PVALKITTESTDATA pTst)
+{
+    drvHostValKiUnregisterTest(pTst);
+
+    Assert(pThis->cTestsPlay);
+    pThis->cTestsPlay--;
+}
+
+/** @copydoc ATSCALLBACKS::pfnTonePlay
+ *
+ * Creates and registers a new test tone recording test
+ * which later then gets recorded by the guest side.
+ */
+static DECLCALLBACK(int) drvHostValKitRegisterGuestRecTest(void const *pvUser, PAUDIOTESTTONEPARMS pToneParms)
 {
     PDRVHOSTVALKITAUDIO pThis = (PDRVHOSTVALKITAUDIO)pvUser;
@@ -127 +182 @@
     AudioTestToneInit(&pTestData->t.TestTone.Tone, &pToneParms->Props, pTestData->t.TestTone.Parms.dbFreqHz);
 
-    pTestData->t.TestTone.cbToWrite = PDMAudioPropsMilliToBytes(&pToneParms->Props,
+    pTestData->t.TestTone.u.Rec.cbToWrite = PDMAudioPropsMilliToBytes(&pToneParms->Props,
+                                                                      pTestData->t.TestTone.Parms.msDuration);
+    int rc = RTCritSectEnter(&pThis->CritSect);
+    if (RT_SUCCESS(rc))
+    {
+        LogRel(("Audio: Validation Kit: Registered guest recording test (%RU32ms, %RU64 bytes)\n",
+                pTestData->t.TestTone.Parms.msDuration, pTestData->t.TestTone.u.Rec.cbToWrite));
+
+        RTListAppend(&pThis->lstTestsRec, &pTestData->Node);
+
+        pThis->cTestsRec++;
+
+        int rc2 = RTCritSectLeave(&pThis->CritSect);
+        AssertRC(rc2);
+    }
+
+    return VINF_SUCCESS;
+}
+
+/** @copydoc ATSCALLBACKS::pfnToneRecord
+ *
+ * Creates and registers a new test tone playback test
+ * which later then records audio played back by the guest side.
+ */
+static DECLCALLBACK(int) drvHostValKitRegisterGuestPlayTest(void const *pvUser, PAUDIOTESTTONEPARMS pToneParms)
+{
+    PDRVHOSTVALKITAUDIO pThis = (PDRVHOSTVALKITAUDIO)pvUser;
+
+    PVALKITTESTDATA pTestData = (PVALKITTESTDATA)RTMemAllocZ(sizeof(VALKITTESTDATA));
+    AssertPtrReturn(pTestData, VERR_NO_MEMORY);
+
+    memcpy(&pTestData->t.TestTone.Parms, pToneParms, sizeof(AUDIOTESTTONEPARMS));
+
+    pTestData->t.TestTone.u.Rec.cbToWrite = PDMAudioPropsMilliToBytes(&pToneParms->Props,
                                                                 pTestData->t.TestTone.Parms.msDuration);
     int rc = RTCritSectEnter(&pThis->CritSect);
     if (RT_SUCCESS(rc))
     {
-        RTListAppend(&pThis->lstTestsRec, &pTestData->Node);
-
-        pThis->cTestsRec++;
+        LogRel(("Audio: Validation Kit: Registered guest playback test (%RU32ms, %RU64 bytes)\n",
+                pTestData->t.TestTone.Parms.msDuration, pTestData->t.TestTone.u.Rec.cbToWrite));
+
+        RTListAppend(&pThis->lstTestsPlay, &pTestData->Node);
+
+        pThis->cTestsPlay++;
 
         int rc2 = RTCritSectLeave(&pThis->CritSect);
@@ -325 +416 @@
                                                          const void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
 {
-    PDRVHOSTVALKITAUDIO pThis      = RT_FROM_MEMBER(pInterface, DRVHOSTVALKITAUDIO, IHostAudio);
-    PVALKITAUDIOSTREAM  pStreamDbg = (PVALKITAUDIOSTREAM)pStream;
-    RT_NOREF(pThis, pStreamDbg, pvBuf, cbBuf);
-
-    *pcbWritten = 0;
-    return VINF_SUCCESS;
+    RT_NOREF(pStream);
+
+    PDRVHOSTVALKITAUDIO pThis = RT_FROM_MEMBER(pInterface, DRVHOSTVALKITAUDIO, IHostAudio);
+
+    int rc = RTCritSectEnter(&pThis->CritSect);
+    if (RT_SUCCESS(rc))
+    {
+        pThis->pTestCur = RTListGetFirst(&pThis->lstTestsPlay, VALKITTESTDATA, Node);
+
+        int rc2 = RTCritSectLeave(&pThis->CritSect);
+        AssertRC(rc2);
+    }
+
+    if (pThis->pTestCur == NULL) /* Empty list? */
+    {
+        LogRelMax(64, ("Audio: Validation Kit: Warning: Guest is playing back data when no playback test is active\n"));
+#ifdef DEBUG_andy
+        AssertFailed();
+#endif
+        *pcbWritten = 0;
+        return VINF_SUCCESS;
+    }
+
+    PVALKITTESTDATA pTst = pThis->pTestCur;
+
+    if (pTst->t.TestTone.u.Play.cbRead == 0)
+    {
+        AUDIOTESTPARMS Parms;
+        RT_ZERO(Parms);
+        Parms.TestTone = pTst->t.TestTone.Parms;
+
+        Assert(pTst->pEntry == NULL);
+        rc = AudioTestSetTestBegin(&pThis->Set, "Recording audio data from guest",
+                                    &Parms, &pTst->pEntry);
+        if (RT_SUCCESS(rc))
+            rc = AudioTestSetObjCreateAndRegister(&pThis->Set, "guest-output.pcm", &pTst->pObj);
+
+        if (RT_SUCCESS(rc))
+        {
+            pTst->msStartedTS = RTTimeMilliTS();
+            LogRel(("Audio: Validation Kit: Recording audio data (%RU16Hz, %RU32ms) started\n",
+                    (uint16_t)pTst->t.TestTone.Tone.rdFreqHz,
+                    pTst->t.TestTone.Parms.msDuration));
+        }
+    }
+
+    uint32_t cbWritten = 0;
+
+    if (RT_SUCCESS(rc))
+    {
+        uint32_t cbToRead = RT_MIN(cbBuf,
+                                   pTst->t.TestTone.u.Play.cbToRead- pTst->t.TestTone.u.Play.cbRead);
+
+        rc = AudioTestSetObjWrite(pTst->pObj, pvBuf, cbToRead);
+        if (RT_SUCCESS(rc))
+        {
+            pTst->t.TestTone.u.Play.cbRead += cbToRead;
+
+            Assert(pTst->t.TestTone.u.Play.cbRead <= pTst->t.TestTone.u.Play.cbToRead);
+
+            const bool fComplete = pTst->t.TestTone.u.Play.cbToRead == pTst->t.TestTone.u.Play.cbRead;
+
+            if (fComplete)
+            {
+                LogRel(("Audio: Validation Kit: Recording audio data done (took %RU32ms)\n",
+                        RTTimeMilliTS() - pTst->msStartedTS));
+
+                rc = RTCritSectEnter(&pThis->CritSect);
+                if (RT_SUCCESS(rc))
+                {
+                    drvHostValKiUnregisterPlayTest(pThis, pTst);
+
+                    int rc2 = RTCritSectLeave(&pThis->CritSect);
+                    AssertRC(rc2);
+                }
+            }
+        }
+    }
+
+    if (RT_FAILURE(rc))
+    {
+        if (pTst->pEntry)
+            AudioTestSetTestFailed(pTst->pEntry, rc, "Recording audio data failed");
+        LogRel(("Audio: Validation Kit: Recording audio data failed with %Rrc\n", rc));
+    }
+
+    *pcbWritten = cbWritten;
+
+    return VINF_SUCCESS; /** @todo Return rc here? */
 }
 
@@ -347 +521 @@
     if (RT_SUCCESS(rc))
     {
-        pThis->pTestRecCur = RTListGetFirst(&pThis->lstTestsRec, VALKITTESTDATA, Node);
+        pThis->pTestCur = RTListGetFirst(&pThis->lstTestsRec, VALKITTESTDATA, Node);
 
         int rc2 = RTCritSectLeave(&pThis->CritSect);
@@ -353 +527 @@
     }
 
-    if (pThis->pTestRecCur == NULL) /* Empty list? */
-    {
+    if (pThis->pTestCur == NULL) /* Empty list? */
+    {
+        LogRelMax(64, ("Audio: Validation Kit: Warning: Guest is recording audio data when no recording test is active\n"));
+#ifdef DEBUG_andy
+        AssertFailed();
+#endif
         *pcbRead = 0;
         return VINF_SUCCESS;
     }
 
-    PVALKITTESTDATA pTst = pThis->pTestRecCur;
-
-    if (pTst->t.TestTone.cbWritten == 0)
-    {
-        pTst->msStartedTS = RTTimeMilliTS();
-
-        LogRel(("Audio: Validation Kit: Injecting input tone (%RU16Hz, %RU32ms)\n",
-                (uint16_t)pTst->t.TestTone.Tone.rdFreqHz,
-                pTst->t.TestTone.Parms.msDuration));
-    }
-
-    uint32_t cbToWrite = pTst->t.TestTone.cbToWrite - pTst->t.TestTone.cbWritten;
-    uint32_t cbRead    = 0;
-    if (cbToWrite)
-        rc = AudioTestToneGenerate(&pTst->t.TestTone.Tone, pvBuf, RT_MIN(cbToWrite, cbBuf), &cbRead);
-
-    pTst->t.TestTone.cbWritten += cbRead;
-    Assert(pTst->t.TestTone.cbWritten <= pTst->t.TestTone.cbToWrite);
-
-    const bool fComplete = pTst->t.TestTone.cbToWrite == pTst->t.TestTone.cbWritten;
-
-    if (fComplete)
-    {
-        LogRel(("Audio: Validation Kit: Injection done (took %RU32ms)\n",
-                RTTimeMilliTS() - pTst->msStartedTS));
-
-        rc = RTCritSectEnter(&pThis->CritSect);
+    PVALKITTESTDATA pTst = pThis->pTestCur;
+
+    if (pTst->t.TestTone.u.Rec.cbWritten == 0)
+    {
+        AUDIOTESTPARMS Parms;
+        RT_ZERO(Parms);
+        Parms.TestTone = pTst->t.TestTone.Parms;
+
+        Assert(pTst->pEntry == NULL);
+        rc = AudioTestSetTestBegin(&pThis->Set, "Injecting audio input data to guest",
+                                    &Parms, &pTst->pEntry);
+        if (RT_SUCCESS(rc))
+            rc = AudioTestSetObjCreateAndRegister(&pThis->Set, "host-input.pcm", &pTst->pObj);
+
         if (RT_SUCCESS(rc))
         {
-            RTListNodeRemove(&pTst->Node);
-
-            RTMemFree(pTst);
-            pTst = NULL;
-
-            Assert(pThis->cTestsRec);
-            pThis->cTestsRec--;
-
-            int rc2 = RTCritSectLeave(&pThis->CritSect);
-            AssertRC(rc2);
+            pTst->msStartedTS = RTTimeMilliTS();
+            LogRel(("Audio: Validation Kit: Injecting audio input data (%RU16Hz, %RU32ms) started\n",
+                    (uint16_t)pTst->t.TestTone.Tone.rdFreqHz,
+                    pTst->t.TestTone.Parms.msDuration));
         }
     }
 
+    uint32_t cbRead = 0;
+
+    if (RT_SUCCESS(rc))
+    {
+        uint32_t cbToWrite = pTst->t.TestTone.u.Rec.cbToWrite - pTst->t.TestTone.u.Rec.cbWritten;
+        if (cbToWrite)
+            rc = AudioTestToneGenerate(&pTst->t.TestTone.Tone, pvBuf, RT_MIN(cbToWrite, cbBuf), &cbRead);
+        if (   RT_SUCCESS(rc)
+            && cbToWrite)
+        {
+            rc = AudioTestSetObjWrite(pTst->pObj, pvBuf, cbToWrite);
+            if (RT_SUCCESS(rc))
+            {
+                pTst->t.TestTone.u.Rec.cbWritten += cbRead;
+                Assert(pTst->t.TestTone.u.Rec.cbWritten <= pTst->t.TestTone.u.Rec.cbToWrite);
+
+                const bool fComplete = pTst->t.TestTone.u.Rec.cbToWrite == pTst->t.TestTone.u.Rec.cbWritten;
+
+                if (fComplete)
+                {
+                    LogRel(("Audio: Validation Kit: Injecting audio input data done (took %RU32ms)\n",
+                            RTTimeMilliTS() - pTst->msStartedTS));
+
+                    rc = RTCritSectEnter(&pThis->CritSect);
+                    if (RT_SUCCESS(rc))
+                    {
+                        drvHostValKiUnregisterRecTest(pThis, pTst);
+
+                        int rc2 = RTCritSectLeave(&pThis->CritSect);
+                        AssertRC(rc2);
+                    }
+                }
+            }
+        }
+    }
+
+    if (RT_FAILURE(rc))
+    {
+        if (pTst->pEntry)
+            AudioTestSetTestFailed(pTst->pEntry, rc, "Injecting audio input data failed");
+        LogRel(("Audio: Validation Kit: Injecting audio input data failed with %Rrc\n", rc));
+    }
+
     *pcbRead = cbRead;
 
-    return VINF_SUCCESS;
+    return VINF_SUCCESS; /** @todo Return rc here? */
 }
 
@@ -458 +660 @@
 
     RTListInit(&pThis->lstTestsRec);
-    pThis->cTestsRec = 0;
+    pThis->cTestsRec  = 0;
+    RTListInit(&pThis->lstTestsPlay);
+    pThis->cTestsPlay = 0;
 
     ATSCALLBACKS Callbacks;
-    Callbacks.pfnTonePlay = drvHostValKitAudioSvcTonePlayCallback;
-    Callbacks.pvUser      = pThis;
+    Callbacks.pfnTonePlay   = drvHostValKitRegisterGuestRecTest;
+    Callbacks.pfnToneRecord = drvHostValKitRegisterGuestPlayTest;
+    Callbacks.pvUser        = pThis;
 
     LogRel(("Audio: Validation Kit: Starting Audio Test Service (ATS) ...\n"));
@@ -498 +703 @@
         LogRel(("Audio: Validation Kit: Shutdown of Audio Test Service complete\n"));
 
-        PVALKITTESTDATA pData, pDataNext;
-        RTListForEachSafe(&pThis->lstTestsRec, pData, pDataNext, VALKITTESTDATA, Node)
-        {
-            RTListNodeRemove(&pData->Node);
-
-            RTMemFree(pData);
-
-            Assert(pThis->cTestsRec);
-            pThis->cTestsRec--;
-        }
+        if (pThis->cTestsRec)
+            LogRel(("Audio: Validation Kit: Warning: %RU32 guest recording tests still outstanding\n", pThis->cTestsRec));
+        if (pThis->cTestsPlay)
+            LogRel(("Audio: Validation Kit: Warning: %RU32 guest playback tests still outstanding\n", pThis->cTestsPlay));
+
+        PVALKITTESTDATA pTst, pTstNext;
+        RTListForEachSafe(&pThis->lstTestsRec, pTst, pTstNext, VALKITTESTDATA, Node)
+            drvHostValKiUnregisterRecTest(pThis, pTst);
+
+        RTListForEachSafe(&pThis->lstTestsPlay, pTst, pTstNext, VALKITTESTDATA, Node)
+            drvHostValKiUnregisterPlayTest(pThis, pTst);
 
         Assert(pThis->cTestsRec == 0);
+        Assert(pThis->cTestsPlay == 0);
     }
     else