Changeset 92234 in vbox for trunk/src

Timestamp:

Nov 5, 2021 8:44:14 AM (3 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

148068

Message:

Audio/Validation Kit: More code for audio data beacon handling. Now has dedicated beacons for recording / playback tests. bugref:10008

Location:

trunk/src/VBox

Files:

• Devices/Audio/AudioTest.cpp (modified) (7 diffs)
• Devices/Audio/AudioTest.h (modified) (1 diff)
• Devices/Audio/DrvHostAudioValidationKit.cpp (modified) (6 diffs)
• ValidationKit/utils/audio/vkatCommon.cpp (modified) (4 diffs)

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

@@ -2458 +2458 @@
  * Adds audio data to a given beacon.
  *
- * @returns Bytes added to the beacon, or 0 if invalid / nothing was added.
+ * @returns VBox status code, VERR_NOT_FOUND if not beacon data was not found.
  * @param   pBeacon             Beacon to add data for.
  * @param   pauBuf              Buffer of audio data to add.
  * @param   cbBuf               Size (in bytes) of \a pauBuf.
+ * @param   pOff                Where to return the offset within \a pauBuf where beacon ended on success.
+ *                              Optional and can be NULL.
  *
  * @note    The audio data must be a) match the beacon type and b) consecutive, that is, without any gaps,
  *          to be added as valid to the beacon.
  */
-uint32_t AudioTestBeaconAddConsecutive(PAUDIOTESTTONEBEACON pBeacon, const uint8_t *pauBuf, size_t cbBuf)
-{
+int AudioTestBeaconAddConsecutive(PAUDIOTESTTONEBEACON pBeacon, const uint8_t *pauBuf, size_t cbBuf, size_t *pOff)
+{
+    AssertPtrReturn(pBeacon, VERR_INVALID_POINTER);
+    AssertPtrReturn(pauBuf,  VERR_INVALID_POINTER);
+    /* pOff is optional. */
+
+    size_t         offBeacon   = UINT64_MAX;
     uint32_t const cbFrameSize = PDMAudioPropsFrameSize(&pBeacon->Props); /* Use the audio frame size as chunk size. */
-
-    if (cbBuf < cbFrameSize) /* Fend-off data which isn't at least one full frame. */
-        return 0;
-
-    AssertMsgReturn(cbBuf % cbFrameSize == 0,
-                    ("Buffer size must be frame-aligned"), 0);
 
     uint8_t  const byBeacon      = AudioTestBeaconByteFromType(pBeacon->enmType);
     unsigned const cbStep        = cbFrameSize;
-    uint32_t const cbUsedInitial = pBeacon->cbUsed;
+
+    /* Make sure that we do frame-aligned reads. */
+    cbBuf = PDMAudioPropsFloorBytesToFrame(&pBeacon->Props, cbBuf);
 
     for (size_t i = 0; i < cbBuf; i += cbStep)
@@ -2487 +2490 @@
             && pauBuf[i + 3] == byBeacon)
         {
-            pBeacon->cbUsed += cbStep;
-
-            if (pBeacon->cbUsed > pBeacon->cbSize)
-                pBeacon->cbUsed -= pBeacon->cbSize;
+            /* Make sure to handle overflows and let beacon start from scratch. */
+            pBeacon->cbUsed = (pBeacon->cbUsed + cbStep) % pBeacon->cbSize;
+            if (pBeacon->cbUsed == 0) /* Beacon complete (see module line above)? */
+            {
+                pBeacon->cbUsed = pBeacon->cbSize;
+                offBeacon       = i + cbStep; /* Point to data right *after* the beacon. */
+            }
         }
         else
         {
             /* If beacon is not complete yet, we detected a gap here. Start all over then. */
-            if (pBeacon->cbUsed < pBeacon->cbSize)
+            if (RT_LIKELY(pBeacon->cbUsed != pBeacon->cbSize))
                 pBeacon->cbUsed = 0;
         }
     }
 
-    if (!pBeacon->cbUsed)
-        return 0;
-
-    AssertMsg(pBeacon->cbUsed >= cbUsedInitial, ("cbUsed (%RU32) < cbUsedInitial (%RU32)\n", pBeacon->cbUsed, cbUsedInitial));
-    return pBeacon->cbUsed - cbUsedInitial;
+    if (offBeacon != UINT32_MAX)
+    {
+        if (pOff)
+            *pOff = offBeacon;
+    }
+
+    return offBeacon == UINT64_MAX ? VERR_NOT_FOUND : VINF_SUCCESS;
 }
 
