]> git.lizzy.rs Git - minetest.git/blobdiff - src/sound.h
Handle the newly added TOCLIENT_ACCESS_DENIED and TOCLIENT_DELETE_PARTICLESPAWNER
[minetest.git] / src / sound.h
index 72764345e641ae2eb8c1fc268b303320075d6971..c21401e8ba946751525b72b873c38ebc7329b670 100644 (file)
@@ -1,18 +1,18 @@
 /*
-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.
 */
@@ -20,9 +20,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SOUND_HEADER
 #define SOUND_HEADER
 
-#include "irrlichttypes.h"
+#include "irrlichttypes_bloated.h"
 #include <string>
-#include <vector>
 #include <set>
 
 class OnDemandSoundFetcher
@@ -30,7 +29,19 @@ class OnDemandSoundFetcher
 public:
        virtual void fetchSounds(const std::string &name,
                        std::set<std::string> &dst_paths,
-                       std::set<std::vector<char> > &dst_datas) = 0;
+                       std::set<std::string> &dst_datas) = 0;
+};
+
+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
 };
 
 class ISoundManager
@@ -41,34 +52,46 @@ class 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,
+       virtual bool loadSoundFile(const std::string &name,
                        const std::string &filepath) = 0;
-       virtual bool loadSound(const std::string &name,
-                       const std::vector<char> &filedata) = 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
+       // 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;
+
+       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); }
 };
 
 class DummySoundManager: public ISoundManager
 {
 public:
-       virtual bool loadSound(const std::string &name,
+       virtual bool loadSoundFile(const std::string &name,
                        const std::string &filepath) {return true;}
-       virtual bool loadSound(const std::string &name,
-                       const std::vector<char> &filedata) {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) {}
 };
 
 // Global DummySoundManager singleton