Changeset 89051 in vbox for trunk/src/VBox/Devices/Audio

Timestamp:

May 14, 2021 6:58:11 PM (4 years ago)

Author:

vboxsync

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

144391

Message:

Audio/ValKit: More code for VKAT audio test set generation; initial implementation now can pack up tests sets as .tar.gz files. bugref:10008

Location:

trunk/src/VBox/Devices/Audio

Files:

• AudioTest.cpp (modified) (13 diffs)
• AudioTest.h (modified) (8 diffs)
• DrvHostAudioDebug.cpp (modified) (1 diff)

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

@@ -34 +34 @@
 #include <iprt/uuid.h>
 #include <iprt/vfs.h>
+#include <iprt/zip.h>
 
 #define _USE_MATH_DEFINES
@@ -110 +111 @@
  * @param   pcbWritten          How many bytes were written on success.
  */
-int AudioTestToneWrite(PAUDIOTESTTONE pTone, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
+int AudioTestToneGenerate(PAUDIOTESTTONE pTone, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
 {
     /*
-     * Clear the buffer first so we don't need to thing about additional channels.
+     * Clear the buffer first so we don't need to think about additional channels.
      */
-    uint32_t cFrames = PDMAudioPropsBytesToFrames(&pTone->Props, cbBuf);
+    uint32_t cFrames   = PDMAudioPropsBytesToFrames(&pTone->Props, cbBuf);
+
+    /* Input cbBuf not necessarily is aligned to the frames, so re-calculate it. */
+    const uint32_t cbToWrite = PDMAudioPropsFramesToBytes(&pTone->Props, cFrames);
+
     PDMAudioPropsClearBuffer(&pTone->Props, pvBuf, cbBuf, cFrames);
 
@@ -206 +211 @@
 
     if (pcbWritten)
-        *pcbWritten = PDMAudioPropsFramesToBytes(&pTone->Props, cFrames);
+        *pcbWritten = cbToWrite;
 
     return VINF_SUCCESS;
@@ -225 +230 @@
 
     pToneParams->msPrequel      = RTRandU32Ex(0, RT_MS_5SEC);
+#ifdef DEBUG_andy
+    pToneParams->msDuration     = RTRandU32Ex(0, RT_MS_1SEC);
+#else
     pToneParams->msDuration     = RTRandU32Ex(0, RT_MS_10SEC); /** @todo Probably a bit too long, but let's see. */
+#endif
     pToneParams->msSequel       = RTRandU32Ex(0, RT_MS_5SEC);
     pToneParams->uVolumePercent = RTRandU32Ex(0, 100);
@@ -246 +255 @@
 int AudioTestPathCreate(char *pszPath, size_t cbPath, const char *pszTag)
 {
+    AssertReturn(strlen(pszTag) <= AUDIOTEST_TAG_MAX, VERR_INVALID_PARAMETER);
+
     int rc;
 
@@ -263 +274 @@
     }
 
-    char szName[128];
-    if (RTStrPrintf2(szName, sizeof(szName), "%s%s", AUDIOTEST_PATH_PREFIX_STR, szTag) < 0)
+    char szName[RT_ELEMENTS(AUDIOTEST_PATH_PREFIX_STR) + AUDIOTEST_TAG_MAX + 4];
+    if (RTStrPrintf2(szName, sizeof(szName), "%s-%s", AUDIOTEST_PATH_PREFIX_STR, szTag) < 0)
         AssertFailedReturn(VERR_BUFFER_OVERFLOW);
 
@@ -365 +376 @@
 {
     pSet->f.hFile = NIL_RTFILE;
+
+    RTListInit(&pSet->lstObj);
 }
 
@@ -510 +523 @@
 int AudioTestPathCreateTemp(char *pszPath, size_t cbPath, const char *pszTag)
 {
+    AssertReturn(strlen(pszTag) <= AUDIOTEST_TAG_MAX, VERR_INVALID_PARAMETER);
+
     char szPath[RTPATH_MAX];
 
@@ -531 +546 @@
 int AudioTestSetCreate(PAUDIOTESTSET pSet, const char *pszPath, const char *pszTag)
 {
+    AssertReturn(strlen(pszTag) <= AUDIOTEST_TAG_MAX, VERR_INVALID_PARAMETER);
+
     int rc;
 
@@ -596 +613 @@
 
         pSet->enmMode = AUDIOTESTSETMODE_TEST;
+
+        rc = RTStrCopy(pSet->szTag, sizeof(pSet->szTag), pszTag);
+        AssertRCReturn(rc, rc);
     }
 
@@ -604 +624 @@
  * Destroys a test set.
  *
+ * @returns VBox status code.
  * @param   pSet                Test set to destroy.
  */
-void AudioTestSetDestroy(PAUDIOTESTSET pSet)
+int AudioTestSetDestroy(PAUDIOTESTSET pSet)
 {
     if (!pSet)
-        return;
+        return VINF_SUCCESS;
+
+    int rc = VINF_SUCCESS;
+
+    PAUDIOTESTOBJ pObj, pObjNext;
+    RTListForEachSafe(&pSet->lstObj, pObj, pObjNext, AUDIOTESTOBJ, Node)
+    {
+        rc = AudioTestSetObjClose(pObj);
+        if (RT_SUCCESS(rc))
+        {
+            RTListNodeRemove(&pObj->Node);
+            RTMemFree(pObj);
+
+            Assert(pSet->cObj);
+            pSet->cObj--;
+        }
+        else
+            break;
+    }
+
+    if (RT_FAILURE(rc))
+        return rc;
+
+    Assert(pSet->cObj == 0);
 
     if (RTFileIsValid(pSet->f.hFile))
@@ -616 +660 @@
         pSet->f.hFile = NIL_RTFILE;
     }
+
+    return rc;
 }
 
@@ -661 +707 @@
 
 /**
+ * Physically wipes all related test set files off the disk.
+ *
+ * @param   pSet                Test set to wipe.
+ */
+void AudioTestSetWipe(PAUDIOTESTSET pSet)
+{
+    RT_NOREF(pSet);
+}
+
+/**
+ * Creates and registers a new audio test object to a test set.
+ *
+ * @returns VBox status code.
+ * @param   pSet                Test set to create and register new object for.
+ * @param   pszName             Name of new object to create.
+ * @param   ppObj               Where to return the pointer to the newly created object on success.
+ */
+int AudioTestSetObjCreateAndRegister(PAUDIOTESTSET pSet, const char *pszName, PAUDIOTESTOBJ *ppObj)
+{
+    AssertPtrReturn(pszName, VERR_INVALID_POINTER);
+
+    PAUDIOTESTOBJ pObj = (PAUDIOTESTOBJ)RTMemAlloc(sizeof(AUDIOTESTOBJ));
+    AssertPtrReturn(pObj, VERR_NO_MEMORY);
+
+    int rc = RTStrPrintf(pObj->szName, sizeof(pObj->szName), "%04RU32-%s", pSet->cObj, pszName);
+    AssertRCReturn(rc, rc);
+
+    /** @todo Generalize this function more once we have more object types. */
+
+    char szFilePath[RTPATH_MAX];
+    rc = RTPathJoin(szFilePath, sizeof(szFilePath), pSet->szPathAbs, pObj->szName);
+    AssertRCReturn(rc, rc);
+
+    rc = RTFileOpen(&pObj->File.hFile, szFilePath, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE);
+    if (RT_SUCCESS(rc))
+    {
+        pObj->enmType = AUDIOTESTOBJTYPE_FILE;
+
+        RTListAppend(&pSet->lstObj, &pObj->Node);
+        pSet->cObj++;
+
+        *ppObj = pObj;
+    }
+
+    if (RT_FAILURE(rc))
+        RTMemFree(pObj);
+
+    return rc;
+}
+
+/**
+ * Writes to a created audio test object.
+ *
+ * @returns VBox status code.
+ * @param   pObj                Audio test object to write to.
+ */
+int AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, void *pvBuf, size_t cbBuf)
+{
+    /** @todo Generalize this function more once we have more object types. */
+    AssertReturn(pObj->enmType == AUDIOTESTOBJTYPE_FILE, VERR_INVALID_PARAMETER);
+
+    return RTFileWrite(pObj->File.hFile, pvBuf, cbBuf, NULL);
+}
+
+/**
+ * Closes an opened audio test object.
+ *
+ * @returns VBox status code.
+ * @param   pObj                Audio test object to close.
+ */
+int AudioTestSetObjClose(PAUDIOTESTOBJ pObj)
+{
+    if (!pObj)
+        return VINF_SUCCESS;
+
+    /** @todo Generalize this function more once we have more object types. */
+    AssertReturn(pObj->enmType == AUDIOTESTOBJTYPE_FILE, VERR_INVALID_PARAMETER);
+
+    int rc = VINF_SUCCESS;
+
+    if (RTFileIsValid(pObj->File.hFile))
+    {
+        rc = RTFileClose(pObj->File.hFile);
+        pObj->File.hFile = NIL_RTFILE;
+    }
+
+    return rc;
+}
+
+/**
  * Packs an audio test so that it's ready for transmission.
  *
  * @returns VBox status code.
  * @param   pSet                Test set to pack.
- * @param   pszOutDir           Where to store the packed test set.
- */
-int AudioTestSetPack(PAUDIOTESTSET pSet, const char *pszOutDir)
-{
-    RT_NOREF(pSet, pszOutDir);
-
+ * @param   pszOutDir           Directory where to store the packed test set.
+ * @param   pszFileName         Where to return the final name of the packed test set. Optional and can be NULL.
+ * @param   cbFileName          Size (in bytes) of \a pszFileName.
+ */
+int AudioTestSetPack(PAUDIOTESTSET pSet, const char *pszOutDir, char *pszFileName, size_t cbFileName)
+{
+    AssertReturn(!pszFileName || cbFileName, VERR_INVALID_PARAMETER);
     AssertReturn(audioTestManifestIsOpen(pSet), VERR_WRONG_ORDER);
-    // RTZipTarCmd()
-
-    return VERR_NOT_IMPLEMENTED;
+
+    /** @todo Check and deny if \a pszOutDir is part of the set's path. */
+
+    char szOutName[RT_ELEMENTS(AUDIOTEST_PATH_PREFIX_STR) + AUDIOTEST_TAG_MAX + 16];
+    int rc = RTStrPrintf(szOutName, sizeof(szOutName), "%s-%s.tar.gz", AUDIOTEST_PATH_PREFIX_STR, pSet->szTag);
+    AssertRCReturn(rc, rc);
+
+    char szOutPath[RTPATH_MAX];
+    rc = RTPathJoin(szOutPath, sizeof(szOutPath), pszOutDir, szOutName);
+    AssertRCReturn(rc, rc);
+
+    const char *apszArgs[10];
+    unsigned    cArgs = 0;
+
+    apszArgs[cArgs++] = "AudioTest";
+    apszArgs[cArgs++] = "--create";
+    apszArgs[cArgs++] = "--gzip";
+    apszArgs[cArgs++] = "--directory";
+    apszArgs[cArgs++] = pSet->szPathAbs;
+    apszArgs[cArgs++] = "--file";
+    apszArgs[cArgs++] = szOutPath;
+    apszArgs[cArgs++] = ".";
+
+    RTEXITCODE rcExit = RTZipTarCmd(cArgs, (char **)apszArgs);
+    if (rcExit != RTEXITCODE_SUCCESS)
+        rc = VERR_GENERAL_FAILURE; /** @todo Fudge! */
+
+    if (RT_SUCCESS(rc))
+    {
+        if (pszFileName)
+            rc = RTStrCopy(pszFileName, cbFileName, szOutPath);
+    }
+
+    return rc;
 }
 

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

@@ -24 +24 @@
 #endif
 
+/** @todo Some stuff here can be private-only to the implementation. */
+
+/** Maximum length in characters an audio test tag can have. */
+#define AUDIOTEST_TAG_MAX          64
+/** Maximum length in characters a single audio test error description can have. */
+#define AUDIOTEST_ERROR_DESC_MAX   128
 /** Prefix for audio test (set) directories. */
-#define AUDIOTEST_PATH_PREFIX_STR "audio-test-"
+#define AUDIOTEST_PATH_PREFIX_STR "vkat"
 
 /**
@@ -131 +137 @@
 typedef struct AUDIOTESTPARMS
 {
-    /** Specifies the test to run. */
-    uint32_t                idxTest;
+    /** Specifies the current test iteration. */
+    uint32_t                idxCurrent;
     /** How many iterations the test should be executed. */
     uint32_t                cIterations;
@@ -152 +158 @@
 typedef AUDIOTESTPARMS *PAUDIOTESTPARMS;
 
+typedef enum AUDIOTESTOBJTYPE
+{
+    AUDIOTESTOBJTYPE_UNKNOWN = 0,
+    AUDIOTESTOBJTYPE_FILE,
+    /** The usual 32-bit hack. */
+    AUDIOTESTOBJTYPE_32BIT_HACK = 0x7fffffff
+} AUDIOTESTOBJTYPE;
+
+typedef struct AUDIOTESTOBJFILE
+{
+    RTFILE hFile;
+} AUDIOTESTOBJFILE;
+
+typedef struct AUDIOTESTOBJ
+{
+    RTLISTNODE           Node;
+    char                 szName[64];
+    AUDIOTESTOBJTYPE     enmType;
+    union
+    {
+        AUDIOTESTOBJFILE File;
+    };
+} AUDIOTESTOBJ;
+/** Pointer to an audio test object. */
+typedef AUDIOTESTOBJ *PAUDIOTESTOBJ;
+
 /**
  * Structure specifying an audio test set.
@@ -157 +189 @@
 typedef struct AUDIOTESTSET
 {
+    /** The set's tag. */
+    char             szTag[AUDIOTEST_TAG_MAX];
     /** Absolute path where to store the test audio data. */
     char             szPathAbs[RTPATH_MAX];
@@ -166 +200 @@
         RTINIFILE    hIniFile;
     } f;
+    uint32_t         cObj;
+    RTLISTANCHOR     lstObj;
 } AUDIOTESTSET;
 /** Pointer to an audio test set. */
@@ -180 +216 @@
     int              rc;
     /** Actual error description. */
-    char             szDesc[128];
+    char             szDesc[AUDIOTEST_ERROR_DESC_MAX];
 } AUDIOTESTERRORENTRY;
 /** Pointer to an audio test error description. */
