3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "irrlichttypes_bloated.h"
27 class OnDemandSoundFetcher
30 virtual void fetchSounds(const std::string &name,
31 std::set<std::string> &dst_paths,
32 std::set<std::string> &dst_datas) = 0;
35 struct SimpleSoundSpec
37 SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
38 float fade = 0.0f, float pitch = 1.0f)
39 : name(name), gain(gain), fade(fade), pitch(pitch)
43 bool exists() const { return name != ""; }
45 std::string name = "";
54 virtual ~ISoundManager() {}
55 // Multiple sounds can be loaded per name; when played, the sound
56 // should be chosen randomly from alternatives
57 // Return value determines success/failure
58 virtual bool loadSoundFile(
59 const std::string &name, const std::string &filepath) = 0;
60 virtual bool loadSoundData(
61 const std::string &name, const std::string &filedata) = 0;
63 virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
64 virtual void setListenerGain(float gain) = 0;
66 // playSound functions return -1 on failure, otherwise a handle to the
67 // sound. If name=="", call should be ignored without error.
68 virtual int playSound(const std::string &name, bool loop, float volume,
69 float fade = 0.0f, float pitch = 1.0f) = 0;
70 virtual int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
71 float pitch = 1.0f) = 0;
72 virtual void stopSound(int sound) = 0;
73 virtual bool soundExists(int sound) = 0;
74 virtual void updateSoundPosition(int sound, v3f pos) = 0;
75 virtual bool updateSoundGain(int id, float gain) = 0;
76 virtual float getSoundGain(int id) = 0;
77 virtual void step(float dtime) = 0;
78 virtual void fadeSound(int sound, float step, float gain) = 0;
80 int playSound(const SimpleSoundSpec &spec, bool loop)
82 return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
84 int playSoundAt(const SimpleSoundSpec &spec, bool loop, v3f pos)
86 return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
90 class DummySoundManager : public ISoundManager
93 virtual bool loadSoundFile(const std::string &name, const std::string &filepath)
97 virtual bool loadSoundData(const std::string &name, const std::string &filedata)
101 void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
102 void setListenerGain(float gain) {}
103 int playSound(const std::string &name, bool loop, float volume, float fade,
108 int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
113 void stopSound(int sound) {}
114 bool soundExists(int sound) { return false; }
115 void updateSoundPosition(int sound, v3f pos) {}
116 bool updateSoundGain(int id, float gain) { return false; }
117 float getSoundGain(int id) { return 0; }
118 void step(float dtime) {}
119 void fadeSound(int sound, float step, float gain) {}
122 // Global DummySoundManager singleton
123 extern DummySoundManager dummySoundManager;