sound.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 // sound.h -- client sound i/o functions
  21
  22 #ifndef __SOUND__
  23 #define __SOUND__
  24
  25 #define DEFAULT_SOUND_PACKET_VOLUME 255
  26 #define DEFAULT_SOUND_PACKET_ATTENUATION 1.0
  27
  28 typedef struct
  29 {
  30         int left;
  31         int right;
  32 } portable_samplepair_t;
  33
  34 typedef struct sfx_s
  35 {
  36         char    name[MAX_QPATH];
  37         cache_user_t    cache;
  38 } sfx_t;
  39
  40 typedef struct
  41 {
  42         int     length;
  43         int     loopstart;
  44         int     speed;
  45         int     width;
  46         int     stereo;
  47         byte    data[1];                // variable sized
  48 } sfxcache_t;
  49
  50 typedef struct
  51 {
  52         qboolean                gamealive;
  53         qboolean                soundalive;
  54         qboolean                splitbuffer;
  55         int                             channels;
  56         int                             samples;                                // mono samples in buffer
  57         int                             submission_chunk;               // don't mix less than this #
  58         int                             samplepos;                              // in mono samples
  59         int                             samplebits;
  60         int                             speed;
  61         unsigned char   *buffer;
  62 } dma_t;
  63
  64 typedef struct
  65 {
  66         sfx_t   *sfx;                   // sfx number
  67         int             leftvol;                // 0-255 volume
  68         int             rightvol;               // 0-255 volume
  69         int             end;                    // end time in global paintsamples
  70         int     pos;                    // sample position in sfx
  71         int             looping;                // where to loop, -1 = no looping
  72         int             entnum;                 // to allow overriding a specific sound
  73         int             entchannel;             //
  74         vec3_t  origin;                 // origin of sound effect
  75         vec_t   dist_mult;              // distance multiplier (attenuation/clipK)
  76         int             master_vol;             // 0-255 master volume
  77 } channel_t;
  78
  79 typedef struct
  80 {
  81         int             rate;
  82         int             width;
  83         int             channels;
  84         int             loopstart;
  85         int             samples;
  86         int             dataofs;                // chunk starts this many bytes from file start
  87 } wavinfo_t;
  88
  89 void S_Init (void);
  90 void S_Startup (void);
  91 void S_Shutdown (void);
  92 void S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol,  float attenuation);
  93 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
  94 void S_StopSound (int entnum, int entchannel);
  95 void S_StopAllSounds(qboolean clear);
  96 void S_ClearBuffer (void);
  97 void S_Update (vec3_t origin, vec3_t v_forward, vec3_t v_right, vec3_t v_up);
  98 void S_ExtraUpdate (void);
  99
 100 sfx_t *S_PrecacheSound (char *sample);
 101 void S_TouchSound (char *sample);
 102 void S_ClearPrecache (void);
 103 void S_BeginPrecaching (void);
 104 void S_EndPrecaching (void);
 105 void S_PaintChannels(int endtime);
 106 void S_InitPaintChannels (void);
 107
 108 // picks a channel based on priorities, empty slots, number of channels
 109 channel_t *SND_PickChannel(int entnum, int entchannel);
 110
 111 // spatializes a channel
 112 void SND_Spatialize(channel_t *ch);
 113
 114 // initializes cycling through a DMA buffer and returns information on it
 115 qboolean SNDDMA_Init(void);
 116
 117 // gets the current DMA position
 118 int SNDDMA_GetDMAPos(void);
 119
 120 // shutdown the DMA xfer.
 121 void SNDDMA_Shutdown(void);
 122
 123 // ====================================================================
 124 // User-setable variables
 125 // ====================================================================
 126
 127 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
 128 #define MAX_CHANNELS                    516
 129 // LordHavoc: increased maximum sound channels from 8 to 128
 130 #define MAX_DYNAMIC_CHANNELS    128
 131
 132
 133 extern channel_t channels[MAX_CHANNELS];
 134 // 0 to MAX_DYNAMIC_CHANNELS-1  = normal entity sounds
 135 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
 136 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
 137
 138 extern int total_channels;
 139
 140 //
 141 // Fake dma is a synchronous faking of the DMA progress used for
 142 // isolating performance in the renderer.  The fakedma_updates is
 143 // number of times S_Update() is called per second.
 144 //
 145
 146 extern qboolean fakedma;
 147 extern int fakedma_updates;
 148 extern int paintedtime;
 149 extern int soundtime;
 150 extern vec3_t listener_origin;
 151 extern vec3_t listener_forward;
 152 extern vec3_t listener_right;
 153 extern vec3_t listener_up;
 154 extern volatile dma_t *shm;
 155 extern volatile dma_t sn;
 156 extern vec_t sound_nominal_clip_dist;
 157
 158 extern cvar_t loadas8bit;
 159 extern cvar_t bgmvolume;
 160 extern cvar_t volume;
 161 extern cvar_t snd_swapstereo;
 162
 163 extern qboolean snd_initialized;
 164
 165 extern int snd_blocked;
 166
 167 void S_LocalSound (char *s);
 168 sfxcache_t *S_LoadSound (sfx_t *s);
 169
 170 wavinfo_t GetWavinfo (char *name, byte *wav, int wavlength);
 171
 172 void SND_InitScaletable (void);
 173 void SNDDMA_Submit(void);
 174
 175 void S_AmbientOff (void);
 176 void S_AmbientOn (void);
 177
 178 #endif