Moved back button to an old dir.
[supertux.git] / src / sound.h
1 //  $Id$
2 //
3 //  SuperTux -  A Jump'n Run
4 //  Copyright (C) 2000 Bill Kendrick <bill@newbreedsoftware.com>
5 //  Copyright (C) 2004 Duong-Khang NGUYEN <neoneurone@users.sf.net>
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  02111-1307, USA.
20
21 #ifndef SUPERTUX_SOUND_H
22 #define SUPERTUX_SOUND_H
23
24 #include "defines.h"     /* get YES/NO defines */
25
26 /*global variable*/
27 extern bool use_sound;           /* handle sound on/off menu and command-line option */
28 extern bool use_music;           /* handle music on/off menu and command-line */
29 extern bool audio_device;        /* != 0: available and initialized */
30
31 /* enum of different internal music types */
32 enum Music_Type {
33   NO_MUSIC,
34   LEVEL_MUSIC,
35   HURRYUP_MUSIC,
36   HERRING_MUSIC
37 };
38
39 /* panning effects: terrible :-) ! */
40 enum Sound_Speaker {
41   SOUND_LEFT_SPEAKER = 0,
42   SOUND_RIGHT_SPEAKER = 1,
43   SOUND_RESERVED_CHANNELS = 2, // 2 channels reserved for left/right speaker
44   SOUND_CENTER_SPEAKER = -1
45 };
46
47 /* Sound files: */
48 enum {
49   SND_JUMP,
50   SND_BIGJUMP,
51   SND_SKID,
52   SND_DISTRO,
53   SND_HERRING,
54   SND_BRICK,
55   SND_HURT,
56   SND_SQUISH,
57   SND_FALL,
58   SND_RICOCHET,
59   SND_BUMP_UPGRADE,
60   SND_UPGRADE,
61   SND_EXCELLENT,
62   SND_COFFEE,
63   SND_SHOOT,
64   SND_LIFEUP,
65   SND_STOMP,
66   SND_KICK,
67   SND_EXPLODE,
68   NUM_SOUNDS
69 };
70
71 extern char* soundfilenames[NUM_SOUNDS];
72
73 #include <string>
74 #include <SDL_mixer.h>
75
76 /* variables for stocking the sound and music */
77 extern Mix_Chunk* sounds[NUM_SOUNDS];
78
79 /* functions handling the sound and music */
80 int open_audio(int frequency, Uint16 format, int channels, int chunksize);
81 void close_audio( void );
82
83 Mix_Chunk * load_sound(const std::string& file);
84 void free_chunk(Mix_Chunk*chunk);
85 void play_sound(Mix_Chunk * snd, enum Sound_Speaker whichSpeaker);
86
87 #endif /*SUPERTUX_SOUND_H*/