Added sound channel group for menu sounds and used it when an activity isn't running, so immobile sounds in game are separated and can thus be paused separately

Author: garethyr

Entities/Activity.cpp

@@ -333,7 +333,7 @@ void Activity::Clear() {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	void Activity::End() {
-		g_AudioMan.FinishAllLoopingSounds();
+		g_AudioMan.FinishIngameLoopingSounds();
 		// Actor control is automatically disabled when players are set to observation mode, so no need to do anything directly.
 		for (int player = Players::PlayerOne; player < Players::MaxPlayerCount; ++player) {
 			m_ViewState[player] = ViewState::Observe;

Managers/ActivityMan.cpp

@@ -328,7 +328,7 @@ namespace RTE {
 
 		m_LastMusicPath = "";
 		m_LastMusicPos = 0;
-		g_AudioMan.PauseAllSounds(false);
+		g_AudioMan.PauseIngameSounds(false);
 
 		return error;
 	}
@@ -378,7 +378,7 @@ namespace RTE {
 
 			m_Activity->SetPaused(pause);
 			m_InActivity = !pause;
-			g_AudioMan.PauseAllSounds(pause);
+			g_AudioMan.PauseIngameSounds(pause);
 			g_ConsoleMan.PrintString("SYSTEM: Activity \"" + m_Activity->GetPresetName() + "\" was " + (pause ? "paused" : "resumed"));
 		} else {
 			g_ConsoleMan.PrintString("ERROR: No Activity to pause!");

Managers/AudioMan.cpp

@@ -69,10 +69,12 @@ namespace RTE {
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("Sounds", &m_SoundChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("MobileSounds", &m_MobileSoundChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("ImmobileSounds", &m_ImmobileSoundChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("MenuSounds", &m_MenuSoundChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_MusicChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_SoundChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_SoundChannelGroup->addGroup(m_MobileSoundChannelGroup) : audioSystemSetupResult;
 		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_SoundChannelGroup->addGroup(m_ImmobileSoundChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_SoundChannelGroup->addGroup(m_MenuSoundChannelGroup) : audioSystemSetupResult;
 
 		m_AudioEnabled = audioSystemSetupResult == FMOD_OK;
 
@@ -244,7 +246,7 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-    void AudioMan::FinishAllLoopingSounds() {
+    void AudioMan::FinishIngameLoopingSounds() {
 		if (m_AudioEnabled) {
 			int numberOfPlayingChannels;
 			FMOD::Channel *soundChannel;
@@ -575,7 +577,14 @@ namespace RTE {
 			g_ConsoleMan.PrintString("Unable to select new sounds to play for SoundContainer " + soundContainer->GetPresetName());
 			return false;
 		}
-		FMOD::ChannelGroup *channelGroupToPlayIn = soundContainer->IsImmobile() ? m_ImmobileSoundChannelGroup : m_MobileSoundChannelGroup;
+
+		FMOD::ChannelGroup *channelGroupToPlayIn;
+		if (g_ActivityMan.ActivityRunning()) {
+			channelGroupToPlayIn = soundContainer->IsImmobile() ? m_ImmobileSoundChannelGroup : m_MobileSoundChannelGroup;
+		} else {
+			channelGroupToPlayIn = m_MenuSoundChannelGroup;
+		}
+
 		FMOD::Channel *channel;
 		int channelIndex;
 		std::vector<const SoundSet::SoundData *> selectedSoundData;

Managers/AudioMan.h

@@ -295,7 +295,13 @@ namespace RTE {
 		/// <summary>
 		/// Makes all sounds that are looping stop looping, allowing them to play once more then be finished.
 		/// </summary>
-		void FinishAllLoopingSounds();
+		void FinishIngameLoopingSounds();
+
+		/// <summary>
+		/// Pauses all ingame sounds.
+		/// <param name="pause">Whether to pause sounds or resume them.</param>
+		/// </summary>
+		void PauseIngameSounds(bool pause = true) { if (m_AudioEnabled) { m_MobileSoundChannelGroup->setPaused(pause); m_ImmobileSoundChannelGroup->setPaused(pause); } }
 #pragma endregion
 
 #pragma region Music Playback and Handling
@@ -336,14 +342,6 @@ namespace RTE {
 		void ClearMusicQueue() { m_MusicPlayList.clear(); }
 #pragma endregion
 
-#pragma region Mobile Sound Playback and Handling
-		/// <summary>
-		/// Pauses all sound playback.
-		/// <param name="pause">Whether to pause sounds or resume them.</param>
-		/// </summary>
-		void PauseAllSounds(bool pause = true) { if (m_AudioEnabled) { m_MobileSoundChannelGroup->setPaused(pause); m_ImmobileSoundChannelGroup->setPaused(pause); } }
-#pragma endregion
-
 #pragma region Lua Sound File Playing
 		/// <summary>
 		/// Starts playing a certain sound file.
@@ -440,6 +438,7 @@ namespace RTE {
 		FMOD::ChannelGroup *m_SoundChannelGroup; //!< The FMOD ChannelGroup for sounds.
 		FMOD::ChannelGroup *m_MobileSoundChannelGroup; //!< The FMOD ChannelGroup for mobile sounds.
 		FMOD::ChannelGroup *m_ImmobileSoundChannelGroup; //!< The FMOD ChannelGroup for immobile sounds.
+		FMOD::ChannelGroup *m_MenuSoundChannelGroup; //!< The FMOD ChannelGroup for immobile sounds.
 
 		bool m_AudioEnabled; //!< Bool to tell whether audio is enabled or not.
 		std::vector<std::unique_ptr<const Vector>> m_CurrentActivityHumanPlayerPositions; //!< The stored positions of each human player in the current activity. Only filled when there's an activity running.