prj/cam/src/sound/psndinst.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 ///////////////////////////////////////////////////////////////////////////////
   7 // $Header: r:/t2repos/thief2/src/sound/psndinst.h,v 1.22 2000/01/29 13:41:46 adurant Exp $
   8 //
   9 // Sound propagation instance header
  10 //
  11 #pragma once
  12
  13 #ifndef __PSNDINST_H
  14 #define __PSNDINST_H
  15
  16 #include <matrixs.h>
  17
  18 #include <dynarray.h>
  19 #include <hashpp.h>
  20
  21 #include <appsfx.h>
  22 #include <roomsys.h>
  23 #include <roompa.h>
  24
  25 #include <psndinfo.h>
  26
  27 F_DECLARE_INTERFACE(IAIManager);
  28
  29 ////////////////////////////////////////
  30
  31 // Max active sounds.
  32 const int kMaxActiveSounds = 32;
  33
  34 ////////////////////////////////////////////////////////////////////////////////
  35
  36 EXTERN void EndSampleCallback(int hSound, void *ptr);
  37 EXTERN void LoopSampleCallback(int hSound, void *ptr);
  38
  39 ////////////////////////////////////////////////////////////////////////////////
  40
  41 typedef cHashTableFunctions<ObjID> ObjIDHashFunctions;
  42
  43 typedef cHashTable<ObjID, cSoundInfoList *, ObjIDHashFunctions> cSoundInfoTable;
  44 typedef cHashTable<ObjID, mxs_real, ObjIDHashFunctions>         cSoundPropTable;
  45
  46 typedef cDynArray<ObjID> cSoundObjectList;
  47
  48 typedef cDynArray<const cRoomPortal *> cPortalStack;
  49
  50 typedef struct
  51 {
  52    mxs_vector pos;
  53    BOOL valid;
  54 } sAnchorPt;
  55
  56 ////////////////////
  57 enum PrioritizationResult
  58 {
  59    PRIORITY_RES_OK,
  60    PRIORITY_RES_FAIL,
  61    PRIORITY_RES_DEFERRED
  62 };
  63
  64 enum eDeferredHaltType
  65 {
  66    kDH_Kill,
  67    kDH_Silence,
  68 };
  69
  70 typedef struct
  71 {
  72    int sfx_handle;
  73    int type;
  74 } sDeferredHalt;
  75
  76
  77 ////////////////////////////////////////////////////////////////////////////////
  78
  79 class cPropSndInst : public cRoomPAFuncs
  80 {
  81 public:
  82
  83    /////////////////
  84    //
  85    // Constructor / Destructor
  86    //
  87    cPropSndInst();
  88    ~cPropSndInst();
  89
  90    void Init(int handle, ObjID objID, const mxs_vector &loc, ObjID schemaID, const char *sampleName,
  91              int flags, float atten_factor, sfx_parm *parms, void *data);
  92    void Cleanup();
  93
  94    void ApplySoundInfo();
  95    void ClearSoundInfo();
  96
  97    cPlayerSoundList *GeneratePlayerSoundList(int handle);
  98
  99    void AddDeferredHalt(int sfx_handle, int type);
 100    void ApplyDeferredHaltList();
 101
 102    void AddActiveSound(cSoundInfo *pSoundInfo);
 103    void EndActiveSound(cSoundInfo *pSoundInfo);
 104
 105    void BumpActiveSound(cPlayerSoundList *pPlayerList);
 106
 107    void SetupPlayerSoundListCallbacks (cPlayerSoundList* pCurPlayerList);
 108    BOOL PlaySoundList (cPlayerSoundList* pCurPlayerList);
 109
 110    #ifndef SHIP
 111    void SetDrawSoundPath(BOOL state) { m_DrawSoundPath = state; };
 112
 113    void DrawActiveSounds();
 114    void SpewActiveSounds();
 115    #endif
 116
 117 protected:
 118
 119    ////////////////////////////
 120
 121    mxs_real    m_MaxDistance;    // Maximum distance the sound can be heard
 122    mxs_real    m_ScaleDistance;  // Forces max distance for sound
 123
 124    ObjID       m_SrcObject;      // ID of object making sound (-1 if not applicable)
 125    mxs_vector  m_SrcPoint;       // Coordinates of sound source
 126
 127    const char *m_SampleName;     // Name of sample being propagated
 128    sfx_parm   *m_pParms;         // Parameters from schema system
 129
 130    ObjID       m_SchemaID;       // ObjID of the schema
 131
 132    void       *m_Data;           // Any data that wants to be propagated too
 133
 134    int         m_Handle;         // Sound propagation handle
 135
 136    int         m_Flags;          // Sound info flags
 137
 138    ////////////////////////////
 139
 140    cSoundInfoTable  m_InfoTable;      // Hash by objid to list sounds heard this frame
 141    cSoundObjectList m_InfoList;       // List of objects that have heard a sound this frame
 142
 143    cSoundInfo      *m_ActiveSound[kMaxActiveSounds];
 144    ObjID            m_ActiveObject[kMaxActiveSounds];
 145    int              m_nActiveSoundObjects;
 146
 147    cDynArray<sDeferredHalt> m_deferredHaltList;
 148
 149    short m_roomNoBlock1;
 150    short m_roomNoBlock2;
 151
 152    float m_attenFactor;
 153
 154 #ifndef SHIP
 155    BOOL m_DrawSoundPath;
 156
 157    BOOL m_SoundSpew;
 158    BOOL m_SoundFullSpew;
 159    BOOL m_SoundGhostSpew;
 160    BOOL m_SoundFullAISpew;
 161    BOOL m_SoundPathSpew;
 162    BOOL m_SoundHearSpew;
 163 #endif
 164
 165    void FindSoundPath(const mxs_vector &src_pt, const mxs_vector &hear_pt, const cBFRoomInfo *room_table, int end_room,
 166                       mxs_real *dist, mxs_vector *position, mxs_real *realDist, mxs_real *blockingFactor);
 167    void BackCastPath(sAnchorPt *anchor_list, cRoomPortal **portal_list, int i, const mxs_vector &L, const mxs_vector &src_pt);
 168
 169 private:
 170
 171    BOOL MergeSounds(cSoundInfoList *pSoundInfoList);
 172
 173    BOOL ActiveSound(cSoundInfo *pSoundInfo);
 174
 175    void ResolveActiveSounds(ObjID hearingObj);
 176    void UpdateActiveSounds();
 177
 178    void ResolveDeferredSounds(ObjID hearingObj);
 179    void UpdateDeferredSounds();
 180
 181    IAIManager * m_pAIManager;
 182 };
 183
 184 ////////////////////////////////////////////////////////////////////////////////
 185
 186 class cPropSndInstHigh : public cPropSndInst
 187 {
 188 public:
 189
 190    /////////////////
 191    //
 192    // Callbacks
 193    //
 194    BOOL     EnterCallback(const cRoom *room, const cRoomPortal *enterPortal, const mxs_vector &enterPt, mxs_real dist);
 195    void     ExitCallback(const cRoom *room);
 196    mxs_real PortalsCallback(const cRoomPortal *enterPortal, const cRoomPortal *exitPortal, mxs_real dist);
 197 };
 198
 199 ////////////////////////////////////////////////////////////////////////////////
 200
 201 #endif
 202
 203
 204
 205
 206
 207
 208
 209