@@ -2531 +2539 @@
  * @param   pToneParms          Tone parameters to use for verification.
  * @param   puOff               Where to return the absolute file offset (in bytes) right after the found beacon on success.
+ *                              Optional and can be NULL.
  */
 static int audioTestToneVerifyBeacon(PAUDIOTESTVERIFYJOB pVerJob,
@@ -2545 +2554 @@
                         : (fPre ? AUDIOTESTTONEBEACONTYPE_REC_PRE  : AUDIOTESTTONEBEACONTYPE_REC_POST), &pToneParms->Props);
 
-    LogRel2(("Verifying %s beacon @ %RU64\n", AudioTestBeaconTypeGetName(Beacon.enmType), pCmp->offStart));
-
-    uint8_t        auBuf[64];
+    uint8_t        auBuf[_64K];
     uint64_t       cbToCompare   = pCmp->cbSize;
     uint32_t const cbFrameSize   = PDMAudioPropsFrameSize(&Beacon.Props);
-    uint64_t       offBeaconLast = 0;
-
-    /* Slow as heck, but does the job for now. */
+    uint64_t       offBeaconLast = UINT64_MAX;
+
+    Assert(sizeof(auBuf) % cbFrameSize == 0);
+
     while (cbToCompare)
     {
         size_t cbRead;
-        rc = RTFileRead(pCmp->hFile, auBuf, RT_MIN(cbToCompare, cbFrameSize), &cbRead);
+        rc = RTFileRead(pCmp->hFile, auBuf, RT_MIN(cbToCompare, sizeof(auBuf)), &cbRead);
         AssertRCBreak(rc);
 
@@ -2562 +2570 @@
             break;
 
-        const uint32_t cbAdded = AudioTestBeaconAddConsecutive(&Beacon, auBuf, cbRead);
-        if (cbAdded)
-            offBeaconLast = RTFileTell(pCmp->hFile);
+        size_t uOff;
+        int rc2 = AudioTestBeaconAddConsecutive(&Beacon, auBuf, cbRead, &uOff);
+        if (RT_SUCCESS(rc2))
+        {
+            /* Save the last found (absolute bytes, in file) position of a (partially) found beacon. */
+            offBeaconLast = RTFileTell(pCmp->hFile) - (cbRead - uOff);
+        }
 
         Assert(cbToCompare >= cbRead);
@@ -2585 +2597 @@
     {
         AssertReturn(AudioTestBeaconGetRemaining(&Beacon) == 0, VERR_INTERNAL_ERROR);
+        AssertReturn(offBeaconLast != UINT32_MAX, VERR_INTERNAL_ERROR);
         AssertReturn(offBeaconLast >= AudioTestBeaconGetSize(&Beacon), VERR_INTERNAL_ERROR);
 
@@ -2981 +2994 @@
     pOpts->fNormalize      = false; /* Skip normalization by default now, as we now use the OS' master volume to play/record tones. */
     pOpts->cMaxDiff        = 0;     /* By default we're very strict and consider any diff as being erroneous. */
-    pOpts->uMaxSizePercent = 1;     /* 1% is okay for us; might be due to any buffering / setup phase. */
-
-    /* We use a search window of 10ms by default for finding (non-)silent parts. */
-    pOpts->msSearchWindow  = 10;
-
+    pOpts->uMaxSizePercent = 10;    /* 10% is okay for us for now; might be due to any buffering / setup phase.
+                                       Anything above this is suspicious and should be reported for further investigation. */
+    pOpts->msSearchWindow  = 10;    /* We use a search window of 10ms by default for finding (non-)silent parts. */
 }
 

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

@@ -378 +378 @@
 
 void   AudioTestBeaconInit(PAUDIOTESTTONEBEACON pBeacon, AUDIOTESTTONEBEACONTYPE enmType, PPDMAUDIOPCMPROPS pProps);
-uint32_t AudioTestBeaconAddConsecutive(PAUDIOTESTTONEBEACON pBeacon, const uint8_t *auBuf, size_t cbBuf);
+int    AudioTestBeaconAddConsecutive(PAUDIOTESTTONEBEACON pBeacon, const uint8_t *auBuf, size_t cbBuf, size_t *pOff);
 int    AudioTestBeaconWrite(PAUDIOTESTTONEBEACON pBeacon, void *pvBuf, uint32_t cbBuf);
 uint32_t AudioTestBeaconGetSize(PCAUDIOTESTTONEBEACON pBeacon);

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

@@ -298 +298 @@
                     pTst->idxTest, AudioTestStateToStr(pTst->enmState)));
 
