Fix #4166 (Engine Sounds of other Helicopters and planes missing...) (#128)

* Fix #4166 (Engine Sounds of other Helicopters and planes missing unless you get in a Helicopter or plane)

* Addendum to last commit

Use #pragma once

Author: lopezloo

Client/game_sa/CAEAudioHardwareSA.cpp

@@ -0,0 +1,50 @@
+/*****************************************************************************
+*
+*  PROJECT:     Multi Theft Auto v1.0
+*  LICENSE:     See LICENSE in the top level directory
+*  FILE:        game_sa/CAEAudioHardwareSA.cpp
+*  PURPOSE:     Audio hardware
+*
+*  Multi Theft Auto is available from http://www.multitheftauto.com/
+*
+*****************************************************************************/
+
+#include "StdInc.h"
+
+CAEAudioHardwareSA::CAEAudioHardwareSA ( CAEAudioHardwareSAInterface * pInterface )
+{
+    m_pInterface = pInterface;
+}
+
+bool CAEAudioHardwareSA::IsSoundBankLoaded ( short wSoundBankID, short wSoundBankSlotID )
+{
+    DWORD dwSoundBankID = wSoundBankID;
+    DWORD dwSoundBankSlotID = wSoundBankSlotID;
+    DWORD dwThis = ( DWORD ) m_pInterface;
+    DWORD dwFunc = FUNC_CAEAudioHardware__IsSoundBankLoaded;
+    bool bReturn = false;
+    _asm
+    {
+        push    dwSoundBankSlotID
+        push    dwSoundBankID
+        mov     ecx, dwThis
+        call    dwFunc
+        mov     bReturn, al
+    }
+    return bReturn;
+}
+
+void CAEAudioHardwareSA::LoadSoundBank ( short wSoundBankID, short wSoundBankSlotID )
+{
+    DWORD dwSoundBankID = wSoundBankID;
+    DWORD dwSoundBankSlotID = wSoundBankSlotID;
+    DWORD dwThis = ( DWORD ) m_pInterface;
+    DWORD dwFunc = FUNC_CAEAudioHardware__LoadSoundBank;
+    _asm
+    {
+        push    dwSoundBankSlotID
+        push    dwSoundBankID
+        mov     ecx, dwThis
+        call    dwFunc
+    }
+}

Client/game_sa/CAEAudioHardwareSA.h

@@ -0,0 +1,36 @@
+/*****************************************************************************
+*
+*  PROJECT:     Multi Theft Auto v1.0
+*  LICENSE:     See LICENSE in the top level directory
+*  FILE:        game_sa/CAEAudioHardwareSA.h
+*  PURPOSE:     Audio hardware header
+*
+*  Multi Theft Auto is available from http://www.multitheftauto.com/
+*
+*****************************************************************************/
+
+#pragma once
+
+#include "Common.h"
+#include <game/CAEAudioHardware.h>
+
+#define FUNC_CAEAudioHardware__IsSoundBankLoaded                            0x4D88C0
+#define FUNC_CAEAudioHardware__LoadSoundBank                                0x4D88A0
+
+#define CLASS_CAEAudioHardware                                              0xB5F8B8
+
+class CAEAudioHardwareSAInterface
+{
+
+};
+
+class CAEAudioHardwareSA : public CAEAudioHardware
+{
+public:
+                                        CAEAudioHardwareSA                  ( CAEAudioHardwareSAInterface * pInterface );
+    bool                                IsSoundBankLoaded                   ( short wSoundBankID, short wSoundBankSlotID );
+    void                                LoadSoundBank                       ( short wSoundBankID, short wSoundBankSlotID );
+
+private:
+    CAEAudioHardwareSAInterface *       m_pInterface;
+};

Client/game_sa/CAEVehicleAudioEntitySA.cpp

