[EXPLORER] Implement volume control

SigmaTel71 · SigmaTel71 · commit 030c2e511874 · 2026-02-11T22:29:07.000+03:00
diff --git a/base/shell/explorer/CMakeLists.txt b/base/shell/explorer/CMakeLists.txt
@@ -8,6 +8,7 @@ list(APPEND SOURCE
     appbar.cpp
     desktop.cpp
     explorer.cpp
+    mediabtns.cpp
     notifyiconscust.cpp
     rshell.cpp
     settings.cpp
diff --git a/base/shell/explorer/mediabtns.cpp b/base/shell/explorer/mediabtns.cpp
@@ -0,0 +1,222 @@
+/*
+ * PROJECT:     ReactOS Explorer
+ * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
+ * PURPOSE:     Backend class for media buttons
+ * COPYRIGHT:   Copyright 2026 Vitaly Orekhov <vkvo2000@vivaldi.net>
+ */
+
+#include "precomp.h"
+#include "mediabtns.h"
+
+CMultimediaBackend::CMultimediaBackend()
+{
+    m_isWinMMAvailable = false;
+
+    m_hWinMM = LoadLibraryW(L"winmm.dll");
+    if (!m_hWinMM)
+        return;
+
+    if (!WINMM_PROC(mixerOpen, pmxOpen))
+        return;
+
+    if (!WINMM_PROC(mixerClose, pmxClose))
+        return;
+
+    if (!WINMM_PROC(mixerSetControlDetails, pmxControlDetails))
+        return;
+
+    if (!WINMM_PROC(mixerGetControlDetailsW, pmxControlDetails))
+        return;
+
+    if (!WINMM_PROC(mixerGetLineInfoW, pmxLine))
+        return;
+
+    if (!WINMM_PROC(mixerGetLineControlsW, pmxLineControls))
+        return;
+    
+    if (!WINMM_PROC(waveOutGetErrorTextW, pwoGetErrText))
+        return;
+};
+
+CMultimediaBackend::~CMultimediaBackend()
+{
+    if (m_isWinMMAvailable)
+        mixerClose(m_hMixer);
+
+    CloseHandle(m_hWinMM);
+}
+
+void
+CMultimediaBackend::GetMasterMixer()
+{
+    if (m_hMixer != NULL)
+        mixerClose(m_hMixer);
+
+    WCHAR pszWinMMErrText[MAXERRORLENGTH] = {0};
+
+    MMRESULT mmres = mixerOpen(&m_hMixer, 0, NULL, 0, MIXER_OBJECTF_MIXER);
+    if (mmres != MMSYSERR_NOERROR)
+    {
+        waveOutGetErrorTextW(mmres, pszWinMMErrText, _countof(pszWinMMErrText));
+        ERR("GetMasterMixer: mixerOpen failed: %lu (%S)\n", mmres, pszWinMMErrText);
+        return;
+    }
+
+    MIXERLINEW mxln;
+    mxln.cbStruct = sizeof(mxln);
+    mxln.dwComponentType = MIXERLINE_COMPONENTTYPE_DST_SPEAKERS;
+
+    mmres = mixerGetLineInfoW((HMIXEROBJ)m_hMixer, &mxln, MIXER_OBJECTF_HMIXER | MIXER_GETLINEINFOF_COMPONENTTYPE);
+    if (mmres != MMSYSERR_NOERROR)
+    {
+        waveOutGetErrorTextW(mmres, pszWinMMErrText, _countof(pszWinMMErrText));
+        ERR("GetMasterMixer: mixerGetLineInfoW failed: %lu (%S)\n", mmres, pszWinMMErrText);
+        return;
+    }
+
+    m_dwMasterChannels = mxln.cChannels;        
+
+    MIXERLINECONTROLS mxlctrl;
+    MIXERCONTROLW mxc;
+    mxlctrl.cbStruct = sizeof(mxlctrl);
+    mxlctrl.dwLineID = mxln.dwLineID;
+    mxlctrl.dwControlID = MIXERCONTROL_CONTROLTYPE_MUTE;
+    mxlctrl.cControls = 1;
+    mxlctrl.cbmxctrl = sizeof(mxc);
+    mxlctrl.pamxctrl = &mxc;
+
+    mmres = mixerGetLineControlsW((HMIXEROBJ)m_hMixer, &mxlctrl, MIXER_OBJECTF_HMIXER | MIXER_GETLINECONTROLSF_ONEBYTYPE);
+    if (mmres != MMSYSERR_NOERROR)
+    {
+        waveOutGetErrorTextW(mmres, pszWinMMErrText, _countof(pszWinMMErrText));
+        ERR("GetMasterMixer: mixerGetLineControlsW failed retrieving Master Mute control: %lu (%S)\n", mmres, pszWinMMErrText);
+        return;
+    }
+
+    m_dwMasterMuteControlID = mxc.dwControlID;
+
+    mxlctrl.dwControlID = MIXERCONTROL_CONTROLTYPE_VOLUME;
+
+    mmres = mixerGetLineControlsW((HMIXEROBJ)m_hMixer, &mxlctrl, MIXER_OBJECTF_HMIXER | MIXER_GETLINECONTROLSF_ONEBYTYPE);
+    if (mmres != MMSYSERR_NOERROR)
+    {
+        waveOutGetErrorTextW(mmres, pszWinMMErrText, _countof(pszWinMMErrText));
+        ERR("GetMasterMixer: mixerGetLineControlsW failed retrieving Master Volume control: %lu (%S)\n", mmres, pszWinMMErrText);
+        return;
+    }
+
+    m_dwMasterVolumeID = mxc.dwControlID;
+    m_dwMasterRanges[0] = mxc.Bounds.dwMinimum;
+    m_dwMasterRanges[1] = mxc.Bounds.dwMaximum;
+    m_dwVolumeStep = (m_dwMasterRanges[1] - m_dwMasterRanges[0]) / VOLUME_STEPS_COUNT;
+
+    TRACE("GetMasterMixer: Master controls configured successfully:\n"
+          "   Master Mute dwControlID: %lu; Master Volume dwControlID %lu\n"
+          "   Master Volume channels: %lu; Master Volume value range: %lu-%lu\n"
+          "   Master Volume update step: %lu\n",
+          m_dwMasterMuteControlID, m_dwMasterVolumeID,
+          m_dwMasterChannels, m_dwMasterRanges[0], m_dwMasterRanges[1],
+          m_dwVolumeStep);
+
+    m_isWinMMAvailable = true;
+}
+
+bool
+CMultimediaBackend::Mute()
+{
+    if (!m_isWinMMAvailable)
+    {
+        WARN("CMultimediaBackend: Mixer is not available; cannot (un)mute sound. Check the prior class constructor calls\n");
+        return false;
+    }
+
+    MIXERCONTROLDETAILS mxcd;
+    MIXERCONTROLDETAILS_BOOLEAN mxcdMute;
+
+    mxcd.cbStruct = sizeof(mxcd);
+    mxcd.dwControlID = m_dwMasterMuteControlID;
+    mxcd.cChannels = 1;
+    mxcd.cMultipleItems = 0;
+    mxcd.cbDetails = sizeof(mxcdMute);
+    mxcd.paDetails = &mxcdMute;
+
+    mixerGetControlDetailsW((HMIXEROBJ)m_hMixer, &mxcd, MIXER_OBJECTF_HMIXER | MIXER_GETCONTROLDETAILSF_VALUE);
+
+    mxcdMute.fValue = !mxcdMute.fValue;
+
+    mixerSetControlDetails((HMIXEROBJ)m_hMixer, &mxcd, MIXER_OBJECTF_HMIXER | MIXER_SETCONTROLDETAILSF_VALUE);
+
+    return true;
+}
+
+bool
+CMultimediaBackend::AdjustVolume(_In_ UINT direction, _In_ HANDLE hProcessHeap)
+{
+    if (!m_isWinMMAvailable)
+    {
+        WARN("CMultimediaBackend: Mixer is not available; cannot %s volume. Check the prior class constructor calls\n",
+              direction == APPCOMMAND_VOLUME_DOWN ? "decrease" : "increase");
+        return FALSE;
+    }
+
+    MIXERCONTROLDETAILS mxcd;
+    mxcd.cbStruct = sizeof(mxcd);
+    mxcd.cMultipleItems = 0;
+
+    /* If sound is muted and we want to increase volume, we are unmuting it. */
+    if (direction == APPCOMMAND_VOLUME_UP)
+    {
+        MIXERCONTROLDETAILS_BOOLEAN mxcdMute;
+        
+        mxcd.cChannels = 1;
+        mxcd.dwControlID = m_dwMasterMuteControlID;
+        mxcd.cbDetails = sizeof(mxcdMute);
+        mxcd.paDetails = &mxcdMute;
+        mxcdMute.fValue = false;
+
+        mixerSetControlDetails((HMIXEROBJ)m_hMixer, &mxcd, MIXER_OBJECTF_HMIXER | MIXER_SETCONTROLDETAILSF_VALUE);
+    }
+
+    PMIXERCONTROLDETAILS_UNSIGNED mxcdVolume =
+        (PMIXERCONTROLDETAILS_UNSIGNED)HeapAlloc(hProcessHeap,
+                                                 0,
+                                                 m_dwMasterChannels * sizeof(*mxcdVolume));
+
+    if (mxcdVolume == NULL)
+    {
+        ERR("CMultimediaBackend: HeapAlloc failed, requested %lu bytes\n", m_dwMasterChannels * sizeof(*mxcdVolume));
+        return FALSE;
+    }
+
+    mxcd.cChannels = m_dwMasterChannels;
+    mxcd.dwControlID = m_dwMasterVolumeID;
+    mxcd.cbDetails = sizeof(*mxcdVolume);
+    mxcd.paDetails = mxcdVolume;
+
+    mixerGetControlDetailsW((HMIXEROBJ)m_hMixer, &mxcd, MIXER_OBJECTF_HMIXER | MIXER_GETCONTROLDETAILSF_VALUE);
+
+    /* TODO: implement restoring balance between channels when all channels were put to 0 */
+    for (DWORD i = 0; i < m_dwMasterChannels; ++i)
+    {                            
+        if (direction == APPCOMMAND_VOLUME_DOWN)
+        {
+            /* Protecting from underflow when decreasing volume */
+            if (mxcdVolume[i].dwValue < m_dwVolumeStep)
+                mxcdVolume[i].dwValue = 0;
+            else
+                mxcdVolume[i].dwValue -= m_dwVolumeStep;
+        }
+        else
+        {
+            /* Protecting from overflow when increasing volume */
+            if (m_dwMasterRanges[1] - mxcdVolume[i].dwValue < m_dwVolumeStep)
+                mxcdVolume[i].dwValue = m_dwMasterRanges[1];
+            else
+                mxcdVolume[i].dwValue += m_dwVolumeStep;
+        }
+    }
+
+    mixerSetControlDetails((HMIXEROBJ)m_hMixer, &mxcd, MIXER_OBJECTF_HMIXER | MIXER_SETCONTROLDETAILSF_VALUE);
+    HeapFree(hProcessHeap, 0, mxcdVolume);
+    return TRUE;
+}
diff --git a/base/shell/explorer/mediabtns.h b/base/shell/explorer/mediabtns.h
@@ -0,0 +1,50 @@
+/*
+ * PROJECT:     ReactOS Explorer
+ * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
+ * PURPOSE:     Backend class for media buttons (header)
+ * COPYRIGHT:   Copyright 2026 Vitaly Orekhov <vkvo2000@vivaldi.net>
+ */
+
+typedef MMRESULT (WINAPI* pmxControlDetails)(HMIXEROBJ hmxobj, LPMIXERCONTROLDETAILS pmxcd, DWORD fdwDetails);
+typedef MMRESULT (WINAPI* pmxLine)(HMIXEROBJ hmxobj, LPMIXERLINEW pmxcd, DWORD fdwDetails);
+typedef MMRESULT (WINAPI* pmxLineControls)(HMIXEROBJ hmxobj, LPMIXERLINECONTROLSW pmxcd, DWORD fdwDetails);
+typedef MMRESULT (WINAPI* pmxOpen)(LPHMIXER phmx, UINT uMxId, DWORD_PTR dwCallback, DWORD_PTR dwInstance, DWORD fdwOpen);
+typedef MMRESULT (WINAPI* pmxClose)(HMIXER hmx);
+typedef MMRESULT (WINAPI* pwoGetErrText)(MMRESULT mmrError, LPWSTR pszText, UINT cchText);
+#define WINMM_PROC(func, type) ((func) = (type)GetProcAddress(m_hWinMM, #func))
+
+/* Media volume buttons must be synchronized with sndvol32 meters */
+#define VOLUME_STEPS_COUNT 25
+
+class CMultimediaBackend
+{
+public:
+    CMultimediaBackend();
+    ~CMultimediaBackend();
+    CMultimediaBackend(CMultimediaBackend&) = delete;
+    CMultimediaBackend(CMultimediaBackend&&) = delete;
+    CMultimediaBackend& operator=(CMultimediaBackend&) = delete;
+    CMultimediaBackend& operator=(CMultimediaBackend&&) = delete;
+
+    void GetMasterMixer();
+    bool Mute();
+    bool AdjustVolume(_In_ UINT direction, _In_ HANDLE hProcessHeap);
+
+private:
+    pmxControlDetails mixerSetControlDetails;
+    pmxControlDetails mixerGetControlDetailsW;
+    pmxLine mixerGetLineInfoW;
+    pmxLineControls mixerGetLineControlsW;
+    pmxOpen mixerOpen;
+    pmxClose mixerClose;
+    pwoGetErrText waveOutGetErrorTextW;
+ 
+    HMODULE m_hWinMM;
+    HMIXER m_hMixer = NULL;
+    DWORD m_dwMasterMuteControlID;
+    DWORD m_dwMasterVolumeID;
+    DWORD m_dwMasterChannels;
+    DWORD m_dwMasterRanges[2];
+    DWORD m_dwVolumeStep;
+    bool m_isWinMMAvailable;    
+};
diff --git a/base/shell/explorer/precomp.h b/base/shell/explorer/precomp.h
@@ -31,6 +31,7 @@
 #include <atlstr.h>
 #include <atlcoll.h>
 #include <atlsimpcoll.h>
+#include <mmddk.h>
 #include <shellapi.h>
 #include <shlobj.h>
 #include <shlwapi.h>
diff --git a/base/shell/explorer/taskswnd.cpp b/base/shell/explorer/taskswnd.cpp
@@ -7,6 +7,7 @@
  */
 
 #include "precomp.h"
+#include "mediabtns.h"
 #include <commoncontrols.h>
 #include <regstr.h>
 #include <shlwapi_undoc.h>
@@ -1530,6 +1531,10 @@ class CTaskSwitchWnd :
 #if DUMP_TASKS != 0
         SetTimer(hwnd, 1, 5000, NULL);
 #endif
+
+        /* WinMM is needed to change system volume via media buttons */
+        Mixer.GetMasterMixer();
+
         return TRUE;
     }
 