-        size_t const cbOutstanding = pTst->t.TestTone.u.Rec.cbToWrite - pTst->t.TestTone.u.Rec.cbWritten;
-        if (cbOutstanding)
-            LogRel(("ValKit: \tWarning: Recording test #%RU32 has %RU64 bytes (%RU32ms) outstanding (%RU8%% left)\n",
-                    pTst->idxTest, cbOutstanding, PDMAudioPropsBytesToMilli(&pTst->t.TestTone.Parms.Props, (uint32_t)cbOutstanding),
-                    100 - (pTst->t.TestTone.u.Rec.cbWritten * 100) / RT_MAX(pTst->t.TestTone.u.Rec.cbToWrite, 1)));
+        if (pTst->t.TestTone.u.Rec.cbToWrite > pTst->t.TestTone.u.Rec.cbWritten)
+        {
+            size_t const cbOutstanding = pTst->t.TestTone.u.Rec.cbToWrite - pTst->t.TestTone.u.Rec.cbWritten;
+            if (cbOutstanding)
+                LogRel(("ValKit: \tWarning: Recording test #%RU32 has %RU64 bytes (%RU32ms) outstanding (%RU8%% left)\n",
+                        pTst->idxTest, cbOutstanding, PDMAudioPropsBytesToMilli(&pTst->t.TestTone.Parms.Props, (uint32_t)cbOutstanding),
+                        100 - (pTst->t.TestTone.u.Rec.cbWritten * 100) / RT_MAX(pTst->t.TestTone.u.Rec.cbToWrite, 1)));
+        }
         drvHostValKiUnregisterRecTest(pThis, pTst);
     }
@@ -315 +318 @@
                     pTst->idxTest, AudioTestStateToStr(pTst->enmState)));
 
-        size_t const cbOutstanding = pTst->t.TestTone.u.Play.cbToRead - pTst->t.TestTone.u.Play.cbRead;
-        if (cbOutstanding)
-            LogRel(("ValKit: \tWarning: Playback test #%RU32 has %RU64 bytes (%RU32ms) outstanding (%RU8%% left)\n",
-                    pTst->idxTest, cbOutstanding, PDMAudioPropsBytesToMilli(&pTst->t.TestTone.Parms.Props, (uint32_t)cbOutstanding),
-                    100 - (pTst->t.TestTone.u.Play.cbRead * 100) / RT_MAX(pTst->t.TestTone.u.Play.cbToRead, 1)));
+        if (pTst->t.TestTone.u.Play.cbToRead > pTst->t.TestTone.u.Play.cbRead)
+        {
+            size_t const cbOutstanding = pTst->t.TestTone.u.Play.cbToRead - pTst->t.TestTone.u.Play.cbRead;
+            if (cbOutstanding)
+                LogRel(("ValKit: \tWarning: Playback test #%RU32 has %RU64 bytes (%RU32ms) outstanding (%RU8%% left)\n",
+                        pTst->idxTest, cbOutstanding, PDMAudioPropsBytesToMilli(&pTst->t.TestTone.Parms.Props, (uint32_t)cbOutstanding),
+                        100 - (pTst->t.TestTone.u.Play.cbRead * 100) / RT_MAX(pTst->t.TestTone.u.Play.cbToRead, 1)));
+        }
         drvHostValKiUnregisterPlayTest(pThis, pTst);
     }
