Added SoundContainer::Create that doesn't take any filepaths, to allow empty sound containers to be made. Useful for multiplayer and lua.

Added parameter to SoundContainer::AddSound and ContentFile::GetAsSample to allow it to send errors to console instead of aborting the game. Used this in AudioMan::PlaySound(filePath), since that's only ever called from lua (all internal stuff uses SoundContainer::Play)

Author: garethyr

Entities/SoundContainer.cpp

@@ -33,15 +33,6 @@ namespace RTE {
 		m_AffectedByGlobalPitch = reference.m_AffectedByGlobalPitch;
 		m_Hash = reference.m_Hash;
 
-		return 0;
-	}
-
-/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-
-	int SoundContainer::Create(std::string samplePath, int loops, bool affectedByGlobalPitch) {
-		m_AffectedByGlobalPitch = affectedByGlobalPitch;
-		m_Loops = loops;
-		AddSound(samplePath);
 
 		return 0;
 	}
@@ -75,16 +66,17 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void SoundContainer::AddSound(std::string soundPath) {
+	void SoundContainer::AddSound(std::string const soundPath, bool abortGameForInvalidSound) {
 		ContentFile newFile(soundPath.c_str());
-		m_Hash = newFile.GetHash();
 
-		FMOD::Sound *pNewSample = newFile.GetAsSample();
-		FMOD_RESULT result = pNewSample->setMode(m_Loops == 0 ? FMOD_LOOP_OFF : FMOD_LOOP_NORMAL);
-		result = result == FMOD_OK ? pNewSample->setLoopCount(m_Loops) : result;
+		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));
+		}
+	}
 
-		RTEAssert(pNewSample, "Failed to load the sample from the file");
-		m_Sounds.push_back(std::pair<ContentFile, FMOD::Sound *>(newFile, pNewSample));
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Entities/SoundContainer.h

