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 #define PSND_SILENCE            0
  94 #define PSND_MAX_VOLUME_BITS    7
  95 #define PSND_MIN_VOLUME         0
  96 #define PSND_MAX_VOLUME         (1 << PSND_MAX_VOLUME_BITS)
  97 #define PSND_NO_LOOP            0
  98 #define PSND_LOOP               1
  99 #define PSND_MIDDLE             0
 100 #define PSND_MAX_STEREO_BITS    7
 101 #define PSND_MAX_STEREO         (1 << PSND_MAX_STEREO_BITS)
 102 #define PSND_MAX_LEFT           (-PSND_MAX_STEREO)
 103 #define PSND_MAX_RIGHT          (+PSND_MAX_STEREO)
 104 #define PSND_MAX_LEFT2RIGHT_BITS (PSND_MAX_STEREO_BITS+1)
 105 #define PSND_MAX_LEFT2RIGHT     (1 << PSND_MAX_LEFT2RIGHT_BITS)
 106 #else
 107 #define PSND_SILENCE            0
 108 #define PSND_MIN_VOLUME         0
 109 #define PSND_MAX_VOLUME         255
 110 #define PSND_NO_LOOP            0
 111 #define PSND_LOOP               1
 112 #define PSND_MAX_LEFT           0
 113 #define PSND_MAX_RIGHT          255
 114 #define PSND_MIDDLE             128
 115 #endif
 116
 117 #define SSND_FADE_SOUND         (1<<0)
 118 #define SSND_FADE_ALL_SOUNDS    (1<<1)
 119 #define SSND_FADING(x)          (x & (SSND_FADE_SOUND | SSND_FADE_ALL_SOUNDS))
 120 #define SSND_STOP_SOUND         (1<<2)
 121 #define SSND_STOP_ALL_SOUNDS    (1<<3)
 122 #define SSND_STOPPING(x)        (x & (SSND_STOP_SOUND | SSND_STOP_ALL_SOUNDS))
 123 #define SSND_ALL(x)             (x&(SSND_FADE_ALL_SOUNDS|SSND_STOP_ALL_SOUNDS))
 124
 125 /* settings for sound path, sound device, etc. */
 126 #ifndef SND_PATH
 127 #define SND_PATH        "./sounds"
 128 #endif
 129
 130 #define DEVICENAME_DSP          "/dev/dsp"
 131 #define DEVICENAME_AUDIO        "/dev/audio"
 132 #define DEVICENAME_AUDIOCTL     "/dev/audioCtl"
 133
 134 #if 0
 135 #if defined(AUDIO_STREAMING_DSP)
 136 #define AUDIO_DEVICE    DEVICENAME_DSP
 137 #else
 138 #define AUDIO_DEVICE    DEVICENAME_AUDIO
 139 #endif
 140 #endif
 141
 142 #if 0
 143 struct SoundHeader_SUN
 144 {
 145   unsigned long magic;
 146   unsigned long hdr_size;
 147   unsigned long data_size;
 148   unsigned long encoding;
 149   unsigned long sample_rate;
 150   unsigned long channels;
 151 };
 152
 153 struct SoundHeader_8SVX
 154 {
 155   char magic_FORM[4];
 156   unsigned long chunk_size;
 157   char magic_8SVX[4];
 158 };
 159 #endif
 160
 161 struct SampleInfo
 162 {
 163   byte *data_ptr;
 164   long data_len;
 165
 166 #if defined(PLATFORM_MSDOS)
 167   SAMPLE *sample_ptr;
 168 #endif
 169
 170 #if defined(TARGET_SDL)
 171   Mix_Chunk *mix_chunk;
 172   Mix_Music *mix_music;
 173 #endif
 174 };
 175
 176 struct SoundControl
 177 {
 178   int nr;
 179   int volume;
 180   int stereo;
 181   boolean active;
 182   boolean loop;
 183   boolean fade_sound;
 184   boolean stop_sound;
 185   boolean stop_all_sounds;
 186   boolean reload_sounds;
 187   boolean reload_music;
 188   int playingtime;
 189   long playingpos;
 190   long data_len;
 191   byte *data_ptr;
 192
 193 #if defined(PLATFORM_MSDOS)
 194   int voice;
 195 #endif
 196 };
 197
 198 /* general sound functions */
 199 void UnixOpenAudio(void);
 200 void UnixCloseAudio(void);
 201
 202 /* sound server functions */
 203 void InitPlaylist(void);
 204 void StartSoundserver(void);
 205 void SoundServer(void);
 206
 207 /* sound client functions */
 208 void ReloadSounds(void);
 209 void ReloadMusic(void);
 210 boolean LoadCustomSound(char *);
 211 int LoadCustomMusic(void);
 212 void PlayMusic(int);
 213 void PlaySound(int);
 214 void PlaySoundStereo(int, int);
 215 void PlaySoundLoop(int);
 216 void PlaySoundExt(int, int, int, boolean);
 217 void FadeMusic(void);
 218 void FadeSound(int);
 219 void FadeSounds(void);
 220 void StopMusic(void);
 221 void StopSound(int);
 222 void StopSounds(void);
 223 void StopSoundExt(int, int);
 224 void InitReloadSounds(char *);
 225 void InitReloadMusic(char *);
 226 void FreeSounds(int);
 227
 228 #endif