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 #pragma once
  21
  22 #include <set>
  23 #include <string>
  24 #include "irrlichttypes_bloated.h"
  25
  26 class OnDemandSoundFetcher
  27 {
  28 public:
  29         virtual void fetchSounds(const std::string &name,
  30                         std::set<std::string> &dst_paths,
  31                         std::set<std::string> &dst_datas) = 0;
  32 };
  33
  34 struct SimpleSoundSpec
  35 {
  36         SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
  37                         float fade = 0.0f, float pitch = 1.0f)
  38             : name(name), gain(gain), fade(fade), pitch(pitch)
  39         {
  40         }
  41
  42         bool exists() const { return !name.empty(); }
  43
  44         std::string name = "";
  45         float gain = 1.0f;
  46         float fade = 0.0f;
  47         float pitch = 1.0f;
  48 };
  49
  50 class ISoundManager
  51 {
  52 public:
  53         virtual ~ISoundManager() = default;
  54
  55         // Multiple sounds can be loaded per name; when played, the sound
  56         // should be chosen randomly from alternatives
  57         // Return value determines success/failure
  58         virtual bool loadSoundFile(
  59                         const std::string &name, const std::string &filepath) = 0;
  60         virtual bool loadSoundData(
  61                         const std::string &name, const std::string &filedata) = 0;
  62
  63         virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
  64         virtual void setListenerGain(float gain) = 0;
  65
  66         // playSound functions return -1 on failure, otherwise a handle to the
  67         // sound. If name=="", call should be ignored without error.
  68         virtual int playSound(const std::string &name, bool loop, float volume,
  69                         float fade = 0.0f, float pitch = 1.0f) = 0;
  70         virtual int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
  71                         float pitch = 1.0f) = 0;
  72         virtual void stopSound(int sound) = 0;
  73         virtual bool soundExists(int sound) = 0;
  74         virtual void updateSoundPosition(int sound, v3f pos) = 0;
  75         virtual bool updateSoundGain(int id, float gain) = 0;
  76         virtual float getSoundGain(int id) = 0;
  77         virtual void step(float dtime) = 0;
  78         virtual void fadeSound(int sound, float step, float gain) = 0;
  79
  80         int playSound(const SimpleSoundSpec &spec, bool loop)
  81         {
  82                 return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
  83         }
  84         int playSoundAt(const SimpleSoundSpec &spec, bool loop, const v3f &pos)
  85         {
  86                 return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
  87         }
  88 };
  89
  90 class DummySoundManager : public ISoundManager
  91 {
  92 public:
  93         virtual bool loadSoundFile(const std::string &name, const std::string &filepath)
  94         {
  95                 return true;
  96         }
  97         virtual bool loadSoundData(const std::string &name, const std::string &filedata)
  98         {
  99                 return true;
 100         }
 101         void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
 102         void setListenerGain(float gain) {}
 103         int playSound(const std::string &name, bool loop, float volume, float fade,
 104                         float pitch)
 105         {
 106                 return 0;
 107         }
 108         int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
 109                         float pitch)
 110         {
 111                 return 0;
 112         }
 113         void stopSound(int sound) {}
 114         bool soundExists(int sound) { return false; }
 115         void updateSoundPosition(int sound, v3f pos) {}
 116         bool updateSoundGain(int id, float gain) { return false; }
 117         float getSoundGain(int id) { return 0; }
 118         void step(float dtime) {}
 119         void fadeSound(int sound, float step, float gain) {}
 120 };
 121
 122 // Global DummySoundManager singleton
 123 extern DummySoundManager dummySoundManager;