lib/audio/sound_manager.h

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 Matthias Braun <matze@braunis.de
   5 //
   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.
  10 //
  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.
  15 //
  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
  20 #ifndef SUPERTUX_SOUND_MANAGER_H
  21 #define SUPERTUX_SOUND_MANAGER_H
  22
  23 #include <string>
  24 #include <map>
  25
  26 #include "SDL_mixer.h"
  27 #include "math/vector.h"
  28
  29 namespace SuperTux
  30   {
  31
  32   class MusicRef;
  33   class MovingObject;
  34
  35   /// Sound manager
  36   /** This class handles all sounds that are played
  37    */
  38   class SoundManager
  39     {
  40     public:
  41       SoundManager();
  42       ~SoundManager();
  43
  44       /// Play sound.
  45       void play_sound(Mix_Chunk* sound);
  46       /// Play sound relative to two Vectors.
  47       void play_sound(Mix_Chunk* sound, const Vector& pos, const Vector& pos2);
  48       /// Play sound relative to a MovingObject and a Vector.
  49       void play_sound(Mix_Chunk* sound, const MovingObject* object, const Vector& pos);
  50
  51       /// Load music.
  52       /** Is used to load the music for a MusicRef. */
  53       MusicRef load_music(const std::string& file);
  54       /// Test if a certain music file exists.
  55       bool exists_music(const std::string& filename);
  56
  57       /// Play music.
  58       /** @param loops: Defaults to -1, which means endless loops. */
  59       void play_music(const MusicRef& music, int loops = -1);
  60
  61       /// Halt music.
  62       void halt_music();
  63
  64       /// Enable/Disable music.
  65       void enable_music(bool enable);
  66
  67     private:
  68       // music part
  69       friend class MusicRef;
  70
  71       /// Resource for music.
  72       /** Contains the raw music data and
  73           information for music reference
  74           counting. */
  75       class MusicResource
  76         {
  77         public:
  78           ~MusicResource();
  79
  80           SoundManager* manager;
  81           Mix_Music* music;
  82           int refcount;
  83         };
  84
  85       void free_music(MusicResource* music);
  86
  87       std::map<std::string, MusicResource> musics;
  88       MusicResource* current_music;
  89       bool music_enabled;
  90     };
  91
  92 } // namespace SuperTux
  93
  94 #endif /*SUPERTUX_SOUND_MANAGER_H*/
  95