@@ -0,0 +1,41 @@
+/*****************************************************************************
+*
+*  PROJECT:     Multi Theft Auto v1.0
+*  LICENSE:     See LICENSE in the top level directory
+*  FILE:        game_sa/CAEVehicleAudioEntitySA.cpp
+*  PURPOSE:     Vehicle audio entity
+*
+*  Multi Theft Auto is available from http://www.multitheftauto.com/
+*
+*****************************************************************************/
+
+#include "StdInc.h"
+
+CAEVehicleAudioEntitySA::CAEVehicleAudioEntitySA ( CAEVehicleAudioEntitySAInterface * pInterface )
+{
+    m_pInterface = pInterface;
+}
+
+// Based on CAEVehicleAudioEntity::JustGotInVehicleAsDriver
+// Loads accelerate sound bank for planes and helis.
+void CAEVehicleAudioEntitySA::LoadDriverSounds ( void )
+{
+    CAEVehicleAudioEntitySAInterface * pVehicleAudioEntity = m_pInterface;
+    char soundType = pVehicleAudioEntity->m_nSettings.m_nVehicleSoundType;
+
+    // If it's heli or plane sound type
+    if ( soundType == 4 || soundType == 5 )
+    {
+        // If there is accelerate sound bank defined
+        if ( pVehicleAudioEntity->m_wEngineAccelerateSoundBankId != -1 )
+        {
+            CAEAudioHardware * pAEAudioHardware = pGame->GetAEAudioHardware ();
+            // If this bank is not already loaded
+            if ( !pAEAudioHardware->IsSoundBankLoaded ( pVehicleAudioEntity->m_wEngineAccelerateSoundBankId, BANKSLOT_ENGINE_RESIDENT ) )
+            {
+                // Load it
+                pAEAudioHardware->LoadSoundBank ( pVehicleAudioEntity->m_wEngineAccelerateSoundBankId, BANKSLOT_ENGINE_RESIDENT );
+            }
+        }
+    }
+}

Client/game_sa/CAEVehicleAudioEntitySA.h

@@ -55,38 +55,67 @@ class CAEAudioEntity
 public:
     CAEAudioEntityVTBL * vtbl;
     CEntitySAInterface * pEntity;
+    char m_tempSound[0x74]; // CAESound
 };
+static_assert(sizeof(CAEAudioEntity) == 0x7C, "Invalid size for CAEAudioEntity");
 
 class CAESound
 {
 public:
-    ushort  usGroup;    //+0
-    ushort  usIndex;    //+2
-    CAEAudioEntity*         pAudioEntity;   //+4
-    CEntitySAInterface*     pGameEntity;    //+8    Either a player or NULL
-    int     a;          //+c  = 3
-    float   b;          //+10 = -1.f
-    float   c;          //+14 = -50.f
-    float   fVolume;    //+18 = 1.f
-    float   fPitch;     //+1c = 1.f
-    uint    d;          //+20
-    CVector vec1;       //+24 = Position of player?
-    CVector vec2;       //+30 = Position of player?
-    int     e;          //+3c = 1,621         set from framecounter, no set pos if non zero
-    int     f;          //+40 = 300           time in milliseconds
-    int     g;          //+44 = 300           set from framecounter
-    float   h;          //+48 = 2997.3567f    start something?
-    float   j;          //+4c = 2997.3567f    current something?
-    float   k;          //+50 = 1.0f
-    ushort  l;          //+54 = 31488
-    ushort  m;          //+56 = 1005
-    int     n;          //+58 = 1
-    int     o;          //+5C = 0
-    float   p;          //+60 = -100.f
-    float   q;          //+64 = 1.f
-    ushort  r;          //+68 = 0         (1 on stop)
-    ushort  s;          //+6a = 114       
+    ushort  usGroup;                        // +0
+    ushort  usIndex;                        // +2
+    CAEAudioEntity*         pAudioEntity;   // +4
+    CEntitySAInterface*     pGameEntity;    // +8    Either a player or NULL
+    unsigned int m_dwEvent;                 // +12
+    float   m_fMaxVolume;                   // +16
+    float   m_fVolume;                      // +20
+    float   m_fSoundDistance;               // +24
+    float   m_fSpeed;                       // +28
+    float   unk1;                           // +32
+    CVector m_vCurrPosn;                    // +36
+    CVector m_vPrevPosn;                    // +48
+    int     m_dwLastFrameUpdate;            // +60
+    int     m_dwCurrTimeUpdate;             // +64
+    int     m_dwPrevTimeUpdate;             // +68
+    float   m_fCurrCamDist;                 // +72
+    float   m_fPrevCamDist;                 // +76
+    float   m_fTimeScale;                   // +80
+    char    unk2;                           // +84 = 31488
+    char    unk3;                           // +85 = 1005
+    union
+    {
+        unsigned short m_wEnvironmentFlags;
+        struct
+        {
+            unsigned short m_bFrontEnd : 1;
+            unsigned short m_bUncancellable : 1;
+            unsigned short m_bRequestUpdates : 1;
+            unsigned short m_bPlayPhysically : 1;
+            unsigned short m_bUnpausable : 1;
+            unsigned short m_bStartPercentage : 1;
+            unsigned short m_bMusicMastered : 1;
+            unsigned short m_bLifespanTiedToPhysicalEntity : 1;
+            unsigned short m_bUndackable : 1;
+            unsigned short m_bUncompressable : 1;
+            unsigned short m_bRolledOff : 1;
+            unsigned short m_bSmoothDucking : 1;
+            unsigned short m_bForcedFront : 1;
+        };
+    };
+    unsigned short m_wIsUsed;               // +88
+    short   unk4;                           // +90 = 1005
+    short   m_wCurrentPlayPosition;         // +92
+    short   unk5;                           // +94 = 0
+    float   m_fFinalVolume;                 // +96
+    float   m_fFrequency;                   // +100
+    short   m_wPlayingState;                // +104
+    char    unk6[2];                        // +106
+    float   m_fSoundHeadRoom;               // +108
+    short   unk7;                           // +112
+    short   unk8;                           // +114
+
 };
