src/sound.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef SOUND_HEADER
  21 #define SOUND_HEADER
  22
  23 #include <set>
  24 #include <string>
  25 #include "irrlichttypes_bloated.h"
  26
  27 class OnDemandSoundFetcher
  28 {
  29 public:
  30         virtual void fetchSounds(const std::string &name,
  31                         std::set<std::string> &dst_paths,
  32                         std::set<std::string> &dst_datas) = 0;
  33 };
  34
  35 struct SimpleSoundSpec
  36 {
  37         SimpleSoundSpec(const std::string &name = "", float gain = 1.0)
  38             : name(name), gain(gain)
  39         {
  40         }
  41
  42         bool exists() const { return name != ""; }
  43
  44         std::string name;
  45         float gain;
  46 };
  47
  48 class ISoundManager
  49 {
  50 public:
  51         virtual ~ISoundManager() {}
  52
  53         // Multiple sounds can be loaded per name; when played, the sound
  54         // should be chosen randomly from alternatives
  55         // Return value determines success/failure
  56         virtual bool loadSoundFile(
  57                         const std::string &name, const std::string &filepath) = 0;
  58         virtual bool loadSoundData(
  59                         const std::string &name, const std::string &filedata) = 0;
  60
  61         virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
  62         virtual void setListenerGain(float gain) = 0;
  63
  64         // playSound functions return -1 on failure, otherwise a handle to the
  65         // sound. If name=="", call should be ignored without error.
  66         virtual int playSound(const std::string &name, bool loop, float volume) = 0;
  67         virtual int playSoundAt(
  68                         const std::string &name, bool loop, float volume, v3f pos) = 0;
  69         virtual void stopSound(int sound) = 0;
  70         virtual bool soundExists(int sound) = 0;
  71         virtual void updateSoundPosition(int sound, v3f pos) = 0;
  72
  73         int playSound(const SimpleSoundSpec &spec, bool loop)
  74         {
  75                 return playSound(spec.name, loop, spec.gain);
  76         }
  77         int playSoundAt(const SimpleSoundSpec &spec, bool loop, v3f pos)
  78         {
  79                 return playSoundAt(spec.name, loop, spec.gain, pos);
  80         }
  81 };
  82
  83 class DummySoundManager : public ISoundManager
  84 {
  85 public:
  86         virtual bool loadSoundFile(const std::string &name, const std::string &filepath)
  87         {
  88                 return true;
  89         }
  90         virtual bool loadSoundData(const std::string &name, const std::string &filedata)
  91         {
  92                 return true;
  93         }
  94         void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
  95         void setListenerGain(float gain) {}
  96         int playSound(const std::string &name, bool loop, float volume) { return 0; }
  97         int playSoundAt(const std::string &name, bool loop, float volume, v3f pos)
  98         {
  99                 return 0;
 100         }
 101         void stopSound(int sound) {}
 102         bool soundExists(int sound) { return false; }
 103         void updateSoundPosition(int sound, v3f pos) {}
 104 };
 105
 106 // Global DummySoundManager singleton
 107 extern DummySoundManager dummySoundManager;
 108
 109 #endif