Merge pull request #254 from cortex-command-community/CF112-FMOD-Fixes

Cf112 fmod fixes

Author: garethyr

CHANGELOG.md

@@ -143,6 +143,32 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Added new lua `Vector` functions: `GetRadRotated(angle)` and `GetDegRotated(angle)`. They return a rotated copy of the vector without modifying it.
 
+- Added `Enum` binding for `SoundSet.SoundSelectionCycleMode`: `RANDOM = 0, FORWARDS = 1, ALL = 2`.
+
+- Added `Enum` binding for `SoundContainer.SoundOverlapMode`: `OVERLAP = 0, RESTART = 1, IGNORE_PLAY = 2`.
+
+- New `SoundContainer` function `Restart`, which allows you to restart a playing `SoundContainer`. Also another `Play` function, that lets you just specify the player to play the sound for.
+
+- New `HDFirearm` INI property `PreFireSound`, which allows you to specify a sound that will play exactly once before the weapon fires.  
+	Note that this was designed primarily for things like flamethrowers, semi-auto weapons may wonky with it, and full-auto weapons may fire multiple shots in the first burst, if you don't also set an `ActivationDelay`.	
+
+- `SoundSets` have been made a bit more fully featured, they can now have sub `SoundSets` and their own `SoundSelectionCycleMode` and they now have a Lua binding so you can create them in Lua with `local mySoundSet = SoundSet()`.  
+	They have the following INI and Lua properties:  	
+	
+	`SoundSelectionCycleMode` (INI and Lua R/W) - Determines how sounds in this `SoundSet` will be selected each time it is played (or when `SelectNextSounds` is called).  
+	Note that sub `SoundSets` can have different `SoundSelectionCycleModes`. `SoundSets` with sub `SoundSets` and sounds whose `SoundSelectionCycleMode` is `FORWARDS` will first go through their sounds, then each sub `SoundSet`.  
+	
+	`soundSet.SubSoundSets` (Lua R) - An iterator over the sub `SoundSets` of this `SoundSet`, allowing you to manipulate them as you would any `SoundSet`.  
+	`soundSet:HasAnySounds(includeSubSoundSets)` (Lua) - Whether or not this `SoundSet` has any sounds, optionally including its sub `SoundSets`.  
+	`soundSet:SelectNextSounds()` (Lua) - Selects the next sounds for this `SoundSet`. Note that playing a `SoundContainer` will always also do this, so this is only really useful to allow you to skip sounds when `SoundSelectionCycleMode` is set to `FORWARDS`.  
+	`soundSet:AddSound("Path/to/sound")` (Lua) - Adds the sound at the given path with no offset, 0 minimum audible distance, and default attenuation start distance.  
+	`soundSet:AddSound("Path/to/sound", offset, minimumAudibleDistance, attenuationStartDistance)` (Lua) - Adds the sound at the given path with the given parameters.  
+	`soundSet:AddSoundSet(soundSetToAdd)` (Lua) - Adds the given `SoundSet` as a sub `SoundSet` of this `SoundSet`.  
+	
+	Additionally, `AddSound` and `AddSoundSet` INI properties work for `SoundSets`. They are exactly the same as they are for `SoundContainers`.
+
+- You can get the top level `SoundSet` of a `SoundContainer` with `soundContainer:GetTopLevelSoundSet` and manipulate it as described above. This allows you full interaction with all levels of `SoundSets` in a `SoundContainer`.
+
 ### Changed
 
 - Codebase now uses the C++17 standard.
@@ -236,6 +262,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - `Scenes` with a `PresetName` containing the strings "Test", "Editor" and "Tutorial" are no longer excluded from the scenarios screen and from the MetaGame.
 
+- `SoundContainer` is now a concrete Lua entity. This means it can now be created with `CreateSoundContainer("PresetName", "DataModule.rte")` and has all the standard functionality like cloning, etc.  
+	To support these changes, a bunch of Lua functionality has been added and modified:  
+
+	`soundContainer.Immobile` - Whether or not the `SoundContainer` is immobile. Immobile sounds are generally used for GUI elements and will never be automatically panned, pitched or attenuated.  
+	`soundContainer.AttenuationStartDistance` - Formerly INI only, this property is now gettable and settable through Lua. See previous changelog entries for details on it.  
+	`soundContainer.Pos` - Rather than updating the `SoundContainer's` position through `AudioMan`, you should now use the `Pos` property.  
+	`soundContainer.Volume` - In addition to attenuation based volume changes, it is now possible to set a `SoundContainer's` overall volume. This works together with volume changes caused by attenuation.  
+	`soundContainer.Pitch` - Rather than updating the `SoundContainer's` pitch through `AudioMan`, you should now use the `Pitch` property. Also note that this now works properly with the game's global pitch so no complicated handling is necessary.
+	
+- `AddSound` and `SelectNextSoundSet` Lua bindings have been moved from `SoundContainer` to `SoundSet`. The latter has been renamed and the former have been trimmed down slightly since some complexity is no longer needed. Their speciifcs are mentioned in the `Added` section.
+
 ### Fixed
 
 - Fix crash when returning to `MetaGame` scenario screen after activity end.
