Cleanup in content_mapblock (#5746)

[oweals/minetest.git] / src / sound.h

diff --git a/src/sound.h b/src/sound.h
index d74acd550e73fef4b89ac1b9a4d8db1a4dfb3e60..76c0d1be4cfd5e8d9a8ff76fd176c680de800dcd 100644 (file)
--- a/src/sound.h
+++ b/src/sound.h
@@ -1,6 +1,6 @@
 /*
-Minetest-c55
-Copyright (C) 2012 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -20,9 +20,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SOUND_HEADER
 #define SOUND_HEADER
 
-#include "irrlichttypes_bloated.h"
-#include <string>
 #include <set>
+#include <string>
+#include "irrlichttypes_bloated.h"
 
 class OnDemandSoundFetcher
 {
@@ -34,68 +34,88 @@ public:
 
 struct SimpleSoundSpec
 {
+       SimpleSoundSpec(const std::string &name = "", float gain = 1.0, float fade = 0.0)
+           : name(name), gain(gain), fade(fade)
+       {
+       }
+
+       bool exists() const { return name != ""; }
+
        std::string name;
        float gain;
-       SimpleSoundSpec(std::string name="", float gain=1.0):
-               name(name),
-               gain(gain)
-       {}
-       bool exists() {return name != "";}
-       // Serialization intentionally left out
+       float fade;
 };
 
 class ISoundManager
 {
 public:
-       virtual ~ISoundManager(){}
-       
+       virtual ~ISoundManager() {}
        // Multiple sounds can be loaded per name; when played, the sound
        // should be chosen randomly from alternatives
        // Return value determines success/failure
-       virtual bool loadSoundFile(const std::string &name,
-                       const std::string &filepath) = 0;
-       virtual bool loadSoundData(const std::string &name,
-                       const std::string &filedata) = 0;
+       virtual bool loadSoundFile(
+                       const std::string &name, const std::string &filepath) = 0;
+       virtual bool loadSoundData(
+                       const std::string &name, const std::string &filedata) = 0;
 
        virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
        virtual void setListenerGain(float gain) = 0;
 
        // 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) = 0;
+       virtual int playSoundAt(
+                       const std::string &name, bool loop, float volume, v3f pos) = 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);
+       }
        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);
+       }
 };
 
-class DummySoundManager: public ISoundManager
+class DummySoundManager : public ISoundManager
 {
 public:
-       virtual bool loadSoundFile(const std::string &name,
-                       const std::string &filepath) {return true;}
-       virtual bool loadSoundData(const std::string &name,
-                       const std::string &filedata) {return true;}
+       virtual bool loadSoundFile(const std::string &name, const std::string &filepath)
+       {
+               return true;
+       }
+       virtual bool loadSoundData(const std::string &name, const std::string &filedata)
+       {
+               return true;
+       }
        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) {return 0;}
+       int playSound(const std::string &name, bool loop, float volume, float fade)
+       {
+               return 0;
+       }
+       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos)
+       {
+               return 0;
+       }
        void stopSound(int sound) {}
-       bool soundExists(int sound) {return false;}
+       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
 extern DummySoundManager dummySoundManager;
 
 #endif
-