Add chat HUD flag (#13189)

[minetest.git] / src / sound.h

diff --git a/src/sound.h b/src/sound.h
index 6b20bbd321ebcce199c8d806648bb600cf60595e..801c552a96143d6dcb5c7d950a5040f9e7da0b82 100644 (file)
--- a/src/sound.h
+++ b/src/sound.h
@@ -1,77 +1,69 @@
 /*
-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 General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 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.h"
-#include <string>
-#include <vector>
 #include <set>
+#include <string>
+#include "util/serialize.h"
+#include "irrlichttypes_bloated.h"
 
-class OnDemandSoundFetcher
-{
-public:
-       virtual void getSoundFilenames(const std::string &name,
-                       std::set<std::string> &dst);
-};
+// This class describes the basic sound information for playback.
+// Positional handling is done separately.
 
-class ISoundManager
+struct SimpleSoundSpec
 {
-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 loadSound(const std::string &name,
-                       const std::string &filepath) = 0;
-       virtual bool loadSound(const std::string &name,
-                       const std::vector<char> &filedata) = 0;
+       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)
+       {
+       }
 
-       virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
-       // playSound functions return -1 on failure, otherwise a handle to the
-       // sound
-       virtual int playSound(const std::string &name, int loopcount,
-                       float volume) = 0;
-       virtual int playSoundAt(const std::string &name, int loopcount,
-                       v3f pos, float volume) = 0;
-       virtual void stopSound(int sound) = 0;
-};
+       bool exists() const { return !name.empty(); }
 
-class DummySoundManager: public ISoundManager
-{
-public:
-       virtual bool loadSound(const std::string &name,
-                       const std::string &filepath) {return true;}
-       virtual bool loadSound(const std::string &name,
-                       const std::vector<char> &filedata) {return true;}
-       void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
-       int playSound(const std::string &name, int loopcount,
-                       float volume) {return 0;}
-       int playSoundAt(const std::string &name, int loopcount,
-                       v3f pos, float volume) {return 0;}
-       void stopSound(int sound) {}
-};
+       void serialize(std::ostream &os, u16 protocol_version) const
+       {
+               os << serializeString16(name);
+               writeF32(os, gain);
+               writeF32(os, pitch);
+               writeF32(os, fade);
+       }
 
-// Global DummySoundManager singleton
-extern DummySoundManager dummySoundManager;
+       void deSerialize(std::istream &is, u16 protocol_version)
+       {
+               name = deSerializeString16(is);
+               gain = readF32(is);
+               pitch = readF32(is);
+               fade = readF32(is);
+       }
 
-#endif
+       std::string name;
+       float gain = 1.0f;
+       float fade = 0.0f;
+       float pitch = 1.0f;
+       bool loop = false;
+};
 
+
+// The order must not be changed. This is sent over the network.
+enum class SoundLocation : u8 {
+       Local,
+       Position,
+       Object
+};