@@ -260,6 +297,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Pressing escape at the options, mod manager, game editors and credits screens no longer quits the game.
 
+- `HDFirearm` INI property `DeactivationSound` now works properly instead of constantly playing.
+
+- Gold mining sound has been set to restart its playback everytime it's played, making it way less annoying. It's still pretty wonky, but it's better.
+
+- Sound panning should now work properly around scene seams. Additionally, sounds should be less stuttery (e.g. distant jetpacks) and generally sound better.
+
 ### Removed
 
 - Removed the ability to remove scripts from objects with Lua. This is no longer needed cause of code efficiency increases.
@@ -276,6 +319,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Removed `Activity` property `FundsOfTeam#`, use `Team#Funds` instead.
 
+- Some functionality has been moved from `AudioMan` to `SoundContainer`. As such, the following `AudioMan` Lua bindings are no longer available:  
+	`SetSoundPosition(soundContainer)`, `SetSoundPitch(soundContainer`, `PlaySound(filePath, position, player, loops, priority, pitchOrAffectedByGlobalPitch`, `attenuationStartDistance, immobile)`  
+	
+	The lengthy `PlaySound` function should be replaced by making a `SoundContainer` in your `Create` function and setting properties appropriately.  
+	This can be done by creating one defined INI with `soundContainer = CreateSoundContainer(...)`, or by making an empty one with `soundContainer = SoundContainer()`.
+
 ***
 
 ## [0.1.0 pre-release 2][0.1.0-pre2] - 2020/05/08

Entities/ADoor.cpp

@@ -422,7 +422,7 @@ namespace RTE {
 			m_SpriteAnimDuration = LERP(0, m_MaxHealth, 10, m_InitialSpriteAnimDuration, m_Health);
 
 			if (!m_DoorMoveSound.IsBeingPlayed()) { m_DoorMoveSound.Play(m_Pos); }
-			g_AudioMan.SetSoundPitch(&m_DoorMoveSound, LERP(10, m_InitialSpriteAnimDuration, 2, 1, m_SpriteAnimDuration) * g_AudioMan.GetGlobalPitch());
+			m_DoorMoveSound.SetPitch(LERP(10, m_InitialSpriteAnimDuration, 2, 1, m_SpriteAnimDuration));
 
 			m_Health -= 0.4F;
 		}

Entities/HDFirearm.cpp

@@ -35,7 +35,9 @@ void HDFirearm::Clear()
     m_pMagazine = 0;
 
     m_pFlash = 0;
+    m_PreFireSound.Reset();
     m_FireSound.Reset();
+    m_FireEchoSound.Reset();
     m_ActiveSound.Reset();
     m_DeactivationSound.Reset();
     m_EmptySound.Reset();
@@ -111,7 +113,9 @@ int HDFirearm::Create(const HDFirearm &reference)
         m_pFlash = dynamic_cast<Attachable *>(reference.m_pFlash->Clone());
         m_pFlash->Attach(this, m_pFlash->GetParentOffset());
     }
+    m_PreFireSound = reference.m_PreFireSound;
     m_FireSound = reference.m_FireSound;
+    m_FireEchoSound = reference.m_FireEchoSound;
     m_ActiveSound = reference.m_ActiveSound;
     m_DeactivationSound = reference.m_DeactivationSound;
     m_EmptySound = reference.m_EmptySound;
@@ -172,15 +176,20 @@ int HDFirearm::ReadProperty(std::string propName, Reader &reader)
             if (m_pFlash)
                 m_pFlash->Attach(this);
         }
-    }
-    else if (propName == "FireSound")
+    } else if (propName == "PreFireSound") {
+        reader >> m_PreFireSound;
+        m_DeactivationSound.SetSoundOverlapMode(SoundContainer::SoundOverlapMode::IGNORE_PLAY);
+    } else if (propName == "FireSound")
         reader >> m_FireSound;
