snd_main.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
  21 #ifndef SND_MAIN_H
  22 #define SND_MAIN_H
  23
  24 #include "sound.h"
  25
  26
  27 typedef struct snd_format_s
  28 {
  29         unsigned int    speed;
  30         unsigned short  width;
  31         unsigned short  channels;
  32 } snd_format_t;
  33
  34 typedef struct snd_buffer_s
  35 {
  36         snd_format_t            format;
  37         unsigned int            nbframes;       // current size, in sample frames
  38         unsigned int            maxframes;      // max size (buffer size), in sample frames
  39         unsigned char           samples[4];     // variable sized
  40 } snd_buffer_t;
  41
  42 typedef struct snd_ringbuffer_s
  43 {
  44         snd_format_t            format;
  45         unsigned char*          ring;
  46         unsigned int            maxframes;      // max size (buffer size), in sample frames
  47         unsigned int            startframe;     // index of the first frame in the buffer
  48                                                                         // if startframe == endframe, the bufffer is empty
  49         unsigned int            endframe;       // index of the first EMPTY frame in the "ring" buffer
  50                                                                         // may be smaller than startframe if the "ring" buffer has wrapped
  51 } snd_ringbuffer_t;
  52
  53 // sfx_t flags
  54 #define SFXFLAG_NONE                    0
  55 #define SFXFLAG_FILEMISSING             (1 << 0) // wasn't able to load the associated sound file
  56 #define SFXFLAG_SERVERSOUND             (1 << 1) // the sfx is part of the server precache list
  57 #define SFXFLAG_STREAMED                (1 << 2) // informative only. You shouldn't need to know that
  58 #define SFXFLAG_PERMANENTLOCK   (1 << 3) // can never be freed (ex: used by the client code)
  59
  60 typedef struct snd_fetcher_s snd_fetcher_t;
  61 struct sfx_s
  62 {
  63         char                            name[MAX_QPATH];
  64         sfx_t                           *next;
  65         size_t                          memsize;                // total memory used (including sfx_t and fetcher data)
  66
  67                                                                                 // One lock is automatically granted while the sfx is
  68                                                                                 // playing (and removed when stopped). Locks can also be
  69         int                                     locks;                  // added by S_PrecacheSound and S_ServerSounds.
  70                                                                                 // A SFX with no lock and no SFXFLAG_PERMANENTLOCK is
  71                                                                                 // freed at level change by S_ServerSounds.
  72
  73         unsigned int            flags;                  // cf SFXFLAG_* defines
  74         unsigned int            loopstart;              // in sample frames. equals total_length if not looped
  75         unsigned int            total_length;   // in sample frames
  76         const snd_fetcher_t     *fetcher;
  77         void                            *fetcher_data;  // Per-sfx data for the sound fetching functions
  78
  79         float                           volume_mult;    // for replay gain (multiplier to apply)
  80         float                           volume_peak;    // for replay gain (highest peak); if set to 0, ReplayGain isn't supported
  81 };
  82
  83 // maximum supported speakers constant
  84 #define SND_LISTENERS 8
  85
  86 typedef struct channel_s
  87 {
  88         short                   listener_volume [SND_LISTENERS];        // 0-255 volume per speaker
  89         int                             master_vol;             // 0-255 master volume
  90         sfx_t                   *sfx;                   // sfx number
  91         unsigned int    flags;                  // cf CHANNELFLAG_* defines
  92         int                             pos;                    // sample position in sfx, negative values delay the start of the sound playback
  93         int                             entnum;                 // to allow overriding a specific sound
  94         int                             entchannel;
  95         vec3_t                  origin;                 // origin of sound effect
  96         vec_t                   dist_mult;              // distance multiplier (attenuation/clipK)
  97         void                    *fetcher_data;  // Per-channel data for the sound fetching function
  98 } channel_t;
  99
 100 // Sound fetching functions
 101 // "start" is both an input and output parameter: it returns the actual start time of the sound buffer
 102 typedef const snd_buffer_t* (*snd_fetcher_getsb_t) (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes);
 103 typedef void (*snd_fetcher_endsb_t) (void *chfetcherdata);
 104 typedef void (*snd_fetcher_free_t) (void *sfxfetcherdata);
 105 typedef const snd_format_t* (*snd_fetcher_getfmt_t) (sfx_t* sfx);
 106 struct snd_fetcher_s
 107 {
 108         snd_fetcher_getsb_t             getsb;
 109         snd_fetcher_endsb_t             endsb;
 110         snd_fetcher_free_t              free;
 111         snd_fetcher_getfmt_t    getfmt;
 112 };
 113
 114 // 0 to NUM_AMBIENTS - 1 = water, etc
 115 // NUM_AMBIENTS to NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS - 1 = normal entity sounds
 116 // NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS to total_channels = static sounds
 117 #define MAX_DYNAMIC_CHANNELS    512
 118 #define MAX_CHANNELS                    1028
 119
 120 extern unsigned int total_channels;
 121 extern channel_t channels[MAX_CHANNELS];
 122
 123 extern snd_ringbuffer_t *snd_renderbuffer;
 124 extern unsigned int soundtime;  // WARNING: sound modules must NOT use it
 125
 126 extern cvar_t _snd_mixahead;
 127 extern cvar_t snd_swapstereo;
 128 extern cvar_t snd_streaming;
 129
 130 #define SND_CHANNELLAYOUT_AUTO          0
 131 #define SND_CHANNELLAYOUT_STANDARD      1
 132 #define SND_CHANNELLAYOUT_ALSA          2
 133 extern cvar_t snd_channellayout;
 134
 135 extern int snd_blocked;         // counter. When > 0, we stop submitting sound to the audio device
 136
 137 extern mempool_t *snd_mempool;
 138
 139 // If simsound is true, the sound card is not initialized and no sound is submitted to it.
 140 // More generally, all arch-dependent operations are skipped or emulated.
 141 // Used for isolating performance in the renderer.
 142 extern qboolean simsound;
 143
 144
 145 // ====================================================================
 146 //         Architecture-independent functions
 147 // ====================================================================
 148
 149 void S_PaintChannels (snd_ringbuffer_t* rb, unsigned int starttime, unsigned int endtime);
 150
 151 qboolean S_LoadSound (sfx_t *sfx, qboolean complain);
 152
 153 void S_LockSfx (sfx_t *sfx);
 154 void S_UnlockSfx (sfx_t *sfx);
 155
 156 snd_buffer_t *Snd_CreateSndBuffer (const unsigned char *samples, unsigned int sampleframes, const snd_format_t* in_format, unsigned int sb_speed);
 157 qboolean Snd_AppendToSndBuffer (snd_buffer_t* sb, const unsigned char *samples, unsigned int sampleframes, const snd_format_t* format);
 158
 159 // If "buffer" is NULL, the function allocates one buffer of "sampleframes" sample frames itself
 160 // (if "sampleframes" is 0, the function chooses the size).
 161 snd_ringbuffer_t *Snd_CreateRingBuffer (const snd_format_t* format, unsigned int sampleframes, void* buffer);
 162
 163
 164 // ====================================================================
 165 //         Architecture-dependent functions
 166 // ====================================================================
 167
 168 // Create "snd_renderbuffer" with the proper sound format if the call is successful
 169 // May return a suggested format if the requested format isn't available
 170 qboolean SndSys_Init (const snd_format_t* requested, snd_format_t* suggested);
 171
 172 // Stop the sound card, delete "snd_renderbuffer" and free its other resources
 173 void SndSys_Shutdown (void);
 174
 175 // Submit the contents of "snd_renderbuffer" to the sound card
 176 void SndSys_Submit (void);
 177
 178 // Returns the number of sample frames consumed since the sound started
 179 unsigned int SndSys_GetSoundTime (void);
 180
 181 // Get the exclusive lock on "snd_renderbuffer"
 182 qboolean SndSys_LockRenderBuffer (void);
 183
 184 // Release the exclusive lock on "snd_renderbuffer"
 185 void SndSys_UnlockRenderBuffer (void);
 186
 187
 188 #endif