Changeset 89226 in vbox

Timestamp:

May 21, 2021 3:02:10 PM (4 years ago)

Author:

vboxsync

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

144569

Message:

Audio/ValKit: Initial support for the audio test execution service (ATS) to support playing test tones. bugref:10008

Location:

trunk/src/VBox

Files:

• Devices/Audio/AudioTestService.cpp (modified) (3 diffs)
• Devices/Audio/AudioTestService.h (modified) (3 diffs)
• Devices/Audio/AudioTestServiceClient.cpp (modified) (1 diff)
• Devices/Audio/AudioTestServiceClient.h (modified) (1 diff)
• Devices/Audio/AudioTestServiceProtocol.h (modified) (1 diff)
• ValidationKit/utils/audio/vkat.cpp (modified) (3 diffs)

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

@@ -536 +536 @@
         return atsReplyInvalidState(pThis, pClient, pPktHdr);
 
+    if (!pThis->Callbacks.pfnTonePlay)
+        return atsReplyRC(pThis, pClient, pPktHdr, VERR_NOT_SUPPORTED, "Playing tones not supported");
+
+    PATSPKTREQTONEPLAY pReq = (PATSPKTREQTONEPLAY)pPktHdr;
+    rc = pThis->Callbacks.pfnTonePlay(pThis->Callbacks.pvUser, &pReq->StreamCfg, &pReq->ToneParms);
+
+    int rc2 = atsReplyAck(pThis, pClient, pPktHdr);
+    if (RT_SUCCESS(rc))
+        rc = rc2;
+
     return rc;
 }
@@ -564 +574 @@
     else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_BYE))
         rc = atsDoBye(pThis, pClient, pPktHdr);
-    /* Gadget API. */
+    /* Audio testing: */
     else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TONE_PLAY))
         rc = atsDoTonePlay(pThis, pClient, pPktHdr);
@@ -762 +772 @@
  * @param   pThis               The ATS instance.
  *  */
