Audio mute options (#2504)

* Audio mute toggle hotkey

* Mute while fastforwarding option

* Fix capitalization in "Toggle audio mute"

Author: nico-abram

src/frontend/qt_sdl/Config.cpp

@@ -307,6 +307,7 @@ LegacyEntry LegacyFile[] =
     {"MouseHide",        1, "Mouse.Hide", false},
     {"MouseHideSeconds", 0, "Mouse.HideSeconds", false},
     {"PauseLostFocus",   1, "PauseLostFocus", false},
+    {"MuteFastForward",   1, "MuteFastForward", false},
     {"UITheme",          2, "UITheme", false},
 
     {"RTCOffset",       3, "RTC.Offset", true},

src/frontend/qt_sdl/EmuInstance.h

@@ -48,6 +48,7 @@ enum
     HK_PowerButton,
     HK_VolumeUp,
     HK_VolumeDown,
+    HK_AudioMuteToggle,
     HK_SlowMo,
     HK_FastForwardToggle,
     HK_SlowMoToggle,
@@ -222,7 +223,9 @@ class EmuInstance
     void audioDeInit();
     void audioEnable();
     void audioDisable();
-    void audioMute();
+    void updateAudioMuteByWindowFocus();
+    void toggleAudioMute();
+    void updateFastForwardMute(bool fastForward);
     void audioSync();
     void audioUpdateSettings();
 
@@ -313,7 +316,9 @@ class EmuInstance
     int audioFreq;
     int audioBufSize;
     float audioSampleFrac;
-    bool audioMuted;
+    bool audioMutedToggle;
+    bool audioMutedByFastForward;
+    bool audioMutedByWindowFocus;
     SDL_cond* audioSyncCond;
     SDL_mutex* audioSyncLock;
 

src/frontend/qt_sdl/EmuInstanceAudio.cpp

@@ -36,7 +36,9 @@ void EmuInstance::audioInit()
     audioVolume = localCfg.GetInt("Audio.Volume");
     audioDSiVolumeSync = localCfg.GetBool("Audio.DSiVolumeSync");
 
-    audioMuted = false;
+    audioMutedToggle = false;
+    audioMutedByFastForward = false;
+    audioMutedByWindowFocus = false;
     audioSyncCond = SDL_CreateCond();
     audioSyncLock = SDL_CreateMutex();
 
@@ -97,32 +99,42 @@ void EmuInstance::audioDeInit()
     micLock = nullptr;
 }
 
-void EmuInstance::audioMute()
+void EmuInstance::updateAudioMuteByWindowFocus()
 {
-    audioMuted = false;
+    audioMutedByWindowFocus = false;
     if (numEmuInstances() < 2) return;
 
     switch (mpAudioMode)
     {
         case 1: // only instance 1
-            if (instanceID > 0) audioMuted = true;
+            if (instanceID > 0) audioMutedByWindowFocus = true;
             break;
 
         case 2: // only currently focused instance
-            audioMuted = true;
+            audioMutedByWindowFocus = true;
             for (int i = 0; i < kMaxWindows; i++)
             {
                 if (!windowList[i]) continue;
                 if (windowList[i]->isFocused())
                 {
-                    audioMuted = false;
+                    audioMutedByWindowFocus = false;
                     break;
                 }
             }
             break;
     }
 }
 