-    else if (propName == "ActiveSound") {
+    else if (propName == "FireEchoSound") {
+        reader >> m_FireEchoSound;
+        m_FireEchoSound.SetSoundOverlapMode(SoundContainer::SoundOverlapMode::RESTART);
+    } else if (propName == "ActiveSound") {
         reader >> m_ActiveSound;
-        m_ActiveSound.SetAffectedByGlobalPitch(false); //Active sound (i.e. weapon spinup) modifies its pitch, so it has to account for global pitch on its own.
-    } else if (propName == "DeactivationSound")
+    } else if (propName == "DeactivationSound") {
         reader >> m_DeactivationSound;
-    else if (propName == "EmptySound")
+        m_DeactivationSound.SetSoundOverlapMode(SoundContainer::SoundOverlapMode::IGNORE_PLAY);
+    } else if (propName == "EmptySound")
         reader >> m_EmptySound;
     else if (propName == "ReloadStartSound")
         reader >> m_ReloadStartSound;
@@ -254,8 +263,12 @@ int HDFirearm::Save(Writer &writer) const
     writer << m_pMagazine;
     writer.NewProperty("Flash");
     writer << m_pFlash;
+    writer.NewProperty("PreFireSound");
+    writer << m_PreFireSound;
     writer.NewProperty("FireSound");
     writer << m_FireSound;
+    writer.NewProperty("FireEchoSound");
+    writer << m_FireEchoSound;
     writer.NewProperty("ActiveSound");
     writer << m_ActiveSound;
     writer.NewProperty("DeactivationSound");
