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

Timestamp:

Apr 6, 2021 8:31:12 PM (4 years ago)

Author:

vboxsync

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

143622

Message:

DrvAudio: Arm a timer when entering the PENDING_DISABLE state to work pfnStreamIterate and pfnStreamPlay, otherwise we probably will not get out of this state till the stream is re-enabled. bugref:9890

File:

• trunk/src/VBox/Devices/Audio/DrvAudio.cpp (modified) (12 diffs)

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

@@ -91 +91 @@
     uintptr_t           uMagic;
 
-    /** List entry (some DrvAudio internal list). */
+    /** List entry in DRVAUDIO::lstStreams. */
     RTLISTNODE          ListEntry;
 
@@ -314 +314 @@
         STAMCOUNTER         StatsReBuffering;
     } Out;
+
+    /** Handle to the disable-iteration timer. */
+    TMTIMERHANDLE           hTimer;
+    /** Set if hTimer is armed. */
+    bool volatile           fTimerArmed;
+    /** Unique name for the the disable-iteration timer.  */
+    char                    szTimerName[23];
+
 #ifdef VBOX_WITH_STATISTICS
     /** Statistics for the statistics manager (STAM). */
@@ -336 +344 @@
 static void drvAudioStreamFree(PDRVAUDIOSTREAM pStream);
 static int drvAudioStreamUninitInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx);
-static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx);
+static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx, bool fWorkMixBuf);
+static int drvAudioStreamPlayLocked(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx, uint32_t *pcFramesPlayed);
 static void drvAudioStreamDropInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx);
 static void drvAudioStreamResetInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx);
@@ -651 +660 @@
                     LogFunc(("[%s] Pending disable/pause\n", pStreamEx->Core.szName));
                     pStreamEx->Core.fStatus |= PDMAUDIOSTREAMSTS_FLAGS_PENDING_DISABLE;
+
+                    /* Schedule a follow up timer to the pending-disable state.  We cannot rely
+                       on the device to provide further callouts to finish the state transition.
+                       10ms is taking out of thin air and may be too course grained, we should
+                       really consider the amount of unplayed buffer in the backend and what not... */
+                    if (!pThis->fTimerArmed)
+                    {
+                        LogFlowFunc(("Arming emergency pending-disable hack...\n"));
+                        int rc2 = PDMDrvHlpTimerSetMillies(pThis->pDrvIns, pThis->hTimer, 10 /*ms*/);
+                        AssertRC(rc2);
+                        pThis->fTimerArmed = true;
+                    }
                 }
 
@@ -730 +751 @@
         return VINF_SUCCESS;
 
-    int rc = VINF_SUCCESS;
 
     /*
@@ -753 +773 @@
                                                               PDMAudioDirGetName(pStreamEx->Core.enmDir),
                                                               fEnabled ? "enabled" : "disabled"));
+    int rc = VINF_SUCCESS;
     switch (enmStreamCmd)
     {
@@ -1180 +1201 @@
     AssertRCReturn(rc, rc);
 
-    rc = drvAudioStreamIterateInternal(pThis, pStreamEx);
+    rc = drvAudioStreamIterateInternal(pThis, pStreamEx, false /*fWorkMixBuf*/); /** @todo r=bird: why didn't it work the mixing buffer initially.  We can probably set this to true...  It may cause repeat work though. */
 
     RTCritSectLeave(&pThis->CritSect);
