Added better handling for when the Audio system fails to start for some reason. Should avoid crashing the game now.

Fixed actor death sounds not being affected by global pitch
Changed SoundContainer AddSound to default to not aborting on errors (instead printing to lua console) so it's easier to access with lua. Updated GUISound accordingly.
Also added AddSound methods that let you specify things like sound set index, offset and attenuation
Added software channel setting to AudioMan so we can up that to whatever number we want (currently 128). Also added AudioMan PlaySound that just takes filePath and position
Added various audio constants

Author: garethyr

Entities/Actor.h

@@ -1319,7 +1319,7 @@ ENTITYALLOCATION(Actor)
 			m_DeathSound.Reset();
 		} else {
             SoundContainer newDeathSound;
-			newDeathSound.Create(samplePath, false);
+			newDeathSound.Create(samplePath);
 			m_DeathSound = newDeathSound;
 		}
 	}

Entities/SoundContainer.cpp

@@ -70,15 +70,20 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void SoundContainer::AddSound(std::string const soundPath, bool abortGameForInvalidSound) {
-		ContentFile newFile(soundPath.c_str());
-
-		FMOD::Sound *newSample = newFile.GetAsSample(abortGameForInvalidSound);
-		if (newSample) {
-			FMOD_RESULT result = newSample->setMode((m_Loops == 0) ? FMOD_LOOP_OFF : FMOD_LOOP_NORMAL);
-			result = (result == FMOD_OK) ? newSample->setLoopCount(m_Loops) : result;
-			m_Sounds.push_back(std::pair<ContentFile, FMOD::Sound *>(newFile, newSample));
+	void SoundContainer::AddSound(std::string const &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound) {
+		vector<SoundData> soundSet;
+		if (soundSetIndex < m_SoundSets.size()) { soundSet = m_SoundSets[soundSetIndex]; }
+
+		ContentFile soundFile(soundFilePath.c_str());
+		FMOD::Sound *soundObject = soundFile.GetAsSample(abortGameForInvalidSound);
+		if (!soundObject) {
+			return;
 		}
+
+		soundSet.push_back({soundFile, soundObject, offset, attenuationStartDistance});
+		if (soundSetIndex >= m_SoundSets.size()) { m_SoundSets.push_back(soundSet); }
+
+		m_AllSoundPropertiesUpToDate = false;
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Entities/SoundContainer.h

@@ -58,11 +58,40 @@ namespace RTE {
 		int Create(std::string const soundPath, int loops = 0, bool affectedByGlobalPitch = true, float attenuationStartDistance = 1, bool immobile = false) { int result = Create(loops, affectedByGlobalPitch, attenuationStartDistance, immobile); AddSound(soundPath); return result; }
 
 		/// <summary>
-		/// Adds a new Sound to this SoundContainer, loaded from a file.
+		/// 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="soundPath">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. Default true.</param>
-		void AddSound(std::string const soundPath, bool abortGameForInvalidSound = true);
+		/// <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); }
+
+		/// <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); }
+
+		/// <summary>
+		/// Adds a new sound to this SoundContainer, either spitting out a lua error or aborting if it fails.
+		/// The sound will be configured based on parameters, 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="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(), c_DefaultAttenuationStartDistance, abortGameForInvalidSound); }
+
+		/// <summary>
+		/// Adds a new sound to this SoundContainer, either spitting out a lua error or aborting if it fails.
+		/// The sound will be configured based on parameters, and be added to the SoundSet at the given index, or a new one if there is none at that index.
+		/// </summary>
+		/// <param name="soundFilePath">A path to the new sound to add. This will be handled through PresetMan.</param>
+		/// <param name="soundSetIndex">The SoundSet index to add this new Sound to. If it's not an existing index, a new SoundSet will be added with this Sound.</param>
+		/// <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, unsigned int soundSetIndex, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound);
 #pragma endregion
 
 #pragma region Destruction

GUI/GUISound.cpp

@@ -44,7 +44,7 @@ namespace RTE {
 		m_EnterMenuSound.Create("Base.rte/Sounds/GUIs/MenuEnter.wav", 0, false, 0, true);
 
 		m_ExitMenuSound.Create("Base.rte/Sounds/GUIs/MenuExit1.wav", 0, false, 0, true);
-		m_ExitMenuSound.AddSound("Base.rte/Sounds/GUIs/MenuExit2.wav");
+		m_ExitMenuSound.AddSound("Base.rte/Sounds/GUIs/MenuExit2.wav", true);
 
 		m_FocusChangeSound.Create("Base.rte/Sounds/GUIs/FocusChange.wav", 0, false, 0, true);
 
@@ -78,19 +78,19 @@ namespace RTE {
 		m_DisabledPickedSound = m_PieMenuExitSound;
 
 		m_FundsChangedSound.Create("Base.rte/Sounds/GUIs/FundsChanged1.wav", 0, false, 0, true);
-		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged2.wav");
-		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged3.wav");
-		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged4.wav");
-		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged5.wav");
-		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged6.wav");
+		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged2.wav", true);
+		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged3.wav", true);
+		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged4.wav", true);
+		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged5.wav", true);
+		m_FundsChangedSound.AddSound("Base.rte/Sounds/GUIs/FundsChanged6.wav", true);
 
 		m_ActorSwitchSound.Create("Base.rte/Sounds/GUIs/ActorSwitch.wav", 0, false, 0, true);
 
 		m_BrainSwitchSound.Create("Base.rte/Sounds/GUIs/BrainSwitch.wav", 0, false, 0, true);
 
 		m_CameraTravelSound.Create("Base.rte/Sounds/GUIs/CameraTravel1.wav", 0, false, 0, true);
-		m_CameraTravelSound.AddSound("Base.rte/Sounds/GUIs/CameraTravel2.wav");
-		m_CameraTravelSound.AddSound("Base.rte/Sounds/GUIs/CameraTravel3.wav");
+		m_CameraTravelSound.AddSound("Base.rte/Sounds/GUIs/CameraTravel2.wav", true);
+		m_CameraTravelSound.AddSound("Base.rte/Sounds/GUIs/CameraTravel3.wav", true);
 
 		//		m_AreaPickedSound.Create("Base.rte/Sounds/GUIs/MenuEnter.wav", 0, false, 0, true);
 		m_AreaPickedSound = m_ConfirmSound;
@@ -104,12 +104,12 @@ namespace RTE {
 		m_PlacementBlip.Create("Base.rte/Sounds/GUIs/PlacementBlip.wav", 0, false, 0, true);
 
 		m_PlacementThud.Create("Base.rte/Sounds/GUIs/PlacementThud1.wav", 0, false, 0, true);
-		m_PlacementThud.AddSound("Base.rte/Sounds/GUIs/PlacementThud2.wav");
+		m_PlacementThud.AddSound("Base.rte/Sounds/GUIs/PlacementThud2.wav", true);
 
 		m_PlacementGravel.Create("Base.rte/Sounds/GUIs/PlacementGravel1.wav", 0, false, 0, true);
-		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel2.wav");
-		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel3.wav");
-		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel4.wav");
+		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel2.wav", true);
+		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel3.wav", true);
+		m_PlacementGravel.AddSound("Base.rte/Sounds/GUIs/PlacementGravel4.wav", true);
 
 		return 0;
 	}

Main.cpp

@@ -1907,8 +1907,10 @@ int main(int argc, char *argv[]) {
     g_TimerMan.Create();
     g_PresetMan.Create();
     g_FrameMan.Create();
-    g_AudioMan.Create(); //NOTE: By necessity of when things can be instantiated, this internally does: new GUISound()
-	g_GUISound.Create();
+    //NOTE: By necessity of when things can be instantiated, this internally does: new GUISound()
+    if (g_AudioMan.Create() >= 0) {
+        g_GUISound.Create();
+    }
     g_UInputMan.Create();
 	if (g_NetworkServer.IsServerModeEnabled()) { g_UInputMan.SetMultiplayerMode(true); }
     g_ConsoleMan.Create();

Managers/AudioMan.cpp

@@ -34,28 +34,31 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	int AudioMan::Create() {
-		FMOD_RESULT soundSystemSetupResult = FMOD::System_Create(&m_AudioSystem);
-		soundSystemSetupResult = (soundSystemSetupResult == FMOD_OK) ? m_AudioSystem->set3DSettings(1, g_FrameMan.GetPPM(), 1) : soundSystemSetupResult;
-
-		soundSystemSetupResult = (soundSystemSetupResult == FMOD_OK) ? m_AudioSystem->init(c_MaxAudioChannels, 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;
-		soundSystemSetupResult = (soundSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_MusicChannelGroup) : soundSystemSetupResult;
-		soundSystemSetupResult = (soundSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_SoundChannelGroup) : soundSystemSetupResult;
+		FMOD_RESULT audioSystemSetupResult = FMOD::System_Create(&m_AudioSystem);
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->set3DSettings(1, g_FrameMan.GetPPM(), 1) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->setSoftwareChannels(c_MaxSoftwareChannels) : audioSystemSetupResult;
+
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->init(c_MaxVirtualChannels, FMOD_INIT_NORMAL, 0) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->getMasterChannelGroup(&m_MasterChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("Music", &m_MusicChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_AudioSystem->createChannelGroup("Sounds", &m_SoundChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_MusicChannelGroup) : audioSystemSetupResult;
+		audioSystemSetupResult = (audioSystemSetupResult == FMOD_OK) ? m_MasterChannelGroup->addGroup(m_SoundChannelGroup) : audioSystemSetupResult;
 
-		m_AudioEnabled = true;
-		if (soundSystemSetupResult != FMOD_OK) {
-			m_AudioEnabled = false;
+		m_AudioEnabled = audioSystemSetupResult == FMOD_OK;
+
+		// NOTE: Anything that instantiates SoundContainers needs to wait until the Audio System is up and running before they start doing that. It'll fail safely even if Audio is not enabled.
+		new GUISound();
+
+		if (!m_AudioEnabled) {
+			g_ConsoleMan.PrintString("ERROR: Failed to enable audio: " + std::string(FMOD_ErrorString(audioSystemSetupResult)));
 			return -1;
-		}	
+		}
+
 		SetGlobalPitch(m_GlobalPitch);
 		SetSoundsVolume(m_SoundsVolume);
 		SetMusicVolume(m_MusicVolume);
 
-		// NOTE: Anything that instantiates SoundContainers needs to wait until the Audio System is up and running before they start doing that. It'll fail safely even if Audio is not enabled.
-		new GUISound(); 
-
 		return 0;
 	}
 
@@ -573,7 +576,7 @@ namespace RTE {
 				NetworkSoundData soundData;
 				soundData.State = state;
 
-				std::fill_n(soundData.Channels, c_MaxPlayingSoundsPerContainer, c_MaxAudioChannels + 1);
+				std::fill_n(soundData.Channels, c_MaxPlayingSoundsPerContainer, c_MaxVirtualChannels + 1);
 				if (channels) { std::copy(channels->begin(), channels->end(), soundData.Channels); }
 
 				std::fill_n(soundData.SoundFileHashes, c_MaxPlayingSoundsPerContainer, 0);
@@ -616,7 +619,7 @@ namespace RTE {
 			void *userData;
 			result = (result == FMOD_OK) ? channel->getUserData(&userData) : result;
 			SoundContainer *channelSoundContainer = (SoundContainer *)userData;
-			if (channelSoundContainer->GetPlayingSoundCount() > 0) { channelSoundContainer->RemovePlayingChannel(channelIndex); }
+			if (channelSoundContainer->IsBeingPlayed()) { channelSoundContainer->RemovePlayingChannel(channelIndex); }
 			result = (result == FMOD_OK) ? channel->setUserData(NULL) : result;
 
 			if (result != FMOD_OK) {
@@ -627,13 +630,20 @@ namespace RTE {
 		return FMOD_OK;
 	}
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	FMOD_VECTOR AudioMan::GetAsFMODVector(const Vector &vector, float zValue) {
 		Vector sceneDimensions = g_SceneMan.GetSceneDim();
-		if (sceneDimensions.IsZero()) {
-			return FMOD_VECTOR{ 0, 0, zValue };
-		}
-		return FMOD_VECTOR{ vector.m_X, sceneDimensions.m_Y - vector.m_Y, zValue };
+		return sceneDimensions.IsZero() ? FMOD_VECTOR{0, 0, zValue} : FMOD_VECTOR{vector.m_X, sceneDimensions.m_Y - vector.m_Y, zValue};
+	}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	
+	Vector AudioMan::GetAsVector(FMOD_VECTOR fmodVector) {
+		Vector sceneDimensions = g_SceneMan.GetSceneDim();
+		return sceneDimensions.IsZero() ? Vector() : Vector(fmodVector.x, sceneDimensions.m_Y - fmodVector.y);
 	}
 }

Managers/AudioMan.h

@@ -280,7 +280,14 @@ namespace RTE {
 		SoundContainer *PlaySound(const char *filePath) { return PlaySound(filePath, Vector(), -1); }
 
 		/// <summary>
-		/// Starts playing a certain sound file with a certain attenuation for a certain player.
+		/// Starts playing a certain sound file at a certain position for all players.
+		/// </summary>
+		/// <param name="filePath">The path to the sound file to play.</param>
+		/// <returns>The new SoundContainer being played. OWNERSHIP IS TRANSFERRED!</returns>
+		SoundContainer *PlaySound(const char *filePath, const Vector &position) { return PlaySound(filePath, position, -1); }
+
+		/// <summary>
+		/// Starts playing a certain sound file at a certain position for a certain player.
 		/// </summary>
 		/// <param name="filePath">The path to the sound file to play.</param>
 		/// <param name="position">The position at which to play the SoundContainer's sounds.</param>
@@ -394,6 +401,7 @@ namespace RTE {
 #pragma endregion
 
 	protected:
+
 		static Entity::ClassInfo m_sClass; //!< ClassInfo for this class.
 		static const std::string m_ClassName; //!< A string with the friendly-formatted type name of this object.
 
@@ -434,13 +442,21 @@ namespace RTE {
 		/// </summary>
 		static FMOD_RESULT F_CALLBACK SoundChannelEndedCallback(FMOD_CHANNELCONTROL *channelControl, FMOD_CHANNELCONTROL_TYPE channelControlType, FMOD_CHANNELCONTROL_CALLBACK_TYPE callbackType, void *commandData1, void *commandData2);
 
+		/// <summary>
 		/// <summary>
 		/// Gets the corresponding FMOD_VECTOR for a given RTE Vector.
 		/// </summary>
-		/// <param name="vector">The vector to get as an FMOD_VECTOR.</param>
-		/// <returns>The FMOD_VECTOR that corresponds to the given RTE Vector</returns>
+		/// <param name="vector">The RTE Vector to get as an FMOD_VECTOR.</param>
+		/// <returns>The FMOD_VECTOR that corresponds to the given RTE Vector.</returns>
 		FMOD_VECTOR GetAsFMODVector(const Vector &vector, float zValue = 0);
 
+		/// <summary>
+		/// Gets the corresponding RTE Vector for a given FMOD_VECTOR.
+		/// </summary>
+		/// <param name="fmodVector">The FMOD_VECTOR to get as an RTE Vector.</param>
+		/// <returns>The RTE Vector that corresponds to the given FMOD_VECTOR.</returns>
+		Vector GetAsVector(FMOD_VECTOR fmodVector);
+
 		/// <summary>
 		/// Clears all the member variables of this AudioMan, effectively resetting the members of this abstraction level only.
 		/// </summary>

Managers/LuaMan.cpp

@@ -559,7 +559,9 @@ int LuaMan::Create()
             .def("Play", (bool (SoundContainer:: *)(const Vector &position, int player)) &SoundContainer::Play)
             .def("Stop", (bool (SoundContainer:: *)()) &SoundContainer::Stop)
             .def("Stop", (bool (SoundContainer:: *)(int player)) &SoundContainer::Stop)
-            .def("AddSound", &SoundContainer::AddSound)
+            .def("AddSound", (void (SoundContainer:: *)(std::string const &soundFilePath)) &SoundContainer::AddSound)
+            .def("AddSound", (void (SoundContainer:: *)(std::string const &soundFilePath, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound)) &SoundContainer::AddSound)
+            .def("AddSound", (void (SoundContainer:: *)(std::string const &soundFilePath, unsigned int soundSetIndex, const Vector &offset, float attenuationStartDistance, bool abortGameForInvalidSound)) &SoundContainer::AddSound)
 			.def("SetPosition", &SoundContainer::SetPosition)
 			.property("Loops", &SoundContainer::GetLoopSetting, &SoundContainer::SetLoopSetting)
             .property("Priority", &SoundContainer::GetPriority, &SoundContainer::SetPriority)
@@ -1498,6 +1500,7 @@ int LuaMan::Create()
             .def("QueueSilence", &AudioMan::QueueSilence)
             .def("ClearMusicQueue", &AudioMan::ClearMusicQueue)
             .def("PlaySound", (SoundContainer *(AudioMan:: *)(const char *filePath)) &AudioMan::PlaySound)
+            .def("PlaySound", (SoundContainer *(AudioMan:: *)(const char *filePath, const Vector &position)) &AudioMan::PlaySound)
             .def("PlaySound", (SoundContainer *(AudioMan:: *)(const char *filePath, const Vector &position, int player)) &AudioMan::PlaySound)
             .def("PlaySound", (SoundContainer *(AudioMan:: *)(const char *filePath, const Vector &position, int player, int loops, int priority, double pitchOrAffectedByGlobalPitch, float attenuationStartDistance, bool immobile)) &AudioMan::PlaySound)
             .def("StopSound", (bool (AudioMan:: *)(SoundContainer *soundContainer)) &AudioMan::StopSound)

System/Constants.h

@@ -34,8 +34,11 @@ namespace RTE {
 #pragma endregion
 
 #pragma region Audio Constants
-	static constexpr unsigned short c_MaxAudioChannels = 512;
+	static constexpr unsigned short c_MaxSoftwareChannels = 128;
+	static constexpr unsigned short c_MaxVirtualChannels = 1024;
 	static constexpr unsigned short c_MaxPlayingSoundsPerContainer = 64;
+	static constexpr short c_ListenerZOffset = 0; //!< The Z offset for Audio listeners. Can be used to lessen harsh panning if panning effect strength is at max.
+	static constexpr short c_DefaultAttenuationStartDistance = 100; //!< The default start distance for attenuating sounds. Individual sounds can have different values for this.
 #pragma endregion
 
 #pragma region Network Constants