@@ -1030 +1036 @@
     if (RT_SUCCESS(rc))
     {
-        /* Always write (record) everything, no matter if the current audio contains complete silence or not.
-         * Might be also become handy later if we want to have a look at start/stop timings and so on. */
-        rc = AudioTestObjWrite(pTst->Obj, pvBuf, cbBuf);
-
         switch (pTst->enmState)
         {
@@ -1046 +1048 @@
                     bool const fStarted = AudioTestBeaconGetRemaining(pBeacon) == AudioTestBeaconGetSize(pBeacon);
 
-                    /* Limit adding data to the beacon size. */
-                    uint32_t const cbToAddMax = RT_MIN(cbBuf, AudioTestBeaconGetRemaining(pBeacon));
-
-                    AudioTestBeaconAddConsecutive(pBeacon, (uint8_t *)pvBuf, cbToAddMax);
-                    /** @todo Take left-over data into account (and stash them away for the test tone)? */
+                    size_t uOff; /* Points at the data right *after the found beacon data. */
+                    rc2 = AudioTestBeaconAddConsecutive(pBeacon, (uint8_t *)pvBuf, cbBuf, &uOff);
+                    if (RT_SUCCESS(rc2))
+                    {
+                        /*
+                         * When being in the AUDIOTESTSTATE_PRE state, we might get more audio data
+                         * than we need for the pre-beacon to complete. In other words, that "more data"
+                         * needs to be counted to the actual recorded test tone data then.
+                         */
+                        if (pTst->enmState == AUDIOTESTSTATE_PRE)
+                            pTst->t.TestTone.u.Play.cbRead += cbBuf - (uint32_t)uOff; /* Add data after pre-beacon */
+                    }
 
                     if (fStarted)
@@ -1077 +1086 @@
                  * Currently we don't, as otherwise consequtively played tones will be cut off in the end. */
                 if (!fIsAllSilence)
+                {
+                    uint32_t const cbToAddMax = pTst->t.TestTone.u.Play.cbToRead - pTst->t.TestTone.u.Play.cbRead;
+
+                    /* Don't read more than we're told to.
+                     * After the actual test tone data there might come a post beacon which also
+                     * needs to be handled in the AUDIOTESTSTATE_POST state then. */
+                    if (cbBuf > cbToAddMax)
+                        cbBuf = cbToAddMax;
+
                     pTst->t.TestTone.u.Play.cbRead += cbBuf;
+                }
 
                 const bool fComplete = pTst->t.TestTone.u.Play.cbRead >= pTst->t.TestTone.u.Play.cbToRead;
@@ -1106 +1125 @@
                 break;
         }
+
+        /* Always write (record) everything, no matter if the current audio contains complete silence or not.
+         * Might be also become handy later if we want to have a look at start/stop timings and so on. */
+        rc = AudioTestObjWrite(pTst->Obj, pvBuf, cbBuf);
+        AssertRC(rc);
 
         /* Always report everything as being played. */

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

@@ -803 +803 @@
                     cbRecTotal += cbRecorded; /* Do a bit of accounting. */
 
-                    /* Always write (record) everything, no matter if the current audio contains complete silence or not.
-                     * Might be also become handy later if we want to have a look at start/stop timings and so on. */
-                    rc = AudioTestObjWrite(Obj, abSamples, cbRecorded);
-                    AssertRCBreak(rc);
-
                     switch (enmState)
                     {
@@ -819 +814 @@
                                 bool const fStarted = AudioTestBeaconGetRemaining(&Beacon) == AudioTestBeaconGetSize(&Beacon);
 
-                                /* Limit adding data to the beacon size. */
-                                uint32_t const cbToAddMax = RT_MIN(cbRecorded, AudioTestBeaconGetRemaining(&Beacon));
-
-                                AudioTestBeaconAddConsecutive(&Beacon, abSamples, cbToAddMax);
-                                /** @todo Take left-over data into account (and stash them away for the test tone)? */
+                                size_t uOff;
+                                rc = AudioTestBeaconAddConsecutive(&Beacon, abSamples, cbRecorded, &uOff);
+                                if (RT_SUCCESS(rc))
+                                {
+                                    /*
+                                     * When being in the AUDIOTESTSTATE_PRE state, we might get more audio data
+                                     * than we need for the pre-beacon to complete. In other words, that "more data"
+                                     * needs to be counted to the actual recorded test tone data then.
+                                     */
+                                    if (enmState == AUDIOTESTSTATE_PRE)
+                                        cbTestRec += cbRecorded - (uint32_t)uOff;
+                                }
 
                                 if (   fStarted
@@ -852 +854 @@
                              * Currently we don't, as otherwise consequtively played tones will be cut off in the end. */
                             if (!fIsAllSilence)
+                            {
+                                uint32_t const cbToAddMax = cbTestToRec - cbTestRec;
+
+                                /* Don't read more than we're told to.
+                                 * After the actual test tone data there might come a post beacon which also
+                                 * needs to be handled in the AUDIOTESTSTATE_POST state then. */
+                                if (cbRecorded > cbToAddMax)
+                                    cbRecorded = cbToAddMax;
+
                                 cbTestRec += cbRecorded;
+                            }
 
                             if (cbTestToRec - cbTestRec == 0) /* Done recording the test tone? */
@@ -874 +886 @@
                 }
 
-                if (enmState == AUDIOTESTSTATE_DONE)
+                if (cbRecorded)
+                {
+                    /* Always write (record) everything, no matter if the current audio contains complete silence or not.
+                     * Might be also become handy later if we want to have a look at start/stop timings and so on. */
+                    rc = AudioTestObjWrite(Obj, abSamples, cbRecorded);
+                    AssertRCBreak(rc);
+                }
+
+                if (enmState == AUDIOTESTSTATE_DONE) /* Bail out when in state "done". */
                     break;
             }