+void EmuInstance::toggleAudioMute()
+{
+    audioMutedToggle = !audioMutedToggle;
+}
+
+void EmuInstance::updateFastForwardMute(bool fastForward)
+{
+    audioMutedByFastForward = fastForward && globalCfg.GetBool("MuteFastForward");
+}
+
 void EmuInstance::audioSync()
 {
     if (audioDevice)
@@ -164,7 +176,7 @@ void EmuInstance::audioCallback(void* data, Uint8* stream, int len)
     SDL_CondSignal(inst->audioSyncCond);
     SDL_UnlockMutex(inst->audioSyncLock);
 
-    if ((num_in < 1) || inst->audioMuted)
+    if ((num_in < 1) || inst->audioMutedByWindowFocus || inst->audioMutedToggle || inst->audioMutedByFastForward)
     {
         memset(stream, 0, len*sizeof(s16)*2);
         return;

src/frontend/qt_sdl/EmuInstanceInput.cpp

@@ -60,6 +60,7 @@ const char* EmuInstance::hotkeyNames[HK_MAX] =
     "HK_PowerButton",
     "HK_VolumeUp",
     "HK_VolumeDown",
+    "HK_AudioMuteToggle",
     "HK_SlowMo",
     "HK_FastForwardToggle",
     "HK_SlowMoToggle",

src/frontend/qt_sdl/EmuThread.cpp

@@ -344,6 +344,8 @@ void EmuThread::run()
             if (emuInstance->hotkeyPressed(HK_FastForwardToggle)) emuInstance->fastForwardToggled = !emuInstance->fastForwardToggled;
             if (emuInstance->hotkeyPressed(HK_SlowMoToggle)) emuInstance->slowmoToggled = !emuInstance->slowmoToggled;
 
+            if (emuInstance->hotkeyPressed(HK_AudioMuteToggle)) emuInstance->toggleAudioMute();
+
             bool enablefastforward = emuInstance->hotkeyDown(HK_FastForward) | emuInstance->fastForwardToggled;
             bool enableslowmo = emuInstance->hotkeyDown(HK_SlowMo) | emuInstance->slowmoToggled;
 
@@ -362,6 +364,7 @@ void EmuThread::run()
 
             fastforward = enablefastforward;
             slowmo = enableslowmo;
+            emuInstance->updateFastForwardMute(fastforward);
 
             if (slowmo) emuInstance->curFPS = emuInstance->slowmoFPS;
             else if (fastforward) emuInstance->curFPS = emuInstance->fastForwardFPS;

src/frontend/qt_sdl/InputConfig/InputConfigDialog.h

@@ -67,7 +67,8 @@ static constexpr std::initializer_list<int> hk_general =
     HK_SwapScreenEmphasis,
     HK_PowerButton,
     HK_VolumeUp,
-    HK_VolumeDown
+    HK_VolumeDown,
+    HK_AudioMuteToggle
 };
 
 static constexpr std::initializer_list<const char*> hk_general_labels =
@@ -87,7 +88,8 @@ static constexpr std::initializer_list<const char*> hk_general_labels =
     "Swap screen emphasis",
     "DSi Power button",
     "DSi Volume up",
-    "DSi Volume down"
+    "DSi Volume down",
+    "Toggle audio mute"
 };
 
 static_assert(hk_general.size() == hk_general_labels.size());

src/frontend/qt_sdl/InterfaceSettingsDialog.cpp

@@ -39,6 +39,7 @@ InterfaceSettingsDialog::InterfaceSettingsDialog(QWidget* parent) : QDialog(pare
     ui->spinMouseHideSeconds->setEnabled(ui->cbMouseHide->isChecked());
     ui->spinMouseHideSeconds->setValue(cfg.GetInt("Mouse.HideSeconds"));
     ui->cbPauseLostFocus->setChecked(cfg.GetBool("PauseLostFocus"));
+    ui->cbMuteFastForward->setChecked(cfg.GetBool("MuteFastForward"));
     ui->spinTargetFPS->setValue(cfg.GetDouble("TargetFPS"));
     ui->spinFFW->setValue(cfg.GetDouble("FastForwardFPS"));
     ui->spinSlow->setValue(cfg.GetDouble("SlowmoFPS"));
@@ -118,6 +119,7 @@ void InterfaceSettingsDialog::done(int r)
         cfg.SetBool("Mouse.Hide", ui->cbMouseHide->isChecked());
         cfg.SetInt("Mouse.HideSeconds", ui->spinMouseHideSeconds->value());
         cfg.SetBool("PauseLostFocus", ui->cbPauseLostFocus->isChecked());
+        cfg.SetBool("MuteFastForward", ui->cbMuteFastForward->isChecked());
 
         double val = ui->spinTargetFPS->value();
         if (val == 0.0) cfg.SetDouble("TargetFPS", 0.0001);

src/frontend/qt_sdl/InterfaceSettingsDialog.ui

@@ -90,6 +90,13 @@
         </property>
        </widget>
       </item>
+      <item>
+       <widget class="QCheckBox" name="cbMuteFastForward">
+        <property name="text">
+         <string>Mute audio while fast forwarding</string>
+        </property>
+       </widget>
+      </item>
      </layout>
     </widget>
    </item>

src/frontend/qt_sdl/Window.cpp

@@ -1073,7 +1073,7 @@ void MainWindow::onFocusIn()
 {
     focused = true;
     if (emuInstance)
-        emuInstance->audioMute();
+        emuInstance->updateAudioMuteByWindowFocus();
 }
 
 void MainWindow::onFocusOut()
@@ -1082,7 +1082,7 @@ void MainWindow::onFocusOut()
     // prevent use after free
     focused = false;
     if (emuInstance)
-        emuInstance->audioMute();
+        emuInstance->updateAudioMuteByWindowFocus();
 }
 
 void MainWindow::onAppStateChanged(Qt::ApplicationState state)
@@ -2004,7 +2004,7 @@ void MainWindow::onOpenMPSettings()
 void MainWindow::onMPSettingsFinished(int res)
 {
     emuInstance->mpAudioMode = globalCfg.GetInt("MP.AudioMode");
-    emuInstance->audioMute();
+    emuInstance->updateAudioMuteByWindowFocus();
     MPInterface::Get().SetRecvTimeout(globalCfg.GetInt("MP.RecvTimeout"));
 
     emuThread->emuUnpause();