Reorganized NetworkSoundEnum and Data positioning in AudioMan header, added a couple missing states. Reorganized NetworkSoundData so it's consistent and changed some of its types around slightly.

Reorganized RegisterMusicEvent and RegisterSoundEvent so they're consistent and changed all callers accordingly
Updated RegisterSoundEvent so it copies channels and sound hashes properly, and generally works correctly.
Updated NetworkServer to match with these changes.

Author: garethyr

Managers/AudioMan.cpp

@@ -120,7 +120,7 @@ namespace RTE {
 			return;
 		}
 
-		if (m_IsInMultiplayerMode) { RegisterSoundEvent(-1, SOUND_SET_PITCH, 0, 0, std::unordered_set<short int>(), 0, pitch, excludeMusic); }
+		if (m_IsInMultiplayerMode) { RegisterSoundEvent(-1, SOUND_SET_GLOBAL_PITCH, NULL, NULL, 0, 0, pitch, excludeMusic); }
 
 		m_GlobalPitch = Limit(pitch, 8, 0.125); //Limit pitch change to 8 octaves up or down
 
@@ -226,6 +226,7 @@ namespace RTE {
 			return false;
 		}
 
+		if (m_IsInMultiplayerMode) { RegisterSoundEvent(-1, SOUND_SET_ATTENUATION, pSoundContainer->GetPlayingChannels(), &pSoundContainer->GetSelectedSoundHashes(), attenuation); }
 
 		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)
 
@@ -251,9 +252,7 @@ namespace RTE {
 			return false;
 		}
 
-		if (IsInMultiplayerMode() && pSoundContainer) {
-			RegisterSoundEvent(-1, SOUND_SET_PITCH, pSoundContainer->GetHash(), 0, pSoundContainer->GetPlayingChannels(), pSoundContainer->GetLoopSetting(), pitch, pSoundContainer->IsAffectedByGlobalPitch());
-		}
+		if (m_IsInMultiplayerMode) { RegisterSoundEvent(-1, SOUND_SET_PITCH, pSoundContainer->GetPlayingChannels(), &pSoundContainer->GetSelectedSoundHashes(), 0, 0, pitch); }
 
 		pitch = Limit(pitch, 8, 0.125); //Limit pitch change to 8 octaves up or down
 