-int AudioTestSvcInit(PATSSERVER pThis)
-{
+int AudioTestSvcInit(PATSSERVER pThis, PCATSCALLBACKS pCallbacks)
+{
+    memcpy(&pThis->Callbacks, pCallbacks, sizeof(ATSCALLBACKS));
+
     pThis->fStarted   = false;
     pThis->fTerminate = false;

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

@@ -26 +26 @@
 
 /**
+ * Structure for keeping an Audio Test Server (ATS) callback table.
+ */
+typedef struct ATSCALLBACKS
+{
+    /**
+     * Plays a test tone.
+     *
+     * @returns VBox status code.
+     * @param   pvUser          User-supplied pointer to context data. Optional.
+     * @param   pStreamCfg      Audio stream configuration to use for stream to play tone on.
+     * @param   pToneParms      Tone parameters to use for playback.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnTonePlay, (void const *pvUser, PPDMAUDIOSTREAMCFG pStreamCfg, PAUDIOTESTTONEPARMS pToneParms));
+    /** Pointer to opaque user-provided context data. */
+    void const *pvUser;
+} ATSCALLBACKS;
+/** Pointer to a const ATS callbacks table. */
+typedef const struct ATSCALLBACKS *PCATSCALLBACKS;
+
+/**
  * Structure for keeping an Audio Test Server (ATS) instance.
  */
@@ -32 +52 @@
     /** The selected transport layer. */
     PCATSTRANSPORT       pTransport;
+    /** The callbacks table. */
+    ATSCALLBACKS         Callbacks;
     /** Whether server is in started state or not. */
     bool volatile        fStarted;
@@ -55 +77 @@
 
 
-int AudioTestSvcInit(PATSSERVER pThis);
+int AudioTestSvcInit(PATSSERVER pThis, PCATSCALLBACKS pCallbacks);
 int AudioTestSvcDestroy(PATSSERVER pThis);
 int AudioTestSvcStart(PATSSERVER pThis);

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

@@ -227 +227 @@
 }
 
+int AudioTestSvcClientTonePlay(PATSCLIENT pClient, PPDMAUDIOSTREAMCFG pStreamCfg, PAUDIOTESTTONEPARMS pToneParms)
+{
+    ATSPKTREQTONEPLAY Req;
+
+    memcpy(&Req.StreamCfg, pStreamCfg, sizeof(PDMAUDIOSTREAMCFG));
+    memcpy(&Req.ToneParms, pToneParms, sizeof(AUDIOTESTTONEPARMS));
+
+    audioTestSvcClientReqHdrInit(&Req.Hdr, sizeof(Req), ATSPKT_OPCODE_TONE_PLAY, 0);
+
+    int rc = audioTestSvcClientSendMsg(pClient, &Req, sizeof(Req), NULL, 0);
+    if (RT_SUCCESS(rc))
+        rc = audioTestSvcClientRecvAck(pClient);
+
+    return rc;
+}
+
 int AudioTestSvcClientClose(PATSCLIENT pClient)
 {

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

@@ -31 +31 @@
 
 int AudioTestSvcClientConnect(PATSCLIENT pClient, const char *pszAddr);
+int AudioTestSvcClientTonePlay(PATSCLIENT pClient, PPDMAUDIOSTREAMCFG pStreamCfg, PAUDIOTESTTONEPARMS pToneParms);
 int AudioTestSvcClientClose(PATSCLIENT pClient);
 

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

@@ -130 +130 @@
     /** Embedded packet header. */
     ATSPKTHDR          Hdr;
-    AUDIOTESTTONEPARMS Parms;
-    uint8_t            au8Padding[8];
+    /** Stream configuration to use for playing the tone.
+     *  Note: Depending on the actual implementation this configuration might or might not be available / supported. */
+    PDMAUDIOSTREAMCFG  StreamCfg;
+    /** Test tone parameters for playback. */
+    AUDIOTESTTONEPARMS ToneParms;
 } ATSPKTREQTONEPLAY;
 AssertCompileSizeAlignment(ATSPKTREQTONEPLAY, ATSPKT_ALIGNMENT);

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

@@ -2484 +2484 @@
 
 /**
+ * Structure for keeping a user context for the test service callbacks.
+ */
+typedef struct ATSCALLBACKCTX
+{
+    /** Driver stack to use. */
+    PAUDIOTESTDRVSTACK pDrvStack;
+    /** Audio stream to use. */
+    PPDMAUDIOSTREAM    pStream;
+} ATSCALLBACKCTX;
+typedef ATSCALLBACKCTX *PATSCALLBACKCTX;
+
+/**
+ * Note: Called within server (client serving) thread.
+ */
+static DECLCALLBACK(int) audioTestSvcTonePlayCallback(void const *pvUser, PPDMAUDIOSTREAMCFG pStreamCfg, PAUDIOTESTTONEPARMS pToneParms)
+{
+    PATSCALLBACKCTX pCtx = (PATSCALLBACKCTX)pvUser;
+
+    AUDIOTESTTONE TstTone;
+    AudioTestToneInitRandom(&TstTone, &pStreamCfg->Props);
+
+    int rc;
+
+    if (audioTestDriverStackStreamIsOkay(pCtx->pDrvStack, pCtx->pStream))
+    {
+        uint32_t cbBuf;
+        uint8_t  abBuf[_4K];
+
+        const uint64_t tsStartMs     = RTTimeMilliTS();
+        const uint16_t cSchedulingMs = RTRandU32Ex(10, 80); /* Chose a random scheduling (in ms). */
+        const uint32_t cbPerMs       = PDMAudioPropsMilliToBytes(&pCtx->pStream->Props, cSchedulingMs);
+
+        do
+        {
+            rc = AudioTestToneGenerate(&TstTone, abBuf, RT_MIN(cbPerMs, sizeof(abBuf)), &cbBuf);
+            if (RT_SUCCESS(rc))
+            {
+                uint32_t cbWritten;
+                rc = audioTestDriverStackStreamPlay(pCtx->pDrvStack, pCtx->pStream, abBuf, cbBuf, &cbWritten);
+            }
+
+            if (RTTimeMilliTS() - tsStartMs >= pToneParms->msDuration)
+                break;
+
+            if (RT_FAILURE(rc))
+                break;
+
+            RTThreadSleep(cSchedulingMs);
+
+        } while (RT_SUCCESS(rc));
+    }
+    else
+        rc = VERR_AUDIO_STREAM_NOT_READY;
+
+    return rc;
+}
+
+/**
  * Tests the Audio Test Service (ATS).
  *
+ * @param   pDrvReg             Backend driver to use.
  * @returns VBox status code.
  */
-static int audioTestDoSelftestSvc(void)
-{
-    ATSSERVER Srv;
-    int rc = AudioTestSvcInit(&Srv);
+static int audioTestDoSelftestSvc(PCPDMDRVREG pDrvReg)
+{
+    AUDIOTESTDRVSTACK DrvStack;
+    int rc = audioTestDriverStackInit(&DrvStack, pDrvReg, true /* fWithDrvAudio */);
     if (RT_SUCCESS(rc))
     {
-        rc = AudioTestSvcStart(&Srv);
+        PDMAUDIOPCMPROPS  Props;
+        PDMAudioPropsInit(&Props, 16 /* bit */ / 8, true /* fSigned */, 2 /* Channels */, 44100 /* Hz */);
+
+        PDMAUDIOSTREAMCFG CfgAcq;
+        PPDMAUDIOSTREAM   pStream = NULL;
+        rc = audioTestDriverStackStreamCreateOutput(&DrvStack, &Props,
+                                                    UINT32_MAX /* cMsBufferSize */,
+                                                    UINT32_MAX /* cMsPreBuffer */,
+                                                    UINT32_MAX /* cMsSchedulingHint */, &pStream, &CfgAcq);
         if (RT_SUCCESS(rc))
         {
-            ATSCLIENT Conn;
-            rc = AudioTestSvcClientConnect(&Conn, NULL);
+            rc = audioTestDriverStackStreamEnable(&DrvStack, pStream);
             if (RT_SUCCESS(rc))
             {
-                rc = AudioTestSvcClientClose(&Conn);
+                ATSCALLBACKCTX Ctx;
+                Ctx.pDrvStack = &DrvStack;
+                Ctx.pStream   = pStream;
+
+                ATSCALLBACKS Callbacks;
+                Callbacks.pfnTonePlay = audioTestSvcTonePlayCallback;
+                Callbacks.pvUser      = &Ctx;
+
+                ATSSERVER Srv;
+                rc = AudioTestSvcInit(&Srv, &Callbacks);
+                if (RT_SUCCESS(rc))
+                {
+                    rc = AudioTestSvcStart(&Srv);
+                    if (RT_SUCCESS(rc))
+                    {
+                        ATSCLIENT Conn;
+                        rc = AudioTestSvcClientConnect(&Conn, NULL);
+                        if (RT_SUCCESS(rc))
+                        {
+                            /* Do the bare minimum here to get a test tone out. */
+                            AUDIOTESTTONEPARMS ToneParms = { 0 };
+                            ToneParms.msDuration = 2000;
+                            memcpy(&ToneParms.Props, &CfgAcq.Props, sizeof(PDMAUDIOPCMPROPS));
+
+                            rc = AudioTestSvcClientTonePlay(&Conn, &CfgAcq, &ToneParms);
+
+                            int rc2 = AudioTestSvcClientClose(&Conn);
+                            if (RT_SUCCESS(rc))
+                                rc = rc2;
+                        }
+
+                        int rc2 = AudioTestSvcShutdown(&Srv);
+                        if (RT_SUCCESS(rc))
+                            rc = rc2;
+                    }
+
+                    int rc2 = AudioTestSvcDestroy(&Srv);
+                    if (RT_SUCCESS(rc))
+                        rc = rc2;
+                }
             }
-
-            int rc2 = AudioTestSvcShutdown(&Srv);
-            if (RT_SUCCESS(rc))
-                rc = rc2;
         }
-
-        int rc2 = AudioTestSvcDestroy(&Srv);
-        if (RT_SUCCESS(rc))
-            rc = rc2;
     }
 
@@ -2521 +2618 @@
  *
  * @returns VBox status code.
- */
-static int audioTestDoSelftest(void)
-{
-    int rc = audioTestDoSelftestSvc();
+ * @param   pDrvReg             Backend driver to use.
+ */
+static int audioTestDoSelftest(PCPDMDRVREG pDrvReg)
+{
+    int rc = audioTestDoSelftestSvc(pDrvReg);
     if (RT_FAILURE(rc))
         RTTestFailed(g_hTest, "Self-test failed with: %Rrc", rc);
@@ -2579 +2677 @@
     }
 
-    audioTestDoSelftest();
+    audioTestDoSelftest(pDrvReg);
         /*
      * Print summary and exit.