CAEWeaponAudioEntity

source/Base.h

@@ -153,6 +153,27 @@ T& StaticRef(uintptr addr) {
     return *reinterpret_cast<T*>(addr);
 }
 
+/*!
+ * @brief Use for scoped static variables (That is, static variables that are initialized in functions)
+ * @brief See `CAEGlobalWeaponAudioEntity::ServiceAmbientGunFire` for examples)
+ * @tparam T The type of the var
+ * @param varAddr 
+ * @param flagsAddr 
+ * @param flagsMask 
+ * @param initVal 
+ * @return 
+ */
+template<typename T>
+T& ScopedStaticRef(uintptr varAddr, uintptr flagsAddr, uint32 flagsMask, T&& initVal) {
+    auto& var   = StaticRef<T>(varAddr);
+    auto& flags = StaticRef<uint32>(flagsAddr);
+    if (!(flags & flagsMask)) {
+        flags |= flagsMask;
+        var    = initVal;
+    }
+    return var;
+}
+
 // TODO: Replace this with the one above
 template<typename T, uintptr Addr>
 T& StaticRef() {

source/extensions/utility.hpp

@@ -184,9 +184,14 @@ constexpr auto IsFixBugs() {
 }
 
 /// Predicate to check if `value` is null
-template<typename T>
-    requires(std::is_pointer_v<T>)
-bool IsNull(T value) { return value == nullptr; }
+struct IsNull {
+    template<typename T>
+        requires(std::is_pointer_v<T>)
+    bool operator()(T ptr) { return ptr == nullptr; }
+};
+//template<typename T>
+//    requires(std::is_pointer_v<T>)
+//bool IsNull(T value) { return value == nullptr; }
 
 /// Negate another predicate function
 template<typename T>

source/game_sa/Audio/AEAudioEnvironment.cpp

@@ -2,7 +2,8 @@
 #include "AEAudioEnvironment.h"
 
 sReverbEnvironment (&gAudioZoneToReverbEnvironmentMap)[NUM_AUDIO_ENVIRONMENTS] = *(sReverbEnvironment(*)[NUM_AUDIO_ENVIRONMENTS])0x8AD670;
-float (&gSoundDistAttenuationTable)[NUM_SOUND_DIST_ATTENUATION_ENTRIES] = *(float(*)[NUM_SOUND_DIST_ATTENUATION_ENTRIES])0x8AC270;
+
+#include "data/SoundAttenuationTable.h"
 
 void CAEAudioEnvironment::InjectHooks() {
     RH_ScopedClass(CAEAudioEnvironment);
@@ -17,29 +18,30 @@ void CAEAudioEnvironment::InjectHooks() {
 }
 
 // 0x4D7E40
-float CAEAudioEnvironment::GetDopplerRelativeFrequency(float prevDist, float curDist, uint32 prevTime, uint32 curTime, float timeScale) {
-    const auto fDistDiff = curDist - prevDist;
-    if (TheCamera.Get_Just_Switched_Status())
+float CAEAudioEnvironment::GetDopplerRelativeFrequency(float prevDist, float curDist, uint32 prevTime, uint32 curTime, float dopplerScale) {
+    if (TheCamera.Get_Just_Switched_Status()) {
         return 1.0F;
+    }
 
-    if (timeScale == 0.0F || fDistDiff == 0.0F || curTime <= prevTime)
+    const auto deltaDist = curDist - prevDist;
+    if (dopplerScale == 0.0F || deltaDist == 0.0F || curTime <= prevTime) {
         return 1.0F;
+    }
 
-    const auto fDoppler = fDistDiff * 1000.0F / static_cast<float>(curTime - prevTime) * timeScale;
-    if (std::fabs(fDoppler) >= 340.0F)
+    const auto doppler = deltaDist * 1000.0F / (float)(curTime - prevTime) * dopplerScale;
+    if (std::fabs(doppler) >= 340.0F) {
         return 1.0F;
+    }
 
-    const auto fClamped = std::clamp(fDoppler, -35.0F, 35.0F);
-    return 340.0F / (fClamped + 340.0F);
+    return 340.0F / (std::clamp(doppler, -35.0F, 35.0F) + 340.0F);
 }
 
 // 0x4D7F20
 float CAEAudioEnvironment::GetDistanceAttenuation(float dist) {
-    if (dist >= 128.0F)
-        return -100.0F;
-
-    auto iArrIndex = static_cast<uint32>(std::floor(dist * 10.0F));
-    return gSoundDistAttenuationTable[iArrIndex];
+    assert(dist >= 0.f);
+    return dist < ATTENUATION_TABLE_MAX_DIST
+        ? gSoundDistAttenuationTable[(uint32)std::floor(dist / ATTENUATION_TABLE_RESOLUTION)]
+        : -100.f;
 }
 
 // 0x4D7F60

source/game_sa/Audio/AEAudioEnvironment.h

@@ -13,7 +13,7 @@ class CAEAudioEnvironment {
 public:
     static void InjectHooks();
 
-    static float GetDopplerRelativeFrequency(float prevDist, float curDist, uint32 prevTime, uint32 curTime, float timeScale);
+    static float GetDopplerRelativeFrequency(float prevDist, float curDist, uint32 prevTime, uint32 curTime, float dopplerScale);
     static float GetDistanceAttenuation(float dist);
     static float GetDirectionalMikeAttenuation(const CVector& soundDir);
     static void  GetReverbEnvironmentAndDepth(int8* reverbEnv, int32* depth);
@@ -23,6 +23,3 @@ class CAEAudioEnvironment {
 
 static constexpr int32 NUM_AUDIO_ENVIRONMENTS = 68;
 extern sReverbEnvironment (&gAudioZoneToReverbEnvironmentMap)[NUM_AUDIO_ENVIRONMENTS];
-
-static constexpr int32 NUM_SOUND_DIST_ATTENUATION_ENTRIES = 1280;
-extern float (&gSoundDistAttenuationTable)[NUM_SOUND_DIST_ATTENUATION_ENTRIES];

source/game_sa/Audio/AEAudioUtility.cpp

@@ -4,7 +4,8 @@
 
 #include "AEAudioUtility.h"
 
-uint64& CAEAudioUtility::startTimeMs = *reinterpret_cast<uint64*>(0xb610f8);
+auto& Frequency = StaticRef<LARGE_INTEGER>(0xB610F0);
+uint64& startTimeMs = *reinterpret_cast<uint64*>(0xb610f8);
 float (&CAEAudioUtility::m_sfLogLookup)[50][2] = *reinterpret_cast<float (*)[50][2]>(0xb61100);
 
 // NOTE: For me all values were 0... The below values should be the correct ones:
@@ -84,16 +85,23 @@ float CAEAudioUtility::GetPiecewiseLinear(float x, int16 dataCount, float (*data
 
 // 0x4d9e50
 float CAEAudioUtility::AudioLog10(float p) {
-    return 0.00001f <= p ? std::log10f(p) : -5.0f;
+    return p >= 0.00001f
+        ? std::log10f(p)
+        : -5.0f;
 }
 
 // REFACTORED
 // 0x4d9e80
 uint64 CAEAudioUtility::GetCurrentTimeInMS() {
     using namespace std::chrono;
-    auto nowMs = time_point_cast<milliseconds>(high_resolution_clock::now());
-    auto value = duration_cast<milliseconds>(nowMs.time_since_epoch());
-    return static_cast<uint64>(value.count());
+    const auto nowMs = time_point_cast<milliseconds>(high_resolution_clock::now());
+    const auto value = duration_cast<milliseconds>(nowMs.time_since_epoch());
+    return static_cast<uint64>(value.count()) - startTimeMs;
+
+    //For some reason this doesn't work (original code):
+    //LARGE_INTEGER counter;
+    //QueryPerformanceCounter(&counter);
+    //return counter.QuadPart / Frequency.QuadPart * 1000 - startTimeMs;
 }
 
 // 0x4d9ef0
@@ -122,6 +130,7 @@ void CAEAudioUtility::StaticInitialise() {
         m_sfLogLookup[1][1] = log10f(v);
     }
 
+    VERIFY(QueryPerformanceFrequency(&Frequency));
     startTimeMs = GetCurrentTimeInMS();
 }
 

source/game_sa/Audio/AEAudioUtility.h

@@ -40,7 +40,6 @@ class CAEAudioUtility {
     }
 
 private:
-    static uint64& startTimeMs;
     static float (&m_sfLogLookup)[50][2];
 
 private:

source/game_sa/Audio/AESound.cpp

@@ -42,7 +42,7 @@ CAESound::CAESound(CAESound& sound) {
     m_nSoundIdInSlot = sound.m_nSoundIdInSlot;
     m_pBaseAudio = sound.m_pBaseAudio;
     m_nEvent = sound.m_nEvent;
-    m_fMaxVolume = sound.m_fMaxVolume;
+    m_ClientVariable = sound.m_ClientVariable;
     m_fVolume = sound.m_fVolume;
     m_fSoundDistance = sound.m_fSoundDistance;
     m_fSpeed = sound.m_fSpeed;
@@ -80,7 +80,7 @@ CAESound::CAESound(int16 bankSlotId, int16 sfxId, CAEAudioEntity* baseAudio, CVe
     m_pBaseAudio = baseAudio;
     m_vecPrevPosn = CVector(0.0f, 0.0f, 0.0f);
     m_pPhysicalEntity = nullptr;
-    m_fMaxVolume = -1.0F;
+    m_ClientVariable = -1.0F;
     m_nEvent = AE_UNDEFINED;
     m_nLastFrameUpdate = 0;
 
@@ -116,7 +116,7 @@ CAESound& CAESound::operator=(const CAESound& sound) {
     m_nSoundIdInSlot        = sound.m_nSoundIdInSlot;
     m_pBaseAudio            = sound.m_pBaseAudio;
     m_nEvent                = sound.m_nEvent;
-    m_fMaxVolume            = sound.m_fMaxVolume;
+    m_ClientVariable            = sound.m_ClientVariable;
     m_fVolume               = sound.m_fVolume;
     m_fSoundDistance        = sound.m_fSoundDistance;
     m_fSpeed                = sound.m_fSpeed;
@@ -295,34 +295,35 @@ void CAESound::CalculateVolume() {
 }
 
 // 0x4EFE50
-void CAESound::Initialise(int16 bankSlotId, int16 sfxId, CAEAudioEntity* baseAudio, CVector posn, float volume, float maxDistance, float speed, float timeScale,
-                          uint8 ignoredServiceCycles, eSoundEnvironment environmentFlags, float speedVariability, int16 currPlayPosn)
+void CAESound::Initialise(
+    int16 bankSlotId, int16 soundID, CAEAudioEntity* audioEntity, CVector pos, float volume, float rollOffFactor, float relativeFrequency, float doppler,
+                          uint8 frameDelay, uint32 flags, float frequencyVariance, int16 playTime)
 {
     UnregisterWithPhysicalEntity();
 
-    m_nSoundIdInSlot        = sfxId;
+    m_nSoundIdInSlot        = soundID;
     m_nBankSlotId           = bankSlotId;
-    m_pBaseAudio            = baseAudio;
+    m_pBaseAudio            = audioEntity;
     m_fVolume               = volume;
-    m_fSoundDistance        = maxDistance;
-    m_fSpeed                = speed;
-    m_fSpeedVariability     = speedVariability;
+    m_fSoundDistance        = rollOffFactor;
+    m_fSpeed                = relativeFrequency;
+    m_fSpeedVariability     = frequencyVariance;
     m_vecPrevPosn           .Set(0.0F, 0.0F, 0.0F);
     m_nEvent                = AE_UNDEFINED;
-    m_fMaxVolume            = -1.0F;
+    m_ClientVariable            = -1.0F;
     m_nLastFrameUpdate      = 0;
 
-    SetPosition(posn);
+    SetPosition(pos);
 
-    m_fTimeScale            = timeScale;
+    m_fTimeScale            = doppler;
     m_nSoundLength          = -1;
     m_nHasStarted           = 0;
     m_nPlayingState         = eSoundState::SOUND_ACTIVE;
     m_fSoundHeadRoom        = 0.0F;
-    m_nIgnoredServiceCycles = ignoredServiceCycles;
-    m_nEnvironmentFlags     = environmentFlags;
+    m_nIgnoredServiceCycles = frameDelay;
+    m_nEnvironmentFlags     = flags;
     m_nIsUsed               = 1;
-    m_nCurrentPlayPosition  = currPlayPosn;
+    m_nCurrentPlayPosition  = playTime;
     m_fFinalVolume          = -100.0F;
     m_fFrequency            = 1.0F;
 }

source/game_sa/Audio/AESound.h

@@ -11,6 +11,8 @@
 class CAEAudioEntity;
 class CEntity;
 
+using tSoundID = int16;
+
 enum eSoundEnvironment : uint16 {
     SOUND_DEFAULT                          = 0x0,
     SOUND_FRONT_END                        = 0x1,
@@ -39,8 +41,8 @@ class CAESound {
     int16           m_nSoundIdInSlot;
     CAEAudioEntity* m_pBaseAudio;
     CEntity*        m_pPhysicalEntity;
-    eAudioEvents    m_nEvent;
-    float           m_fMaxVolume;
+    int32           m_nEvent; // Not necessarily `eAudioEvents`, for ex. see `CAEWeaponAudioEntity`
+    float           m_ClientVariable;
     float           m_fVolume;
     float           m_fSoundDistance;
     float           m_fSpeed;
@@ -98,14 +100,20 @@ class CAESound {
 
     CAESound& operator=(const CAESound& sound);
 
-    void Initialise(int16 bankSlotId, int16 sfxId, CAEAudioEntity* baseAudio, CVector posn, float volume,
-                    float maxDistance = 1.0f,
-                    float speed = 1.0f,
-                    float timeScale = 1.0f,
-                    uint8 ignoredServiceCycles = 0,
-                    eSoundEnvironment environmentFlags = static_cast<eSoundEnvironment>(0),
-                    float speedVariability = 0,
-                    int16 currPlayPosn = 0);
+    void Initialise(
+        int16           bankSlotId,
+        int16           soundID,
+        CAEAudioEntity* audioEntity,
+        CVector         pos,
+        float           volume,
+        float           rollOffFactor = 1.f,
+        float           relativeFrequency = 1.f, // Speed
+        float           doppler = 1.f,
+        uint8           frameDelay = 0,
+        uint32          flags = 0,
+        float           frequencyVariance = 0.f,
+        int16           playTime = 0
+    );
 
     void  UnregisterWithPhysicalEntity();
     void  StopSound();

source/game_sa/Audio/AudioEngine.cpp

@@ -105,6 +105,9 @@ void CAudioEngine::InjectHooks() {
 bool CAudioEngine::Initialise() {
     CLoadingScreen::Pause();
 
+    // NOTSA: Initialize AudioUtility before `AEAudioHardware` to avoid crash (Division by zero in `GetCurrentTimeInMS`)
+    CAEAudioUtility::StaticInitialise();
+
     if (!AEAudioHardware.Initialise()) {
         NOTSA_LOG_ERR("Failed to initialise Audio Hardware");
         return false;
@@ -138,7 +141,7 @@ bool CAudioEngine::Initialise() {
 
     m_FrontendAE.Initialise();
     CAudioEngine::SetEffectsFaderScalingFactor(0.0f);
-    CAEAudioUtility::StaticInitialise();
+    //CAEAudioUtility::StaticInitialise(); // Initialized above
     CAEPedAudioEntity::StaticInitialise();
     CAEPedSpeechAudioEntity::StaticInitialise();
     CAEVehicleAudioEntity::StaticInitialise();