- patch from MatzeB to make music handling easier and more stable
[supertux.git] / src / sound.cpp
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 #include "defines.h"
22 #include "globals.h"
23 #include "sound.h"
24 #include "setup.h"
25
26 /*global variable*/
27 bool use_sound = true;    /* handle sound on/off menu and command-line option */
28 bool use_music = true;    /* handle music on/off menu and command-line option */
29 bool audio_device = true; /* != 0: available and initialized */
30 int current_music;
31
32 char * soundfilenames[NUM_SOUNDS] = {
33                                        "/sounds/jump.wav",
34                                        "/sounds/bigjump.wav",
35                                        "/sounds/skid.wav",
36                                        "/sounds/distro.wav",
37                                        "/sounds/herring.wav",
38                                        "/sounds/brick.wav",
39                                        "/sounds/hurt.wav",
40                                        "/sounds/squish.wav",
41                                        "/sounds/fall.wav",
42                                        "/sounds/ricochet.wav",
43                                        "/sounds/bump-upgrade.wav",
44                                        "/sounds/upgrade.wav",
45                                        "/sounds/excellent.wav",
46                                        "/sounds/coffee.wav",
47                                        "/sounds/shoot.wav",
48                                        "/sounds/lifeup.wav",
49                                        "/sounds/stomp.wav",
50                                        "/sounds/kick.wav",
51                                        "/sounds/explode.wav"
52                                     };
53
54
55 #include <SDL_mixer.h>
56
57 Mix_Chunk * sounds[NUM_SOUNDS];
58
59 /* --- OPEN THE AUDIO DEVICE --- */
60
61 int open_audio (int frequency, Uint16 format, int channels, int chunksize)
62 {
63   /* if success we reserved some channels and register panning effects */
64   if (Mix_OpenAudio( frequency, format, channels, chunksize ) == 0)
65     {
66       if (Mix_ReserveChannels( SOUND_RESERVED_CHANNELS )
67                             != SOUND_RESERVED_CHANNELS )
68         {
69           DEBUG_MSG( "Warning: open_audio could'nt reserve channels" );
70         }
71
72       /* prepare the spanning effects, no error checking */
73       Mix_SetPanning( SOUND_LEFT_SPEAKER, 230, 24 );
74       Mix_SetPanning( SOUND_RIGHT_SPEAKER, 24, 230 );
75       return 0;
76     }
77   else
78     {
79       return -1;
80     }
81 }
82
83
84 /* --- CLOSE THE AUDIO DEVICE --- */
85
86 void close_audio( void )
87 {
88   if (audio_device) {
89     Mix_UnregisterAllEffects( SOUND_LEFT_SPEAKER );
90     Mix_UnregisterAllEffects( SOUND_RIGHT_SPEAKER );
91     Mix_CloseAudio();
92   }
93 }
94
95
96 /* --- LOAD A SOUND --- */
97
98 Mix_Chunk * load_sound(const std::string& file)
99 {
100   Mix_Chunk * snd;
101
102   snd = Mix_LoadWAV(file.c_str());
103
104   if ((snd == NULL) && audio_device)
105     st_abort("Can't load", file);
106
107   return(snd);
108 }
109
110
111 /* --- LOAD A SONG --- */
112
113 Mix_Music * load_song(const std::string& file)
114 {
115   if(!audio_device)
116     return (Mix_Music*) ~0;
117   
118   Mix_Music* song = Mix_LoadMUS(file.c_str());
119   return song;
120 }
121
122
123 /* --- PLAY A SOUND ON LEFT OR RIGHT OR CENTER SPEAKER --- */
124
125 void play_sound(Mix_Chunk * snd, enum Sound_Speaker whichSpeaker)
126 {
127   /* this won't call the function if the user has disabled sound
128    * either via menu or via command-line option
129    */
130   if (use_sound && audio_device)
131     {
132       Mix_PlayChannel( whichSpeaker, snd, 0);
133
134       /* prepare for panning effects for next call */
135       /* warning: currently, I do not check for errors here */
136       switch (whichSpeaker) {
137         case SOUND_LEFT_SPEAKER:
138           Mix_SetPanning( SOUND_LEFT_SPEAKER, 230, 24 );
139           break;
140         case SOUND_RIGHT_SPEAKER:
141           Mix_SetPanning( SOUND_RIGHT_SPEAKER, 24, 230 );
142           break;
143         default:  // keep the compiler happy
144           break;
145       }
146     }
147 }
148
149
150 void free_chunk(Mix_Chunk *chunk)
151 {
152   if (chunk != NULL)
153     {
154       Mix_FreeChunk( chunk );
155       chunk = NULL;
156     }
157 }
158