1 // $Id: sound_manager.h 2353 2005-04-06 23:00:16Z matzebraun $
3 // SuperTux - A Jump'n Run
4 // Copyright (C) 2004 Matthias Braun <matze@braunis.de
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 #ifndef SUPERTUX_SOUND_MANAGER_H
20 #define SUPERTUX_SOUND_MANAGER_H
26 #include "SDL_mixer.h"
27 #include "math/vector.h"
33 * This class handles all sounds that are played
41 /// Play sound (maybe looping), return channel number (or -1 on error)
42 int play_sound(const std::string& sound,int loops=0);
44 /// Play sound relative to two Vectors.
45 void play_sound(const std::string& sound, const Vector& pos,
47 /// Play sound relative to a MovingObject and a Vector.
48 void play_sound(const std::string& sound, const MovingObject* object,
51 /// register an effect to a channel - basti_
52 void register_effect(int channel,Mix_EffectFunc_t f,Mix_EffectDone_t d,
56 static void volume_adjust(int,void *,int,void *);
59 * Is used to load the music for a MusicRef.
61 MusicRef load_music(const std::string& file);
64 * If the sound isn't loaded yet try to load it.
65 * Returns an existing instance of the sound, loads a new one and returns that
66 * or returns 0 if loading failed.
68 Mix_Chunk* preload_sound(const std::string& name);
70 /// Test if a certain music file exists.
71 bool exists_music(const std::string& filename);
74 * @param loops: Defaults to -1, which means endless loops.
76 void play_music(const MusicRef& music, int loops = -1);
81 /// Enable/Disable music.
82 void enable_music(bool enable);
87 return m_music_enabled;
90 /// Enable/Disable sound.
91 void enable_sound(bool enable);
96 return m_sound_enabled;
99 /// Is audio available?
100 bool audio_device_available()
105 void set_audio_device_available(bool available)
107 audio_device = available;
111 friend class MusicRef;
114 /// Resource for music.
115 /** Contains the raw music data and
116 information for music reference
123 SoundManager* manager;
128 void free_music(MusicResource* music);
130 typedef std::map<std::string, Mix_Chunk*> Sounds;
133 typedef std::map<std::string, MusicResource> Musics;
136 MusicResource* current_music;
137 bool m_music_enabled;
138 bool m_sound_enabled;
139 bool audio_device; /* true: available and initialized */
142 #endif /*SUPERTUX_SOUND_MANAGER_H*/