@@ -1264 +1285 @@
 /**
  * Does one iteration of an audio stream.
+ *
  * This function gives the backend the chance of iterating / altering data and
  * does the actual mixing between the guest <-> host mixing buffers.
@@ -1270 +1292 @@
  * @param   pThis       Pointer to driver instance.
  * @param   pStreamEx   Stream to iterate.
- */
-static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx)
+ * @param   fWorkMixBuf Push data from the mixing buffer to the backend.
+ * @todo    r=bird: Don't know why the default behavior isn't to push data into
+ *          the backend...  We'll never get out of the pending-disable state if
+ *          the mixing buffer doesn't empty out.
+ */
+static int drvAudioStreamIterateInternal(PDRVAUDIO pThis, PDRVAUDIOSTREAM pStreamEx, bool fWorkMixBuf)
 {
     AssertPtrReturn(pThis, VERR_INVALID_POINTER);
@@ -1308 +1334 @@
             /* No audio frames to transfer from guest to host (anymore)?
              * Then try closing this stream if marked so in the next block. */
-            const uint32_t cFramesLive = AudioMixBufLive(&pStreamEx->Host.MixBuf);
+            uint32_t cFramesLive = AudioMixBufLive(&pStreamEx->Host.MixBuf);
+            if (cFramesLive && fWorkMixBuf)
+            {
+                uint32_t cIgnored = 0;
+                drvAudioStreamPlayLocked(pThis, pStreamEx, &cIgnored);
+
+                cFramesLive = AudioMixBufLive(&pStreamEx->Host.MixBuf);
+            }
+
             fTryClosePending = cFramesLive == 0;
             Log3Func(("[%s] fTryClosePending=%RTbool, cFramesLive=%RU32\n", pStreamEx->Core.szName, fTryClosePending, cFramesLive));
@@ -1358 +1392 @@
 
     return rc;
+}
+
+/**
+ * @callback_method_impl{FNTMTIMERDRV}
+ */
+static DECLCALLBACK(void) drvAudioEmergencyIterateTimer(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, void *pvUser)
+{
+    PDRVAUDIO pThis = PDMINS_2_DATA(pDrvIns, PDRVAUDIO);
+    RT_NOREF(hTimer, pvUser);
+    RTCritSectEnter(&pThis->CritSect);
+
+    /*
+     * Iterate any stream with the pending-disable flag set.
+     */
+    uint32_t        cMilliesToNext = 0;
+    PDRVAUDIOSTREAM pStreamEx, pStreamExNext;
+    RTListForEachSafe(&pThis->lstStreams, pStreamEx, pStreamExNext, DRVAUDIOSTREAM, ListEntry)
+    {
+        if (   pStreamEx->uMagic == DRVAUDIOSTREAM_MAGIC
+            && pStreamEx->Core.cRefs >= 1)
+        {
+            if (pStreamEx->Core.fStatus & PDMAUDIOSTREAMSTS_FLAGS_PENDING_DISABLE)
+            {
+                drvAudioStreamIterateInternal(pThis, pStreamEx, true /*fWorkMixBuf*/);
+
+                if (pStreamEx->Core.fStatus & PDMAUDIOSTREAMSTS_FLAGS_PENDING_DISABLE)
+                    cMilliesToNext = 10;
+            }
+        }
+    }
+
+    /*
+     * Re-arm the timer if we still got streams in the pending state.
+     */
+    if (cMilliesToNext)
+    {
+        pThis->fTimerArmed = true;
+        PDMDrvHlpTimerSetMillies(pDrvIns, pThis->hTimer, cMilliesToNext);
+    }
+    else
+        pThis->fTimerArmed = false;
+
+    RTCritSectLeave(&pThis->CritSect);
 }
 
@@ -3833 +3910 @@
                                  STAMUNIT_NS_PER_CALL, "Profiling of output data processing.");
 #endif
+
+    /*
+     * Create a timer to do finish closing output streams in PENDING_DISABLE state.
+     *
+     * The device won't call us again after it has disabled a the stream and this is
+     * a real problem for truely cyclic buffer backends like DSound which will just
+     * continue to loop and loop if not stopped.
+     */
+    RTStrPrintf(pThis->szTimerName, sizeof(pThis->szTimerName), "AudioIterate-%u", pDrvIns->iInstance);
+    rc = PDMDrvHlpTMTimerCreate(pDrvIns, TMCLOCK_VIRTUAL, drvAudioEmergencyIterateTimer, NULL /*pvUser*/,
+                                0 /*fFlags*/, pThis->szTimerName, &pThis->hTimer);
+    AssertRCReturn(rc, rc);
 
     /*