feature creep

Author: pawnishoovy

CHANGELOG.md

@@ -17,6 +17,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	`ResetMusicState()` to immediately end all music and return the MusicMan to a blank state.
 
 - New entities `DynamicSongSection` and `DynamicSong` which are used for organizing music to play using the new system.
+	`DynamicSongSection` is made up of TransitionSoundContainers, SoundContainers, a string SectionType, and either randomnorepeat or shuffle SoundContainerSelectionCycleMode.
+	`DynamicSong` is a simple container of DynamicSongSections. It can have one DefaultSongSection and as many added sections as needed.
+	
+- New `SoundContainer` features.
+		Lua property `Paused` (R/W) to pause or unpause all sounds of a SoundContainer. Newly played sounds will not begin playback until unpaused.
+		Lua function `GetAudibleVolume` to get the real audible volume of a SoundContainer's sounds as a float from 0 to 1. This accounts for literally everything, including game volume.
 
 </details>
 

Source/Entities/SoundContainer.cpp

@@ -282,6 +282,11 @@ void SoundContainer::SetPosition(const Vector& newPosition) {
 	}
 }
 
+float SoundContainer::GetAudibleVolume() const {
+	return g_AudioMan.GetSoundContainerAudibleVolume(this);
+}
+
+
 void SoundContainer::SetVolume(float newVolume) {
 	newVolume = std::clamp(newVolume, 0.0F, 10.0F);
 	if (IsBeingPlayed()) {

Source/Entities/SoundContainer.h

@@ -223,6 +223,10 @@ namespace RTE {
 		/// @return Whether this SoundContainer's attenuation setting was successful.
 		void SetPosition(const Vector& newPosition);
 
+		/// Gets the real audible volume sounds in this SoundContainer are currently playing at, if any. Accounts for literally everything, including game volume.
+		/// @return The real audible volume the sounds in this SoundContainer are played at.
+		float GetAudibleVolume() const;
+
 		/// Gets the volume the sounds in this SoundContainer are played at. Note that this does not factor volume changes due to the SoundContainer's position.
 		/// @return The volume the sounds in this SoundContainer are played at.
 		float GetVolume() const { return m_Volume; }

Source/Lua/LuaBindingsEntities.cpp

@@ -1282,6 +1282,7 @@ LuaBindingRegisterFunctionDefinitionForType(EntityLuaBindings, SoundContainer) {
 	    .def("HasAnySounds", &SoundContainer::HasAnySounds)
 	    .def("GetTopLevelSoundSet", &SoundContainer::GetTopLevelSoundSet)
 	    .def("SetTopLevelSoundSet", &SoundContainer::SetTopLevelSoundSet)
+	    .def("GetAudibleVolume", &SoundContainer::GetAudibleVolume)
 	    .def("IsBeingPlayed", &SoundContainer::IsBeingPlayed)
 	    .def("Play", (bool(SoundContainer::*)()) & SoundContainer::Play)
 	    .def("Play", (bool(SoundContainer::*)(const int player)) & SoundContainer::Play)

Source/Lua/LuaBindingsManagers.cpp

@@ -44,6 +44,7 @@ LuaBindingRegisterFunctionDefinitionForType(ManagerLuaBindings, MusicMan) {
 	return luabind::class_<MusicMan>("MusicManager")
 
 	    .def("ResetMusicState", &MusicMan::ResetMusicState)
+	    .def("IsMusicPlaying", &MusicMan::IsMusicPlaying)
 	    .def("PlayDynamicSong", &LuaAdaptersMusicMan::PlayDynamicSong1)
 	    .def("PlayDynamicSong", &LuaAdaptersMusicMan::PlayDynamicSong2)
 	    .def("PlayDynamicSong", &LuaAdaptersMusicMan::PlayDynamicSong3)

Source/Managers/AudioMan.cpp

@@ -471,6 +471,30 @@ bool AudioMan::ChangeSoundContainerPlayingChannelsPosition(const SoundContainer*
 	return result == FMOD_OK;
 }
 
+float AudioMan::GetSoundContainerAudibleVolume(const SoundContainer* soundContainer) {
+	if (!m_AudioEnabled || !soundContainer || !soundContainer->IsBeingPlayed()) {
+		return 0.0F;
+	}
+
+	FMOD_RESULT result;
+	FMOD::Channel* soundChannel;
+	float audibleVolume;
+
+	const std::unordered_set<int> channels = *soundContainer->GetPlayingChannels();
+	for (int channel: channels) {
+		result = m_AudioSystem->getChannel(channel, &soundChannel);
+		result = (result == FMOD_OK) ? soundChannel->getAudibility(&audibleVolume) : result;
+
+		if (result != FMOD_OK) {
+			g_ConsoleMan.PrintString("ERROR: Could not get sound audible volume in SoundContainer " + soundContainer->GetPresetName() + ": " + std::string(FMOD_ErrorString(result)));
+		} else {
+			// Simply return the first one, they are all the same
+			return audibleVolume;
+		}
+	}
+	return 0.0F;
+}
+
 bool AudioMan::ChangeSoundContainerPlayingChannelsVolume(const SoundContainer* soundContainer, float newVolume) {
 	if (!m_AudioEnabled || !soundContainer || !soundContainer->IsBeingPlayed()) {
 		return false;

Source/Managers/AudioMan.h

@@ -360,6 +360,11 @@ namespace RTE {
 		/// @return Whether the position was successfully set.
 		bool ChangeSoundContainerPlayingChannelsPosition(const SoundContainer* soundContainer);
 
+		/// Sets/updates the position of a SoundContainer's playing sounds.
+		/// @param soundContainer A pointer to a SoundContainer object. Ownership IS NOT transferred!
+		/// @return Whether the position was successfully set.
+		float GetSoundContainerAudibleVolume(const SoundContainer* soundContainer);
+
 		/// Changes the volume of a SoundContainer's playing sounds.
 		/// @param soundContainer A pointer to a SoundContainer object. Ownership IS NOT transferred!
 		/// @param newVolume The new volume to play sounds at, between 0 and 1.

Source/Managers/MusicMan.cpp

@@ -56,15 +56,25 @@ void MusicMan::Update() {
 			m_PreviousSoundContainerSetToFade = false;
 		}
 	} else {
-		if (m_PreviousSoundContainer && !m_PreviousSoundContainer->IsBeingPlayed()) {
+		if (m_PreviousSoundContainer && m_PreviousSoundContainer->GetAudibleVolume() == 0.0F) {
 			m_PreviousSoundContainer = nullptr;
 		}
-		if (m_CurrentSoundContainer && !m_CurrentSoundContainer->IsBeingPlayed()) {
+		if (m_CurrentSoundContainer && m_CurrentSoundContainer->GetAudibleVolume() == 0.0F) {
 			m_CurrentSoundContainer = nullptr;
 		}
 	}
 }
 
+bool MusicMan::IsMusicPlaying() const {
+	bool interruptingMusicSoundContainerPlaying = m_InterruptingMusicSoundContainer != nullptr && m_InterruptingMusicSoundContainer->GetAudibleVolume() > 0.0F;
+	bool previousSoundContainerPlaying = m_PreviousSoundContainer != nullptr && m_PreviousSoundContainer->GetAudibleVolume() > 0.0F;
+	bool currentSoundContainerPlaying = m_CurrentSoundContainer != nullptr && m_CurrentSoundContainer->GetAudibleVolume() > 0.0F;
+	if (interruptingMusicSoundContainerPlaying || previousSoundContainerPlaying || currentSoundContainerPlaying) {
+		return true;
+	}
+	return false;
+}
+
 void MusicMan::ResetMusicState() {
 	if (m_InterruptingMusicSoundContainer != nullptr) {
 		m_InterruptingMusicSoundContainer->Stop();

Source/Managers/MusicMan.h

@@ -38,6 +38,10 @@ namespace RTE {
 		/// Resets music state, stopping and clearing playing dynamic songs or interrupting music, etc. to make ready for new music.
 		void ResetMusicState();
 
+		/// Gets whether any music is audible, even if further playback is disabled.
+		/// @return Whether any music is audible or not.
+		bool IsMusicPlaying() const;
+
 		/// Begins playing a new dynamic song.
 		/// @param songName PresetName of the dynamic song to play.
 		/// @param songSectionType Type of DynamicSongSection to play first.