+static_assert(sizeof(CAESound) == 0x74, "Invalid size for CAESound");
 
 class CAudioEngineSA : public CAudioEngine
 {

Client/game_sa/CAudioEngineSA.h

@@ -66,6 +66,7 @@ CGameSA::CGameSA()
 
     DEBUG_TRACE("CGameSA::CGameSA()");
     this->m_pAudioEngine            = new CAudioEngineSA((CAudioEngineSAInterface*)CLASS_CAudioEngine);
+    this->m_pAEAudioHardware        = new CAEAudioHardwareSA((CAEAudioHardwareSAInterface*)CLASS_CAEAudioHardware);
     this->m_pAudioContainer         = new CAudioContainerSA();
     this->m_pWorld                  = new CWorldSA();
     this->m_pPools                  = new CPoolsSA();
@@ -240,6 +241,7 @@ CGameSA::~CGameSA ( void )
     delete reinterpret_cast < CPoolsSA* > ( m_pPools );
     delete reinterpret_cast < CWorldSA* > ( m_pWorld );
     delete reinterpret_cast < CAudioEngineSA* > ( m_pAudioEngine );
+    delete reinterpret_cast < CAEAudioHardwareSA* > ( m_pAEAudioHardware );
     delete reinterpret_cast < CAudioContainerSA* > ( m_pAudioContainer );
     delete reinterpret_cast < CPointLightsSA * > ( m_pPointLights );
 }

Client/game_sa/CGameSA.cpp

@@ -135,6 +135,7 @@ class CGameSA : public CGame
     inline CTheCarGenerators        * GetTheCarGenerators()     { DEBUG_TRACE("CTheCarGenerators  * GetTheCarGenerators()");return m_pTheCarGenerators; };
     inline CAERadioTrackManager     * GetAERadioTrackManager()  { DEBUG_TRACE("CAERadioTrackManager * GetAERadioTrackManager()");return m_pCAERadioTrackManager; };
     inline CAudioEngine             * GetAudioEngine()          { DEBUG_TRACE("CAudio     * GetAudioEngine()");return m_pAudioEngine; };
+    inline CAEAudioHardware         * GetAEAudioHardware()      { DEBUG_TRACE("CAEAudioHardware     * GetAEAudioHardware()");return m_pAEAudioHardware; };
     inline CAudioEngine             * GetAudio()                { DEBUG_TRACE("CAudio     * GetAudioEngine()");return m_pAudioEngine; };
     inline CAudioContainer          * GetAudioContainer()       { DEBUG_TRACE("CAudio     * GetAudioContainer()");return m_pAudioContainer; };
     inline CMenuManager             * GetMenuManager()          { DEBUG_TRACE("CMenuManager         * GetMenuManager()");return m_pMenuManager; };
