src/libgame/sound.h

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // sound.h
  10 // ============================================================================
  11
  12 #ifndef SOUND_H
  13 #define SOUND_H
  14
  15 #include "system.h"
  16
  17
  18 #if defined(PLATFORM_LINUX) || defined(PLATFORM_FREEBSD) || defined(VOXWARE)
  19 #define AUDIO_LINUX_IOCTL
  20 #endif
  21
  22 #if defined(AUDIO_LINUX_IOCTL) || defined(PLATFORM_NETBSD)
  23 #define AUDIO_STREAMING_DSP
  24 #endif
  25
  26 /* values for platform specific sound initialization */
  27 #define AUDIO_SAMPLE_RATE_8000          8000
  28 #define AUDIO_SAMPLE_RATE_22050         22050
  29
  30 #define AUDIO_FRAGMENT_SIZE_512         512
  31 #define AUDIO_FRAGMENT_SIZE_1024        1024
  32 #define AUDIO_FRAGMENT_SIZE_2048        2048
  33 #define AUDIO_FRAGMENT_SIZE_4096        4096
  34 #define AUDIO_FRAGMENT_SIZE_32768       32768
  35
  36 #define AUDIO_NUM_CHANNELS_MONO         1
  37 #define AUDIO_NUM_CHANNELS_STEREO       2
  38
  39 #define AUDIO_FORMAT_UNKNOWN            (0)
  40 #define AUDIO_FORMAT_U8                 (1 << 0)
  41 #define AUDIO_FORMAT_S16                (1 << 1)
  42 #define AUDIO_FORMAT_LE                 (1 << 2)
  43 #define AUDIO_FORMAT_BE                 (1 << 3)
  44
  45 #if defined(AUDIO_UNIX_NATIVE) && !defined(AUDIO_STREAMING_DSP)
  46 #define DEFAULT_AUDIO_SAMPLE_RATE       AUDIO_SAMPLE_RATE_8000
  47 #else
  48 #define DEFAULT_AUDIO_SAMPLE_RATE       AUDIO_SAMPLE_RATE_22050
  49 #endif
  50
  51 #if defined(PLATFORM_HPUX)
  52 #define DEFAULT_AUDIO_FRAGMENT_SIZE     AUDIO_FRAGMENT_SIZE_32768
  53 #elif defined(PLATFORM_WIN32)
  54 #define DEFAULT_AUDIO_FRAGMENT_SIZE     AUDIO_FRAGMENT_SIZE_1024
  55 #else
  56 #define DEFAULT_AUDIO_FRAGMENT_SIZE     AUDIO_FRAGMENT_SIZE_512
  57 #endif
  58
  59 #if defined(TARGET_SDL)
  60 #define NUM_MIXER_CHANNELS              MIX_CHANNELS
  61 #else
  62 #define NUM_MIXER_CHANNELS              8
  63 #endif
  64
  65 #define MUSIC_CHANNEL                   0
  66 #define FIRST_SOUND_CHANNEL             1
  67
  68
  69 /* values for PlaySound(), StopSound() and friends */
  70 #define SND_CTRL_NONE                   (0)
  71 #define SND_CTRL_MUSIC                  (1 << 0)
  72 #define SND_CTRL_LOOP                   (1 << 1)
  73 #define SND_CTRL_FADE                   (1 << 2)
  74 #define SND_CTRL_STOP                   (1 << 3)
  75 #define SND_CTRL_ALL_SOUNDS             (1 << 4)
  76 #define SND_CTRL_RELOAD_SOUNDS          (1 << 5)
  77 #define SND_CTRL_RELOAD_MUSIC           (1 << 6)
  78
  79 #define SND_CTRL_PLAY_SOUND             (SND_CTRL_NONE)
  80 #define SND_CTRL_PLAY_LOOP              (SND_CTRL_LOOP)
  81 #define SND_CTRL_PLAY_MUSIC             (SND_CTRL_LOOP | SND_CTRL_MUSIC)
  82
  83 #define SND_CTRL_FADE_SOUND             (SND_CTRL_FADE)
  84 #define SND_CTRL_FADE_MUSIC             (SND_CTRL_FADE | SND_CTRL_MUSIC)
  85 #define SND_CTRL_FADE_ALL               (SND_CTRL_FADE | SND_CTRL_ALL_SOUNDS)
  86
  87 #define SND_CTRL_STOP_SOUND             (SND_CTRL_STOP)
  88 #define SND_CTRL_STOP_MUSIC             (SND_CTRL_STOP | SND_CTRL_MUSIC)
  89 #define SND_CTRL_STOP_ALL               (SND_CTRL_STOP | SND_CTRL_ALL_SOUNDS)
  90
  91 #define IS_MUSIC(x)                     ((x).state & SND_CTRL_MUSIC)
  92 #define IS_LOOP(x)                      ((x).state & SND_CTRL_LOOP)
  93 #define IS_FADING(x)                    ((x).state & SND_CTRL_FADE)
  94 #define IS_STOPPING(x)                  ((x).state & SND_CTRL_STOP)
  95 #define IS_RELOADING(x)                 ((x).state & (SND_CTRL_RELOAD_SOUNDS |\
  96                                                       SND_CTRL_RELOAD_MUSIC))
  97 #define ALL_SOUNDS(x)                   ((x).state & SND_CTRL_ALL_SOUNDS)
  98
  99 #define MAP_NOCONF_MUSIC(x)             (-((x) + 1))
 100 #define UNMAP_NOCONF_MUSIC(x)           MAP_NOCONF_MUSIC(x)
 101
 102
 103 #define SOUND_MIN_VOLUME                0
 104 #if defined(TARGET_SDL)
 105 #define SOUND_MAX_VOLUME                SDL_MIX_MAXVOLUME
 106 #else
 107 #define SOUND_MAX_VOLUME                128
 108 #endif
 109
 110 #define SOUND_MAX_LEFT                  0
 111 #define SOUND_MAX_RIGHT                 255
 112 #define SOUND_MAX_LEFT2RIGHT            255
 113 #define SOUND_MIDDLE                    (SOUND_MAX_LEFT2RIGHT / 2)
 114
 115
 116 /* general sound functions */
 117 void UnixOpenAudio(void);
 118 void UnixCloseAudio(void);
 119
 120 /* mixer functions */
 121 void Mixer_InitChannels(void);
 122 void StartMixer(void);
 123
 124 /* sound client functions */
 125 void PlayMusic(int);
 126 void PlaySound(int);
 127 void PlaySoundStereo(int, int);
 128 void PlaySoundLoop(int);
 129 void PlaySoundMusic(int);
 130 void PlaySoundExt(int, int, int, int);
 131 void FadeMusic(void);
 132 void FadeSound(int);
 133 void FadeSounds(void);
 134 void FadeSoundsAndMusic(void);
 135 void StopMusic(void);
 136 void StopSound(int);
 137 void StopSounds(void);
 138 void StopSoundExt(int, int);
 139
 140 int getSoundListSize();
 141 int getMusicListSize();
 142 struct FileInfo *getSoundListEntry(int);
 143 struct FileInfo *getMusicListEntry(int);
 144 int getSoundListPropertyMappingSize();
 145 int getMusicListPropertyMappingSize();
 146 struct PropertyMapping *getSoundListPropertyMapping();
 147 struct PropertyMapping *getMusicListPropertyMapping();
 148 void InitSoundList(struct ConfigInfo *, int, struct ConfigTypeInfo *,
 149                    char **, char **, char **, char **, char **);
 150 void InitMusicList(struct ConfigInfo *, int, struct ConfigTypeInfo *,
 151                    char **, char **, char **, char **, char **);
 152 void InitReloadCustomSounds(char *);
 153 void InitReloadCustomMusic(char *);
 154 void FreeAllSounds(void);
 155 void FreeAllMusic(void);
 156
 157 #endif