Changeset 70926 in vbox for trunk/src/VBox/Devices

Timestamp:

Feb 9, 2018 9:56:43 AM (7 years ago)

Author:

vboxsync

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

120754

Message:

Audio/DrvHostDSound.cpp: Cleanup / docs.

File:

• trunk/src/VBox/Devices/Audio/DrvHostDSound.cpp (modified) (20 diffs)

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

@@ -120 +120 @@
     /** Whether this stream is in an enable state on the DirectSound side. */
     bool               fEnabled;
+    /** The stream's critical section for synchronizing access. */
     RTCRITSECT         CritSect;
+    /** The internal playback / capturing buffer. */
     PRTCIRCBUF         pCircBuf;
+    /** Size (in bytes) of the DirectSound buffer.
+     *  Note: This in *not* the size of the circular buffer above! */
+    DWORD              cbBufSize;
     union
     {
@@ -131 +136 @@
             /** Current read offset (in bytes) within the DSB. */
             DWORD                       offReadPos;
-            /** Size (in bytes) of the DirectSound buffer. */
-            DWORD                       cbBufSize;
         } In;
         struct
@@ -147 +150 @@
             /** Total amount (in bytes) written. */
             uint64_t                    cbWritten;
-            /** Size (in bytes) of the DirectSound buffer. */
-            DWORD                       cbBufSize;
             /** Flag indicating whether playback was (re)started. */
             bool                        fFirstPlayback;
-            uint64_t tsLastPlayMs;
-            bool fPendingPlayback;
-            bool fPendingClose;
+            /** Timestamp (in ms) of When the last playback has happened. */
+            uint64_t                    tsLastPlayMs;
         } Out;
     };
@@ -308 +308 @@
             int32_t cbDiff = cbWriteCursor - cbPlayCursor;
             if (cbDiff < 0)
-                cbDiff += pStreamDS->Out.cbBufSize;
+                cbDiff += pStreamDS->cbBufSize;
 
             int32_t cbFree = cbPlayCursor - pStreamDS->Out.offWritePos;
             if (cbFree < 0)
-                cbFree += pStreamDS->Out.cbBufSize;
-
-            if (cbFree > (int32_t)pStreamDS->Out.cbBufSize - cbDiff)
+                cbFree += pStreamDS->cbBufSize;
+
+            if (cbFree > (int32_t)pStreamDS->cbBufSize - cbDiff)
             {
                 pStreamDS->Out.offWritePos = cbWriteCursor;
-                cbFree = pStreamDS->Out.cbBufSize - cbDiff;
+                cbFree = pStreamDS->cbBufSize - cbDiff;
             }
 
@@ -326 +326 @@
              * So use our per-stream written indicator to see if we just started a stream. */
             if (pStreamDS->Out.cbWritten == 0)
-                cbFree = pStreamDS->Out.cbBufSize;
+                cbFree = pStreamDS->cbBufSize;
 
             DSLOGREL(("DSound: cbPlayCursor=%RU32, cbWriteCursor=%RU32, offWritePos=%RU32 -> cbFree=%RI32\n",
@@ -761 +761 @@
          * playback buffer position.
          */
-        pStreamDS->Out.cbBufSize = bc.dwBufferBytes;
+        pStreamDS->cbBufSize = bc.dwBufferBytes;
 
         RTCritSectEnter(&pThis->CritSect);
 
-        rc = RTCircBufCreate(&pStreamDS->pCircBuf, pStreamDS->Out.cbBufSize);
+        rc = RTCircBufCreate(&pStreamDS->pCircBuf, pStreamDS->cbBufSize);
         AssertRC(rc);
 
@@ -781 +781 @@
             dsPosNotify[0].hEventNotify = pThis->aEvents[DSOUNDEVENT_OUTPUT];
 
-            dsPosNotify[1].dwOffset     = float(pStreamDS->Out.cbBufSize * 0.3);
+            dsPosNotify[1].dwOffset     = float(pStreamDS->cbBufSize * 0.3);
             dsPosNotify[1].hEventNotify = pThis->aEvents[DSOUNDEVENT_OUTPUT];
 
-            dsPosNotify[2].dwOffset     = float(pStreamDS->Out.cbBufSize * 0.6);
+            dsPosNotify[2].dwOffset     = float(pStreamDS->cbBufSize * 0.6);
             dsPosNotify[2].hEventNotify = pThis->aEvents[DSOUNDEVENT_OUTPUT];
 
@@ -800 +800 @@
         RTCritSectLeave(&pThis->CritSect);
 
-        pCfgAcq->cFrameBufferHint = PDMAUDIOSTREAMCFG_B2F(pCfgAcq, pStreamDS->Out.cbBufSize);
+        pCfgAcq->cFrameBufferHint = PDMAUDIOSTREAMCFG_B2F(pCfgAcq, pStreamDS->cbBufSize);
 
     } while (0);
@@ -824 +824 @@
     PVOID pv1;
     hr = directSoundPlayLock(pThis, pStreamDS,
-                             0 /* dwOffset */, pStreamDS->Out.cbBufSize,
+                             0 /* dwOffset */, pStreamDS->cbBufSize,
                              &pv1, NULL, 0, 0, DSBLOCK_ENTIREBUFFER);
     if (SUCCEEDED(hr))
     {
-        DrvAudioHlpClearBuf(pProps, pv1, pStreamDS->Out.cbBufSize, PDMAUDIOPCMPROPS_B2F(pProps, pStreamDS->Out.cbBufSize));
+        DrvAudioHlpClearBuf(pProps, pv1, pStreamDS->cbBufSize, PDMAUDIOPCMPROPS_B2F(pProps, pStreamDS->cbBufSize));
 
         directSoundPlayUnlock(pThis, pStreamDS->Out.pDSB, pv1, NULL, 0, 0);
@@ -1208 +1208 @@
 
         /* Initial state: reading at the initial capture position, no error. */
-        pStreamDS->In.offReadPos    = 0;
-        pStreamDS->In.cbBufSize     = bc.dwBufferBytes;
-
-        rc = RTCircBufCreate(&pStreamDS->pCircBuf, pStreamDS->In.cbBufSize);
+        pStreamDS->In.offReadPos = 0;
+        pStreamDS->cbBufSize     = bc.dwBufferBytes;
+
+        rc = RTCircBufCreate(&pStreamDS->pCircBuf, pStreamDS->cbBufSize);
         AssertRC(rc);
 
@@ -1227 +1227 @@
             dsPosNotify[0].hEventNotify = pThis->aEvents[DSOUNDEVENT_INPUT];
 
-            dsPosNotify[1].dwOffset     = float(pStreamDS->In.cbBufSize * 0.3);
+            dsPosNotify[1].dwOffset     = float(pStreamDS->cbBufSize * 0.3);
             dsPosNotify[1].hEventNotify = pThis->aEvents[DSOUNDEVENT_INPUT];
 
-            dsPosNotify[2].dwOffset     = float(pStreamDS->In.cbBufSize * 0.6);
+            dsPosNotify[2].dwOffset     = float(pStreamDS->cbBufSize * 0.6);
             dsPosNotify[2].hEventNotify = pThis->aEvents[DSOUNDEVENT_INPUT];
 
@@ -1242 +1242 @@
         }
 
-        pCfgAcq->cFrameBufferHint = PDMAUDIOSTREAMCFG_B2F(pCfgAcq, pStreamDS->In.cbBufSize);
+        pCfgAcq->cFrameBufferHint = PDMAUDIOSTREAMCFG_B2F(pCfgAcq, pStreamDS->cbBufSize);
 
     } while (0);
