prj/cam/src/sound/psnd.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/psnd.h,v 1.22 1999/08/05 18:20:32 Justin Exp $
   8 //
   9 // Sound propagation header
  10 //
  11
  12 #pragma once
  13
  14 #ifndef __PSND_H
  15 #define __PSND_H
  16
  17 #include <matrixs.h>
  18 #include <hashpp.h>
  19
  20 #include <objtype.h>
  21
  22 #include <roomsys.h>
  23 #include <roompa.h>
  24
  25 #include <psndapi.h>
  26 #include <psndinst.h>
  27 #include <psndinfo.h>
  28
  29 #include <mprintf.h>
  30
  31 ///////////////////////////////////////////////////////////////////////////////
  32
  33 #define EFF_PRI_MIN 0
  34 #define EFF_PRI_MAX 65535
  35
  36 const int kMinUpdateFrequency = 16;
  37 const int kMaxUpdateFrequency = 1;
  38 const int kDeferredUpdateFrequency = 16;
  39
  40 ////////////////////////////////////////////////////////////////////////////////
  41
  42 typedef class cPropSndInst     cPropSndInst;
  43 typedef class cPropSndInstHigh cPropSndInstHigh;
  44 typedef class cPropSndInstLow  cPropSndInstLow;
  45
  46 typedef cHashTableFunctions<long> LongHashFunctions;
  47 typedef cHashTable<long, mxs_real, LongHashFunctions> cSoundBlockingTable;
  48
  49 ////////////////////////////////////////////////////////////////////////////////
  50
  51 class cPropSnd
  52 {
  53 public:
  54
  55    /////////////////
  56    //
  57    // Constructor / Destructor
  58    //
  59    cPropSnd();
  60    ~cPropSnd();
  61
  62    /////////////////
  63    //
  64    // Functions
  65    //
  66    int  GenerateSound(ObjID objID, ObjID schemaID, const char *sampleName, float atten_factor,
  67                       sfx_parm *parms, int flags, void *data = NULL);
  68    int  GenerateSound(mxs_vector &vec, ObjID src_obj, ObjID schemaID, const char *sampleName, float atten_factor,
  69                       sfx_parm *parms, int flags, void *data = NULL);
  70    int  GenerateSound(const char *sampleName, sfx_parm *parms);
  71
  72
  73    int  GenerateSoundHandle(int handle, ObjID objID, ObjID schemaID, const char *sampleName, float atten_factor,
  74                             sfx_parm *parms, int flags, void *data = NULL);
  75    int  GenerateSoundHandle(int handle, mxs_vector &vec, ObjID src_obj, ObjID schemaID, const char *sampleName,
  76                             float atten_factor, sfx_parm *parms, int flags, void *data = NULL);
  77
  78    // Stops the sound, all sounds, and checks for any playing sounds
  79    void SoundHalt(int handle);
  80    void SoundHaltObj(ObjID objID);
  81    void SoundHaltAll();
  82    BOOL AreSounds();
  83
  84    // Informs each non-player object about sounds this frame
  85    void ApplySoundInfo();
  86    void ClearSoundInfo();
  87
  88    // Cleans up game-mode created objects
  89    void Cleanup();
  90
  91    // Informs the active sound system that the sound has ended
  92    void EndActiveSound(cSoundInfo *pSoundInfo);
  93
  94    // Valid handle checking
  95    int               GetSoundHandle();
  96    void              RegisterSound(int handle, cPlayerSoundList *pSoundList);
  97    int               FindSound(cPlayerSoundList *pSoundList);
  98    cPlayerSoundList *GetSound(int handle);
  99    void              RemoveSound(int handle);
 100
 101    // Sound blocking functions
 102    void     ClearBlockingFactors();
 103    void     SetBlockingFactor(short roomID1, short roomID2, mxs_real factor, BOOL blockAdjacent = TRUE);
 104    mxs_real GetBlockingFactor(short roomID1, short roomID2);
 105    void     RemoveBlockingFactor(short roomID1, short roomID2, BOOL blockAdjacent = TRUE);
 106
 107    PrioritizationResult Prioritize(const cPlayerSoundList* pPlayerList);
 108
 109    // Networking functions
 110    BOOL ShouldPlaySound(const sfx_parm *pParms, int flags, BOOL onObject, ObjID srcObject) const;
 111    BOOL ShouldNetworkSound(const sfx_parm *pParms, int flags, BOOL onObject, ObjID srcObject) const;
 112
 113 #ifndef SHIP
 114    void SetDrawSoundPath(BOOL state);
 115
 116    void DrawActiveSounds();
 117    void SpewActiveSounds();
 118 #endif
 119
 120 private:
 121    // Prioritization functions.
 122    BOOL TypeCapReached(uchar type);
 123    int  EffectivePriority(const cPlayerSoundList *pPlayerList);
 124    cPlayerSoundList* LowestPrioritySoundOfType(uchar type, int *itsEffectivePriority);
 125    cPlayerSoundList* LowestPrioritySound(int *itsEffectivePriority);
 126
 127    void BumpActiveSound(cPlayerSoundList *pPlayerList);
 128
 129    // Sound blocking
 130    void BlockAdjacentRooms(short roomID1, short roomID2, mxs_real factor);
 131
 132    cPlayerSoundList *GeneratePlayerSoundList(int handle);
 133
 134    cPlayerSoundList *m_SoundList[kMaxActiveSounds];
 135
 136    cSoundBlockingTable m_SoundBlockingTable;
 137
 138    cPropSndInstHigh  m_SoundInstHigh;
 139
 140    cPropSndInst   *m_SoundInstance;
 141    cRoomPropAgent  m_PropAgent;
 142
 143    BOOL  m_NoSound;
 144
 145 };
 146
 147 ////////////////////////////////////////
 148
 149 inline void cPropSnd::ApplySoundInfo()
 150 {
 151    Assert_(m_SoundInstance);
 152    m_SoundInstance->ApplySoundInfo();
 153 }
 154
 155 ////////////////////////////////////////
 156
 157 inline void cPropSnd::ClearSoundInfo()
 158 {
 159    Assert_(m_SoundInstance);
 160    m_SoundInstance->ClearSoundInfo();
 161 }
 162
 163 ////////////////////////////////////////
 164
 165 inline void cPropSnd::Cleanup()
 166 {
 167    Assert_(m_SoundInstance);
 168    m_SoundInstance->Cleanup();
 169 }
 170
 171 ////////////////////////////////////////////////////////////////////////////////
 172
 173 inline void cPropSnd::RegisterSound(int handle, cPlayerSoundList *pSoundList)
 174 {
 175    Assert_((handle >= 0) && (handle < kMaxActiveSounds));
 176    Assert_(m_SoundList[handle] == NULL);
 177
 178    m_SoundList[handle] = pSoundList;
 179 }
 180
 181 ////////////////////////////////////////
 182
 183 inline cPlayerSoundList *cPropSnd::GetSound(int handle)
 184 {
 185    Assert_((handle >= 0) && (handle < kMaxActiveSounds));
 186
 187    return m_SoundList[handle];
 188 }
 189
 190 ////////////////////////////////////////
 191
 192 inline void cPropSnd::RemoveSound(int handle)
 193 {
 194    Assert_((handle >= 0) && (handle < kMaxActiveSounds));
 195
 196    m_SoundList[handle] = NULL;
 197 }
 198
 199 ////////////////////////////////////////////////////////////////////////////////
 200
 201 inline void cPropSnd::EndActiveSound(cSoundInfo *pSoundInfo)
 202 {
 203    m_SoundInstance->EndActiveSound(pSoundInfo);
 204 }
 205
 206 ////////////////////////////////////////////////////////////////////////////////
 207
 208 inline cPlayerSoundList *cPropSnd::GeneratePlayerSoundList(int handle)
 209 {
 210    return m_SoundInstance->GeneratePlayerSoundList(handle);
 211 }
 212 ////////////////////////////////////////////////////////////////////////////////
 213
 214 inline void cPropSnd::ClearBlockingFactors()
 215 {
 216    m_SoundBlockingTable.Clear();
 217 }
 218
 219 ////////////////////////////////////////////////////////////////////////////////
 220
 221 #ifndef SHIP
 222 inline void cPropSnd::SetDrawSoundPath(BOOL state)
 223 {
 224    Assert_(m_SoundInstance);
 225    m_SoundInstance->SetDrawSoundPath(state);
 226 }
 227
 228 inline void cPropSnd::DrawActiveSounds()
 229 {
 230    Assert_(m_SoundInstance);
 231    m_SoundInstance->DrawActiveSounds();
 232 }
 233
 234 #endif
 235
 236 ////////////////////////////////////////////////////////////////////////////////
 237
 238 EXTERN cPropSnd *g_pPropSnd;
 239 EXTERN int       g_SndWatchHandle;
 240
 241
 242 ////////////////////////////////////////////////////////////////////////////////
 243
 244 #endif
 245
 246