In SoundContainer.h, stop including SoundSet

Author: MyNameIsTrez

Source/Activities/GAScripted.cpp

@@ -28,6 +28,7 @@
 #include "Scene.h"
 #include "Actor.h"
 #include "PieMenu.h"
+#include "LuaMan.h"
 
 #include "GUI.h"
 #include "GUIFont.h"

Source/Activities/MultiplayerServerLobby.cpp

@@ -26,6 +26,7 @@
 #include "DataModule.h"
 #include "MetaMan.h"
 #include "AudioMan.h"
+#include "LuaMan.h"
 
 #include "GUI.h"
 #include "AllegroBitmap.h"

Source/Entities/PieMenu.cpp

@@ -4,6 +4,7 @@
 #include "UInputMan.h"
 #include "PresetMan.h"
 #include "SettingsMan.h"
+#include "LuaMan.h"
 
 #include "AHuman.h"
 #include "ContentFile.h"

Source/Entities/SoundContainer.cpp

@@ -1,4 +1,6 @@
 #include "SoundContainer.h"
+
+#include "SoundSet.h"
 #include "SettingsMan.h"
 
 namespace RTE {
@@ -17,10 +19,26 @@ namespace RTE {
 		{"Music", SoundContainer::BusRouting::MUSIC}
 	};
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	SoundContainer::SoundContainer() {
+		Clear();
+	}
+
+	SoundContainer::SoundContainer(const SoundContainer &reference) {
+		Clear();
+		Create(reference);
+	}
+
+	SoundContainer::~SoundContainer() {
+		Destroy(true);
+	}
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	void SoundContainer::Clear() {
-		m_TopLevelSoundSet.Destroy();
+		m_TopLevelSoundSet = std::make_shared<SoundSet>();
+		m_TopLevelSoundSet->Destroy();
 
 		m_PlayingChannels.clear();
 		m_SoundOverlapMode = SoundOverlapMode::OVERLAP;
@@ -47,7 +65,7 @@ namespace RTE {
 	int SoundContainer::Create(const SoundContainer &reference) {
 		Entity::Create(reference);
 
-		m_TopLevelSoundSet.Create(reference.m_TopLevelSoundSet);
+		m_TopLevelSoundSet->Create(*reference.m_TopLevelSoundSet);
 
 		m_PlayingChannels.clear();
 		m_SoundOverlapMode = reference.m_SoundOverlapMode;
@@ -70,19 +88,29 @@ namespace RTE {
 		return 0;
 	}
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	int SoundContainer::Create(const std::string &soundFilePath, bool immobile, bool affectedByGlobalPitch, BusRouting busRouting) {
+		m_TopLevelSoundSet->AddSound(soundFilePath, true);
+		SetImmobile(immobile);
+		SetAffectedByGlobalPitch(affectedByGlobalPitch);
+		SetBusRouting(busRouting);
+		return 0;
+	}
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	int SoundContainer::ReadProperty(const std::string_view &propName, Reader &reader) {
 		StartPropertyList(return Entity::ReadProperty(propName, reader));
 
-		MatchProperty("SpecialBehaviour_TopLevelSoundSet", { reader >> m_TopLevelSoundSet; });
-		MatchProperty("AddSound", { m_TopLevelSoundSet.AddSoundData(SoundSet::ReadAndGetSoundData(reader)); });
+		MatchProperty("SpecialBehaviour_TopLevelSoundSet", { reader >> *m_TopLevelSoundSet; });
+		MatchProperty("AddSound", { m_TopLevelSoundSet->AddSoundData(SoundSet::ReadAndGetSoundData(reader)); });
 		MatchProperty("AddSoundSet", {
 			SoundSet soundSetToAdd;
 			reader >> soundSetToAdd;
-			m_TopLevelSoundSet.AddSoundSet(soundSetToAdd);
+			m_TopLevelSoundSet->AddSoundSet(soundSetToAdd);
 		});
-		MatchForwards("SoundSelectionCycleMode") MatchProperty("CycleMode", { m_TopLevelSoundSet.SetSoundSelectionCycleMode(SoundSet::ReadSoundSelectionCycleMode(reader)); });
+		MatchForwards("SoundSelectionCycleMode") MatchProperty("CycleMode", { m_TopLevelSoundSet->SetSoundSelectionCycleMode(SoundSet::ReadSoundSelectionCycleMode(reader)); });
 		MatchProperty("SoundOverlapMode", {
 			std::string soundOverlapModeString = reader.ReadPropValue();
 			if (c_SoundOverlapModeMap.find(soundOverlapModeString) != c_SoundOverlapModeMap.end()) {
@@ -134,10 +162,10 @@ namespace RTE {
 		Entity::Save(writer);
 
 		// Due to writer limitations, the top level SoundSet has to be explicitly written out, even though SoundContainer standard behaviour is to hide it in INI and just have properties be part of the SoundContainer.
-		writer.NewPropertyWithValue("SpecialBehaviour_TopLevelSoundSet", m_TopLevelSoundSet);
+		writer.NewPropertyWithValue("SpecialBehaviour_TopLevelSoundSet", *m_TopLevelSoundSet);
 
 		writer.NewProperty("SoundSelectionCycleMode");
-		SoundSet::SaveSoundSelectionCycleMode(writer, m_TopLevelSoundSet.GetSoundSelectionCycleMode());
+		SoundSet::SaveSoundSelectionCycleMode(writer, m_TopLevelSoundSet->GetSoundSelectionCycleMode());
 
 		writer.NewProperty("SoundOverlapMode");
 		auto overlapModeMapEntry = std::find_if(c_SoundOverlapModeMap.begin(), c_SoundOverlapModeMap.end(), [&soundOverlapMode = m_SoundOverlapMode](auto element) { return element.second == soundOverlapMode; });
@@ -176,20 +204,26 @@ namespace RTE {
 		return 0;
 	}
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	bool SoundContainer::HasAnySounds() const {
+		return m_TopLevelSoundSet->HasAnySounds();
+	}
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	float SoundContainer::GetLength(LengthOfSoundType type) const {
 		if (!m_SoundPropertiesUpToDate) {
 			// Todo - use a post-load fixup stage instead of lazily initializing shit everywhere... Eugh.
 			const_cast<SoundContainer *>(this)->UpdateSoundProperties();
-			const_cast<SoundContainer*>(this)->m_TopLevelSoundSet.SelectNextSounds();
+			const_cast<SoundContainer*>(this)->m_TopLevelSoundSet->SelectNextSounds();
 		}
 
-		std::vector<const SoundSet::SoundData*> flattenedSoundData;
-		m_TopLevelSoundSet.GetFlattenedSoundData(flattenedSoundData, type == LengthOfSoundType::NextPlayed);
+		std::vector<const SoundData*> flattenedSoundData;
+		m_TopLevelSoundSet->GetFlattenedSoundData(flattenedSoundData, type == LengthOfSoundType::NextPlayed);
 
 		float lengthMilliseconds = 0.0f;
-		for (const SoundSet::SoundData *selectedSoundData : flattenedSoundData) {
+		for (const SoundData *selectedSoundData : flattenedSoundData) {
 			unsigned int length;
 			selectedSoundData->SoundObject->getLength(&length, FMOD_TIMEUNIT_MS);
 			lengthMilliseconds = std::max(lengthMilliseconds, static_cast<float>(length));
@@ -198,24 +232,31 @@ namespace RTE {
 		return lengthMilliseconds;
 	}
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	void SoundContainer::SetTopLevelSoundSet(const SoundSet &newTopLevelSoundSet) {
+		*m_TopLevelSoundSet = newTopLevelSoundSet;
+		m_SoundPropertiesUpToDate = false;
+	}
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	std::vector<std::size_t> SoundContainer::GetSelectedSoundHashes() const {
 		std::vector<size_t> soundHashes;
-		std::vector<const SoundSet::SoundData *> flattenedSoundData;
-		m_TopLevelSoundSet.GetFlattenedSoundData(flattenedSoundData, false);
-		for (const SoundSet::SoundData *selectedSoundData : flattenedSoundData) {
+		std::vector<const SoundData *> flattenedSoundData;
+		m_TopLevelSoundSet->GetFlattenedSoundData(flattenedSoundData, false);
+		for (const SoundData *selectedSoundData : flattenedSoundData) {
 			soundHashes.push_back(selectedSoundData->SoundFile.GetHash());
 		}
 		return soundHashes;
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	const SoundSet::SoundData * SoundContainer::GetSoundDataForSound(const FMOD::Sound *sound) const {
-		std::vector<const SoundSet::SoundData *> flattenedSoundData;
-		m_TopLevelSoundSet.GetFlattenedSoundData(flattenedSoundData, false);
-		for (const SoundSet::SoundData *soundData : flattenedSoundData) {
+	const SoundData * SoundContainer::GetSoundDataForSound(const FMOD::Sound *sound) const {
+		std::vector<const SoundData *> flattenedSoundData;
+		m_TopLevelSoundSet->GetFlattenedSoundData(flattenedSoundData, false);
+		for (const SoundData *soundData : flattenedSoundData) {
 			if (sound == soundData->SoundObject) {
 				return soundData;
 			}
@@ -245,9 +286,9 @@ namespace RTE {
 	FMOD_RESULT SoundContainer::UpdateSoundProperties() {
 		FMOD_RESULT result = FMOD_OK;
 
-		std::vector<SoundSet::SoundData *> flattenedSoundData;
-		m_TopLevelSoundSet.GetFlattenedSoundData(flattenedSoundData, false);
-		for (SoundSet::SoundData *soundData : flattenedSoundData) {
+		std::vector<SoundData *> flattenedSoundData;
+		m_TopLevelSoundSet->GetFlattenedSoundData(flattenedSoundData, false);
+		for (SoundData *soundData : flattenedSoundData) {
 			FMOD_MODE soundMode = (m_Loops == 0) ? FMOD_LOOP_OFF : FMOD_LOOP_NORMAL;
 			if (m_Immobile) {
 				soundMode |= FMOD_2D;

Source/Entities/SoundContainer.h

@@ -1,11 +1,12 @@
 #pragma once
 
 #include "Entity.h"
-#include "SoundSet.h"
 #include "AudioMan.h"
 
 namespace RTE {
 	class Vector;
+	struct SoundData;
+	class SoundSet;
 
 	/// <summary>
 	/// A container for sounds that represent a specific sound effect.
@@ -40,13 +41,13 @@ namespace RTE {
 		/// <summary>
 		/// Constructor method used to instantiate a SoundContainer object in system memory. Create() should be called before using the object.
 		/// </summary>
-		SoundContainer() { Clear(); }
+		SoundContainer();
 
 		/// <summary>
 		/// Copy constructor method used to instantiate a SoundContainer object identical to an already existing one.
 		/// </summary>
 		/// <param name="reference">A reference to the SoundContainer to deep copy.</param>
-		SoundContainer(const SoundContainer &reference) { Clear(); Create(reference); }
+		SoundContainer(const SoundContainer &reference);
 
 		/// <summary>
 		/// Creates a SoundContainer to be identical to another, by deep copy.
@@ -63,14 +64,14 @@ namespace RTE {
 		/// <param name="affectedByGlobalPitch">Whether this SoundContainer's sounds' frequency will be affected by the global pitch.</param>
 		/// <param name="busRouting">Bus to route this sound to.</param>
 		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
-		int Create(const std::string &soundFilePath, bool immobile = false, bool affectedByGlobalPitch = true, BusRouting busRouting = BusRouting::SFX) { m_TopLevelSoundSet.AddSound(soundFilePath, true); SetImmobile(immobile); SetAffectedByGlobalPitch(affectedByGlobalPitch); SetBusRouting(busRouting); return 0; }
+		int Create(const std::string &soundFilePath, bool immobile = false, bool affectedByGlobalPitch = true, BusRouting busRouting = BusRouting::SFX);
 #pragma endregion
 
 #pragma region Destruction
 		/// <summary>
 		/// Destructor method used to clean up a SoundContainer object before deletion from system memory.
 		/// </summary>
-		~SoundContainer() override { Destroy(true); }
+		~SoundContainer() override;
 
 		/// <summary>
 		/// Destroys and resets (through Clear()) the SoundContainer object. It doesn't delete the Sound files, since they're owned by ContentFile static maps.
@@ -89,7 +90,7 @@ namespace RTE {
 		/// Shows whether this SoundContainer's top level SoundSet has any SoundData or SoundSets.
 		/// </summary>
 		/// <returns>Whether this SoundContainer has any sounds.</returns>
-		bool HasAnySounds() const { return m_TopLevelSoundSet.HasAnySounds(); }
+		bool HasAnySounds() const;
 
 		enum class LengthOfSoundType {
 			Any,
@@ -107,13 +108,13 @@ namespace RTE {
 		/// Gets a reference to the top level SoundSet of this SoundContainer, to which all SoundData and sub SoundSets belong.
 		/// </summary>
 		/// <returns>A reference to the top level SoundSet of this SoundContainer.</returns>
-		SoundSet & GetTopLevelSoundSet() { return m_TopLevelSoundSet; }
+		SoundSet & GetTopLevelSoundSet() { return *m_TopLevelSoundSet; }
 
 		/// <summary>
 		/// Copies the passed in SoundSet reference into the top level SoundSet of this SoundContainer, effectively making that the new top level SoundSet.
 		/// </summary>
 		/// <param name="newTopLevelSoundSet">A reference to the new top level SoundSet for this SoundContainer.</param>
-		void SetTopLevelSoundSet(const SoundSet &newTopLevelSoundSet) { m_TopLevelSoundSet = newTopLevelSoundSet; m_SoundPropertiesUpToDate = false; }
+		void SetTopLevelSoundSet(const SoundSet &newTopLevelSoundSet);
 
 		/// <summary>
 		/// Gets a vector of hashes of the sounds selected to be played next in this SoundContainer.
@@ -126,7 +127,7 @@ namespace RTE {
 		/// </summary>
 		/// <param name="sound">The FMOD::Sound to search for.</param>
 		/// <returns>A pointer to the corresponding SoundData or a null pointer.</returns>
-		const SoundSet::SoundData * GetSoundDataForSound(const FMOD::Sound *sound) const;
+		const SoundData * GetSoundDataForSound(const FMOD::Sound *sound) const;
 
 		/// <summary>
 		/// Gets the channels playing sounds from this SoundContainer.
@@ -397,7 +398,7 @@ namespace RTE {
 		static const std::unordered_map<std::string, SoundOverlapMode> c_SoundOverlapModeMap; //!< A map of strings to SoundOverlapModes to support string parsing for the SoundOverlapMode enum. Populated in the implementing cpp file.
 		static const std::unordered_map<std::string, BusRouting> c_BusRoutingMap; //!< A map of strings to BusRoutings to support string parsing for the BusRouting enum. Populated in the implementing cpp file.
 
-		SoundSet m_TopLevelSoundSet; //The top level SoundSet that handles all SoundData and sub SoundSets in this SoundContainer.
+		std::shared_ptr<SoundSet> m_TopLevelSoundSet; //The top level SoundSet that handles all SoundData and sub SoundSets in this SoundContainer.
 
 		std::unordered_set<int> m_PlayingChannels; //!< The channels this SoundContainer is currently using.
 		SoundOverlapMode m_SoundOverlapMode; //!< The SoundOverlapMode for this SoundContainer, used to determine how it should handle overlapping play calls.

Source/Entities/SoundSet.cpp

@@ -58,8 +58,8 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	SoundSet::SoundData SoundSet::ReadAndGetSoundData(Reader &reader) {
-		SoundSet::SoundData soundData;
+	SoundData SoundSet::ReadAndGetSoundData(Reader &reader) {
+		SoundData soundData;
 
 		/// <summary>
 		/// Internal lambda function to load an audio file by path in as a ContentFile, which in turn loads it into FMOD, then returns SoundData for it in the outParam outSoundData.
@@ -182,7 +182,7 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	bool SoundSet::RemoveSound(const std::string &soundFilePath, bool removeFromSubSoundSets) {
-		auto soundsToRemove = std::remove_if(m_SoundData.begin(), m_SoundData.end(), [&soundFilePath](const SoundSet::SoundData &soundData) { return soundData.SoundFile.GetDataPath() == soundFilePath; });
+		auto soundsToRemove = std::remove_if(m_SoundData.begin(), m_SoundData.end(), [&soundFilePath](const SoundData &soundData) { return soundData.SoundFile.GetDataPath() == soundFilePath; });
 		bool anySoundsToRemove = soundsToRemove != m_SoundData.end();
 		if (anySoundsToRemove) { m_SoundData.erase(soundsToRemove, m_SoundData.end()); }
 		if (removeFromSubSoundSets) {

Source/Entities/SoundSet.h

@@ -6,6 +6,17 @@
 
 namespace RTE {
 
+	/// <summary>
+	/// Self-contained struct defining an individual sound in a SoundSet.
+	/// </summary>
+	struct SoundData {
+		ContentFile SoundFile;
+		FMOD::Sound *SoundObject;
+		Vector Offset = Vector();
+		float MinimumAudibleDistance = 0.0F;
+		float AttenuationStartDistance = -1.0F;
+	};
+
 	/// <summary>
 	/// A set of sounds, and their selection data.
 	/// </summary>
@@ -25,17 +36,6 @@ namespace RTE {
 			ALL
 		};
 
-		/// <summary>
-		/// Self-contained struct defining an individual sound in a SoundSet.
-		/// </summary>
-		struct SoundData {
-			ContentFile SoundFile;
-			FMOD::Sound *SoundObject;
-			Vector Offset = Vector();
-			float MinimumAudibleDistance = 0.0F;
-			float AttenuationStartDistance = -1.0F;
-		};
-
 #pragma region Creation
 		/// <summary>
 		/// Constructor method used to instantiate a SoundSet object in system memory. Create() should be called before using the object.

Source/GUI/GUISound.cpp

@@ -1,5 +1,7 @@
 #include "GUISound.h"
 
+#include "SoundSet.h"
+
 namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Source/Lua/LuaAdapters.cpp

@@ -2,6 +2,7 @@
 
 #include "LuaAdapterDefinitions.h"
 #include "LuabindObjectWrapper.h"
+#include "LuaMan.h"
 
 namespace RTE {
 

Source/Lua/LuaBindingsEntities.cpp

@@ -3,6 +3,7 @@
 #include "LuaBindingRegisterDefinitions.h"
 
 #include "PieSlice.h"
+#include "SoundSet.h"
 
 namespace RTE {