Changeset 89383 in vbox for trunk/src

Timestamp:

May 31, 2021 7:26:13 AM (4 years ago)

Author:

vboxsync

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

144734

Message:

Audio/ValKit: More validation / test set handling code. bugref:10008

Location:

trunk/src/VBox

Files:

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

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

@@ -27 +27 @@
 #include <iprt/buildconfig.h>
 #include <iprt/dir.h>
+#include <iprt/env.h>
 #include <iprt/file.h>
 #include <iprt/formats/riff.h>
@@ -606 +607 @@
     AssertReturn(pszTag && strlen(pszTag) <= AUDIOTEST_TAG_MAX, VERR_INVALID_PARAMETER);
 
-    char szPath[RTPATH_MAX];
-
-    int rc = RTPathTemp(szPath, sizeof(szPath));
-    AssertRCReturn(rc, rc);
-    rc = AudioTestPathCreate(szPath, sizeof(szPath), pszTag);
-    AssertRCReturn(rc, rc);
-
-    return RTStrCopy(pszPath, cbPath, szPath);
+    char szTemp[RTPATH_MAX];
+    int rc = RTEnvGetEx(RTENV_DEFAULT, "TESTBOX_PATH_SCRATCH", szTemp, sizeof(szTemp), NULL);
+    if (RT_FAILURE(rc))
+    {
+        rc = RTPathTemp(szTemp, sizeof(szTemp));
+        AssertRCReturn(rc, rc);
+    }
+
+    rc = AudioTestPathCreate(szTemp, sizeof(szTemp), pszTag);
+    AssertRCReturn(rc, rc);
+
+    return RTStrCopy(pszPath, cbPath, szTemp);
 }
 
@@ -1224 +1229 @@
 }
 
+static int audioTestVerifyIniValue(PAUDIOTESTSET pSetA, PAUDIOTESTSET pSetB,
+                                   const char *pszSec, const char *pszKey, const char *pszVal)
+{
+    char szValA[_1K];
+    int rc = RTIniFileQueryValue(pSetA->f.hIniFile, pszSec, pszKey, szValA, sizeof(szValA), NULL);
+    if (RT_FAILURE(rc))
+        return rc;
+    char szValB[_1K];
+    rc = RTIniFileQueryValue(pSetB->f.hIniFile, pszSec, pszKey, szValB, sizeof(szValB), NULL);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    if (RTStrCmp(szValA, szValB))
+        return VERR_WRONG_TYPE; /** @todo Fudge! */
+
+    if (pszVal)
+    {
+        if (RTStrCmp(szValA, pszVal))
+            return VERR_WRONG_TYPE; /** @todo Fudge! */
+    }
+
+    return rc;
+}
+
 /**
  * Verifies an opened audio test set.
  *
  * @returns VBox status code.
- * @param   pSet                Test set to verify.
- * @param   pszTag              Tag to use for verification purpose.
+ * @param   pSetA               Test set A to verify.
+ * @param   pSetB               Test set to verify test set A with.
  * @param   pErrDesc            Where to return the test verification errors.
  *
@@ -1235 +1264 @@
  *          actual return code.
  */
