src/sound.h

   1 /*
   2   sound.h
   3
   4   Super Tux - Audio Functions
   5
   6   by Bill Kendrick
   7   bill@newbreedsoftware.com
   8   http://www.newbreedsoftware.com/supertux/
   9
  10   April 22, 2000 - December 28, 2003
  11
  12   Current maintainer:
  13         Duong-Khang NGUYEN <neoneurone@users.sf.net>
  14 */
  15
  16 #ifndef SUPERTUX_SOUND_H
  17 #define SUPERTUX_SOUND_H
  18
  19 #include "defines.h"     /* get YES/NO defines */
  20
  21 /* used to reserve some channels for panning effects */
  22 #define SOUND_RESERVED_CHANNELS 2
  23
  24 /*global variable*/
  25 extern int use_sound;           /* handle sound on/off menu and command-line option */
  26 extern int use_music;           /* handle music on/off menu and command-line option */
  27 extern int audio_device;        /* != 0: available and initialized */
  28
  29 /* enum of different internal music types */
  30 enum Music_Type {
  31   NO_MUSIC,
  32   LEVEL_MUSIC,
  33   HURRYUP_MUSIC,
  34   HERRING_MUSIC
  35 };
  36
  37 extern int current_music;
  38
  39 /* panning effects: terrible :-) ! */
  40 enum Sound_Speaker {
  41   SOUND_LEFT_SPEAKER = 0,
  42   SOUND_RIGHT_SPEAKER = 1,
  43   SOUND_CENTER_SPEAKER = -1
  44 };
  45
  46 /* Sound files: */
  47 enum {
  48   SND_JUMP,
  49   SND_BIGJUMP,
  50   SND_SKID,
  51   SND_DISTRO,
  52   SND_HERRING,
  53   SND_BRICK,
  54   SND_HURT,
  55   SND_SQUISH,
  56   SND_FALL,
  57   SND_RICOCHET,
  58   SND_BUMP_UPGRADE,
  59   SND_UPGRADE,
  60   SND_EXCELLENT,
  61   SND_COFFEE,
  62   SND_SHOOT,
  63   SND_LIFEUP,
  64   SND_STOMP,
  65   SND_KICK,
  66   NUM_SOUNDS
  67 };
  68
  69 #ifndef NOSOUND
  70
  71 #include <SDL_mixer.h>
  72
  73 /* variables for stocking the sound and music */
  74 extern Mix_Chunk * sounds[NUM_SOUNDS];
  75 extern Mix_Music * level_song, * level_song_fast, * herring_song;
  76
  77 /* functions handling the sound and music */
  78 int open_audio(int frequency, Uint16 format, int channels, int chunksize);
  79 void close_audio( void );
  80
  81 Mix_Chunk * load_sound(char * file);
  82 void play_sound(Mix_Chunk * snd, enum Sound_Speaker whichSpeaker);
  83 Mix_Music * load_song(char * file);
  84
  85 int playing_music(void);
  86 int halt_music(void);
  87 int play_music(Mix_Music*music, int loops);
  88 void free_music(Mix_Music*music);
  89 void free_chunk(Mix_Chunk*chunk);
  90
  91 void play_current_music(void);
  92
  93 #else
  94
  95 /* fake variables */
  96 extern void* sounds[NUM_SOUNDS];
  97 extern void* level_song, *herring_song;
  98
  99 /* fake sound handlers */
 100 int open_audio (int frequency, int format, int channels, int chunksize);
 101 void close_audio( void );
 102
 103 void* load_sound(void* file);
 104 void play_sound(void * snd, enum Sound_Speaker whichSpeaker);
 105 void* load_song(void* file);
 106
 107 int playing_music();
 108 void halt_music();
 109 int play_music(void *music, int loops);
 110 void free_music(void *music);
 111 void free_chunk(void *chunk);
 112
 113 void play_current_music(void);
 114
 115 #endif
 116
 117 #endif /*SUPERTUX_SOUND_H*/