@@ -312,7 +325,9 @@ void HDFirearm::Destroy(bool notInherited)
 {
     delete m_pMagazine;
     delete m_pFlash;
+    m_PreFireSound.Stop();
     m_FireSound.Stop();
+    m_FireEchoSound.Stop();
     m_ActiveSound.Stop();
     m_DeactivationSound.Stop();
 
@@ -555,13 +570,14 @@ void HDFirearm::SetID(const MOID newID)
 // Description:     Activates one of this HDFirearm's features. Analogous to 'pulling
 //                  the trigger'.
 
-void HDFirearm::Activate()
-{
+void HDFirearm::Activate() {
+    bool wasActivated = m_Activated;
     HeldDevice::Activate();
 
-    // Play the pre-fire sound
-    if (!IsReloading() && !m_ActiveSound.IsBeingPlayed())
-        m_ActiveSound.Play(this->m_Pos);
+    if (!IsReloading()) {
+        if (!m_ActiveSound.IsBeingPlayed()) { m_ActiveSound.Play(this->m_Pos); }
+        if (!wasActivated && !m_PreFireSound.IsBeingPlayed()) { m_PreFireSound.Play(this->m_Pos); }
+    }
 }
 
 
@@ -571,18 +587,14 @@ void HDFirearm::Activate()
 // Description:     Deactivates one of this HDFirearm's features. Analogous to 'releasing
 //                  the trigger'.
 
-void HDFirearm::Deactivate()
-{
+void HDFirearm::Deactivate() {
+    bool wasActivated = m_Activated;
     HeldDevice::Deactivate();
     m_FiredOnce = false;
 
-    // Stop any looping fire sounds
-    if (m_FireSound.GetLoopSetting() == -1 && m_FireSound.IsBeingPlayed())
-        m_FireSound.Stop();
-
-    // Play the post-fire sound
-    if (!m_DeactivationSound.IsBeingPlayed())
-        m_DeactivationSound.Play(m_Pos);
+    m_PreFireSound.Stop();
+    if (m_FireSound.GetLoopSetting() == -1) { m_FireSound.Stop(); }
+    if (wasActivated && m_pMagazine && !m_pMagazine->IsEmpty() && !m_DeactivationSound.IsBeingPlayed()) { m_DeactivationSound.Play(m_Pos); }
 }
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -691,6 +703,8 @@ void HDFirearm::Update()
 {
     HeldDevice::Update();
 
+    if (m_PreFireSound.IsBeingPlayed()) { m_PreFireSound.SetPosition(m_Pos); }
+    if (m_FireSound.IsBeingPlayed()) { m_FireSound.SetPosition(m_Pos); }
     if (m_ActiveSound.IsBeingPlayed()) { m_ActiveSound.SetPosition(m_Pos); }
     if (m_DeactivationSound.IsBeingPlayed()) { m_DeactivationSound.SetPosition(m_Pos); }
 
@@ -708,8 +722,7 @@ void HDFirearm::Update()
 
     if (m_pMagazine && !m_pMagazine->IsEmpty())
     {
-        if (m_Activated)
-        {
+        if (m_Activated && !m_PreFireSound.IsBeingPlayed()) {
 
             // Get the parent root of this AEmitter
 // TODO: Potentially get this once outside instead, like in attach/detach")
@@ -908,6 +921,7 @@ void HDFirearm::Update()
     {
         // Play empty pin click sound.
         m_EmptySound.Play(m_Pos);
+        m_DeactivationSound.Play(m_Pos);
         // Indicate that we have clicked once during the current activation. 
         m_AlreadyClicked = true;
 
@@ -927,6 +941,8 @@ void HDFirearm::Update()
             m_ActivationTimer.Reset();
             m_ActivationTimer.Reset();
             m_LastFireTmr.Reset();
+
+            if (m_Activated) { m_PreFireSound.Play(); }
         }
 
         m_Reloading = false;
@@ -939,6 +955,7 @@ void HDFirearm::Update()
         // Reset the click indicator.
         m_AlreadyClicked = false;
 
+        m_PreFireSound.Stop();
         // Stop any looping activation sounds
         if (m_FireSound.GetLoopSetting() == -1)// && m_FireSound.IsBeingPlayed())
             m_FireSound.Stop();
@@ -987,8 +1004,12 @@ void HDFirearm::Update()
 
         // Play firing sound
         // Only start playing if it's not a looping fire sound that is already playing, and if there's a mag
-        if (!(m_FireSound.GetLoopSetting() == -1 && m_FireSound.IsBeingPlayed()) && m_pMagazine)
-            m_FireSound.Play(m_Pos);
+        if (m_pMagazine) {
+            if (!(m_FireSound.GetLoopSetting() == -1 && m_FireSound.IsBeingPlayed())) {
+                m_FireSound.Play(m_Pos);
+            }
+            m_FireEchoSound.Play(m_Pos);
+        }
     }
     else {
         m_Recoiled = false;
@@ -1009,13 +1030,13 @@ void HDFirearm::Update()
                 if (m_Activated && !m_Reloading && m_ActivationTimer.GetElapsedSimTimeMS() < m_ActivationDelay)
                 {
                     animDuration = (int)LERP(0, m_ActivationDelay, (float)(m_SpriteAnimDuration * 10), (float)m_SpriteAnimDuration, m_ActivationTimer.GetElapsedSimTimeMS());
-                    g_AudioMan.SetSoundPitch(&m_ActiveSound, LERP(0, m_ActivationDelay, 0, 1.0, m_ActivationTimer.GetElapsedSimTimeMS()) * g_AudioMan.GetGlobalPitch());
+                    m_ActiveSound.SetPitch(LERP(0, m_ActivationDelay, 0, 1.0, m_ActivationTimer.GetElapsedSimTimeMS()));
                 }
                 // Spin down
                 if ((!m_Activated || m_Reloading) && m_LastFireTmr.GetElapsedSimTimeMS() < m_DeactivationDelay)
                 {
                     animDuration = (int)LERP(0, m_DeactivationDelay, (float)m_SpriteAnimDuration, (float)(m_SpriteAnimDuration * 10), m_LastFireTmr.GetElapsedSimTimeMS());
-                    g_AudioMan.SetSoundPitch(&m_ActiveSound, LERP(0, m_DeactivationDelay, 1.0, 0, m_LastFireTmr.GetElapsedSimTimeMS()) * g_AudioMan.GetGlobalPitch());
+                    m_ActiveSound.SetPitch(LERP(0, m_DeactivationDelay, 1.0, 0, m_LastFireTmr.GetElapsedSimTimeMS()));
                 }
 
                 if (animDuration > 0 && !(m_Reloading && m_LastFireTmr.GetElapsedSimTimeMS() >= m_DeactivationDelay))

Entities/HDFirearm.h

@@ -741,8 +741,10 @@ ClassInfoGetters
     // Muzzle Flash Attachable. Owned
     Attachable *m_pFlash;
 
+    SoundContainer m_PreFireSound; //!< The sound this HDFirearm should play before it starts firing. Distinct from activation sound in that it will play exactly once per trigger pull and not pitch up.
     // The audio of this FireArm being fired.
     SoundContainer m_FireSound;
+    SoundContainer m_FireEchoSound; //!< The audio that is played as the echo for the gun. Each shot will restart this sound, so it doesn't ever overlap.
     // The audio that is played immediately upon activation, but perhaps before actual first firing, if there's a pre-delay
     SoundContainer m_ActiveSound;
     // The audio that is played immediately upon cease of activation