@@ -1598,12 +1603,12 @@ class CTaskSwitchWnd :
             return TRUE;
         switch (uAppCmd)
         {
+            // When MMDevAPI arrives, try IMMDeviceEnumerator::GetDefaultAudioEndpoint first and then fall back to WinMM.
             case APPCOMMAND_VOLUME_MUTE:
+                return Mixer.Mute();
             case APPCOMMAND_VOLUME_DOWN:
             case APPCOMMAND_VOLUME_UP:
-                // TODO: Try IMMDeviceEnumerator::GetDefaultAudioEndpoint first and then fall back to mixer.
-                FIXME("Call the mixer API to change the global volume\n");
-                return TRUE;
+                return Mixer.AdjustVolume(uAppCmd, hProcessHeap);
             case APPCOMMAND_BROWSER_SEARCH:
                 return SHFindFiles(NULL, NULL);
         }
@@ -2279,6 +2284,9 @@ class CTaskSwitchWnd :
     BEGIN_COM_MAP(CTaskSwitchWnd)
         COM_INTERFACE_ENTRY_IID(IID_IOleWindow, IOleWindow)
     END_COM_MAP()
+
+private:
+    CMultimediaBackend Mixer;
 };
 
 HRESULT CTaskSwitchWnd_CreateInstance(IN HWND hWndParent, IN OUT ITrayWindow *Tray, REFIID riid, void **ppv)
