src/s_sound.h

   1 // Emacs style mode select   -*- C++ -*-
   2 //-----------------------------------------------------------------------------
   3 //
   4 // Copyright(C) 1993-1996 Id Software, Inc.
   5 // Copyright(C) 2005 Simon Howard
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License
   9 // as published by the Free Software Foundation; either version 2
  10 // of the License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20 // 02111-1307, USA.
  21 //
  22 // DESCRIPTION:
  23 //      The not so system specific sound interface.
  24 //
  25 //-----------------------------------------------------------------------------
  26
  27
  28 #ifndef __S_SOUND__
  29 #define __S_SOUND__
  30
  31 #include "p_mobj.h"
  32 #include "sounds.h"
  33
  34 typedef enum
  35 {
  36     SNDDEVICE_NONE = 0,
  37     SNDDEVICE_PCSPEAKER = 1,
  38     SNDDEVICE_ADLIB = 2,
  39     SNDDEVICE_SB = 3,
  40     SNDDEVICE_PAS = 4,
  41     SNDDEVICE_GUS = 5,
  42     SNDDEVICE_WAVEBLASTER = 6,
  43     SNDDEVICE_SOUNDCANVAS = 7,
  44     SNDDEVICE_GENMIDI = 8,
  45     SNDDEVICE_AWE32 = 9,
  46 } snddevice_t;
  47
  48 // Interface for sound modules
  49
  50 typedef struct
  51 {
  52     // List of sound devices that this sound module is used for.
  53
  54     snddevice_t *sound_devices;
  55     int num_sound_devices;
  56
  57     // Initialize sound module
  58     // Returns true if successfully initialized
  59
  60     boolean (*Init)(void);
  61
  62     // Shutdown sound module
  63
  64     void (*Shutdown)(void);
  65
  66     // Returns the lump index of the given sound.
  67
  68     int (*GetSfxLumpNum)(sfxinfo_t *sfxinfo);
  69
  70     // Called periodically to update the subsystem.
  71
  72     void (*Update)(void);
  73
  74     // Update the sound settings on the given channel.
  75
  76     void (*UpdateSoundParams)(int channel, int vol, int sep);
  77
  78     // Start a sound on a given channel.  Returns the channel id
  79     // or -1 on failure.
  80
  81     int (*StartSound)(int id, int channel, int vol, int sep);
  82
  83     // Stop the sound playing on the given channel.
  84
  85     void (*StopSound)(int channel);
  86
  87     // Query if a sound is playing on the given channel
  88
  89     boolean (*SoundIsPlaying)(int channel);
  90
  91 } sound_module_t;
  92
  93 // Interface for music modules
  94
  95 typedef struct
  96 {
  97     // List of sound devices that this music module is used for.
  98
  99     snddevice_t *sound_devices;
 100     int num_sound_devices;
 101
 102     // Initialize the music subsystem
 103
 104     boolean (*Init)(void);
 105
 106     // Shutdown the music subsystem
 107
 108     void (*Shutdown)(void);
 109
 110     // Set music volume - range 0-127
 111
 112     void (*SetMusicVolume)(int volume);
 113
 114     // Pause music
 115
 116     void (*PauseMusic)(void);
 117
 118     // Un-pause music
 119
 120     void (*ResumeMusic)(void);
 121
 122     // Register a song handle from data
 123     // Returns a handle that can be used to play the song
 124
 125     void *(*RegisterSong)(void *data, int len);
 126
 127     // Un-register (free) song data
 128
 129     void (*UnRegisterSong)(void *handle);
 130
 131     // Play the song
 132
 133     void (*PlaySong)(void *handle, int looping);
 134
 135     // Stop playing the current song.
 136
 137     void (*StopSong)(void);
 138
 139     // Query if music is playing.
 140
 141     boolean (*MusicIsPlaying)(void);
 142 } music_module_t;
 143
 144 extern int snd_sfxdevice;
 145 extern int snd_musicdevice;
 146 extern int snd_samplerate;
 147
 148 //
 149 // Initializes sound stuff, including volume
 150 // Sets channels, SFX and music volume,
 151 //  allocates channel buffer, sets S_sfx lookup.
 152 //
 153
 154 void S_Init(int sfxVolume, int musicVolume);
 155
 156
 157 // Shut down sound
 158
 159 void S_Shutdown(void);
 160
 161
 162
 163 //
 164 // Per level startup code.
 165 // Kills playing sounds at start of level,
 166 //  determines music if any, changes music.
 167 //
 168
 169 void S_Start(void);
 170
 171 //
 172 // Start sound for thing at <origin>
 173 //  using <sound_id> from sounds.h
 174 //
 175
 176 void S_StartSound(void *origin, int sound_id);
 177
 178 // Stop sound for thing at <origin>
 179 void S_StopSound(mobj_t *origin);
 180
 181
 182 // Start music using <music_id> from sounds.h
 183 void S_StartMusic(int music_id);
 184
 185 // Start music using <music_id> from sounds.h,
 186 //  and set whether looping
 187 void S_ChangeMusic(int music_id, int looping);
 188
 189 // query if music is playing
 190 boolean S_MusicPlaying(void);
 191
 192 // Stops the music fer sure.
 193 void S_StopMusic(void);
 194
 195 // Stop and resume music, during game PAUSE.
 196 void S_PauseSound(void);
 197 void S_ResumeSound(void);
 198
 199
 200 //
 201 // Updates music & sounds
 202 //
 203 void S_UpdateSounds(mobj_t *listener);
 204
 205 void S_SetMusicVolume(int volume);
 206 void S_SetSfxVolume(int volume);
 207
 208
 209 #endif
 210