@@ -201 +237 @@
 
 double AudioTestToneInitRandom(PAUDIOTESTTONE pTone, PPDMAUDIOPCMPROPS pProps);
-int    AudioTestToneWrite(PAUDIOTESTTONE pTone, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten);
+int    AudioTestToneGenerate(PAUDIOTESTTONE pTone, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten);
 
 int    AudioTestToneParamsInitRandom(PAUDIOTESTTONEPARMS pToneParams, PPDMAUDIOPCMPROPS pProps);
@@ -208 +244 @@
 int    AudioTestPathCreate(char *pszPath, size_t cbPath, const char *pszUUID);
 
+int    AudioTestSetObjCreateAndRegister(PAUDIOTESTSET pSet, const char *pszName, PAUDIOTESTOBJ *ppObj);
+int    AudioTestSetObjWrite(PAUDIOTESTOBJ pObj, void *pvBuf, size_t cbBuf);
+int    AudioTestSetObjClose(PAUDIOTESTOBJ pObj);
+
 int    AudioTestSetCreate(PAUDIOTESTSET pSet, const char *pszPath, const char *pszTag);
-void   AudioTestSetDestroy(PAUDIOTESTSET pSet);
+int    AudioTestSetDestroy(PAUDIOTESTSET pSet);
 int    AudioTestSetOpen(PAUDIOTESTSET pSet, const char *pszPath);
 void   AudioTestSetClose(PAUDIOTESTSET pSet);
-int    AudioTestSetPack(PAUDIOTESTSET pSet, const char *pszOutDir);
+void   AudioTestSetWipe(PAUDIOTESTSET pSet);
+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);

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

@@ -264 +264 @@
 
     uint32_t cbWritten;
-    int rc = AudioTestToneWrite(&pStreamDbg->In, pvBuf, cbBuf, &cbWritten);
+    int rc = AudioTestToneGenerate(&pStreamDbg->In, pvBuf, cbBuf, &cbWritten);
     if (RT_SUCCESS(rc))
     {