src/audio/sound_manager.h

   1 //  $Id: sound_manager.h 2353 2005-04-06 23:00:16Z matzebraun $
   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 #ifndef SUPERTUX_SOUND_MANAGER_H
  20 #define SUPERTUX_SOUND_MANAGER_H
  21
  22 #include <string>
  23 #include <vector>
  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(const std::string& sound);
  43
  44   /// Play sound looping, return channel number - basti_
  45   int play_sound(const std::string& sound,int loops);
  46
  47   /// Play sound relative to two Vectors.
  48   void play_sound(const std::string& sound, const Vector& pos,
  49       const Vector& pos2);
  50   /// Play sound relative to a MovingObject and a Vector.
  51   void play_sound(const std::string& sound, const MovingObject* object,
  52       const Vector& pos);
  53
  54   /// register an effect to a channel - basti_
  55   void register_effect(int channel,Mix_EffectFunc_t f,Mix_EffectDone_t d,
  56                        void * arg);
  57
  58   // effects - basti_
  59   static void volume_adjust(int,void *,int,void *);
  60
  61   /** Load music.
  62    * Is used to load the music for a MusicRef.
  63    */
  64   MusicRef load_music(const std::string& file);
  65
  66   /**
  67    * If the sound isn't loaded yet try to load it.
  68    * Returns an existing instance of the sound, loads a new one and returns that
  69    * or returns 0 if loading failed.
  70    */
  71   Mix_Chunk* preload_sound(const std::string& name);
  72
  73   /// Test if a certain music file exists.
  74   bool exists_music(const std::string& filename);
  75
  76   /** Play music.
  77    * @param loops: Defaults to -1, which means endless loops.
  78    */
  79   void play_music(const MusicRef& music, int loops = -1);
  80
  81   /// Halt music.
  82   void halt_music();
  83
  84   /// Enable/Disable music.
  85   void enable_music(bool enable);
  86
  87   /// Is music enabled?
  88   bool music_enabled()
  89   {
  90     return m_music_enabled;
  91   }
  92
  93   /// Enable/Disable sound.
  94   void enable_sound(bool enable);
  95
  96   /// Is sound enabled?
  97   bool sound_enabled()
  98   {
  99     return m_sound_enabled;
 100   }
 101
 102   /// Is audio available?
 103   bool audio_device_available()
 104   {
 105     return audio_device;
 106   }
 107
 108   void set_audio_device_available(bool available)
 109   {
 110     audio_device = available;
 111   }
 112
 113 private:
 114   friend class MusicRef;
 115   friend class Setup;
 116
 117   /// Resource for music.
 118   /** Contains the raw music data and
 119       information for music reference
 120       counting. */
 121   class MusicResource
 122     {
 123     public:
 124       ~MusicResource();
 125
 126       SoundManager* manager;
 127       Mix_Music* music;
 128       int refcount;
 129     };
 130
 131   void free_music(MusicResource* music);
 132
 133   typedef std::map<std::string, Mix_Chunk*> Sounds;
 134   Sounds sounds;
 135
 136   typedef std::map<std::string, MusicResource> Musics;
 137   Musics musics;
 138
 139   MusicResource* current_music;
 140   bool m_music_enabled;
 141   bool m_sound_enabled;
 142   bool audio_device;        /* true: available and initialized */
 143 };
 144
 145 #endif /*SUPERTUX_SOUND_MANAGER_H*/
 146