-int AudioTestSetVerify(PAUDIOTESTSET pSet, const char *pszTag, PAUDIOTESTERRORDESC pErrDesc)
-{
-    AssertReturn(audioTestManifestIsOpen(pSet), VERR_WRONG_ORDER);
+int AudioTestSetVerify(PAUDIOTESTSET pSetA, PAUDIOTESTSET pSetB, PAUDIOTESTERRORDESC pErrDesc)
+{
+    AssertReturn(audioTestManifestIsOpen(pSetA), VERR_WRONG_ORDER);
+    AssertReturn(audioTestManifestIsOpen(pSetB), VERR_WRONG_ORDER);
 
     /* We ASSUME the caller has not init'd pErrDesc. */
     audioTestErrorDescInit(pErrDesc);
 
-    char szVal[_1K]; /** @todo Enough, too much? */
-
-    int rc2 = RTIniFileQueryValue(pSet->f.hIniFile, AUDIOTEST_INI_SEC_HDR_STR, "tag", szVal, sizeof(szVal), NULL);
-    if (   RT_FAILURE(rc2)
-        || RTStrICmp(pszTag, szVal))
-        audioTestErrorDescAdd(pErrDesc, "Tag '%s' does not match with manifest's tag '%s'", pszTag, szVal);
+    int rc;
+
+#define VERIFY_VALUE(a_Sec, a_Key, a_Val, ...) \
+    rc = audioTestVerifyIniValue(pSetA, pSetB, a_Sec, a_Key, a_Val); \
+    if (RT_FAILURE(rc)) \
+        return audioTestErrorDescAdd(pErrDesc, (__VA_ARGS__));
+
+    /*
+     * Compare obvious values first.
+     */
+    VERIFY_VALUE("header",   "magic",        "vkat_ini",    "Manifest magic wrong");
+    VERIFY_VALUE("header",   "ver",          "1"       ,    "Manifest version wrong");
+    VERIFY_VALUE("header",   "tag",          NULL,          "Manifest tags don't match");
+    VERIFY_VALUE("header",   "test_count",   NULL,          "Test counts don't match");
+    VERIFY_VALUE("header",   "obj_count",    NULL,          "Object counts don't match");
+
+#undef VERIFY_VALUE
 
     /* Only return critical stuff not related to actual testing here. */

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

@@ -337 +337 @@
 int    AudioTestSetPack(PAUDIOTESTSET pSet, const char *pszOutDir, char *pszFileName, size_t cbFileName);
 int    AudioTestSetUnpack(const char *pszFile, const char *pszOutDir);
-int    AudioTestSetVerify(PAUDIOTESTSET pSet, const char *pszTag, PAUDIOTESTERRORDESC pErrDesc);
+int    AudioTestSetVerify(PAUDIOTESTSET pSetA, PAUDIOTESTSET pSetB, PAUDIOTESTERRORDESC pErrDesc);
 
 bool   AudioTestErrorDescFailed(PAUDIOTESTERRORDESC pErr);

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

@@ -49 +49 @@
     /** The stream's acquired configuration. */
     PDMAUDIOSTREAMCFG       Cfg;
-    /** Audio file to dump output to or read input from. */
-    PAUDIOHLPFILE           pFile;
-    /** Text file to store timing of audio buffers submittions. */
-    PRTSTREAM               pFileTiming;
-    /** Timestamp of the first play or record request. */
-    uint64_t                tsStarted;
-    /** Total number of frames played or recorded so far. */
-    uint32_t                cFramesSinceStarted;
-    union
-    {
-        struct
-        {
-            /** Timestamp of last captured samples. */
-            uint64_t        tsLastCaptured;
-        } In;
-        struct
-        {
-            /** Timestamp of last played samples. */
-            uint64_t        tsLastPlayed;
-            uint8_t        *pbPlayBuffer;
-            uint32_t        cbPlayBuffer;
-        } Out;
-    };
 } VALKITAUDIOSTREAM;
 /** Pointer to a Validation Kit stream. */
@@ -212 +189 @@
                                              PPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
 {
-    RT_NOREF(pThis, pCfgAcq);
-
-    /* Use the test box scratch dir if we're running in such an
-       environment, otherwise just dump the output in the temp
-       directory. */
-    char szTemp[RTPATH_MAX];
-    int rc = RTEnvGetEx(RTENV_DEFAULT, "TESTBOX_PATH_SCRATCH", szTemp, sizeof(szTemp), NULL);
-    if (RT_FAILURE(rc))
-    {
-        rc = RTPathTemp(szTemp, sizeof(szTemp));
-        if (RT_SUCCESS(rc))
-            rc = RTPathAppend(szTemp, sizeof(szTemp), "VBoxAudioValKit");
-        AssertRCReturn(rc, rc);
-    }
-
-    /* Get down to things that may fail and need cleanup. */
-    pStreamDbg->tsStarted           = 0;
-    pStreamDbg->cFramesSinceStarted = 0;
-    pStreamDbg->Out.tsLastPlayed    = 0;
-    pStreamDbg->Out.cbPlayBuffer    = PDMAudioPropsFramesToBytes(&pCfgReq->Props, pCfgReq->Backend.cFramesBufferSize);
-    pStreamDbg->Out.pbPlayBuffer    = (uint8_t *)RTMemAlloc(pStreamDbg->Out.cbPlayBuffer);
-    AssertReturn(pStreamDbg->Out.pbPlayBuffer, VERR_NO_MEMORY);
-
-    rc = AudioHlpFileCreateAndOpenEx(&pStreamDbg->pFile, AUDIOHLPFILETYPE_WAV, szTemp, "ValKit",
-                                     pThis->pDrvIns->iInstance, AUDIOHLPFILENAME_FLAGS_NONE, AUDIOHLPFILE_FLAGS_NONE,
-                                     &pCfgReq->Props, AUDIOHLPFILE_DEFAULT_OPEN_FLAGS);
-    if (RT_SUCCESS(rc))
-    {
-        rc = RTPathAppend(szTemp, sizeof(szTemp), "ValKitTimings.txt");
-        if (RT_SUCCESS(rc))
-        {
-            rc = RTStrmOpen(szTemp, "w", &pStreamDbg->pFileTiming);
-            if (RT_SUCCESS(rc))
-            {
-                RTStrmPrintf(pStreamDbg->pFileTiming, "# %uHz %uch %ubit\n",
-                             PDMAudioPropsHz(&pCfgReq->Props),
-                             PDMAudioPropsChannels(&pCfgReq->Props),
-                             PDMAudioPropsSampleBits(&pCfgReq->Props));
-                return VINF_SUCCESS;
-            }
-
-            LogRel(("ValKitAudio: Opening output file '%s' failed: %Rrc\n", szTemp, rc));
-        }
-        else
-            LogRel(("ValKitAudio: Constructing timing file path: %Rrc\n", rc));
-
-        AudioHlpFileDestroy(pStreamDbg->pFile);
-        pStreamDbg->pFile = NULL;
-    }
-    else
-        LogRel(("ValKitAudio: Creating output file 'ValKit' in '%s' failed: %Rrc\n", szTemp, rc));
-
-    RTMemFree(pStreamDbg->Out.pbPlayBuffer);
-    pStreamDbg->Out.pbPlayBuffer = NULL;
-    return rc;
+    RT_NOREF(pThis, pStreamDbg, pCfgReq, pCfgAcq);
+
+    return VINF_SUCCESS;
 }
 
@@ -276 +201 @@
                                                            PPDMAUDIOSTREAMCFG pCfgReq, PPDMAUDIOSTREAMCFG pCfgAcq)
 {
-    PDRVHOSTVALKITAUDIO pThis       = RT_FROM_MEMBER(pInterface, DRVHOSTVALKITAUDIO, IHostAudio);
+    PDRVHOSTVALKITAUDIO pThis      = RT_FROM_MEMBER(pInterface, DRVHOSTVALKITAUDIO, IHostAudio);
     PVALKITAUDIOSTREAM  pStreamDbg = (PVALKITAUDIOSTREAM)pStream;
     AssertPtrReturn(pStreamDbg, VERR_INVALID_POINTER);
@@ -302 +227 @@
     AssertPtrReturn(pStreamDbg, VERR_INVALID_POINTER);
 
-    if (   pStreamDbg->Cfg.enmDir == PDMAUDIODIR_OUT
-        && pStreamDbg->Out.pbPlayBuffer)
-    {
-        RTMemFree(pStreamDbg->Out.pbPlayBuffer);
-        pStreamDbg->Out.pbPlayBuffer = NULL;
-    }
-
-    if (pStreamDbg->pFile)
-    {
-        size_t cbDataSize = AudioHlpFileGetDataSize(pStreamDbg->pFile);
-        if (cbDataSize)
-            LogRel(("ValKitAudio: Created output file '%s' (%zu bytes)\n", pStreamDbg->pFile->szName, cbDataSize));
-
-        AudioHlpFileDestroy(pStreamDbg->pFile);
-        pStreamDbg->pFile = NULL;
-    }
-
-    if (pStreamDbg->pFileTiming)
-    {
-        RTStrmClose(pStreamDbg->pFileTiming);
-        pStreamDbg->pFileTiming = NULL;
-    }
-
     return VINF_SUCCESS;
 }
