2012-03-23 11:05:17 +01:00
|
|
|
/*
|
2013-02-24 18:40:43 +01:00
|
|
|
Minetest
|
2013-02-24 19:38:45 +01:00
|
|
|
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
2012-03-23 11:05:17 +01:00
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
2012-06-05 16:56:56 +02:00
|
|
|
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
|
2012-03-23 11:05:17 +01:00
|
|
|
(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
|
2012-06-05 16:56:56 +02:00
|
|
|
GNU Lesser General Public License for more details.
|
2012-03-23 11:05:17 +01:00
|
|
|
|
2012-06-05 16:56:56 +02:00
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
2012-03-23 11:05:17 +01:00
|
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
*/
|
|
|
|
|
2017-08-17 22:19:39 +02:00
|
|
|
#pragma once
|
2012-03-23 11:05:17 +01:00
|
|
|
|
|
|
|
#include <set>
|
2017-04-07 08:50:17 +02:00
|
|
|
#include <string>
|
|
|
|
#include "irrlichttypes_bloated.h"
|
2012-03-23 11:05:17 +01:00
|
|
|
|
|
|
|
class OnDemandSoundFetcher
|
|
|
|
{
|
|
|
|
public:
|
2012-03-23 14:29:30 +01:00
|
|
|
virtual void fetchSounds(const std::string &name,
|
|
|
|
std::set<std::string> &dst_paths,
|
2012-03-25 13:47:51 +02:00
|
|
|
std::set<std::string> &dst_datas) = 0;
|
2012-03-23 11:05:17 +01:00
|
|
|
};
|
|
|
|
|
2012-03-23 19:23:03 +01:00
|
|
|
struct SimpleSoundSpec
|
|
|
|
{
|
2017-06-11 13:58:26 +02:00
|
|
|
SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
|
2017-10-09 11:32:06 +02:00
|
|
|
float fade = 0.0f, float pitch = 1.0f) :
|
|
|
|
name(name),
|
|
|
|
gain(gain), fade(fade), pitch(pitch)
|
2017-04-21 23:40:48 +02:00
|
|
|
{
|
|
|
|
}
|
2017-04-20 00:12:52 +02:00
|
|
|
|
2017-08-20 13:30:50 +02:00
|
|
|
bool exists() const { return !name.empty(); }
|
2017-04-20 00:12:52 +02:00
|
|
|
|
2017-06-11 13:58:26 +02:00
|
|
|
std::string name = "";
|
|
|
|
float gain = 1.0f;
|
|
|
|
float fade = 0.0f;
|
|
|
|
float pitch = 1.0f;
|
2012-03-23 19:23:03 +01:00
|
|
|
};
|
|
|
|
|
2012-03-23 11:05:17 +01:00
|
|
|
class ISoundManager
|
|
|
|
{
|
|
|
|
public:
|
2017-08-20 13:30:50 +02:00
|
|
|
virtual ~ISoundManager() = default;
|
|
|
|
|
2012-03-23 11:05:17 +01:00
|
|
|
// Multiple sounds can be loaded per name; when played, the sound
|
|
|
|
// should be chosen randomly from alternatives
|
|
|
|
// Return value determines success/failure
|
2017-04-07 08:50:17 +02:00
|
|
|
virtual bool loadSoundFile(
|
|
|
|
const std::string &name, const std::string &filepath) = 0;
|
|
|
|
virtual bool loadSoundData(
|
|
|
|
const std::string &name, const std::string &filedata) = 0;
|
2012-03-23 11:05:17 +01:00
|
|
|
|
|
|
|
virtual void updateListener(v3f pos, v3f vel, v3f at, v3f up) = 0;
|
2012-04-06 14:30:36 +02:00
|
|
|
virtual void setListenerGain(float gain) = 0;
|
2012-03-23 19:23:03 +01:00
|
|
|
|
2012-03-23 11:05:17 +01:00
|
|
|
// playSound functions return -1 on failure, otherwise a handle to the
|
2012-03-24 02:28:08 +01:00
|
|
|
// sound. If name=="", call should be ignored without error.
|
2016-07-10 07:08:26 +02:00
|
|
|
virtual int playSound(const std::string &name, bool loop, float volume,
|
2017-06-11 13:58:26 +02:00
|
|
|
float fade = 0.0f, float pitch = 1.0f) = 0;
|
|
|
|
virtual int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
|
|
|
|
float pitch = 1.0f) = 0;
|
2012-03-23 11:05:17 +01:00
|
|
|
virtual void stopSound(int sound) = 0;
|
2012-03-24 18:01:26 +01:00
|
|
|
virtual bool soundExists(int sound) = 0;
|
|
|
|
virtual void updateSoundPosition(int sound, v3f pos) = 0;
|
2016-07-10 07:08:26 +02:00
|
|
|
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;
|
2012-03-23 19:23:03 +01:00
|
|
|
|
|
|
|
int playSound(const SimpleSoundSpec &spec, bool loop)
|
2017-04-07 08:50:17 +02:00
|
|
|
{
|
2017-06-11 13:58:26 +02:00
|
|
|
return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
|
2017-04-07 08:50:17 +02:00
|
|
|
}
|
2017-08-20 13:30:50 +02:00
|
|
|
int playSoundAt(const SimpleSoundSpec &spec, bool loop, const v3f &pos)
|
2017-04-07 08:50:17 +02:00
|
|
|
{
|
2017-06-11 13:58:26 +02:00
|
|
|
return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
|
2017-04-07 08:50:17 +02:00
|
|
|
}
|
2012-03-23 11:05:17 +01:00
|
|
|
};
|
|
|
|
|
2017-04-07 08:50:17 +02:00
|
|
|
class DummySoundManager : public ISoundManager
|
2012-03-23 11:05:17 +01:00
|
|
|
{
|
|
|
|
public:
|
2017-04-07 08:50:17 +02:00
|
|
|
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;
|
|
|
|
}
|
2012-03-23 11:05:17 +01:00
|
|
|
void updateListener(v3f pos, v3f vel, v3f at, v3f up) {}
|
2012-04-06 14:30:36 +02:00
|
|
|
void setListenerGain(float gain) {}
|
2017-06-11 13:58:26 +02:00
|
|
|
int playSound(const std::string &name, bool loop, float volume, float fade,
|
|
|
|
float pitch)
|
2016-07-10 07:08:26 +02:00
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
2017-06-11 13:58:26 +02:00
|
|
|
int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
|
|
|
|
float pitch)
|
2017-04-07 08:50:17 +02:00
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
2012-03-23 11:05:17 +01:00
|
|
|
void stopSound(int sound) {}
|
2017-04-07 08:50:17 +02:00
|
|
|
bool soundExists(int sound) { return false; }
|
2012-03-24 18:01:26 +01:00
|
|
|
void updateSoundPosition(int sound, v3f pos) {}
|
2016-07-10 07:08:26 +02:00
|
|
|
bool updateSoundGain(int id, float gain) { return false; }
|
|
|
|
float getSoundGain(int id) { return 0; }
|
2017-05-04 07:52:31 +02:00
|
|
|
void step(float dtime) {}
|
|
|
|
void fadeSound(int sound, float step, float gain) {}
|
2012-03-23 11:05:17 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
// Global DummySoundManager singleton
|
|
|
|
extern DummySoundManager dummySoundManager;
|