src/libgame/sound.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2001 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * sound.h                                                  *
  12 ***********************************************************/
  13
  14 #ifndef SOUND_H
  15 #define SOUND_H
  16
  17 #include <math.h>
  18
  19 #include "platform.h"
  20
  21 #if defined(PLATFORM_LINUX)
  22 #include <sys/ioctl.h>
  23 #endif
  24
  25 #if defined(PLATFORM_LINUX)
  26 #include <linux/soundcard.h>
  27 #elif defined(PLATFORM_FREEBSD)
  28 #include <machine/soundcard.h>
  29 #elif defined(PLATFORM_NETBSD)
  30 #include <sys/ioctl.h>
  31 #include <sys/audioio.h>
  32 #elif defined(PLATFORM_HPUX)
  33 #include <sys/audio.h>
  34 #endif
  35
  36 #include "system.h"
  37
  38
  39 #if defined(PLATFORM_LINUX) || defined(PLATFORM_FREEBSD) || defined(VOXWARE)
  40 #define AUDIO_LINUX_IOCTL
  41 #endif
  42
  43 #if defined(AUDIO_LINUX_IOCTL) || defined(PLATFORM_NETBSD)
  44 #define AUDIO_STREAMING_DSP
  45 #endif
  46
  47 #define AUDIO_SAMPLE_RATE_8000                  8000
  48 #define AUDIO_SAMPLE_RATE_22050                 22050
  49
  50 #define AUDIO_FRAGMENT_SIZE_512                 512
  51 #define AUDIO_FRAGMENT_SIZE_1024                1024
  52 #define AUDIO_FRAGMENT_SIZE_2048                2048
  53 #define AUDIO_FRAGMENT_SIZE_4096                4096
  54
  55 #define AUDIO_MONO_CHANNEL                      1
  56 #define AUDIO_STEREO_CHANNELS                   2
  57
  58 #if defined(TARGET_SDL)
  59 /* one second fading interval == 1000 ticks (milliseconds) */
  60 #define SOUND_FADING_INTERVAL                   1000
  61 #define SOUND_MAX_VOLUME                        SDL_MIX_MAXVOLUME
  62 #endif
  63
  64 #if defined(AUDIO_STREAMING_DSP)
  65 #define SOUND_FADING_VOLUME_STEP                (PSND_MAX_VOLUME / 40)
  66 #define SOUND_FADING_VOLUME_THRESHOLD           (SOUND_FADING_VOLUME_STEP * 2)
  67 #endif
  68
  69 #define DEFAULT_AUDIO_SAMPLE_RATE               AUDIO_SAMPLE_RATE_22050
  70 #define DEFAULT_AUDIO_FRAGMENT_SIZE_UNIX        AUDIO_FRAGMENT_SIZE_512
  71 #define DEFAULT_AUDIO_FRAGMENT_SIZE_WIN32       AUDIO_FRAGMENT_SIZE_2048
  72
  73 #if defined(PLATFORM_UNIX)
  74 #define DEFAULT_AUDIO_FRAGMENT_SIZE     DEFAULT_AUDIO_FRAGMENT_SIZE_UNIX
  75 #else
  76 #define DEFAULT_AUDIO_FRAGMENT_SIZE     DEFAULT_AUDIO_FRAGMENT_SIZE_WIN32
  77 #endif
  78
  79 #if !defined(PLATFORM_MSDOS)
  80 #define MAX_SOUNDS_PLAYING                      16
  81 #else
  82 #define MAX_SOUNDS_PLAYING                      8
  83 #endif
  84
  85 #if !defined(PLATFORM_HPUX)
  86 #define SND_BLOCKSIZE 4096
  87 #else
  88 #define SND_BLOCKSIZE 32768
  89 #endif
  90
  91 /* some values for PlaySound(), StopSound() and friends */
  92 #if !defined(PLATFORM_MSDOS)
  93
  94 #define PSND_SILENCE            0
  95 #define PSND_MAX_VOLUME_BITS    7
  96 #define PSND_MIN_VOLUME         0
  97 #define PSND_MAX_VOLUME         (1 << PSND_MAX_VOLUME_BITS)
  98 #define PSND_MIDDLE             0
  99 #define PSND_MAX_STEREO_BITS    7
 100 #define PSND_MAX_STEREO         (1 << PSND_MAX_STEREO_BITS)
 101 #define PSND_MAX_LEFT           (-PSND_MAX_STEREO)
 102 #define PSND_MAX_RIGHT          (+PSND_MAX_STEREO)
 103 #define PSND_MAX_LEFT2RIGHT_BITS (PSND_MAX_STEREO_BITS+1)
 104 #define PSND_MAX_LEFT2RIGHT     (1 << PSND_MAX_LEFT2RIGHT_BITS)
 105
 106 #else   /* PLATFORM_MSDOS */
 107
 108 #define PSND_SILENCE            0
 109 #define PSND_MIN_VOLUME         0
 110 #define PSND_MAX_VOLUME         255
 111 #define PSND_MAX_LEFT           0
 112 #define PSND_MAX_RIGHT          255
 113 #define PSND_MIDDLE             128
 114
 115 #endif
 116
 117 #define PSND_NO_LOOP            0
 118 #define PSND_LOOP               1
 119 #define PSND_MUSIC              2
 120
 121 #define SSND_FADE_SOUND         (1 << 0)
 122 #define SSND_FADE_MUSIC         (1 << 1)
 123 #define SSND_FADE_ALL           (1 << 2)
 124 #define SSND_FADING             (SSND_FADE_SOUND | \
 125                                  SSND_FADE_MUSIC | \
 126                                  SSND_FADE_ALL)
 127 #define SSND_STOP_SOUND         (1 << 3)
 128 #define SSND_STOP_MUSIC         (1 << 4)
 129 #define SSND_STOP_ALL           (1 << 5)
 130 #define SSND_STOPPING           (SSND_STOP_SOUND | \
 131                                  SSND_STOP_MUSIC | \
 132                                  SSND_STOP_ALL)
 133 #define SSND_MUSIC              (SSND_FADE_MUSIC | SSND_STOP_MUSIC)
 134 #define SSND_ALL                (SSND_FADE_ALL | SSND_STOP_ALL)
 135
 136 #define SND_TYPE_NONE           0
 137 #define SND_TYPE_WAV            1
 138
 139 #define MUS_TYPE_NONE           0
 140 #define MUS_TYPE_WAV            1
 141 #define MUS_TYPE_MOD            2
 142
 143 /* settings for sound path, sound device, etc. */
 144 #ifndef SND_PATH
 145 #define SND_PATH        "./sounds"
 146 #endif
 147
 148 #define DEVICENAME_DSP          "/dev/dsp"
 149 #define DEVICENAME_AUDIO        "/dev/audio"
 150 #define DEVICENAME_AUDIOCTL     "/dev/audioCtl"
 151
 152 #if 0
 153 #if defined(AUDIO_STREAMING_DSP)
 154 #define AUDIO_DEVICE    DEVICENAME_DSP
 155 #else
 156 #define AUDIO_DEVICE    DEVICENAME_AUDIO
 157 #endif
 158 #endif
 159
 160 #if 0
 161 struct SoundHeader_SUN
 162 {
 163   unsigned long magic;
 164   unsigned long hdr_size;
 165   unsigned long data_size;
 166   unsigned long encoding;
 167   unsigned long sample_rate;
 168   unsigned long channels;
 169 };
 170
 171 struct SoundHeader_8SVX
 172 {
 173   char magic_FORM[4];
 174   unsigned long chunk_size;
 175   char magic_8SVX[4];
 176 };
 177 #endif
 178
 179 struct SampleInfo
 180 {
 181   char *source_filename;
 182
 183   int type;
 184
 185   void *data_ptr;
 186   long data_len;
 187 };
 188
 189 typedef struct SampleInfo       SoundInfo;
 190 typedef struct SampleInfo       MusicInfo;
 191
 192 struct SoundControl
 193 {
 194   int nr;
 195   int volume;
 196   int stereo;
 197
 198   boolean active;
 199   boolean loop;
 200   boolean music;
 201   boolean fade_sound;
 202   boolean stop_sound;
 203   boolean stop_all_sounds;
 204   boolean reload_sounds;
 205   boolean reload_music;
 206
 207   int playingtime;
 208   long playingpos;
 209
 210   long data_len;
 211   byte *data_ptr;
 212
 213 #if defined(PLATFORM_MSDOS)
 214   int voice;
 215 #endif
 216 };
 217
 218 /* general sound functions */
 219 void UnixOpenAudio(void);
 220 void UnixCloseAudio(void);
 221
 222 /* sound server functions */
 223 void InitPlaylist(void);
 224 void StartSoundserver(void);
 225 void SoundServer(void);
 226
 227 /* sound client functions */
 228 void ReloadSounds(void);
 229 void ReloadMusic(void);
 230 SoundInfo *LoadCustomSound(char *);
 231 void InitSoundList(int);
 232 void LoadSoundToList(char *, int);
 233 void LoadCustomMusic(void);
 234 void PlayMusic(int);
 235 void PlaySound(int);
 236 void PlaySoundStereo(int, int);
 237 void PlaySoundLoop(int);
 238 void PlaySoundMusic(int);
 239 void PlaySoundExt(int, int, int, boolean);
 240 void FadeMusic(void);
 241 void FadeSound(int);
 242 void FadeSounds(void);
 243 void StopMusic(void);
 244 void StopSound(int);
 245 void StopSounds(void);
 246 void StopSoundExt(int, int);
 247 void InitReloadSounds(char *);
 248 void InitReloadMusic(char *);
 249 void FreeSound(SoundInfo *);
 250 void FreeMusic(MusicInfo *);
 251 void FreeAllSounds(void);
 252 void FreeAllMusic(void);
 253
 254 #endif