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
  35 {
  36         int     length;
  37         int     loopstart;
  38         int     speed;
  39         int     width;
  40         int     stereo;
  41         qbyte   data[1];                // variable sized
  42 } sfxcache_t;
  43
  44 typedef struct sfx_s
  45 {
  46         char    name[MAX_QPATH];
  47         mempool_t       *mempool;
  48         sfxcache_t      *sfxcache;
  49         int silentlymissing; // true if missing and loaded with complain = false
  50 } sfx_t;
  51
  52 typedef struct
  53 {
  54         qboolean                gamealive;
  55         qboolean                soundalive;
  56         qboolean                splitbuffer;
  57         int                             channels;
  58         int                             samples;                                // mono samples in buffer
  59         int                             submission_chunk;               // don't mix less than this #
  60         int                             samplepos;                              // in mono samples
  61         int                             samplebits;
  62         int                             speed;
  63         unsigned char   *buffer;
  64 } dma_t;
  65
  66 typedef struct
  67 {
  68         sfx_t   *sfx;                   // sfx number
  69         int             leftvol;                // 0-255 volume
  70         int             rightvol;               // 0-255 volume
  71         int             end;                    // end time in global paintsamples
  72         int     pos;                    // sample position in sfx
  73         int             looping;                // where to loop, -1 = no looping
  74         int             entnum;                 // to allow overriding a specific sound
  75         int             entchannel;             //
  76         vec3_t  origin;                 // origin of sound effect
  77         vec_t   dist_mult;              // distance multiplier (attenuation/clipK)
  78         int             master_vol;             // 0-255 master volume
  79 } channel_t;
  80
  81 typedef struct
  82 {
  83         int             rate;
  84         int             width;
  85         int             channels;
  86         int             loopstart;
  87         int             samples;
  88         int             dataofs;                // chunk starts this many bytes from file start
  89 } wavinfo_t;
  90
  91 void S_Init (void);
  92 void S_Startup (void);
  93 void S_Shutdown (void);
  94 void S_Open (void);
  95 void S_Close (void);
  96 void S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol,  float attenuation);
  97 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
  98 void S_StopSound (int entnum, int entchannel);
  99 void S_StopAllSounds(qboolean clear);
 100 void S_ClearBuffer (void);
 101 void S_Update (vec3_t origin, vec3_t v_forward, vec3_t v_right, vec3_t v_up);
 102 void S_ExtraUpdate (void);
 103
 104 sfx_t *S_PrecacheSound (char *sample, int complain);
 105 void S_TouchSound (char *sample);
 106 void S_ClearPrecache (void);
 107 void S_BeginPrecaching (void);
 108 void S_EndPrecaching (void);
 109 void S_PaintChannels(int endtime);
 110 void S_InitPaintChannels (void);
 111
 112 // picks a channel based on priorities, empty slots, number of channels
 113 channel_t *SND_PickChannel(int entnum, int entchannel);
 114
 115 // spatializes a channel
 116 void SND_Spatialize(channel_t *ch);
 117
 118 // initializes cycling through a DMA buffer and returns information on it
 119 qboolean SNDDMA_Init(void);
 120
 121 // gets the current DMA position
 122 int SNDDMA_GetDMAPos(void);
 123
 124 // shutdown the DMA xfer.
 125 void SNDDMA_Shutdown(void);
 126
 127 // ====================================================================
 128 // User-setable variables
 129 // ====================================================================
 130
 131 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
 132 #define MAX_CHANNELS                    516
 133 // LordHavoc: increased maximum sound channels from 8 to 128
 134 #define MAX_DYNAMIC_CHANNELS    128
 135
 136
 137 extern channel_t channels[MAX_CHANNELS];
 138 // 0 to MAX_DYNAMIC_CHANNELS-1  = normal entity sounds
 139 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
 140 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
 141
 142 extern int total_channels;
 143
 144 //
 145 // Fake dma is a synchronous faking of the DMA progress used for
 146 // isolating performance in the renderer.  The fakedma_updates is
 147 // number of times S_Update() is called per second.
 148 //
 149
 150 extern qboolean fakedma;
 151 extern int fakedma_updates;
 152 extern int paintedtime;
 153 extern int soundtime;
 154 extern vec3_t listener_origin;
 155 extern vec3_t listener_forward;
 156 extern vec3_t listener_right;
 157 extern vec3_t listener_up;
 158 extern volatile dma_t *shm;
 159 extern volatile dma_t sn;
 160 extern vec_t sound_nominal_clip_dist;
 161
 162 extern cvar_t loadas8bit;
 163 extern cvar_t bgmvolume;
 164 extern cvar_t volume;
 165 extern cvar_t snd_swapstereo;
 166
 167 extern qboolean cdaudioinitialized;
 168 extern qboolean snd_initialized;
 169
 170 extern int snd_blocked;
 171
 172 void S_LocalSound (char *s);
 173 sfxcache_t *S_LoadSound (sfx_t *s, int complain);
 174
 175 wavinfo_t GetWavinfo (char *name, qbyte *wav, int wavlength);
 176
 177 void SND_InitScaletable (void);
 178 void SNDDMA_Submit(void);
 179
 180 void S_AmbientOff (void);
 181 void S_AmbientOn (void);
 182
 183 void *S_LockBuffer(void);
 184 void S_UnlockBuffer(void);
 185
 186 // add some data to the tail of the rawsamples queue
 187 void S_RawSamples_Enqueue(short *samples, unsigned int length);
 188 // read and remove some data from the head of the rawsamples queue
 189 void S_RawSamples_Dequeue(int *samples, unsigned int length);
 190 // empty the rawsamples queue
 191 void S_RawSamples_ClearQueue(void);
 192 // returns how much more data the queue wants, or 0 if it is already full enough
 193 int S_RawSamples_QueueWantsMore(void);
 194
 195 // resamples one sound buffer into another, while changing the length
 196 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength);
 197
 198 // returns the rate that the rawsamples system is running at
 199 int S_RawSamples_SampleRate(void);
 200
 201 #endif
 202