@@ -274,7 +273,7 @@ namespace RTE {
 
 	void AudioMan::PlayMusic(const char *filePath, int loops, double volumeOverrideIfNotMuted) {
 		if (m_AudioEnabled) {
-			if (m_IsInMultiplayerMode) { RegisterMusicEvent(-1, MUSIC_PLAY, filePath, loops, 0.0, 1.0); }
+			if (m_IsInMultiplayerMode) { RegisterMusicEvent(-1, MUSIC_PLAY, filePath, loops); }
 
 			FMOD_RESULT result = m_MusicChannelGroup->stop();
 			if (result != FMOD_OK) {
@@ -343,7 +342,7 @@ namespace RTE {
 				bool isPlaying;
 				FMOD_RESULT result = m_MusicChannelGroup->isPlaying(&isPlaying);
 				if (result == FMOD_OK && isPlaying) {
-					RegisterMusicEvent(-1, MUSIC_SILENCE, 0, seconds, 0.0, 1.0);
+					if (m_IsInMultiplayerMode) { RegisterMusicEvent(-1, MUSIC_SILENCE, NULL, seconds); }
 					result = m_MusicChannelGroup->stop();
 				}
 				if (result != FMOD_OK) {
@@ -462,7 +461,7 @@ namespace RTE {
 
 		// Now that the sound is playing we can register an event with the SoundContainer's channels, which can be used by clients to identify the sound being played.
 		if (m_IsInMultiplayerMode) {
-			RegisterSoundEvent(player, SOUND_PLAY, pSoundContainer->GetHash(), attenuation, pSoundContainer->GetPlayingChannels(), pSoundContainer->GetLoopSetting(), pitch, pSoundContainer->IsAffectedByGlobalPitch());
+			RegisterSoundEvent(player, SOUND_PLAY, pSoundContainer->GetPlayingChannels(), &pSoundContainer->GetSelectedSoundHashes(), attenuation, pSoundContainer->GetLoopSetting(), pitch, pSoundContainer->IsAffectedByGlobalPitch());
 		}
 
 		return true;
@@ -475,6 +474,8 @@ namespace RTE {
 			return false;
 		}
 
+		if (m_IsInMultiplayerMode) { RegisterSoundEvent(player, SOUND_STOP, pSoundContainer->GetPlayingChannels()); }
+
 		FMOD_RESULT result;
 		FMOD::Channel *soundChannel;
 		bool anySoundsPlaying = pSoundContainer->IsBeingPlayed();
@@ -502,6 +503,8 @@ namespace RTE {
 			return;
 		}
 
+		if (m_IsInMultiplayerMode) { RegisterSoundEvent(-1, SOUND_FADE_OUT, pSoundContainer->GetPlayingChannels(), &pSoundContainer->GetSelectedSoundHashes(), 0, 0, 0, false, fadeOutTime); }
+
 		int sampleRate;
 		m_AudioSystem->getSoftwareFormat(&sampleRate, nullptr, nullptr);
 		int fadeOutTimeAsSamples = fadeOutTime * sampleRate / 1000;
@@ -544,7 +547,7 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void AudioMan::RegisterMusicEvent(int player, unsigned char state, const char *filepath, int loops, double position, float pitch) {
+	void AudioMan::RegisterMusicEvent(int player, NetworkMusicState state, const char *filepath, int loops, double position, float pitch) {
 		if (player == -1) {
 			for (int i = 0; i < c_MaxClients; i++) {
 				RegisterMusicEvent(i, state, filepath, loops, position, pitch);
@@ -587,21 +590,26 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void AudioMan::RegisterSoundEvent(int player, unsigned char state, size_t hash, short int attenuation, std::unordered_set<short int> const &channels, short int loops, float pitch, bool affectedByPitch) {
+	void AudioMan::RegisterSoundEvent(int player, NetworkSoundState state, std::unordered_set<unsigned short int> const *channels, std::vector<size_t> const *soundFileHashes, short int attenuation, short int loops, float pitch, bool affectedByGlobalPitch, short int fadeOutTime) {
 		if (player == -1) {
 			for (int i = 0; i < c_MaxClients; i++) {
-				RegisterSoundEvent(i, state, hash, attenuation, channels, loops, pitch, affectedByPitch);
+				RegisterSoundEvent(i, state, channels, soundFileHashes, attenuation, loops, pitch, affectedByGlobalPitch, fadeOutTime);
 			}
 		} else {
 			if (player >= 0 && player < c_MaxClients) {
 				NetworkSoundData soundData;
 				soundData.State = state;
+				if (channels) {
+					std::copy(channels->begin(), channels->end(), soundData.Channels);
+				}
+				if (soundFileHashes) {
+					std::copy(soundFileHashes->begin(), soundFileHashes->end(), soundData.SoundFileHashes);
+				}
 				soundData.Distance = attenuation;
-				soundData.SoundHash = hash;
-				soundData.Channels = channels;
 				soundData.Loops = loops;
 				soundData.Pitch = pitch;
-				soundData.AffectedByPitch = affectedByPitch ? 1 : 0;
+				soundData.AffectedByGlobalPitch = affectedByGlobalPitch;
+				soundData.FadeOutTime = fadeOutTime;
 
 				g_SoundEventsListMutex[player].lock();
 				m_SoundEvents[player].push_back(soundData);

Managers/AudioMan.h

@@ -30,23 +30,6 @@ namespace RTE {
 			PRIORITY_COUNT
 		};
 
-		enum NetworkSoundState {
-			SOUND_PLAY = 0,
-			SOUND_STOP,
-			SOUND_SET_PITCH,
-			SOUND_SET_ATTENUATION
-		};
-
-		struct NetworkSoundData {
-			unsigned char State;
-			size_t SoundHash;
-			unsigned char AffectedByPitch;
-			short int Distance;
-			std::unordered_set<short int> Channels;
-			short int Loops;
-			float Pitch;
-		};
-
 		enum NetworkMusicState {
 			MUSIC_PLAY = 0,
 			MUSIC_STOP,
@@ -62,6 +45,26 @@ namespace RTE {
 			float Pitch;
 		};
 
+		enum NetworkSoundState {
+			SOUND_PLAY = 0,
+			SOUND_STOP,
+			SOUND_SET_ATTENUATION,
+			SOUND_SET_PITCH,
+			SOUND_SET_GLOBAL_PITCH,
+			SOUND_FADE_OUT
+		};
+
+		struct NetworkSoundData {
+			unsigned char State;
+			unsigned short int Channels[c_MaxPlayingSoundsPerContainer]{c_NumberOfAudioChannels + 1};
+			size_t SoundFileHashes[c_NumberOfAudioChannels]{0};
+			short int Distance;
+			short int Loops;
+			float Pitch;
+			bool AffectedByGlobalPitch;
+			short int FadeOutTime;
+		};
+
 #pragma region Creation
 		/// <summary>
 		/// Constructor method used to instantiate a AudioMan object in system memory.
@@ -355,13 +358,13 @@ namespace RTE {
 		/// <summary>
 		/// Adds the music event to internal list of music events for the specified player.
 		/// </summary>
-		/// <param name="player">Player for which the event happened.</param>
-		/// <param name="state">Music state.</param>
+		/// <param name="player">Player(s) for which the event happened.</param>
+		/// <param name="state">NetworkMusicState for the event.</param>
 		/// <param name="filepath">Music file path to transmit to client.</param>
 		/// <param name="loops">Loops counter.</param>
 		/// <param name="position">Music playback position.</param>
 		/// <param name="pitch">Pitch value.</param>
-		void RegisterMusicEvent(int player, unsigned char state, const char *filepath, int loops, double position, float pitch);
+		void RegisterMusicEvent(int player, NetworkMusicState state, const char *filepath, int loops = 0, double position = 0, float pitch = 1);
 
 		/// <summary>
 		/// Fills the list with sound events happened for the specified network player.
@@ -373,15 +376,16 @@ namespace RTE {
 		/// <summary>
 		/// Adds the sound event to internal list of sound events for the specified player.
 		/// </summary>
-		/// <param name="player">Player for which the event happened.</param>
-		/// <param name="state">Sound state.</param>
-		/// <param name="hash">Sound file hash to transmit to client.</param>
-		/// <param name="distance">Sound distance.</param>
-		/// <param name="channels">Channels where sound was played.</param>
+		/// <param name="player">Player(s) for which the event happened.</param>
+		/// <param name="state">NetworkSoundState for the event .</param>
+		/// <param name="channels">Pointer to an unordered_set of channels this sound event applies to on the server.</param>
+		/// <param name="soundFileHashes">Pointer to a vector of hashes describing sound file locations to transmit to client.</param>
+		/// <param name="attenuation">Sound attenuation.</param>
 		/// <param name="loops">Loops counter.</param>
 		/// <param name="pitch">Pitch value.</param>
-		/// <param name="affectedByPitch">Whether the sound is affected by pitch.</param>
-		void RegisterSoundEvent(int player, unsigned char state, size_t hash, short int distance, std::unordered_set<short int> const &channels, short int loops, float pitch, bool affectedByPitch);
+		/// <param name="affectedByGlobalPitch">Whether the sound is affected by pitch.</param>
+		/// <param name="fadeOutTime">The amount of time, in ms, to fade out over.</param>
+		void RegisterSoundEvent(int player, NetworkSoundState state, std::unordered_set<unsigned short int> const *channels = NULL, std::vector<size_t> const *soundFileHashes = NULL, short int attenuation = 0, short int loops = 0, float pitch = 1, bool affectedByGlobalPitch = false, short int fadeOutTime = 0);
 #pragma endregion
 
 	protected:

Managers/NetworkServer.cpp

@@ -1226,12 +1226,13 @@ namespace RTE
 		for (std::list<AudioMan::NetworkSoundData>::iterator eItr = events.begin(); eItr != events.end(); ++eItr)
 		{
 			sndDataPtr->State = (*eItr).State;
-			sndDataPtr->Channels = (*eItr).Channels;
+			std::copy(std::begin(eItr->Channels), std::end(eItr->Channels), sndDataPtr->Channels);
+			std::copy(std::begin(eItr->SoundFileHashes), std::end(eItr->SoundFileHashes), sndDataPtr->SoundFileHashes);
 			sndDataPtr->Distance = (*eItr).Distance;
-			sndDataPtr->SoundHash = (*eItr).SoundHash;
 			sndDataPtr->Loops = (*eItr).Loops;
 			sndDataPtr->Pitch = (*eItr).Pitch;
-			sndDataPtr->AffectedByPitch = (*eItr).AffectedByPitch;
+			sndDataPtr->AffectedByGlobalPitch = (*eItr).AffectedByGlobalPitch;
+			sndDataPtr->FadeOutTime = (*eItr).FadeOutTime;
 
 			msg->SoundEventsCount++;
 			sndDataPtr++;