@@ -296,6 +297,7 @@ class CGameSA : public CGame
     CTheCarGenerators           * m_pTheCarGenerators;
     CAERadioTrackManager        * m_pCAERadioTrackManager;
     CAudioEngine                * m_pAudioEngine;
+    CAEAudioHardware            * m_pAEAudioHardware;
     CAudioContainer             * m_pAudioContainer;
     CMenuManager                * m_pMenuManager;
     CText                       * m_pText;

Client/game_sa/CGameSA.h

@@ -265,6 +265,8 @@ void CVehicleSA::Init ( void )
 
     // only applicable for CAutomobile based vehicles (i.e. not bikes, trains or boats, but includes planes, helis etc)
     this->m_pDamageManager = new CDamageManagerSA( m_pInterface, (CDamageManagerSAInterface *)((DWORD)this->GetInterface() + 1440));
+    
+    this->m_pVehicleAudioEntity = new CAEVehicleAudioEntitySA ( &GetVehicleInterface()->m_VehicleAudioEntity );
 
     // Replace the handling interface with our own to prevent handlig.cfg cheats and allow custom handling stuff.
     // We don't use SA's array because we want one handling per vehicle type and also allow custom handlings
@@ -344,6 +346,12 @@ CVehicleSA::~CVehicleSA()
                 m_pDamageManager = NULL;
             }
 
+            if ( m_pVehicleAudioEntity )
+            {
+                delete m_pVehicleAudioEntity;
+                m_pVehicleAudioEntity = NULL;
+            }
+
             if ( m_pSuspensionLines )
             {
                 delete [] m_pSuspensionLines;

Client/game_sa/CVehicleSA.cpp

@@ -29,6 +29,7 @@ class CVehicleSA;
 #include "CDamageManagerSA.h"
 #include "CDoorSA.h"
 #include "CColPointSA.h"
+#include "CAEVehicleAudioEntitySA.h"
 
 #define SIZEOF_CHELI                            2584
 
@@ -322,17 +323,6 @@ struct CTrainFlags
     unsigned char unknown7 : 8;
 };
 
-
-// TODO: Size?
-class CAEVehicleAudioEntity
-{
-    BYTE pad1[154];
-public:
-    BYTE bCurrentRadioStation;
-private:
-    BYTE pad2;
-};
-
 class CAutoPilot
 {
     BYTE pad[56];
@@ -346,9 +336,7 @@ class CAutoPilot
 class CVehicleSAInterface : public CPhysicalSAInterface
 {
 public:
-    CAEVehicleAudioEntity m_VehicleAudioEntity; // 312
-
-    int padaudio[108];
+    CAEVehicleAudioEntitySAInterface m_VehicleAudioEntity; // 312
 
     tHandlingDataSA* pHandlingData;                             // +900
     tFlyingHandlingDataSA* pFlyingHandlingData;                 // +904
@@ -515,6 +503,7 @@ class CVehicleSA : public virtual CVehicle, public virtual CPhysicalSA
     friend class CPoolsSA;
 private:
     CDamageManagerSA*           m_pDamageManager;
+    CAEVehicleAudioEntitySA*    m_pVehicleAudioEntity;
     CHandlingEntrySA*           m_pHandlingData;
     void*                       m_pSuspensionLines;
     bool                        m_bIsDerailable;
@@ -789,6 +778,8 @@ class CVehicleSA : public virtual CVehicle, public virtual CPhysicalSA
 
     void                        UpdateLandingGearPosition       ( );
 
+    CAEVehicleAudioEntitySA *   GetVehicleAudioEntity           ( void )  { return m_pVehicleAudioEntity; };
+
 private:
     void                        RecalculateSuspensionLines          ( void );
     void                        CopyGlobalSuspensionLinesToPrivate  ( void );

Client/game_sa/CVehicleSA.h

@@ -59,6 +59,8 @@
 #include "CPedSA.h"
 #include "CPedSoundSA.h"
 #include "CAudioEngineSA.h"
+#include "CAEAudioHardwareSA.h"
+#include "CAEVehicleAudioEntitySA.h"
 #include "CAudioContainerSA.h"
 #include "CPlayerInfoSA.h"
 #include "CPopulationSA.h"