@@ -348 +250 @@
     PVALKITAUDIOSTREAM pStreamDbg = (PVALKITAUDIOSTREAM)pStream;
     AssertPtrReturn(pStreamDbg, VERR_INVALID_POINTER);
-
-    if (pStreamDbg->pFileTiming)
-        RTStrmFlush(pStreamDbg->pFileTiming);
 
     return VINF_SUCCESS;
@@ -429 +328 @@
     PDRVHOSTVALKITAUDIO pThis      = RT_FROM_MEMBER(pInterface, DRVHOSTVALKITAUDIO, IHostAudio);
     PVALKITAUDIOSTREAM  pStreamDbg = (PVALKITAUDIOSTREAM)pStream;
-    RT_NOREF(pThis);
-
-    uint64_t cNsSinceStart;
-    if (pStreamDbg->tsStarted != 0)
-        cNsSinceStart = RTTimeNanoTS() - pStreamDbg->tsStarted;
-    else
-    {
-        pStreamDbg->tsStarted = RTTimeNanoTS();
-        cNsSinceStart = 0;
-    }
-
-    // Microseconds are used everythere below
-    uint32_t const cFrames = PDMAudioPropsBytesToFrames(&pStreamDbg->Cfg.Props, cbBuf);
-    RTStrmPrintf(pStreamDbg->pFileTiming, "%d %d %d %d\n",
-                 // Host time elapsed since Guest submitted the first buffer for playback:
-                 (uint32_t)(cNsSinceStart / 1000),
-                 // how long all the samples submitted previously were played:
-                 (uint32_t)(pStreamDbg->cFramesSinceStarted * 1.0E6 / pStreamDbg->Cfg.Props.uHz),
-                 // how long a new uSamplesReady samples should/will be played:
-                 (uint32_t)(cFrames * 1.0E6 / pStreamDbg->Cfg.Props.uHz),
-                 cFrames);
-
-    pStreamDbg->cFramesSinceStarted += cFrames;
-
-    /* Remember when samples were consumed. */
-    // pStreamDbg->Out.tsLastPlayed = PDMDrvHlpTMGetVirtualTime(pThis->pDrvIns);
-
-    int rc2 = AudioHlpFileWrite(pStreamDbg->pFile, pvBuf, cbBuf, 0 /* fFlags */);
-    if (RT_FAILURE(rc2))
-        LogRel(("ValKitAudio: Writing output failed with %Rrc\n", rc2));
-
-    *pcbWritten = cbBuf;
+    RT_NOREF(pThis, pStreamDbg, pvBuf, cbBuf);
+
+    *pcbWritten = 0;
     return VINF_SUCCESS;
 }

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

