Changeset 88667 in vbox for trunk/src/VBox

Timestamp:

Apr 23, 2021 12:00:17 AM (4 years ago)

Author:

vboxsync

Message:

DrvHostAudioWasApi: Always keep IMMDevice pointer to the input and output devices we're using around. Saves ~2ms when setting up a stream. The change notification client keeps them up to date. bugref:9890

File:

• trunk/src/VBox/Devices/Audio/DrvHostAudioWasApi.cpp (modified) (11 diffs)

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

@@ -201 +201 @@
     PRTUTF16                        pwszInputDevId;
 
+    /** Pointer to the MM notification client instance. */
+    DrvHostAudioWasMmNotifyClient  *pNotifyClient;
+    /** The input device to use.  This can be NULL if there wasn't a suitable one
+     * around when we last looked or if it got removed/disabled/whatever.
+    * All access must be done inside the pNotifyClient critsect. */
+    IMMDevice                      *pIDeviceInput;
+    /** The output device to use.  This can be NULL if there wasn't a suitable one
+     * around when we last looked or if it got removed/disabled/whatever.
+     * All access must be done inside the pNotifyClient critsect. */
+    IMMDevice                      *pIDeviceOutput;
+
     /** A drain stop timer that makes sure a draining stream will be properly
      * stopped (mainly for clean state and to reduce resource usage). */
@@ -210 +221 @@
     RTCRITSECTRW                    CritSectStreamList;
 
-    /** Pointer to the MM notification client instance. */
-    DrvHostAudioWasMmNotifyClient  *pNotifyClient;
     /** List of cached devices (DRVHOSTAUDIOWASCACHEDEV).
      * Protected by CritSectCache  */
@@ -860 +869 @@
     }
 
+    /**
+     * Enters the notification critsect for getting at the IMMDevice members in
+     * PDMHOSTAUDIOWAS.
+     */
+    void lockEnter() RT_NOEXCEPT
+    {
+        RTCritSectEnter(&m_CritSect);
+    }
+
+    /**
+     * Leaves the notification critsect.
+     */
+    void lockLeave() RT_NOEXCEPT
+    {
+        RTCritSectLeave(&m_CritSect);
+    }
+
     /** @name IUnknown interface
      * @{ */
@@ -910 +936 @@
         RT_NOREF(pwszDeviceId);
         Log7Func(("pwszDeviceId=%ls\n", pwszDeviceId));
+
+        /*
+         * Is this a device we're interested in?  Grab the enumerator if it is.
+         */
+        bool                 fOutput      = false;
+        IMMDeviceEnumerator *pIEnumerator = NULL;
+        RTCritSectEnter(&m_CritSect);
+        if (   m_pDrvWas != NULL
+            && (   (fOutput = RTUtf16ICmp(m_pDrvWas->pwszOutputDevId, pwszDeviceId) == 0)
+                || RTUtf16ICmp(m_pDrvWas->pwszInputDevId, pwszDeviceId) == 0))
+        {
+            pIEnumerator = m_pDrvWas->pIEnumerator;
+            if (pIEnumerator /* paranoia */)
+                pIEnumerator->AddRef();
+        }
+        RTCritSectLeave(&m_CritSect);
+        if (pIEnumerator)
+        {
+            /*
+             * Get the device and update it.
+             */
+            IMMDevice *pIDevice = NULL;
+            HRESULT hrc = pIEnumerator->GetDevice(pwszDeviceId, &pIDevice);
+            if (SUCCEEDED(hrc))
+                setDevice(fOutput, pIDevice, pwszDeviceId, __PRETTY_FUNCTION__);
+            else
+                LogRelMax(64, ("WasAPI: Failed to get %s device '%ls' (OnDeviceAdded): %Rhrc\n",
+                               fOutput ? "output" : "input", pwszDeviceId, hrc));
+            pIEnumerator->Release();
+        }
         return S_OK;
     }
@@ -917 +973 @@
         RT_NOREF(pwszDeviceId);
         Log7Func(("pwszDeviceId=%ls\n", pwszDeviceId));
+
+        /*
+         * Is this a device we're interested in?  Then set it to NULL.
+         */
+        bool fOutput = false;
+        RTCritSectEnter(&m_CritSect);
+        if (   m_pDrvWas != NULL
+            && (   (fOutput = RTUtf16ICmp(m_pDrvWas->pwszOutputDevId, pwszDeviceId) == 0)
+                || RTUtf16ICmp(m_pDrvWas->pwszInputDevId, pwszDeviceId) == 0))
+            setDevice(fOutput, NULL, pwszDeviceId, __PRETTY_FUNCTION__);
+        RTCritSectLeave(&m_CritSect);
         return S_OK;
     }
