Add chat HUD flag (#13189)

[minetest.git] / src / sound.h

diff --git a/src/sound.h b/src/sound.h
index c21401e8ba946751525b72b873c38ebc7329b670..801c552a96143d6dcb5c7d950a5040f9e7da0b82 100644 (file)
--- a/src/sound.h
+++ b/src/sound.h
@@ -17,85 +17,53 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef SOUND_HEADER
-#define SOUND_HEADER
+#pragma once
 
-#include "irrlichttypes_bloated.h"
-#include <string>
 #include <set>
+#include <string>
+#include "util/serialize.h"
+#include "irrlichttypes_bloated.h"
 
-class OnDemandSoundFetcher
-{
-public:
-       virtual void fetchSounds(const std::string &name,
-                       std::set<std::string> &dst_paths,
-                       std::set<std::string> &dst_datas) = 0;
-};
+// This class describes the basic sound information for playback.
+// Positional handling is done separately.
 
 struct SimpleSoundSpec
 {
-       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
-};
+       SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
+                       bool loop = false, float fade = 0.0f, float pitch = 1.0f) :
+                       name(name), gain(gain), fade(fade), pitch(pitch), loop(loop)
+       {
+       }
 
-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
-       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;
+       bool exists() const { return !name.empty(); }
 
-       // 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 void stopSound(int sound) = 0;
-       virtual bool soundExists(int sound) = 0;
-       virtual void updateSoundPosition(int sound, v3f pos) = 0;
+       void serialize(std::ostream &os, u16 protocol_version) const
+       {
+               os << serializeString16(name);
+               writeF32(os, gain);
+               writeF32(os, pitch);
+               writeF32(os, fade);
+       }
 
-       int playSound(const SimpleSoundSpec &spec, bool loop)
-               { return playSound(spec.name, loop, spec.gain); }
-       int playSoundAt(const SimpleSoundSpec &spec, bool loop, v3f pos)
-               { return playSoundAt(spec.name, loop, spec.gain, pos); }
-};
+       void deSerialize(std::istream &is, u16 protocol_version)
+       {
+               name = deSerializeString16(is);
+               gain = readF32(is);
+               pitch = readF32(is);
+               fade = readF32(is);
+       }
 
-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;}
-       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;}
-       void stopSound(int sound) {}
-       bool soundExists(int sound) {return false;}
-       void updateSoundPosition(int sound, v3f pos) {}
+       std::string name;
+       float gain = 1.0f;
+       float fade = 0.0f;
+       float pitch = 1.0f;
+       bool loop = false;
 };
 
-// Global DummySoundManager singleton
-extern DummySoundManager dummySoundManager;
-
-#endif
 
+// The order must not be changed. This is sent over the network.
+enum class SoundLocation : u8 {
+       Local,
+       Position,
+       Object
+};