@@ -2216 +2216 @@
 *********************************************************************************************************************************/
 
-/**
- * Verifies one single test set.
- *
- * @returns VBox status code.
- * @param   pszPath             Absolute path to test set.
- * @param   pszTag              Tag of test set to verify. Optional and can be NULL.
- */
-static int audioVerifyOne(const char *pszPath, const char *pszTag)
-{
-    RTTestSubF(g_hTest, "Verifying test set ...");
-
-    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Using tag '%s'\n", pszTag ? pszTag : "default");
-    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Opening archive '%s'\n", pszPath);
-
-    int rc = VINF_SUCCESS;
+static int audioVerifyOpenTestSet(const char *pszPathSet, PAUDIOTESTSET pSet)
+{
+    int rc;
 
     char szPathExtracted[RTPATH_MAX];
-    const bool fPacked = AudioTestSetIsPacked(pszPath);
+
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Opening test set '%s'\n", pszPathSet);
+
+    const bool fPacked = AudioTestSetIsPacked(pszPathSet);
     if (fPacked)
     {
+        RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Test set is an archive and needs to be unpacked\n");
+
         char szPathTemp[RTPATH_MAX];
         rc = RTPathTemp(szPathTemp, sizeof(szPathTemp));
@@ -2249 +2242 @@
                 {
                     RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Unpacking archive to '%s'\n", szPathExtracted);
-                    rc = AudioTestSetUnpack(pszPath, szPathExtracted);
+                    rc = AudioTestSetUnpack(pszPathSet, szPathExtracted);
                     if (RT_SUCCESS(rc))
                         RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Archive successfully unpacked\n");
@@ -2256 +2249 @@
         }
     }
+    else
+        rc = VINF_SUCCESS;
+
+    if (RT_SUCCESS(rc))
+        rc = AudioTestSetOpen(pSet, fPacked ? szPathExtracted : pszPathSet);
 
     if (RT_FAILURE(rc))
-    {
         RTTestFailed(g_hTest, "Unable to open / unpack test set archive: %Rrc", rc);
-        return rc;
-    }
-
-    AUDIOTESTSET tstSet;
-    rc = AudioTestSetOpen(&tstSet, fPacked ? szPathExtracted : pszPath);
+
+    return rc;
+}
+
+/**
+ * Verifies one single test set.
+ *
+ * @returns VBox status code.
+ * @param   pszPathSetA         Absolute path to test set A.
+ * @param   pszPathSetB         Absolute path to test set B.
+ */
+static int audioVerifyOne(const char *pszPathSetA, const char *pszPathSetB)
+{
+    RTTestSubF(g_hTest, "Verifying");
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Verifying test set '%s' with test set '%s'\n", pszPathSetA, pszPathSetB);
+
+    AUDIOTESTSET SetA, SetB;
+    int rc = audioVerifyOpenTestSet(pszPathSetA, &SetA);
     if (RT_SUCCESS(rc))
+        rc = audioVerifyOpenTestSet(pszPathSetB, &SetB);
+
+    if (RT_SUCCESS(rc))
     {
         AUDIOTESTERRORDESC errDesc;
-        rc = AudioTestSetVerify(&tstSet, pszTag ? pszTag : "default", &errDesc);
+        rc = AudioTestSetVerify(&SetA, &SetB, &errDesc);
         if (RT_SUCCESS(rc))
         {
@@ -2276 +2289 @@
                 PAUDIOTESTERRORENTRY pErrEntry;
                 RTListForEach(&errDesc.List, pErrEntry, AUDIOTESTERRORENTRY, Node)
-                {
                     RTTestFailed(g_hTest, pErrEntry->szDesc);
-                }
             }
             else
-                RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Verification successful");
+                RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Verification successful\n");
 
             AudioTestErrorDescDestroy(&errDesc);
@@ -2287 +2298 @@
         else
             RTTestFailed(g_hTest, "Verification failed with %Rrc", rc);
-
-        AudioTestSetClose(&tstSet);
-    }
-    else
-        RTTestFailed(g_hTest, "Opening test set '%s' (tag '%s') failed, rc=%Rrc\n", pszPath, pszTag, rc);
+    }
+
+    AudioTestSetClose(&SetA);
+    AudioTestSetClose(&SetB);
 
     RTTestSubDone(g_hTest);
@@ -2309 +2319 @@
      * Parse options and process arguments.
      */
-    const char   *pszTag   = NULL; /* Custom tag to use. Can be NULL if not being used. */
-    unsigned      iTestSet = 0;
+    char     *pszSetA = NULL;
+    char     *pszSetB = NULL;
+    unsigned iTestSet = 0;
 
     int           rc;
@@ -2319 +2330 @@
         {
             case VKAT_VERIFY_OPT_TAG:
-                pszTag = ValueUnion.psz;
-                if (g_uVerbosity > 0)
-                    RTMsgInfo("Using tag '%s'\n", pszTag);
                 break;
 
             case VINF_GETOPT_NOT_OPTION:
+            {
+                char **ppszSet = iTestSet == 0 ? &pszSetA : &pszSetB;
+
                 if (iTestSet == 0)
                     RTTestBanner(g_hTest);
-                audioVerifyOne(ValueUnion.psz, pszTag);
+
+                *ppszSet = RTStrDup(ValueUnion.psz);
+                AssertPtrReturn(*ppszSet, RTEXITCODE_FAILURE);
+
                 iTestSet++;
                 break;
+            }
 
             AUDIO_TEST_COMMON_OPTION_CASES(ValueUnion);
@@ -2338 +2353 @@
     }
 
+    if (!iTestSet)
+        return RTMsgErrorExitFailure("At least one test set must be specified");
+
+    if (iTestSet > 2)
+        return RTMsgErrorExitFailure("Only two test sets can be verified at one time");
+
     /*
-     * If no paths given, default to the current directory.
+     * If only test set A is given, default to the current directory
+     * for test set B.
      */
-    if (iTestSet == 0)
-    {
-        if (iTestSet == 0)
-            RTTestBanner(g_hTest);
+    if (iTestSet == 1)
+    {
         char szDirCur[RTPATH_MAX];
-        int rc2 = RTPathGetCurrent(szDirCur, sizeof(szDirCur));
-        if (RT_FAILURE(rc2))
-            RTTestFailed(g_hTest, "Failed to retrieve current directory: %Rrc", rc2);
-        rc = audioVerifyOne(RT_SUCCESS(rc2) ? szDirCur : ".", pszTag);
-    }
+        rc = RTPathGetCurrent(szDirCur, sizeof(szDirCur));
+        if (RT_SUCCESS(rc))
+        {
+            Assert(pszSetB == NULL);
+            pszSetB = RTStrDup(szDirCur);
+            AssertPtrReturn(pszSetB, RTEXITCODE_FAILURE);
+        }
+        else
+            RTTestFailed(g_hTest, "Failed to retrieve current directory: %Rrc", rc);
+    }
+
+    if (RT_SUCCESS(rc))
+        rc = audioVerifyOne(pszSetA, pszSetB);
+
+    RTStrFree(pszSetA);
+    RTStrFree(pszSetB);
 
     /*