@@ -922 +989 @@
     IFACEMETHODIMP OnDefaultDeviceChanged(EDataFlow enmFlow, ERole enmRole, LPCWSTR pwszDefaultDeviceId)
     {
+        /*
+         * Are we interested in this device?  If so grab the enumerator.
+         */
+        IMMDeviceEnumerator *pIEnumerator = NULL;
+        RTCritSectEnter(&m_CritSect);
+        if (    m_pDrvWas != NULL
+            && (   (enmFlow == eRender  && enmRole == eMultimedia && !m_pDrvWas->pwszOutputDevId)
+                || (enmFlow == eCapture && enmRole == eMultimedia && !m_pDrvWas->pwszInputDevId)))
+        {
+            pIEnumerator = m_pDrvWas->pIEnumerator;
+            if (pIEnumerator /* paranoia */)
+                pIEnumerator->AddRef();
+        }
+        RTCritSectLeave(&m_CritSect);
+        if (pIEnumerator)
+        {
+            /*
+             * Get the device and update it.
+             */
+            IMMDevice *pIDevice = NULL;
+            HRESULT hrc = pIEnumerator->GetDefaultAudioEndpoint(enmFlow, enmRole, &pIDevice);
+            if (SUCCEEDED(hrc))
+                setDevice(enmFlow == eRender, pIDevice, pwszDefaultDeviceId, __PRETTY_FUNCTION__);
+            else
+                LogRelMax(64, ("WasAPI: Failed to get default %s device (OnDefaultDeviceChange): %Rhrc\n",
+                               enmFlow == eRender ? "output" : "input", hrc));
+            pIEnumerator->Release();
+        }
+
         RT_NOREF(enmFlow, enmRole, pwszDefaultDeviceId);
         Log7Func(("enmFlow=%d enmRole=%d pwszDefaultDeviceId=%ls\n", enmFlow, enmRole, pwszDefaultDeviceId));
@@ -934 +1030 @@
     }
     /** @} */
+
+private:
+    /**
+     * Sets DRVHOSTAUDIOWAS::pIDeviceOutput or DRVHOSTAUDIOWAS::pIDeviceInput to @a pIDevice.
+     */
+    void setDevice(bool fOutput, IMMDevice *pIDevice, LPCWSTR pwszDeviceId, const char *pszCaller)
+    {
+        RT_NOREF(pszCaller, pwszDeviceId);
+
+        RTCritSectEnter(&m_CritSect);
+        if (m_pDrvWas)
+        {
+            if (fOutput)
+            {
+                Log7((LOG_FN_FMT ": Changing output device from %p to %p (%ls)\n",
+                      pszCaller, m_pDrvWas->pIDeviceOutput, pIDevice, pwszDeviceId));
+                if (m_pDrvWas->pIDeviceOutput)
+                    m_pDrvWas->pIDeviceOutput->Release();
+                m_pDrvWas->pIDeviceOutput = pIDevice;
+            }
+            else
+            {
+                Log7((LOG_FN_FMT ": Changing input device from %p to %p (%ls)\n",
+                      pszCaller, m_pDrvWas->pIDeviceInput, pIDevice, pwszDeviceId));
+                if (m_pDrvWas->pIDeviceInput)
+                    m_pDrvWas->pIDeviceInput->Release();
+                m_pDrvWas->pIDeviceInput = pIDevice;
+            }
+
+            /** @todo Invalid/update in-use streams. */
+        }
+        else if (pIDevice)
+            pIDevice->Release();
+        RTCritSectLeave(&m_CritSect);
+    }
 };
 
@@ -1196 +1327 @@
     /*
      * Get the device we're supposed to use.
-     */
-    PRTUTF16        pwszDevId = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pwszInputDevId : pThis->pwszOutputDevId;
-    IMMDevice      *pIDevice  = NULL;
-    HRESULT         hrc;
-    if (pwszDevId)
-        hrc = pThis->pIEnumerator->GetDevice(pwszDevId, &pIDevice);
-    else
-    {
-        /** @todo this takes about 2ms. Cache it and update it using the
-         *        notification client. */
-        hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(pCfgReq->enmDir == PDMAUDIODIR_IN ? eCapture : eRender,
-                                                           eMultimedia, &pIDevice);
-        pwszDevId = pCfgReq->enmDir == PDMAUDIODIR_IN ? L"{Default-In}" : L"{Default-Out}";
-    }
-    LogFlowFunc(("Got device %p (%Rhrc)\n", pIDevice, hrc));
-    if (FAILED(hrc))
-    {
-        LogRelMax(64, ("WasAPI: Failed to open audio %s device '%ls': %Rhrc\n", pszStreamType, pwszDevId, hrc));
-        return VERR_AUDIO_STREAM_COULD_NOT_CREATE;
+     * (We cache this as it takes ~2ms to get the default device on a random W10 19042 system.)
+     */
+    pThis->pNotifyClient->lockEnter();
+    IMMDevice *pIDevice = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pIDeviceInput : pThis->pIDeviceOutput;
+    if (pIDevice)
+        pIDevice->AddRef();
+    pThis->pNotifyClient->lockLeave();
+
+    PRTUTF16       pwszDevId     = pCfgReq->enmDir == PDMAUDIODIR_IN ? pThis->pwszInputDevId : pThis->pwszOutputDevId;
+    PRTUTF16 const pwszDevIdDesc = pwszDevId ? pwszDevId : pCfgReq->enmDir == PDMAUDIODIR_IN ? L"{Default-In}" : L"{Default-Out}";
+    if (!pIDevice)
+    {
+        /** @todo we can eliminate this too...   */
+        HRESULT hrc;
+        if (pwszDevId)
+            hrc = pThis->pIEnumerator->GetDevice(pwszDevId, &pIDevice);
+        else
+            hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(pCfgReq->enmDir == PDMAUDIODIR_IN ? eCapture : eRender,
+                                                               eMultimedia, &pIDevice);
+        LogFlowFunc(("Got device %p (%Rhrc)\n", pIDevice, hrc));
+        if (FAILED(hrc))
+        {
+            LogRelMax(64, ("WasAPI: Failed to open audio %s device '%ls': %Rhrc\n", pszStreamType, pwszDevIdDesc, hrc));
+            return VERR_AUDIO_STREAM_COULD_NOT_CREATE;
+        }
     }
 
@@ -1252 +1389 @@
         }
 
