Misc changes, cleanup and rearrangements

Author: MaximDude

Entities/SoundContainer.cpp

@@ -33,9 +33,9 @@ namespace RTE {
 	int SoundContainer::Create(const SoundContainer &reference) {
 		Entity::Create(reference);
 
-		for (std::vector<SoundData> referenceSoundSet : reference.m_SoundSets) {
+		for (const std::vector<SoundData> &referenceSoundSet : reference.m_SoundSets) {
 			std::vector<SoundData> soundSet;
-			for (SoundData referenceData : referenceSoundSet) {
+			for (const SoundData &referenceData : referenceSoundSet) {
 				soundSet.push_back(SoundData {referenceData.SoundFile, referenceData.SoundObject, referenceData.Offset, referenceData.MinimumAudibleDistance, referenceData.AttenuationStartDistance});
 			}
 			m_SoundSets.push_back(soundSet);
@@ -152,8 +152,8 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void SoundContainer::AddSound(std::string const &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance, bool abortGameForInvalidSound) {
-		vector<SoundData> soundSet;
+	void SoundContainer::AddSound(const std::string &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance, bool abortGameForInvalidSound) {
+		std::vector<SoundData> soundSet;
 		if (soundSetIndex < m_SoundSets.size()) { soundSet = m_SoundSets[soundSetIndex]; }
 
 		ContentFile soundFile(soundFilePath.c_str());
@@ -162,7 +162,7 @@ namespace RTE {
 			return;
 		}
 
-		attenuationStartDistance = attenuationStartDistance < 0 ? c_DefaultAttenuationStartDistance : attenuationStartDistance;
+		attenuationStartDistance = (attenuationStartDistance < 0) ? c_DefaultAttenuationStartDistance : attenuationStartDistance;
 		soundSet.push_back({soundFile, soundObject, offset, minimumAudibleDistance, attenuationStartDistance});
 		if (soundSetIndex >= m_SoundSets.size()) { m_SoundSets.push_back(soundSet); }
 
@@ -173,7 +173,7 @@ namespace RTE {
 
 	std::vector<size_t> SoundContainer::GetSelectedSoundHashes() const {
 		std::vector<size_t> soundHashes;
-		for (SoundData selectedSoundData : m_SoundSets[m_SelectedSoundSet]) {
+		for (const SoundData &selectedSoundData : m_SoundSets[m_SelectedSoundSet]) {
 			soundHashes.push_back(selectedSoundData.SoundFile.GetHash());
 		}
 		return soundHashes;
@@ -182,8 +182,8 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	const SoundContainer::SoundData *SoundContainer::GetSoundDataForSound(const FMOD::Sound *sound) const {
-		for (std::vector<SoundData> const &soundSet : m_SoundSets) {
-			for (SoundData const &soundData : soundSet) {
+		for (const std::vector<SoundData> &soundSet : m_SoundSets) {
+			for (const SoundData &soundData : soundSet) {
 				if (sound == soundData.SoundObject) {
 					return &soundData;
 				}
@@ -206,9 +206,9 @@ namespace RTE {
 				break;
 			default:
 				auto selectRandomSound = [](int soundSetSize, size_t *outSelectedSoundSet) {
-					size_t soundToSelect = floorf(static_cast<float>(soundSetSize) * PosRand());
+					size_t soundToSelect = std::floorf(static_cast<float>(soundSetSize) * PosRand());
 					while (soundToSelect == *outSelectedSoundSet) {
-						soundToSelect = floorf(static_cast<float>(soundSetSize) * PosRand());
+						soundToSelect = std::floorf(static_cast<float>(soundSetSize) * PosRand());
 					}
 					*outSelectedSoundSet = soundToSelect;
 				};
@@ -254,7 +254,7 @@ namespace RTE {
 
 					//TODO Consider replacing this with normal min and max distance (but keep custom rolloff mode) so we can save some pointing issues. Might need to store min audible distance in audioman if fmod is strict about min and max distance sizes wrt each other.
 					soundData.CustomRolloffPoints[0] = FMOD_VECTOR{soundData.MinimumAudibleDistance, 0, 0};
-					soundData.CustomRolloffPoints[1] = FMOD_VECTOR{soundData.AttenuationStartDistance < 0 ? m_AttenuationStartDistance : soundData.AttenuationStartDistance, 1, 0};
+					soundData.CustomRolloffPoints[1] = FMOD_VECTOR{(soundData.AttenuationStartDistance < 0) ? m_AttenuationStartDistance : soundData.AttenuationStartDistance, 1, 0};
 					result = (result == FMOD_OK) ? soundData.SoundObject->set3DCustomRolloff(soundData.CustomRolloffPoints, 2) : result;
 				}
 			}
@@ -268,7 +268,7 @@ namespace RTE {
 
 	//TODO this needs to be used or be deleted
 	void SoundContainer::CalculateCustomRolloffPoints(const SoundData &soundDataToCalculateFor, FMOD_VECTOR *rolloffPoints, int numRolloffPoints) {
-		int attenuationStartDistance = soundDataToCalculateFor.AttenuationStartDistance < 0 ? m_AttenuationStartDistance : soundDataToCalculateFor.AttenuationStartDistance;
+		int attenuationStartDistance = (soundDataToCalculateFor.AttenuationStartDistance < 0) ? m_AttenuationStartDistance : soundDataToCalculateFor.AttenuationStartDistance;
 		float currentDistance = attenuationStartDistance;
 		float currentVolumeLevel = 1;
 
@@ -280,10 +280,10 @@ namespace RTE {
 			rolloffPoints[1] = FMOD_VECTOR{soundDataToCalculateFor.MinimumAudibleDistance - 0.1F, 0, 0};
 		}
 
-		for (i = (soundDataToCalculateFor.MinimumAudibleDistance > 0 ? 2 : 0); i < numRolloffPoints - 1; i++) {
+		for (i = ((soundDataToCalculateFor.MinimumAudibleDistance > 0) ? 2 : 0); i < numRolloffPoints - 1; i++) {
 			rolloffPoints[i] = FMOD_VECTOR{currentDistance, currentVolumeLevel, 0};
 			currentDistance += attenuationStartDistance;
-			currentVolumeLevel = currentDistance < c_SoundMaxAudibleDistance ? currentVolumeLevel * 0.5 : 0;
+			currentVolumeLevel = (currentDistance < c_SoundMaxAudibleDistance) ? currentVolumeLevel * 0.5F : 0;
 		}
 		rolloffPoints[numRolloffPoints - 1] = FMOD_VECTOR{currentDistance, 0, 0};
 	}

Entities/SoundContainer.h

@@ -69,22 +69,22 @@ namespace RTE {
 		/// <param name="attenuationStartDistance">The distance at which this SoundContainer's sounds should start attenuating away.</param>
 		/// <param name="immobile">Whether this SoundContainer's sounds will be treated as immobile, i.e. they won't be affected by 3D sound manipulation.</param>
 		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
-		int Create(std::string const soundFilePath, int loops = 0, bool affectedByGlobalPitch = true, float attenuationStartDistance = -1, bool immobile = false) { int result = Create(loops, affectedByGlobalPitch, attenuationStartDistance, immobile); AddSound(soundFilePath); return result; }
+		int Create(const std::string soundFilePath, int loops = 0, bool affectedByGlobalPitch = true, float attenuationStartDistance = -1, bool immobile = false) { int result = Create(loops, affectedByGlobalPitch, attenuationStartDistance, immobile); AddSound(soundFilePath); return result; }
 
 		/// <summary>
 		/// Adds a new sound to this SoundContainer, spitting out a lua error if it fails.
 		/// The Sound will have default configuration and be added to a new SoundSet.
 		/// </summary>
 		/// <param name="soundFilePath">A path to the new sound to add. This will be handled through PresetMan.</param>
-		void AddSound(std::string const &soundFilePath) { return AddSound(soundFilePath, false); }
+		void AddSound(const std::string &soundFilePath) { return AddSound(soundFilePath, false); }
 
 		/// <summary>
 		/// Adds a new sound to this SoundContainer, either spitting out a lua error or aborting if it fails.
 		/// The sound will have default configuration and be added to a new SoundSet.
 		/// </summary>
 		/// <param name="soundFilePath">A path to the new sound to add. This will be handled through PresetMan.</param>
 		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error.</param>
-		void AddSound(std::string const &soundFilePath, bool abortGameForInvalidSound) { return AddSound(soundFilePath, Vector(), c_DefaultAttenuationStartDistance, abortGameForInvalidSound); }
+		void AddSound(const std::string &soundFilePath, bool abortGameForInvalidSound) { return AddSound(soundFilePath, Vector(), c_DefaultAttenuationStartDistance, abortGameForInvalidSound); }
 
 		/// <summary>
 		/// Adds a new sound to this SoundContainer, either spitting out a lua error or aborting if it fails.
@@ -94,7 +94,7 @@ namespace RTE {
 		/// <param name="offset">The offset position to play this sound at, where (0, 0) is no offset.</param>
 		/// <param name="attenuationStartDistance">The attenuation start distance for this sound, -1 is default.</param>
 		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error.</param>
-		void AddSound(std::string const &soundFilePath, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound) { return AddSound(soundFilePath, m_SoundSets.size() + 1, Vector(), 0, c_DefaultAttenuationStartDistance, abortGameForInvalidSound); }
+		void AddSound(const std::string &soundFilePath, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound) { return AddSound(soundFilePath, m_SoundSets.size() + 1, Vector(), 0, c_DefaultAttenuationStartDistance, abortGameForInvalidSound); }
 
 		/// <summary>
 		/// Adds a new sound to this SoundContainer, either spitting out a lua error or aborting if it fails.
@@ -106,7 +106,7 @@ namespace RTE {
 		/// <param name="minimumAudibleDistance">The minimum distance at which this sound will be audible. 0 means there is none, which is normally the case.</param>
 		/// <param name="attenuationStartDistance">The attenuation start distance for this sound, -1 sets it to default.</param>
 		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error.</param>
-		void AddSound(std::string const &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance, bool abortGameForInvalidSound);
+		void AddSound(const std::string &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance, bool abortGameForInvalidSound);
 #pragma endregion
 
 #pragma region Destruction
@@ -251,7 +251,7 @@ namespace RTE {
 		/// Sets the attenuation start distance of this SoundContainer. Values < 0 set it to default. Does not affect currently playing sounds.
 		/// </summary>
 		/// <param name="attenuationStartDistance">The new attenuation start distance.</param>
-		void SetAttenuationStartDistance(float attenuationStartDistance) { m_AttenuationStartDistance = attenuationStartDistance < 0 ? c_DefaultAttenuationStartDistance : attenuationStartDistance; m_AllSoundPropertiesUpToDate = false; }
+		void SetAttenuationStartDistance(float attenuationStartDistance) { m_AttenuationStartDistance = (attenuationStartDistance < 0) ? c_DefaultAttenuationStartDistance : attenuationStartDistance; m_AllSoundPropertiesUpToDate = false; }
 
 		/// <summary>
 		/// Gets the looping setting of this SoundContainer.
@@ -392,18 +392,19 @@ namespace RTE {
 		bool m_AllSoundPropertiesUpToDate = false; //!< Whether this SoundContainer's sounds' modes and properties are up to date. Used primarily to handle discrepancies that can occur when loading from ini if the line ordering isn't ideal.
 
 	private:
-		/// <summary>
-		/// Clears all the member variables of this SoundContainer, effectively resetting the members of this abstraction level only.
-		/// </summary>
-		void Clear();
 
 		/// <summary>
-		/// TODO This is currently not used in favour of a simpler 2-point method but is kept in case it should be changed back. Examine this and remove or use it in future.
+		/// TODO This is currently not used in favor of a simpler 2-point method but is kept in case it should be changed back. Examine this and remove or use it in future.
 		/// </summary>
 		/// <param name="soundDataToCalculateFor"></param>
 		/// <param name="rolloffPoints"></param>
 		/// <param name="numRolloffPoints"></param>
 		void CalculateCustomRolloffPoints(const SoundData &soundDataToCalculateFor, FMOD_VECTOR *rolloffPoints, int numRolloffPoints);
+
+		/// <summary>
+		/// Clears all the member variables of this SoundContainer, effectively resetting the members of this abstraction level only.
+		/// </summary>
+		void Clear();
 	};
 }
 #endif

Managers/AudioMan.cpp

@@ -80,12 +80,12 @@ namespace RTE {
 	void AudioMan::Update() {
 		if (m_AudioEnabled) {
 
-			//TODO allow setting vel for AEmitter and PEmitter. Also maybe consider setting vel on listener when sceneman target scrolling is happening.
+			//TODO allow setting vel for AEmitter and PEmitter. Also maybe consider setting vel on listener when SceneMan target scrolling is happening.
 
 			FMOD_RESULT status = FMOD_OK;
 
 			if (g_ActivityMan.ActivityRunning()) {
-				Activity const *currentActivity = g_ActivityMan.GetActivity();
+				const Activity *currentActivity = g_ActivityMan.GetActivity();
 
 				if (m_CurrentActivityHumanCount != (m_IsInMultiplayerMode ? 1 : currentActivity->GetHumanCount())) {
 					m_CurrentActivityHumanCount = m_IsInMultiplayerMode ? 1 : currentActivity->GetHumanCount();
@@ -100,9 +100,7 @@ namespace RTE {
 					}
 				}
 
-				if (g_SettingsMan.SoundPanningEffectStrength() < 1) {
-					UpdateCalculated3DEffectsForMobileSoundChannels();
-				}
+				if (g_SettingsMan.SoundPanningEffectStrength() < 1) { UpdateCalculated3DEffectsForMobileSoundChannels(); }
 			} else {
 				if (m_CurrentActivityHumanCount != 1) {
 					m_CurrentActivityHumanCount = 1;
@@ -147,7 +145,7 @@ namespace RTE {
 			if (result == FMOD_OK && isPlaying) {
 				void *userData;
 				result == FMOD_OK ? soundChannel->getUserData(&userData) : result;
-				SoundContainer const *channelSoundContainer = (SoundContainer *)userData;
+				const SoundContainer *channelSoundContainer = (SoundContainer *)userData;
 
 				if (channelSoundContainer->IsAffectedByGlobalPitch()) { soundChannel->setPitch(pitch); }
 			}
@@ -233,13 +231,13 @@ namespace RTE {
 		FMOD::Channel *soundChannel;
 		FMOD::Sound *sound;
 
-		std::unordered_set<unsigned short> const *playingChannels = soundContainer->GetPlayingChannels();
+		const std::unordered_set<unsigned short> *playingChannels = soundContainer->GetPlayingChannels();
 		for (unsigned short channelIndex : *playingChannels) {
 			result = m_AudioSystem->getChannel(channelIndex, &soundChannel);
 			result = (result == FMOD_OK) ? soundChannel->getCurrentSound(&sound) : result;
-			SoundContainer::SoundData const *soundData = soundContainer->GetSoundDataForSound(sound);
-
-			result = (result == FMOD_OK) ? soundChannel->set3DAttributes(&GetAsFMODVector(position + (soundData == NULL ? Vector() : soundData->Offset)), NULL) : result;
+			const SoundContainer::SoundData *soundData = soundContainer->GetSoundDataForSound(sound);
+			
+			result = (result == FMOD_OK) ? soundChannel->set3DAttributes(&GetAsFMODVector(position + ((soundData == NULL) ? Vector() : soundData->Offset)), NULL) : result;
 			if (result != FMOD_OK) {
 				g_ConsoleMan.PrintString("ERROR: Could not set sound position for the sound being played on channel " + std::to_string(channelIndex) + " for SoundContainer " + soundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
 			}
@@ -265,7 +263,7 @@ namespace RTE {
 		FMOD_RESULT result;
 		FMOD::Channel *soundChannel;
 
-		std::unordered_set<unsigned short> const *channels = soundContainer->GetPlayingChannels();
+		const std::unordered_set<unsigned short> *channels = soundContainer->GetPlayingChannels();
 		for (std::unordered_set<unsigned short>::iterator channelIterator = channels->begin(); channelIterator != channels->end(); ++channelIterator) {
 			result = m_AudioSystem->getChannel((*channelIterator), &soundChannel);
 			if (result == FMOD_OK) { soundChannel->setPitch(pitch); }
@@ -500,7 +498,7 @@ namespace RTE {
 		bool anySoundsPlaying = soundContainer->IsBeingPlayed();
 
 		if (anySoundsPlaying) {
-			std::unordered_set<unsigned short> const *channels = soundContainer->GetPlayingChannels();
+			const std::unordered_set<unsigned short> *channels = soundContainer->GetPlayingChannels();
 			for (std::unordered_set<unsigned short>::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
@@ -528,7 +526,7 @@ namespace RTE {
 		unsigned long long parentClock;
 		float currentVolume;
 
-		std::unordered_set<unsigned short> const *channels = soundContainer->GetPlayingChannels();
+		const std::unordered_set<unsigned short> *channels = soundContainer->GetPlayingChannels();
 		for (std::unordered_set<unsigned short>::iterator channelIterator = channels->begin(); channelIterator != channels->end(); ++channelIterator) {
 			result = m_AudioSystem->getChannel((*channelIterator), &soundChannel);
 			result = (result == FMOD_OK) ? soundChannel->getDSPClock(nullptr, &parentClock) : result;
@@ -570,9 +568,9 @@ namespace RTE {
 			musicData.Pitch = pitch;
 			musicData.Position = position;
 			if (filepath) {
-				strncpy(musicData.Path, filepath, 255);
+				std::strncpy(musicData.Path, filepath, 255);
 			} else {
-				memset(musicData.Path, 0, 255);
+				std::memset(musicData.Path, 0, 255);
 			}
 			g_SoundEventsListMutex[player].lock();
 			m_MusicEvents[player].push_back(musicData);
@@ -598,7 +596,7 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void AudioMan::RegisterSoundEvent(int player, NetworkSoundState state, std::unordered_set<unsigned short> const *channels, std::vector<size_t> const *soundFileHashes, const Vector &position, short loops, float pitch, bool affectedByGlobalPitch, float attenuationStartDistance, bool immobile, short fadeOutTime) {
+	void AudioMan::RegisterSoundEvent(int player, NetworkSoundState state, const std::unordered_set<unsigned short> *channels, const std::vector<size_t> *soundFileHashes, const Vector &position, short loops, float pitch, bool affectedByGlobalPitch, float attenuationStartDistance, bool immobile, short fadeOutTime) {
 		if (player == -1) {
 			for (int i = 0; i < c_MaxClients; i++) {
 				RegisterSoundEvent(i, state, channels, soundFileHashes, position, loops, pitch, affectedByGlobalPitch, fadeOutTime);
@@ -701,7 +699,7 @@ namespace RTE {
 			return result;
 		}
 
-		Activity const *currentActivity = g_ActivityMan.GetActivity();
+		const Activity *currentActivity = g_ActivityMan.GetActivity();
 		float shortestDistance = g_SceneMan.GetSceneDim().GetMagnitude();
 		float longestDistance = 0;
 		for (int player = 0; player < currentActivity->GetPlayerCount(); player++) {