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 class MusicRef;
  30 class MovingObject;
  31
  32 /// Sound manager
  33 /** This class handles all sounds that are played
  34  */
  35 class SoundManager
  36 {
  37 public:
  38   SoundManager();
  39   ~SoundManager();
  40
  41   /// Play sound.
  42   void play_sound(Mix_Chunk* sound);
  43   /// Play sound relative to two Vectors.
  44   void play_sound(Mix_Chunk* sound, const Vector& pos, const Vector& pos2);
  45   /// Play sound relative to a MovingObject and a Vector.
  46   void play_sound(Mix_Chunk* sound, const MovingObject* object, const Vector& pos);
  47
  48   /// Load music.
  49   /** Is used to load the music for a MusicRef. */
  50   MusicRef load_music(const std::string& file);
  51   /// Test if a certain music file exists.
  52   bool exists_music(const std::string& filename);
  53
  54   /// Play music.
  55   /** @Param loops: Defaults to -1, which means endless loops. */
  56   void play_music(const MusicRef& music, int loops = -1);
  57
  58   /// Halt music.
  59   void halt_music();
  60
  61   /// Enable/Disable music.
  62   void enable_music(bool enable);
  63
  64 private:
  65   // music part
  66   friend class MusicRef;
  67
  68   /// Resource for music.
  69   /** Contains the raw music data and
  70       information for music reference
  71       counting. */
  72   class MusicResource
  73   {
  74   public:
  75     ~MusicResource();
  76
  77     SoundManager* manager;
  78     Mix_Music* music;
  79     int refcount;
  80   };
  81
  82   void free_music(MusicResource* music);
  83
  84   std::map<std::string, MusicResource> musics;
  85   MusicResource* current_music;
  86   bool music_enabled;
  87 };
  88
  89 #endif /*SUPERTUX_SOUND_MANAGER_H*/
  90