@@ -1556 +1556 @@
     pStreamDS->Out.cbWritten = 0;
     pStreamDS->Out.fFirstPlayback = true;
-    pStreamDS->Out.fPendingPlayback = false;
     pStreamDS->Out.tsLastPlayMs = 0;
-    pStreamDS->Out.cbBufSize = 0;
+    pStreamDS->cbBufSize = 0;
 
     int rc = VINF_SUCCESS;
@@ -1715 +1714 @@
 
     /* Init the stream structure and save relevant information to it. */
-    pStreamDS->In.offReadPos    = 0;
-    pStreamDS->In.cbBufSize     = 0;
-    pStreamDS->In.pDSCB         = NULL;
+    pStreamDS->In.offReadPos = 0;
+    pStreamDS->cbBufSize     = 0;
+    pStreamDS->In.pDSCB      = NULL;
 
     int rc = VINF_SUCCESS;
@@ -1963 +1962 @@
                         break;
 
-                    DWORD cbUsed = dsoundRingDistance(offCaptureCursor, pStreamDS->In.offReadPos, pStreamDS->In.cbBufSize);
+                    DWORD cbUsed = dsoundRingDistance(offCaptureCursor, pStreamDS->In.offReadPos, pStreamDS->cbBufSize);
 
                     PRTCIRCBUF pCircBuf = pStreamDS->pCircBuf;
@@ -2001 +2000 @@
                             directSoundCaptureUnlock(pDSCB, pv1, pv2, cb1, cb2);
 
-                            pStreamDS->In.offReadPos = (pStreamDS->In.offReadPos + cb1 + cb2) % pStreamDS->In.cbBufSize;
+                            pStreamDS->In.offReadPos = (pStreamDS->In.offReadPos + cb1 + cb2) % pStreamDS->cbBufSize;
 
                             Assert(cbToCapture >= cbBuf);
@@ -2049 +2048 @@
                         pStreamDS->Out.offWritePos = offWriteCursor;
 
-                        cbFree      = pStreamDS->Out.cbBufSize;
-                        cbRemaining = pStreamDS->Out.cbBufSize;
+                        cbFree      = pStreamDS->cbBufSize;
+                        cbRemaining = pStreamDS->cbBufSize;
                     }
                     else
@@ -2059 +2058 @@
                             break;
 
-                        cbFree      = dsoundRingDistance(offPlayCursor, pStreamDS->Out.offWritePos, pStreamDS->Out.cbBufSize);
-                        cbRemaining = dsoundRingDistance(pStreamDS->Out.offWritePos, offPlayCursor, pStreamDS->Out.cbBufSize);
+                        cbFree      = dsoundRingDistance(offPlayCursor, pStreamDS->Out.offWritePos, pStreamDS->cbBufSize);
+                        cbRemaining = dsoundRingDistance(pStreamDS->Out.offWritePos, offPlayCursor, pStreamDS->cbBufSize);
                     }
 
@@ -2099 +2098 @@
                             directSoundPlayUnlock(pThis, pDSB, pv1, pv2, cb1, cb2);
 
-                            pStreamDS->Out.offWritePos = (pStreamDS->Out.offWritePos + cb1 + cb2) % pStreamDS->Out.cbBufSize;
+                            pStreamDS->Out.offWritePos = (pStreamDS->Out.offWritePos + cb1 + cb2) % pStreamDS->cbBufSize;
 
                             Assert(cbToPlay >= cbBuf);
@@ -2131 +2130 @@
                             DSLOG(("DSound: Started playing output\n"));
                             pStreamDS->Out.fFirstPlayback   = false;
-                            pStreamDS->Out.fPendingPlayback = true;
                         }
                     }