Added setting to mute audio on focus loss

Author: Causeless

CHANGELOG.md

@@ -85,8 +85,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Attachable` INI and Lua (R/W) properties `InheritsVelWhenDetached` and `InheritsAngularVelWhenDetached`, which determine how much of these velocities an attachable inherits from its parent when detached. Defaults to 1.
 
-- New GPU Renderer using OpenGL+Raylib, draw now takes 0ms in pretty much every instance.
-
 - New Z Order for scene layers and primitives: Background layer sits at z=100, Terrain Background at z=50, Terrain color and MO color at z=0, GUIs sit at z=-100, allowed z range is [-200, +200], in the future this'll be expanded to MO draw as well.
 - Added Lua-accessible bitmap manipulation functions to `MOSprite`s:	
 	```
@@ -138,6 +136,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	```
 	Original bindings with no scale argument are untouched and can be called as they were.
 
+- New option to mute audio when the game window loses focus.
+
 </details>
 
 <details><summary><b>Changed</b></summary>
@@ -152,6 +152,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	Savefiles have the extension `.ccsave`, but their underlying format is really just a `.zip` file. This can be opened and modified as before with any zip file viewer.
 	These savefiles can be safely renamed and moved without breaking the savegame, unlike before.
 
+- New GPU Renderer using now OpenGL + Raylib, dramatically improving draw performance. Draw now takes a negligible amount of time.
+
 - All vanilla scenario activities have had their settings polished, respecting settings which make sense and disabling settings which don't.
 	You can now have fog of war in the test scene, and can no longer require path to orbit in Zero-G Diggers-Only One Man Army.
 

Data/Base.rte/GUIs/SettingsGUI.ini

@@ -713,6 +713,20 @@ Anchor = Left, Top
 Checked = Unchecked
 Text = Mute
 
+[CheckboxMuteAudioOnFocusLoss]
+ControlType = CHECKBOX
+Parent = CollectionBoxAudioSettings
+X = 145
+Y = 189
+Width = 120
+Height = 20
+Visible = True
+Enabled = True
+Name = CheckboxMuteAudioOnFocusLoss
+Anchor = Middle, Top
+Checked = Unchecked
+Text = Mute On Focus Loss?
+
 ///////////////////////////////////////////////////////////////////////
 // Input Settings Menu
 

Data/Base.rte/GUIs/SettingsPauseGUI.ini

@@ -714,6 +714,20 @@ Anchor = Left, Top
 Checked = Unchecked
 Text = Mute
 
+[CheckboxMuteAudioOnFocusLoss]
+ControlType = CHECKBOX
+Parent = CollectionBoxAudioSettings
+X = 145
+Y = 189
+Width = 120
+Height = 20
+Visible = True
+Enabled = True
+Name = CheckboxMuteAudioOnFocusLoss
+Anchor = Middle, Top
+Checked = Unchecked
+Text = Mute On Focus Loss?
+
 ///////////////////////////////////////////////////////////////////////
 // Input Settings Menu
 

Source/Managers/AudioMan.cpp

@@ -9,6 +9,7 @@
 #include "SoundContainer.h"
 #include "GUISound.h"
 #include "PresetMan.h"
+#include "WindowMan.h"
 #include "SoundSet.h"
 
 #include <cstring>
@@ -138,9 +139,14 @@ void AudioMan::Destroy() {
 
 void AudioMan::Update() {
 	if (m_AudioEnabled) {
-
 		FMOD_RESULT status = FMOD_OK;
 
+		if (m_MuteAudioOnFocusLoss && !g_WindowMan.AnyWindowHasFocus()) {
+			m_MasterChannelGroup->setMute(true);
+		} else {
+			m_MasterChannelGroup->setMute(m_MuteMaster);
+		}
+
 		float globalPitch = 1.0F;
 
 		float timeScale = g_TimerMan.GetTimeScale();

Source/Managers/AudioMan.h

@@ -151,6 +151,14 @@ namespace RTE {
 			}
 		}
 
+		/// Gets whether to mute all audio when the game loses focus.
+		/// @returns Whether to mute all audio when the game loses focus.
+		bool GetMuteAudioOnFocusLoss() const { return m_MuteAudioOnFocusLoss; }
+
+		/// Sets whether to mute all audio when the game loses focus.
+		/// @param mute Whether to mute all audio when the game loses focus.
+		void SetMuteAudioOnFocusLoss(bool mute) { m_MuteAudioOnFocusLoss = mute; }
+
 		/// Gets the global pitch scalar value for all sounds and music.
 		/// @return The current pitch scalar. Will be > 0.
 		float GetGlobalPitch() const { return m_GlobalPitch; }
@@ -326,6 +334,7 @@ namespace RTE {
 		bool m_MuteMaster; //!< Whether all the audio is muted.
 		bool m_MuteMusic; //!< Whether the music channel is muted.
 		bool m_MuteSounds; //!< Whether all the sound effects channels are muted.
+		bool m_MuteAudioOnFocusLoss; //!< Whether audio should be muted when the game loses focus.
 		float m_MasterVolume; //!< Global volume of all audio.
 		float m_MusicVolume; //!< Global music volume.
 		float m_SoundsVolume; //!< Global sounds effects volume.

Source/Managers/SettingsMan.cpp

@@ -121,6 +121,7 @@ int SettingsMan::ReadProperty(const std::string_view& propName, Reader& reader)
 	MatchProperty("MuteMusic", { reader >> g_AudioMan.m_MuteMusic; });
 	MatchProperty("SoundVolume", { g_AudioMan.SetSoundsVolume(std::stof(reader.ReadPropValue()) / 100.0F); });
 	MatchProperty("MuteSounds", { reader >> g_AudioMan.m_MuteSounds; });
+	MatchProperty("MuteAudioOnFocusLoss", { reader >> g_AudioMan.m_MuteAudioOnFocusLoss; });
 	MatchProperty("SoundPanningEffectStrength", {
 		reader >> g_AudioMan.m_SoundPanningEffectStrength;
 
@@ -230,6 +231,7 @@ int SettingsMan::Save(Writer& writer) const {
 	writer.NewPropertyWithValue("MuteMusic", g_AudioMan.m_MuteMusic);
 	writer.NewPropertyWithValue("SoundVolume", g_AudioMan.m_SoundsVolume * 100);
 	writer.NewPropertyWithValue("MuteSounds", g_AudioMan.m_MuteSounds);
+	writer.NewPropertyWithValue("MuteAudioOnFocusLoss", g_AudioMan.m_MuteAudioOnFocusLoss);
 	writer.NewPropertyWithValue("SoundPanningEffectStrength", g_AudioMan.m_SoundPanningEffectStrength);
 
 	//////////////////////////////////////////////////

Source/Menus/SettingsAudioGUI.cpp

@@ -28,6 +28,9 @@ SettingsAudioGUI::SettingsAudioGUI(GUIControlManager* parentControlManager) :
 	m_SoundMuteCheckbox = dynamic_cast<GUICheckbox*>(m_GUIControlManager->GetControl("CheckboxMuteSound"));
 	m_SoundMuteCheckbox->SetCheck(g_AudioMan.GetSoundsMuted());
 
+	m_MuteOnFocusLossCheckbox = dynamic_cast<GUICheckbox*>(m_GUIControlManager->GetControl("CheckboxMuteAudioOnFocusLoss"));
+	m_MuteOnFocusLossCheckbox->SetCheck(g_AudioMan.GetMuteAudioOnFocusLoss());
+
 	UpdateMasterVolumeControls();
 	UpdateMusicVolumeControls();
 	UpdateSoundVolumeControls();
@@ -81,6 +84,8 @@ void SettingsAudioGUI::HandleInputEvents(GUIEvent& guiEvent) {
 			g_AudioMan.SetMusicMuted(m_MusicMuteCheckbox->GetCheck());
 		} else if (guiEvent.GetControl() == m_SoundMuteCheckbox) {
 			g_AudioMan.SetSoundsMuted(m_SoundMuteCheckbox->GetCheck());
+		} else if (guiEvent.GetControl() == m_MuteOnFocusLossCheckbox) {
+			g_AudioMan.SetMuteAudioOnFocusLoss(m_MuteOnFocusLossCheckbox->GetCheck());
 		}
 	}
 }

Source/Menus/SettingsAudioGUI.h

@@ -43,6 +43,7 @@ namespace RTE {
 		GUILabel* m_SoundVolumeLabel;
 		GUISlider* m_SoundVolumeSlider;
 		GUICheckbox* m_SoundMuteCheckbox;
+		GUICheckbox* m_MuteOnFocusLossCheckbox;
 
 #pragma region Audio Settings Handling
 		/// Updates the position of the master volume slider and volume value label, based on what the AudioMan is currently set to.