@@ -36,19 +36,28 @@ namespace RTE {
 		int Create(const SoundContainer &reference);
 
 		/// <summary>
-		/// Creates a SoundContainer and gives it a path to its first sample.
+		/// Creates an empty SoundContainer with no sounds.
+		/// </summary>
+		/// <param name="loops">The number of times this SoundContainer's sounds will loop. 0 means play once. -1 means play infinitely until stopped.</param>
+		/// <param name="affectedByGlobalPitch">Whether this SoundContainer's sounds' frequency will be affected by the global pitch.</param>
+		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
+		int Create(int loops = 0, bool affectedByGlobalPitch = true) { m_Loops = loops; m_AffectedByGlobalPitch = affectedByGlobalPitch; return 0; }
+
+		/// <summary>
+		/// Creates a SoundContainer and gives it a path to its first sound.
 		/// </summary>
 		/// <param name="soundPath">A path to the sound for this sound to have.</param>
 		/// <param name="loops">The number of times this SoundContainer's sounds will loop. 0 means play once. -1 means play infinitely until stopped.</param>
 		/// <param name="affectedByGlobalPitch">Whether this SoundContainer's sounds' frequency will be affected by the global pitch.</param>
 		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
-		int Create(std::string soundPath, int loops = 0, bool affectedByGlobalPitch = true);
+		int Create(std::string const soundPath, int loops = 0, bool affectedByGlobalPitch = true) { int result = Create(loops, affectedByGlobalPitch); AddSound(soundPath); return result; }
 
 		/// <summary>
 		/// Adds a new Sound to this SoundContainer, loaded from a file.
 		/// </summary>
 		/// <param name="soundPath">A path to the new sound to add. This will be handled through PresetMan.</param>
-		void AddSound(std::string soundPath);
+		/// <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);
 #pragma endregion
 
 #pragma region Destruction

Managers/AudioMan.cpp

@@ -407,8 +407,13 @@ namespace RTE {
 		double pitch = affectedByGlobalPitch ? m_GlobalPitch : pitchOrAffectedByGlobalPitch;
 
 		SoundContainer *newSoundContainer = new SoundContainer();
-		newSoundContainer->Create(filePath, loops, affectedByGlobalPitch);
-		PlaySound(newSoundContainer, attenuation, player, priority, pitch);
+		newSoundContainer->Create(loops, affectedByGlobalPitch);
+		newSoundContainer->AddSound(filePath, false);
+		if (newSoundContainer->HasAnySounds()) {
+			PlaySound(newSoundContainer, attenuation, player, priority, pitch);
+		} else {
+			delete newSoundContainer;
+		}
 
 		return newSoundContainer;
 	}

System/ContentFile.cpp

@@ -1,5 +1,6 @@
 #include "ContentFile.h"
 #include "PresetMan.h"
+#include "ConsoleMan.h"
 
 namespace RTE {
 
@@ -207,11 +208,12 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	FMOD::Sound * ContentFile::GetAsSample() {
+	FMOD::Sound * ContentFile::GetAsSample(bool abortGameForInvalidSound) {
 		if (m_DataPath.empty()) {
 			return 0;
 		}
 		FMOD::Sound *pReturnSample = 0;
+		std::string errorMessage;
 
 		// Check if the file has already been read and loaded from the disk and, if so, use that data. Otherwise, load it
 		std::map<std::string, FMOD::Sound *>::iterator itr = m_sLoadedSamples.find(m_DataPath);
@@ -223,31 +225,45 @@ namespace RTE {
 			char *pRawData = 0;
 
 			if (separatorPos == m_DataPath.length()) {
-				RTEAbort("There was no object name following first pound sign in the ContentFile's datafile path, which means there was no actual object defined. The path was:\n\n" + m_DataPath);
+				errorMessage = "There was no object name following first pound sign in the sound ContentFile's datafile path, which means there was no actual object defined. The path was: ";
+				if (abortGameForInvalidSound) { RTEAbort(errorMessage + "\n\n" + m_DataPath); }
+				g_ConsoleMan.PrintString("ERROR: " + errorMessage + m_DataPath);
+				return pReturnSample;
 			} else if (separatorPos == -1) {
 				// Open the file, allocate space for it, read it and load it in as a Sound object
 				fileSize = file_size(m_DataPath.c_str());
 				PACKFILE *pFile = pack_fopen(m_DataPath.c_str(), F_READ);
-				RTEAssert(pFile && fileSize > 0, "Failed to load datafile object with following path and name:\n\n" + m_DataPath);
+
+				if (!pFile || fileSize <= 0) {
+					errorMessage = "Failed to load sound file with following path and name: ";
+					if (abortGameForInvalidSound) { RTEAbort(errorMessage + "\n\n" + m_DataPath); }
+					g_ConsoleMan.PrintString("ERROR: " + errorMessage + m_DataPath);
+					return pReturnSample;
+				}
 
 				pRawData = new char[fileSize];
 				int bytesRead = pack_fread(pRawData, fileSize, pFile);
-				RTEAssert(bytesRead == fileSize, "Tried to read a file but couldn't read the same amount of data as the reported file size!");
+				RTEAssert(bytesRead == fileSize, "Tried to read a sound file but couldn't read the same amount of data as the reported file size! The path and name were: \n\n" +m_DataPath);
 
-				// Setup fmod info, and make sure to use mode OPENMEMORY_POINT since we're doing the loading ContentFile instead of fmod
+				// Setup fmod info, and make sure to use mode OPENMEMORY since we're doing the loading with ContentFile instead of fmod, and we're deleting the raw data after loading it
 				FMOD_CREATESOUNDEXINFO soundInfo = {};
 				soundInfo.cbsize = sizeof(FMOD_CREATESOUNDEXINFO);
 				soundInfo.length = fileSize;
 				//TODO Consider doing FMOD_CREATESAMPLE for dumping audio files into memory and FMOD_NONBLOCKING to async create sounds
 				FMOD_RESULT result = g_AudioMan.GetAudioSystem()->createSound(pRawData, FMOD_OPENMEMORY, &soundInfo, &pReturnSample);
 
-				RTEAssert(result == FMOD_OK, "Unable to create sound " + m_DataPath);
+				if (result != FMOD_OK) {
+					errorMessage = "Unable to create sound because of FMOD error " + std::string(FMOD_ErrorString(result)) + ". Path and name was: ";
+					if (abortGameForInvalidSound) { RTEAbort(errorMessage + "\n\n" + m_DataPath); }
+					g_ConsoleMan.PrintString("ERROR: " + errorMessage + m_DataPath);
+					return pReturnSample;
+				}
 
 				// Deallocate the intermediary data and close the file stream
 				delete[] pRawData;
 				pack_fclose(pFile);
 			} else if (separatorPos != m_DataPath.length() - 1) {
-				RTEAbort("Loading sound samples from allegro datafiles isn't supported yet!");
+				RTEAbort("Loading sounds from allegro datafiles isn't supported yet!");
 				/*
 				// Split the datapath into the path and the object name and load the datafile from them
 				m_pDataFile = load_datafile_object(m_DataPath.substr(0, separatorPos).c_str(), m_DataPath.substr(separatorPos + 1).c_str());
@@ -256,7 +272,12 @@ namespace RTE {
 				pReturnSample = (FMOD::Sound *)m_pDataFile->dat;
 				*/
 			}
-			RTEAssert(pReturnSample, "Failed to load datafile object with following path and name:\n\n" + m_DataPath);
+			if (!pReturnSample) {
+				errorMessage = "Failed to load sound file with following path and name:";
+				if (abortGameForInvalidSound) { RTEAbort(errorMessage + "\n\n" + m_DataPath); }
+				g_ConsoleMan.PrintString("Error: " + errorMessage + m_DataPath);
+				return pReturnSample;
+			}
 
 			// Insert the Sound object into the map, PASSING OVER OWNERSHIP OF THE LOADED DATAFILE
 			m_sLoadedSamples.insert(std::pair<std::string, FMOD::Sound *>(m_DataPath, pReturnSample));

System/ContentFile.h

@@ -190,8 +190,9 @@ namespace RTE {
 		/// <summary>
 		/// Loads and gets the data represented by this ContentFile object as an FMOD FSOUND_SAMPLE. Note that ownership of the SAMPLE IS NOT TRANSFERRED!
 		/// </summary>
+		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error. Default true.</param>
 		/// <returns>The pointer to the beginning of the data object loaded from the file. Ownership is NOT transferred! If 0, the file could not be found/loaded.</returns>
-		virtual FMOD::Sound * GetAsSample();
+		virtual FMOD::Sound * GetAsSample(bool abortGameForInvalidSound = true);
 
 		/// <summary>
 		/// Loads and gets the data represented by this ContentFile object as a binary chunk of data. Note that ownership of the DATA IS NOT TRANSFERRED!