-        LogRelMax(64, ("WasAPI: Failed to create critical section for stream.\n", hrc));
+        LogRelMax(64, ("WasAPI: Failed to create critical section for stream.\n"));
         drvHostAudioWasCachePutBack(pThis, pDevCfg);
         pStreamWas->pDevCfg = NULL;
     }
     else
-        LogRelMax(64, ("WasAPI: Failed to activate %s audio device '%ls': %Rhrc\n", pszStreamType, pwszDevId, hrc));
+        LogRelMax(64, ("WasAPI: Failed to setup %s on audio device '%ls'.\n", pszStreamType, pwszDevIdDesc));
 
     LogFlowFunc(("returns %Rrc\n", rc));
@@ -2156 +2293 @@
     }
 
+    if (pThis->pIDeviceOutput)
+    {
+        pThis->pIDeviceOutput->Release();
+        pThis->pIDeviceOutput = NULL;
+    }
+
+    if (pThis->pIDeviceInput)
+    {
+        pThis->pIDeviceInput->Release();
+        pThis->pIDeviceInput = NULL;
+    }
+
     if (RTCritSectRwIsInitialized(&pThis->CritSectStreamList))
         RTCritSectRwDelete(&pThis->CritSectStreamList);
@@ -2268 +2417 @@
         pThis->pNotifyClient = NULL;
     }
+
+    /*
+     * Retrieve the input and output device.
+     */
+    IMMDevice *pIDeviceInput = NULL;
+    if (pThis->pwszInputDevId)
+        hrc = pThis->pIEnumerator->GetDevice(pThis->pwszInputDevId, &pIDeviceInput);
+    else
+        hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(eCapture, eMultimedia, &pIDeviceInput);
+    if (SUCCEEDED(hrc))
+        LogFlowFunc(("pIDeviceInput=%p\n", pIDeviceInput));
+    else
+    {
+        LogRel(("WasAPI: Failed to get audio input device '%ls': %Rhrc\n",
+                pThis->pwszInputDevId ? pThis->pwszInputDevId : L"{Default}", hrc));
+        pIDeviceInput = NULL;
+    }
+
+    IMMDevice *pIDeviceOutput = NULL;
+    if (pThis->pwszOutputDevId)
+        hrc = pThis->pIEnumerator->GetDevice(pThis->pwszOutputDevId, &pIDeviceOutput);
+    else
+        hrc = pThis->pIEnumerator->GetDefaultAudioEndpoint(eRender, eMultimedia, &pIDeviceOutput);
+    if (SUCCEEDED(hrc))
+        LogFlowFunc(("pIDeviceOutput=%p\n", pIDeviceOutput));
+    else
+    {
+        LogRel(("WasAPI: Failed to get audio output device '%ls': %Rhrc\n",
+                pThis->pwszOutputDevId ? pThis->pwszOutputDevId : L"{Default}", hrc));
+        pIDeviceOutput = NULL;
+    }
+
+    /* Carefully place them in the instance data:  */
+    pThis->pNotifyClient->lockEnter();
+
+    if (pThis->pIDeviceInput)
+        pThis->pIDeviceInput->Release();
+    pThis->pIDeviceInput = pIDeviceInput;
+
+    if (pThis->pIDeviceOutput)
+        pThis->pIDeviceOutput->Release();
+    pThis->pIDeviceOutput = pIDeviceOutput;
+
+    pThis->pNotifyClient->lockLeave();
 
     /*