Fixed SoundContainer::SelectNextSound to work with changed data structuring. Also fixed cleared-to priority being low instead of normal.

Fixed sound stop callback in AudioMan breaking if the sound was reset before the callback happened (e.g. gib sounds). Made number of channels a constant instead of a settings entry, since it's dumb to have it settable.
Cleaned up various things in AudioMan - renamed distance to attenuation, Reorganized StopSound so there's an easy one for lua that stops all sounds and calls the player specific one and fixed iterator invalidation when stopping sound due to callback erasing it, fixed mutex positioning, made PlaySound iterate through all selected sound objects in a SoundContainer and added error print if it fails to select new sounds

Author: garethyr

Entities/SoundContainer.cpp

@@ -12,7 +12,7 @@ namespace RTE {
 		m_SelectedSounds.clear();
 		m_PlayingChannels.clear();
 		m_Loops = 0;
-		m_Priority = AudioMan::PRIORITY_LOW;
+		m_Priority = AudioMan::PRIORITY_NORMAL;
 		m_AffectedByGlobalPitch = true;
 	}
 
@@ -105,21 +105,32 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	FMOD::Sound *SoundContainer::SelectNextSound() {
+	bool SoundContainer::SelectNextSounds() {
 		int soundCount = GetSoundCount();
-		if (soundCount == 2) {
-			m_CurrentSound = m_CurrentSound == 0 ? 1 : 0; // Alternate between 2 sounds
-		} else if (soundCount > 2) {
-			int lastSound = m_CurrentSound;
-			m_CurrentSound = floorf((float)soundCount * PosRand());
-			// Mix it up again if we got the same sound twice
-			while (m_CurrentSound == lastSound) {
-				m_CurrentSound = floorf((float)soundCount * PosRand());
+		if (soundCount == 0) {
+			return false;
+		}
+
+		std::size_t previouslySelectedSound = m_SelectedSounds.size() > 0 ? m_SelectedSounds[0] : 0;
+
+		if (m_SelectedSounds.empty() || soundCount == 1) {
+			m_SelectedSounds.clear();
+			m_SelectedSounds.push_back(previouslySelectedSound);
+		} else {
+			m_SelectedSounds.clear();
+			if (soundCount == 2) {
+				m_SelectedSounds.push_back((previouslySelectedSound + 1) % soundCount);
+			} else if (soundCount > 2) {
+				size_t soundToSelect = floorf((float)soundCount * PosRand());
+				// Mix it up again if we got the same sound twice
+				while (soundToSelect == previouslySelectedSound) {
+					soundToSelect = floorf((float)soundCount * PosRand());
+				}
+				m_SelectedSounds.push_back(soundToSelect);
 			}
 		}
-		RTEAssert(m_CurrentSound >= 0 && m_CurrentSound < soundCount, "Sample index is out of bounds!");
+		RTEAssert(m_SelectedSounds.size() > 0 && m_SelectedSounds[0] >= 0 && m_SelectedSounds[0] < soundCount, "Failed to select next sound, either none was selected or the selected sound was invalid.");
 
-		FMOD::Sound *soundToStart;
-		return m_Sounds[m_CurrentSound].second;
+		return true;
 	}
 }

Managers/AudioMan.cpp

@@ -24,13 +24,14 @@ namespace RTE {
 			int channelIndex;
 			FMOD_RESULT result = channel->getIndex(&channelIndex);
 
+			// Remove this playing sound index from the SoundContainer if it has any playing sounds, i.e. it hasn't been reset before this callback happened.
 			void *userData;
-			result == FMOD_OK ? channel->getUserData(&userData) : result;
+			result = result == FMOD_OK ? channel->getUserData(&userData) : result;
 			SoundContainer *channelSoundContainer = (SoundContainer *)userData;
-			//Account for PlaySound that doesn't create a SoundContainer
-			if (channelSoundContainer != NULL) {
+			if (channelSoundContainer->GetPlayingSoundCount() > 0) {
 				channelSoundContainer->RemovePlayingChannel(channelIndex);
 			}
+			result = result == FMOD_OK ? channel->setUserData(NULL) : result;
 
 			if (result != FMOD_OK) {
 				g_ConsoleMan.PrintString("ERROR: An error occurred when Ending a sound in SoundContainer " + channelSoundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
@@ -69,7 +70,7 @@ namespace RTE {
 		//TODO 44.1 kHz came from data, fmod defaults to 48 kHz, see if we can just use this instead??
 		m_AudioSystem->setSoftwareFormat(44100, FMOD_SPEAKERMODE_DEFAULT, 0);
 
-		soundSystemSetupResult = soundSystemSetupResult == FMOD_OK ? m_AudioSystem->init(g_SettingsMan.GetAudioChannels(), FMOD_INIT_NORMAL, 0) : soundSystemSetupResult;
+		soundSystemSetupResult = soundSystemSetupResult == FMOD_OK ? m_AudioSystem->init(c_NumberOfAudioChannels, FMOD_INIT_NORMAL, 0) : soundSystemSetupResult;
 		soundSystemSetupResult = soundSystemSetupResult == FMOD_OK ? m_AudioSystem->getMasterChannelGroup(&m_MasterChannelGroup) : soundSystemSetupResult;
 		soundSystemSetupResult = soundSystemSetupResult == FMOD_OK ? m_AudioSystem->createChannelGroup("Music", &m_MusicChannelGroup) : soundSystemSetupResult;
 		soundSystemSetupResult = soundSystemSetupResult == FMOD_OK ? m_AudioSystem->createChannelGroup("Sounds", &m_SoundChannelGroup) : soundSystemSetupResult;
@@ -220,20 +221,21 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	bool AudioMan::SetSoundAttenuation(SoundContainer *pSoundContainer, float distance) {
+	bool AudioMan::SetSoundAttenuation(SoundContainer *pSoundContainer, float attenuation) {
 		if (!m_AudioEnabled || !pSoundContainer) {
 			return false;
 		}
 
-		distance = Limit(distance, 0.95, 0); //Limit distance so it can't be closer than 0 (no attenuation) or farther than 0.95 (quiet but not quite silent)
+
+		attenuation = Limit(attenuation, 0.95, 0); //Limit attenuation so it can't be closer than 0 (full volume) or farther than 0.95 (quiet but not quite silent)
 
 		FMOD_RESULT result = FMOD_OK;
 		FMOD::Channel *soundChannel;
 
-		std::unordered_set<short int> channels = pSoundContainer->GetPlayingChannels();
-		for (std::unordered_set<short int>::iterator channelIterator = channels.begin(); channelIterator != channels.end(); ++channelIterator) {
+		std::unordered_set<unsigned short int> const *channels = pSoundContainer->GetPlayingChannels();
+		for (std::unordered_set<unsigned short int>::iterator channelIterator = channels->begin(); channelIterator != channels->end(); ++channelIterator) {
 			result = m_AudioSystem->getChannel((*channelIterator), &soundChannel);
-			result = result == FMOD_OK ? soundChannel->setVolume(1 - distance) : result;
+			result = result == FMOD_OK ? soundChannel->setVolume(1 - attenuation) : result;
 			if (result != FMOD_OK) {
 				g_ConsoleMan.PrintString("ERROR: Could not set sound attenuation for the sound being played on channel " + std::to_string(*channelIterator) + " for SoundContainer " + pSoundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
 			}
@@ -429,13 +431,20 @@ namespace RTE {
 		pitch = pSoundContainer->IsAffectedByGlobalPitch() ? m_GlobalPitch : pitch;
 
 		FMOD::Channel *channel;
+		FMOD_RESULT result = FMOD_OK;
 		int channelIndex;
-		FMOD_RESULT result = m_AudioSystem->playSound(pSoundContainer->SelectNextSound(), m_SoundChannelGroup, true, &channel);
-		result = result == FMOD_OK ? channel->getIndex(&channelIndex) : result;
-		result = result == FMOD_OK ? channel->setUserData(pSoundContainer) : result;
-		result = result == FMOD_OK ? channel->setCallback(SoundChannelEndedCallback) : result;
-		result = result == FMOD_OK ? channel->setLoopCount(pSoundContainer->GetLoopSetting()) : result;
-		result = result == FMOD_OK ? channel->setPriority(priority) : result;
+		if (!pSoundContainer->SelectNextSounds()) {
+			g_ConsoleMan.PrintString("Unable to select new sounds to play for SoundContainer " + pSoundContainer->GetPresetName() + ". No sounds will be played.");
+		}
+
+		for (FMOD::Sound *sound : pSoundContainer->GetSelectedSoundObjects()) {
+			result = result == FMOD_OK ? m_AudioSystem->playSound(sound, m_SoundChannelGroup, true, &channel) : result;
+			result = result == FMOD_OK ? channel->getIndex(&channelIndex) : result;
+			result = result == FMOD_OK ? channel->setUserData(pSoundContainer) : result;
+			result = result == FMOD_OK ? channel->setCallback(SoundChannelEndedCallback) : result;
+			result = result == FMOD_OK ? channel->setLoopCount(pSoundContainer->GetLoopSetting()) : result;
+			result = result == FMOD_OK ? channel->setPriority(priority) : result;
+		}
 
 		if (result != FMOD_OK) {
 			g_ConsoleMan.PrintString("ERROR: Could not play sounds from SoundContainer " + pSoundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
@@ -461,7 +470,7 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	bool AudioMan::StopSound(SoundContainer *pSoundContainer) {
+	bool AudioMan::StopSound(SoundContainer *pSoundContainer, int player) {
 		if (!m_AudioEnabled || !pSoundContainer) {
 			return false;
 		}
@@ -474,23 +483,16 @@ namespace RTE {
 			std::unordered_set<unsigned short int> const *channels = pSoundContainer->GetPlayingChannels();
 			for (std::unordered_set<unsigned short int>::iterator channelIterator = channels->begin(); channelIterator != channels->end();) {
 				result = m_AudioSystem->getChannel((*channelIterator), &soundChannel);
+				++channelIterator; // NOTE - stopping the sound will remove the channel, screwing things up if we don't move to the next iterator preemptively
 				result = result == FMOD_OK ? soundChannel->stop() : result;
 				if (result != FMOD_OK) {
-					g_ConsoleMan.PrintString("Error: Failed to stop playing channel in SoundContainer "+pSoundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
+					g_ConsoleMan.PrintString("Error: Failed to stop playing channel in SoundContainer " + pSoundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
 				}
 
 			}
 		}
-		return anySoundsPlaying;
-	}
-
-/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	bool AudioMan::StopSound(SoundContainer *pSoundContainer, int player) {
-		if (m_IsInMultiplayerMode && pSoundContainer) {
-			RegisterSoundEvent(player, SOUND_STOP, pSoundContainer->GetHash(), 0, pSoundContainer->GetPlayingChannels(), pSoundContainer->GetLoopSetting(), 1.0, pSoundContainer->IsAffectedByGlobalPitch());
-		}
-		return StopSound(pSoundContainer);
+		return anySoundsPlaying;
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Managers/AudioMan.h

@@ -314,7 +314,7 @@ namespace RTE {
 		/// </summary>
 		/// <param name="pSound">Pointer to the SoundContainer to stop playing. Ownership is NOT transferred!</param>
 		/// <returns>True if sounds were playing and were stopped, false otherwise.</returns>
-		bool StopSound(SoundContainer *pSound);
+		bool StopSound(SoundContainer *pSound) { return StopSound(pSound, -1); }
 
 		/// <summary>
 		/// Stops playing all sounds in a given SoundContainer for a certain player.
@@ -410,6 +410,7 @@ namespace RTE {
 		std::mutex g_SoundEventsListMutex[c_MaxClients]; //!< A list for locking sound events for multiplayer to avoid race conditions and other such problems.
 
 	private:
+
 		/// <summary>
 		/// A static callback function for FMOD to invoke when the music channel finishes playing. See fmod docs - FMOD_SYSTEM_CALLBACK for details
 		/// </summary>
@@ -429,7 +430,5 @@ namespace RTE {
 		AudioMan(const AudioMan &reference);
 		AudioMan & operator=(const AudioMan &rhs);
 	};
-
-	std::mutex g_SoundEventsListMutex[c_MaxClients];
 }
 #endif

Managers/SettingsMan.cpp

@@ -76,8 +76,6 @@ void SettingsMan::Clear()
 
 	m_UseNATService = false;
 	m_DisableLoadingScreen = false;
-
-	m_AudioChannels = 512;
 }
 
 
@@ -271,8 +269,6 @@ int SettingsMan::ReadProperty(std::string propName, Reader &reader)
 		reader >> m_ServerSleepWhenIdle;
 	else if (propName == "ServerSimSleepWhenIdle")
 		reader >> m_ServerSimSleepWhenIdle;
-	else if (propName == "AudioChannels")
-		reader >> m_AudioChannels;
 	else if (propName == "DisableLoadingScreen")
 		reader >> m_DisableLoadingScreen;
 	else if (propName == "SoundVolume")
@@ -466,8 +462,6 @@ int SettingsMan::Save(Writer &writer) const
 	writer.NewProperty("DisableLoadingScreen");
 	writer << m_DisableLoadingScreen;
 
-	writer.NewProperty("AudioChannels");
-	writer << m_AudioChannels;
 	writer.NewProperty("SoundVolume");
     writer << g_AudioMan.GetSoundsVolume() * 100;
     writer.NewProperty("MusicVolume");

Managers/SettingsMan.h

@@ -567,8 +567,6 @@ class SettingsMan:
 
 	bool GetServerSimSleepWhenIdle() { return m_ServerSimSleepWhenIdle; }
 
-	int GetAudioChannels() { return m_AudioChannels; }
-
 	bool DisableLoadingScreen() { return m_DisableLoadingScreen; }
 
 
@@ -652,8 +650,6 @@ class SettingsMan:
 
 	bool m_ServerSimSleepWhenIdle;
 
-	int m_AudioChannels;
-
 	bool m_DisableLoadingScreen;
 
     // List of assemblies groups always shown in editors

System/Constants.h

@@ -35,6 +35,7 @@ namespace RTE {
 
 #pragma region Audio Constants
 	static constexpr unsigned short int c_NumberOfAudioChannels = 512;
+	static constexpr unsigned short int c_MaxPlayingSoundsPerContainer = 64;
 #pragma endregion
 
 #pragma region Network Constants