Modernize client code (#6250)
[oweals/minetest.git] / src / sound.h
index ba2d629d2db1a6ea98d530279f0fbcb51585f4ba..9447b77ef1ae2e71ba7e9ece62afc77d43ae0cb2 100644 (file)
@@ -34,20 +34,24 @@ public:
 
 struct SimpleSoundSpec
 {
-       std::string name;
-       float gain;
-       SimpleSoundSpec(std::string name = "", float gain = 1.0) : name(name), gain(gain)
+       SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
+                       float fade = 0.0f, float pitch = 1.0f)
+           : name(name), gain(gain), fade(fade), pitch(pitch)
        {
        }
-       bool exists() { return name != ""; }
-       // Serialization intentionally left out
+
+       bool exists() const { return name != ""; }
+
+       std::string name = "";
+       float gain = 1.0f;
+       float fade = 0.0f;
+       float pitch = 1.0f;
 };
 
 class ISoundManager
 {
 public:
        virtual ~ISoundManager() {}
-
        // Multiple sounds can be loaded per name; when played, the sound
        // should be chosen randomly from alternatives
        // Return value determines success/failure
@@ -61,20 +65,25 @@ public:
 
        // playSound functions return -1 on failure, otherwise a handle to the
        // sound. If name=="", call should be ignored without error.
-       virtual int playSound(const std::string &name, bool loop, float volume) = 0;
-       virtual int playSoundAt(
-                       const std::string &name, bool loop, float volume, v3f pos) = 0;
+       virtual int playSound(const std::string &name, bool loop, float volume,
+                       float fade = 0.0f, float pitch = 1.0f) = 0;
+       virtual int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
+                       float pitch = 1.0f) = 0;
        virtual void stopSound(int sound) = 0;
        virtual bool soundExists(int sound) = 0;
        virtual void updateSoundPosition(int sound, v3f pos) = 0;
+       virtual bool updateSoundGain(int id, float gain) = 0;
+       virtual float getSoundGain(int id) = 0;
+       virtual void step(float dtime) = 0;
+       virtual void fadeSound(int sound, float step, float gain) = 0;
 
        int playSound(const SimpleSoundSpec &spec, bool loop)
        {
-               return playSound(spec.name, loop, spec.gain);
+               return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
        }
        int playSoundAt(const SimpleSoundSpec &spec, bool loop, v3f pos)
        {
-               return playSoundAt(spec.name, loop, spec.gain, pos);
+               return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
        }
 };
 
@@ -91,14 +100,23 @@ public:
        }
        void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
        void setListenerGain(float gain) {}
-       int playSound(const std::string &name, bool loop, float volume) { return 0; }
-       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos)
+       int playSound(const std::string &name, bool loop, float volume, float fade,
+                       float pitch)
+       {
+               return 0;
+       }
+       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
+                       float pitch)
        {
                return 0;
        }
        void stopSound(int sound) {}
        bool soundExists(int sound) { return false; }
        void updateSoundPosition(int sound, v3f pos) {}
+       bool updateSoundGain(int id, float gain) { return false; }
+       float getSoundGain(int id) { return 0; }
+       void step(float dtime) {}
+       void fadeSound(int sound, float step, float gain) {}
 };
 
 // Global DummySoundManager singleton