Cleanup sound manager class (#7158)
authorLoïc Blot <nerzhul@users.noreply.github.com>
Sat, 24 Mar 2018 14:45:25 +0000 (15:45 +0100)
committerGitHub <noreply@github.com>
Sat, 24 Mar 2018 14:45:25 +0000 (15:45 +0100)
* Cleanup sound manager client

* Use some const refs
* Use auto on iterators
* Drop unused parameters
* Move sound_openal.* to client folder
* Move sound.cpp + OnDemandSoundFetcher to client/ folder + reorganize includes properly

22 files changed:
build/android/jni/Android.mk
src/CMakeLists.txt
src/client.cpp
src/client.h
src/client/CMakeLists.txt
src/client/sound.cpp [new file with mode: 0644]
src/client/sound.h [new file with mode: 0644]
src/client/sound_openal.cpp [new file with mode: 0644]
src/client/sound_openal.h [new file with mode: 0644]
src/content_cao.cpp
src/game.cpp
src/gamedef.h
src/gui/guiEngine.cpp
src/gui/guiEngine.h
src/network/clientpackethandler.cpp
src/script/lua_api/l_client.cpp
src/sound.cpp [deleted file]
src/sound.h
src/sound_openal.cpp [deleted file]
src/sound_openal.h [deleted file]
src/unittest/test.cpp
util/travis/clang-format-whitelist.txt

index 4f2e788a87021fa913735892bd608bd81560e938..1fa8fb7b0a4321e0ce563b4fbe83b8b33f64e477 100644 (file)
@@ -227,8 +227,6 @@ LOCAL_SRC_FILES := \
                jni/src/serverobject.cpp                  \
                jni/src/shader.cpp                        \
                jni/src/sky.cpp                           \
-               jni/src/sound.cpp                         \
-               jni/src/sound_openal.cpp                  \
                jni/src/staticobject.cpp                  \
                jni/src/subgame.cpp                       \
                jni/src/tileanimation.cpp                 \
@@ -280,6 +278,8 @@ LOCAL_SRC_FILES := \
                jni/src/client/hud.cpp                    \
                jni/src/client/inputhandler.cpp           \
                jni/src/client/renderingengine.cpp        \
+               jni/src/client/sound.cpp                  \
+               jni/src/client/sound_openal.cpp           \
                jni/src/client/tile.cpp                   \
                jni/src/client/joystick_controller.cpp    \
                jni/src/client/render/factory.cpp         \
index 7673b6fa5de35d33a631f5a15c1e63e06ab36582..8c7f6b56e41b31d456a23f77b4dc15697837a512 100644 (file)
@@ -101,19 +101,6 @@ if(BUILD_CLIENT AND ENABLE_SOUND)
        endif()
 endif()
 
-if(USE_SOUND)
-       set(sound_SRCS sound_openal.cpp)
-       set(SOUND_INCLUDE_DIRS
-               ${OPENAL_INCLUDE_DIR}
-               ${VORBIS_INCLUDE_DIR}
-               ${OGG_INCLUDE_DIR}
-               )
-       set(SOUND_LIBRARIES
-               ${OPENAL_LIBRARY}
-               ${VORBIS_LIBRARIES}
-               )
-endif()
-
 
 option(ENABLE_GLES "Enable OpenGL ES support" FALSE)
 mark_as_advanced(ENABLE_GLES)
@@ -440,7 +427,6 @@ set(common_SRCS
        serverlist.cpp
        serverobject.cpp
        settings.cpp
-       sound.cpp
        staticobject.cpp
        subgame.cpp
        terminal_chat_console.cpp
@@ -489,7 +475,6 @@ set(client_SRCS
        ${client_SRCS}
        ${common_SRCS}
        ${gui_SRCS}
-       ${sound_SRCS}
        ${client_network_SRCS}
        ${client_irrlicht_changes_SRCS}
        camera.cpp
index 83711688896be6314a905a5b46e2f275d91db38b..5356ef151129916e63bedf0a667cbe2e872a073c 100644 (file)
@@ -30,6 +30,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "client/clientevent.h"
 #include "client/gameui.h"
 #include "client/renderingengine.h"
+#include "client/sound.h"
 #include "client/tile.h"
 #include "util/auth.h"
 #include "util/directiontables.h"
index 8b8923f29a56cb6bd5eb5461ae61b0aa4ac40a65..a468aa721e153459ba1281b947d1b5e72c837548 100644 (file)
@@ -48,6 +48,7 @@ class MapBlockMesh;
 class IWritableTextureSource;
 class IWritableShaderSource;
 class IWritableItemDefManager;
+class ISoundManager;
 class NodeDefManager;
 //class IWritableCraftDefManager;
 class ClientMediaDownloader;
index ea8acd06412dbd9ebe2214cd998acbacf1c13ed7..1cabe1b1134f168b91b137fce0f4250cf3b3c168 100644 (file)
@@ -1,4 +1,21 @@
+set(sound_SRCS  ${CMAKE_CURRENT_SOURCE_DIR}/sound.cpp)
+
+if(USE_SOUND)
+       set(sound_SRCS ${sound_SRCS}
+               ${CMAKE_CURRENT_SOURCE_DIR}/sound_openal.cpp)
+       set(SOUND_INCLUDE_DIRS
+               ${OPENAL_INCLUDE_DIR}
+               ${VORBIS_INCLUDE_DIR}
+               ${OGG_INCLUDE_DIR}
+               PARENT_SCOPE)
+       set(SOUND_LIBRARIES
+               ${OPENAL_LIBRARY}
+               ${VORBIS_LIBRARIES}
+               PARENT_SCOPE)
+endif()
+
 set(client_SRCS
+       ${sound_SRCS}
        ${CMAKE_CURRENT_SOURCE_DIR}/meshgen/collector.cpp
        ${CMAKE_CURRENT_SOURCE_DIR}/render/anaglyph.cpp
        ${CMAKE_CURRENT_SOURCE_DIR}/render/core.cpp
diff --git a/src/client/sound.cpp b/src/client/sound.cpp
new file mode 100644 (file)
index 0000000..44a96dd
--- /dev/null
@@ -0,0 +1,23 @@
+/*
+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 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 Lesser General Public License for more details.
+
+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.
+*/
+
+#include "sound.h"
+
+// Global DummySoundManager singleton
+DummySoundManager dummySoundManager;
diff --git a/src/client/sound.h b/src/client/sound.h
new file mode 100644 (file)
index 0000000..c1d3c0c
--- /dev/null
@@ -0,0 +1,111 @@
+/*
+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 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 Lesser General Public License for more details.
+
+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.
+*/
+
+#pragma once
+
+#include <set>
+#include <string>
+#include "irr_v3d.h"
+#include "../sound.h"
+
+class OnDemandSoundFetcher
+{
+public:
+       virtual void fetchSounds(const std::string &name,
+                       std::set<std::string> &dst_paths,
+                       std::set<std::string> &dst_datas) = 0;
+};
+
+class ISoundManager
+{
+public:
+       virtual ~ISoundManager() = default;
+
+       // 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(
+                       const v3f &pos, const v3f &vel, const v3f &at, const v3f &up) = 0;
+       virtual void setListenerGain(float gain) = 0;
+
+       // 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,
+                       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;
+       virtual void stopSound(int sound) = 0;
+       virtual bool soundExists(int sound) = 0;
+       virtual void updateSoundPosition(int sound, v3f pos) = 0;
+       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;
+
+       int playSound(const SimpleSoundSpec &spec, bool loop)
+       {
+               return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
+       }
+       int playSoundAt(const SimpleSoundSpec &spec, bool loop, const v3f &pos)
+       {
+               return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
+       }
+};
+
+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(const v3f &pos, const v3f &vel, const v3f &at, const v3f &up)
+       {
+       }
+       void setListenerGain(float gain) {}
+       int playSound(const std::string &name, bool loop, float volume, float fade,
+                       float pitch)
+       {
+               return 0;
+       }
+       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
+                       float pitch)
+       {
+               return 0;
+       }
+       void stopSound(int sound) {}
+       bool soundExists(int sound) { return false; }
+       void updateSoundPosition(int sound, v3f pos) {}
+       bool updateSoundGain(int id, float gain) { return false; }
+       float getSoundGain(int id) { return 0; }
+       void step(float dtime) {}
+       void fadeSound(int sound, float step, float gain) {}
+};
+
+// Global DummySoundManager singleton
+extern DummySoundManager dummySoundManager;
diff --git a/src/client/sound_openal.cpp b/src/client/sound_openal.cpp
new file mode 100644 (file)
index 0000000..d663600
--- /dev/null
@@ -0,0 +1,689 @@
+/*
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+OpenAL support based on work by:
+Copyright (C) 2011 Sebastian 'Bahamada' Rühl
+Copyright (C) 2011 Cyriaque 'Cisoun' Skrapits <cysoun@gmail.com>
+Copyright (C) 2011 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; ifnot, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#include "sound_openal.h"
+
+#if defined(_WIN32)
+       #include <al.h>
+       #include <alc.h>
+       //#include <alext.h>
+#elif defined(__APPLE__)
+       #include <OpenAL/al.h>
+       #include <OpenAL/alc.h>
+       //#include <OpenAL/alext.h>
+#else
+       #include <AL/al.h>
+       #include <AL/alc.h>
+       #include <AL/alext.h>
+#endif
+#include <cmath>
+#include <vorbis/vorbisfile.h>
+#include <cassert>
+#include "log.h"
+#include "util/numeric.h" // myrand()
+#include "porting.h"
+#include <vector>
+#include <fstream>
+#include <unordered_map>
+#include <unordered_set>
+
+#define BUFFER_SIZE 30000
+
+std::shared_ptr<SoundManagerSingleton> g_sound_manager_singleton;
+
+typedef std::unique_ptr<ALCdevice, void (*)(ALCdevice *p)> unique_ptr_alcdevice;
+typedef std::unique_ptr<ALCcontext, void(*)(ALCcontext *p)> unique_ptr_alccontext;
+
+static void delete_alcdevice(ALCdevice *p)
+{
+       if (p)
+               alcCloseDevice(p);
+}
+
+static void delete_alccontext(ALCcontext *p)
+{
+       if (p) {
+               alcMakeContextCurrent(nullptr);
+               alcDestroyContext(p);
+       }
+}
+
+static const char *alErrorString(ALenum err)
+{
+       switch (err) {
+       case AL_NO_ERROR:
+               return "no error";
+       case AL_INVALID_NAME:
+               return "invalid name";
+       case AL_INVALID_ENUM:
+               return "invalid enum";
+       case AL_INVALID_VALUE:
+               return "invalid value";
+       case AL_INVALID_OPERATION:
+               return "invalid operation";
+       case AL_OUT_OF_MEMORY:
+               return "out of memory";
+       default:
+               return "<unknown OpenAL error>";
+       }
+}
+
+static ALenum warn_if_error(ALenum err, const char *desc)
+{
+       if(err == AL_NO_ERROR)
+               return err;
+       warningstream<<desc<<": "<<alErrorString(err)<<std::endl;
+       return err;
+}
+
+void f3_set(ALfloat *f3, v3f v)
+{
+       f3[0] = v.X;
+       f3[1] = v.Y;
+       f3[2] = v.Z;
+}
+
+struct SoundBuffer
+{
+       ALenum format;
+       ALsizei freq;
+       ALuint buffer_id;
+       std::vector<char> buffer;
+};
+
+SoundBuffer *load_opened_ogg_file(OggVorbis_File *oggFile,
+               const std::string &filename_for_logging)
+{
+       int endian = 0; // 0 for Little-Endian, 1 for Big-Endian
+       int bitStream;
+       long bytes;
+       char array[BUFFER_SIZE]; // Local fixed size array
+       vorbis_info *pInfo;
+
+       SoundBuffer *snd = new SoundBuffer;
+
+       // Get some information about the OGG file
+       pInfo = ov_info(oggFile, -1);
+
+       // Check the number of channels... always use 16-bit samples
+       if(pInfo->channels == 1)
+               snd->format = AL_FORMAT_MONO16;
+       else
+               snd->format = AL_FORMAT_STEREO16;
+
+       // The frequency of the sampling rate
+       snd->freq = pInfo->rate;
+
+       // Keep reading until all is read
+       do
+       {
+               // Read up to a buffer's worth of decoded sound data
+               bytes = ov_read(oggFile, array, BUFFER_SIZE, endian, 2, 1, &bitStream);
+
+               if(bytes < 0)
+               {
+                       ov_clear(oggFile);
+                       infostream << "Audio: Error decoding "
+                               << filename_for_logging << std::endl;
+                       delete snd;
+                       return nullptr;
+               }
+
+               // Append to end of buffer
+               snd->buffer.insert(snd->buffer.end(), array, array + bytes);
+       } while (bytes > 0);
+
+       alGenBuffers(1, &snd->buffer_id);
+       alBufferData(snd->buffer_id, snd->format,
+                       &(snd->buffer[0]), snd->buffer.size(),
+                       snd->freq);
+
+       ALenum error = alGetError();
+
+       if(error != AL_NO_ERROR){
+               infostream << "Audio: OpenAL error: " << alErrorString(error)
+                               << "preparing sound buffer" << std::endl;
+       }
+
+       infostream << "Audio file "
+               << filename_for_logging << " loaded" << std::endl;
+
+       // Clean up!
+       ov_clear(oggFile);
+
+       return snd;
+}
+
+SoundBuffer *load_ogg_from_file(const std::string &path)
+{
+       OggVorbis_File oggFile;
+
+       // Try opening the given file.
+       // This requires libvorbis >= 1.3.2, as
+       // previous versions expect a non-const char *
+       if (ov_fopen(path.c_str(), &oggFile) != 0) {
+               infostream << "Audio: Error opening " << path
+                       << " for decoding" << std::endl;
+               return nullptr;
+       }
+
+       return load_opened_ogg_file(&oggFile, path);
+}
+
+struct BufferSource {
+       const char *buf;
+       size_t cur_offset;
+       size_t len;
+};
+
+size_t buffer_sound_read_func(void *ptr, size_t size, size_t nmemb, void *datasource)
+{
+       BufferSource *s = (BufferSource *)datasource;
+       size_t copied_size = MYMIN(s->len - s->cur_offset, size);
+       memcpy(ptr, s->buf + s->cur_offset, copied_size);
+       s->cur_offset += copied_size;
+       return copied_size;
+}
+
+int buffer_sound_seek_func(void *datasource, ogg_int64_t offset, int whence)
+{
+       BufferSource *s = (BufferSource *)datasource;
+       if (whence == SEEK_SET) {
+               if (offset < 0 || (size_t)MYMAX(offset, 0) >= s->len) {
+                       // offset out of bounds
+                       return -1;
+               }
+               s->cur_offset = offset;
+               return 0;
+       } else if (whence == SEEK_CUR) {
+               if ((size_t)MYMIN(-offset, 0) > s->cur_offset
+                               || s->cur_offset + offset > s->len) {
+                       // offset out of bounds
+                       return -1;
+               }
+               s->cur_offset += offset;
+               return 0;
+       }
+       // invalid whence param (SEEK_END doesn't have to be supported)
+       return -1;
+}
+
+long BufferSourceell_func(void *datasource)
+{
+       BufferSource *s = (BufferSource *)datasource;
+       return s->cur_offset;
+}
+
+static ov_callbacks g_buffer_ov_callbacks = {
+       &buffer_sound_read_func,
+       &buffer_sound_seek_func,
+       nullptr,
+       &BufferSourceell_func
+};
+
+SoundBuffer *load_ogg_from_buffer(const std::string &buf, const std::string &id_for_log)
+{
+       OggVorbis_File oggFile;
+
+       BufferSource s;
+       s.buf = buf.c_str();
+       s.cur_offset = 0;
+       s.len = buf.size();
+
+       if (ov_open_callbacks(&s, &oggFile, nullptr, 0, g_buffer_ov_callbacks) != 0) {
+               infostream << "Audio: Error opening " << id_for_log
+                       << " for decoding" << std::endl;
+               return nullptr;
+       }
+
+       return load_opened_ogg_file(&oggFile, id_for_log);
+}
+
+struct PlayingSound
+{
+       ALuint source_id;
+       bool loop;
+};
+
+class SoundManagerSingleton
+{
+public:
+       unique_ptr_alcdevice  m_device;
+       unique_ptr_alccontext m_context;
+public:
+       SoundManagerSingleton() :
+               m_device(nullptr, delete_alcdevice),
+               m_context(nullptr, delete_alccontext)
+       {
+               if (!(m_device = unique_ptr_alcdevice(alcOpenDevice(nullptr), delete_alcdevice)))
+                       throw std::runtime_error("Audio: Global Initialization: Device Open");
+
+               if (!(m_context = unique_ptr_alccontext(
+                               alcCreateContext(m_device.get(), nullptr), delete_alccontext))) {
+                       throw std::runtime_error("Audio: Global Initialization: Context Create");
+               }
+
+               if (!alcMakeContextCurrent(m_context.get()))
+                       throw std::runtime_error("Audio: Global Initialization: Context Current");
+
+               alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
+
+               if (alGetError() != AL_NO_ERROR)
+                       throw std::runtime_error("Audio: Global Initialization: OpenAL Error");
+
+               infostream << "Audio: Global Initialized: OpenAL " << alGetString(AL_VERSION)
+                       << ", using " << alcGetString(m_device.get(), ALC_DEVICE_SPECIFIER)
+                       << std::endl;
+       }
+
+       ~SoundManagerSingleton()
+       {
+               infostream << "Audio: Global Deinitialized." << std::endl;
+       }
+};
+
+class OpenALSoundManager: public ISoundManager
+{
+private:
+       OnDemandSoundFetcher *m_fetcher;
+       ALCdevice *m_device;
+       ALCcontext *m_context;
+       int m_next_id;
+       std::unordered_map<std::string, std::vector<SoundBuffer*>> m_buffers;
+       std::unordered_map<int, PlayingSound*> m_sounds_playing;
+       struct FadeState {
+               FadeState() = default;
+
+               FadeState(float step, float current_gain, float target_gain):
+                       step(step),
+                       current_gain(current_gain),
+                       target_gain(target_gain) {}
+               float step;
+               float current_gain;
+               float target_gain;
+       };
+
+       std::unordered_map<int, FadeState> m_sounds_fading;
+       float m_fade_delay;
+public:
+       OpenALSoundManager(SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher):
+               m_fetcher(fetcher),
+               m_device(smg->m_device.get()),
+               m_context(smg->m_context.get()),
+               m_next_id(1),
+               m_fade_delay(0)
+       {
+               infostream << "Audio: Initialized: OpenAL " << std::endl;
+       }
+
+       ~OpenALSoundManager()
+       {
+               infostream << "Audio: Deinitializing..." << std::endl;
+
+               std::unordered_set<int> source_del_list;
+
+               for (const auto &sp : m_sounds_playing)
+                       source_del_list.insert(sp.second->source_id);
+
+               for (const auto &id : source_del_list)
+                       deleteSound(id);
+
+               for (auto &buffer : m_buffers) {
+                       for (SoundBuffer *sb : buffer.second) {
+                               delete sb;
+                       }
+                       buffer.second.clear();
+               }
+               m_buffers.clear();
+
+               infostream << "Audio: Deinitialized." << std::endl;
+       }
+
+       void step(float dtime)
+       {
+               doFades(dtime);
+       }
+
+       void addBuffer(const std::string &name, SoundBuffer *buf)
+       {
+               std::unordered_map<std::string, std::vector<SoundBuffer*>>::iterator i =
+                               m_buffers.find(name);
+               if(i != m_buffers.end()){
+                       i->second.push_back(buf);
+                       return;
+               }
+               std::vector<SoundBuffer*> bufs;
+               bufs.push_back(buf);
+               m_buffers[name] = bufs;
+       }
+
+       SoundBuffer* getBuffer(const std::string &name)
+       {
+               std::unordered_map<std::string, std::vector<SoundBuffer*>>::iterator i =
+                               m_buffers.find(name);
+               if(i == m_buffers.end())
+                       return nullptr;
+               std::vector<SoundBuffer*> &bufs = i->second;
+               int j = myrand() % bufs.size();
+               return bufs[j];
+       }
+
+       PlayingSound* createPlayingSound(SoundBuffer *buf, bool loop,
+                       float volume, float pitch)
+       {
+               infostream << "OpenALSoundManager: Creating playing sound" << std::endl;
+               assert(buf);
+               PlayingSound *sound = new PlayingSound;
+               assert(sound);
+               warn_if_error(alGetError(), "before createPlayingSound");
+               alGenSources(1, &sound->source_id);
+               alSourcei(sound->source_id, AL_BUFFER, buf->buffer_id);
+               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, true);
+               alSource3f(sound->source_id, AL_POSITION, 0, 0, 0);
+               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
+               alSourcei(sound->source_id, AL_LOOPING, loop ? AL_TRUE : AL_FALSE);
+               volume = std::fmax(0.0f, volume);
+               alSourcef(sound->source_id, AL_GAIN, volume);
+               alSourcef(sound->source_id, AL_PITCH, pitch);
+               alSourcePlay(sound->source_id);
+               warn_if_error(alGetError(), "createPlayingSound");
+               return sound;
+       }
+
+       PlayingSound* createPlayingSoundAt(SoundBuffer *buf, bool loop,
+                       float volume, v3f pos, float pitch)
+       {
+               infostream << "OpenALSoundManager: Creating positional playing sound"
+                               << std::endl;
+               assert(buf);
+               PlayingSound *sound = new PlayingSound;
+               assert(sound);
+               warn_if_error(alGetError(), "before createPlayingSoundAt");
+               alGenSources(1, &sound->source_id);
+               alSourcei(sound->source_id, AL_BUFFER, buf->buffer_id);
+               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, false);
+               alSource3f(sound->source_id, AL_POSITION, pos.X, pos.Y, pos.Z);
+               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
+               // Use alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED) and set reference
+               // distance to clamp gain at <1 node distance, to avoid excessive
+               // volume when closer
+               alSourcef(sound->source_id, AL_REFERENCE_DISTANCE, 10.0f);
+               alSourcei(sound->source_id, AL_LOOPING, loop ? AL_TRUE : AL_FALSE);
+               // Multiply by 3 to compensate for reducing AL_REFERENCE_DISTANCE from
+               // the previous value of 30 to the new value of 10
+               volume = std::fmax(0.0f, volume * 3.0f);
+               alSourcef(sound->source_id, AL_GAIN, volume);
+               alSourcef(sound->source_id, AL_PITCH, pitch);
+               alSourcePlay(sound->source_id);
+               warn_if_error(alGetError(), "createPlayingSoundAt");
+               return sound;
+       }
+
+       int playSoundRaw(SoundBuffer *buf, bool loop, float volume, float pitch)
+       {
+               assert(buf);
+               PlayingSound *sound = createPlayingSound(buf, loop, volume, pitch);
+               if(!sound)
+                       return -1;
+               int id = m_next_id++;
+               m_sounds_playing[id] = sound;
+               return id;
+       }
+
+       int playSoundRawAt(SoundBuffer *buf, bool loop, float volume, const v3f &pos,
+                       float pitch)
+       {
+               assert(buf);
+               PlayingSound *sound = createPlayingSoundAt(buf, loop, volume, pos, pitch);
+               if(!sound)
+                       return -1;
+               int id = m_next_id++;
+               m_sounds_playing[id] = sound;
+               return id;
+       }
+
+       void deleteSound(int id)
+       {
+               std::unordered_map<int, PlayingSound*>::iterator i = m_sounds_playing.find(id);
+               if(i == m_sounds_playing.end())
+                       return;
+               PlayingSound *sound = i->second;
+
+               alDeleteSources(1, &sound->source_id);
+
+               delete sound;
+               m_sounds_playing.erase(id);
+       }
+
+       /* If buffer does not exist, consult the fetcher */
+       SoundBuffer* getFetchBuffer(const std::string &name)
+       {
+               SoundBuffer *buf = getBuffer(name);
+               if(buf)
+                       return buf;
+               if(!m_fetcher)
+                       return nullptr;
+               std::set<std::string> paths;
+               std::set<std::string> datas;
+               m_fetcher->fetchSounds(name, paths, datas);
+               for (const std::string &path : paths) {
+                       loadSoundFile(name, path);
+               }
+               for (const std::string &data : datas) {
+                       loadSoundData(name, data);
+               }
+               return getBuffer(name);
+       }
+
+       // Remove stopped sounds
+       void maintain()
+       {
+               verbosestream<<"OpenALSoundManager::maintain(): "
+                               <<m_sounds_playing.size()<<" playing sounds, "
+                               <<m_buffers.size()<<" sound names loaded"<<std::endl;
+               std::unordered_set<int> del_list;
+               for (const auto &sp : m_sounds_playing) {
+                       int id = sp.first;
+                       PlayingSound *sound = sp.second;
+                       // If not playing, remove it
+                       {
+                               ALint state;
+                               alGetSourcei(sound->source_id, AL_SOURCE_STATE, &state);
+                               if(state != AL_PLAYING){
+                                       del_list.insert(id);
+                               }
+                       }
+               }
+               if(!del_list.empty())
+                       verbosestream<<"OpenALSoundManager::maintain(): deleting "
+                                       <<del_list.size()<<" playing sounds"<<std::endl;
+               for (int i : del_list) {
+                       deleteSound(i);
+               }
+       }
+
+       /* Interface */
+
+       bool loadSoundFile(const std::string &name,
+                       const std::string &filepath)
+       {
+               SoundBuffer *buf = load_ogg_from_file(filepath);
+               if (buf)
+                       addBuffer(name, buf);
+               return false;
+       }
+
+       bool loadSoundData(const std::string &name,
+                       const std::string &filedata)
+       {
+               SoundBuffer *buf = load_ogg_from_buffer(filedata, name);
+               if (buf)
+                       addBuffer(name, buf);
+               return false;
+       }
+
+       void updateListener(const v3f &pos, const v3f &vel, const v3f &at, const v3f &up)
+       {
+               alListener3f(AL_POSITION, pos.X, pos.Y, pos.Z);
+               alListener3f(AL_VELOCITY, vel.X, vel.Y, vel.Z);
+               ALfloat f[6];
+               f3_set(f, at);
+               f3_set(f+3, -up);
+               alListenerfv(AL_ORIENTATION, f);
+               warn_if_error(alGetError(), "updateListener");
+       }
+
+       void setListenerGain(float gain)
+       {
+               alListenerf(AL_GAIN, gain);
+       }
+
+       int playSound(const std::string &name, bool loop, float volume, float fade, float pitch)
+       {
+               maintain();
+               if (name.empty())
+                       return 0;
+               SoundBuffer *buf = getFetchBuffer(name);
+               if(!buf){
+                       infostream << "OpenALSoundManager: \"" << name << "\" not found."
+                                       << std::endl;
+                       return -1;
+               }
+               int handle = -1;
+               if (fade > 0) {
+                       handle = playSoundRaw(buf, loop, 0.0f, pitch);
+                       fadeSound(handle, fade, volume);
+               } else {
+                       handle = playSoundRaw(buf, loop, volume, pitch);
+               }
+               return handle;
+       }
+
+       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos, float pitch)
+       {
+               maintain();
+               if (name.empty())
+                       return 0;
+               SoundBuffer *buf = getFetchBuffer(name);
+               if(!buf){
+                       infostream << "OpenALSoundManager: \"" << name << "\" not found."
+                                       << std::endl;
+                       return -1;
+               }
+               return playSoundRawAt(buf, loop, volume, pos, pitch);
+       }
+
+       void stopSound(int sound)
+       {
+               maintain();
+               deleteSound(sound);
+       }
+
+       void fadeSound(int soundid, float step, float gain)
+       {
+               m_sounds_fading[soundid] = FadeState(step, getSoundGain(soundid), gain);
+       }
+
+       void doFades(float dtime)
+       {
+               m_fade_delay += dtime;
+
+               if (m_fade_delay < 0.1f)
+                       return;
+
+               float chkGain = 0;
+               for (auto i = m_sounds_fading.begin();
+                               i != m_sounds_fading.end();) {
+                       if (i->second.step < 0.f)
+                               chkGain = -(i->second.current_gain);
+                       else
+                               chkGain = i->second.current_gain;
+
+                       if (chkGain < i->second.target_gain) {
+                               i->second.current_gain += (i->second.step * m_fade_delay);
+                               i->second.current_gain = rangelim(i->second.current_gain, 0, 1);
+
+                               updateSoundGain(i->first, i->second.current_gain);
+                               ++i;
+                       } else {
+                               if (i->second.target_gain <= 0.f)
+                                       stopSound(i->first);
+
+                               m_sounds_fading.erase(i++);
+                       }
+               }
+               m_fade_delay = 0;
+       }
+
+       bool soundExists(int sound)
+       {
+               maintain();
+               return (m_sounds_playing.count(sound) != 0);
+       }
+
+       void updateSoundPosition(int id, v3f pos)
+       {
+               auto i = m_sounds_playing.find(id);
+               if (i == m_sounds_playing.end())
+                       return;
+               PlayingSound *sound = i->second;
+
+               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, false);
+               alSource3f(sound->source_id, AL_POSITION, pos.X, pos.Y, pos.Z);
+               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
+               alSourcef(sound->source_id, AL_REFERENCE_DISTANCE, 30.0);
+       }
+
+       bool updateSoundGain(int id, float gain)
+       {
+               auto i = m_sounds_playing.find(id);
+               if (i == m_sounds_playing.end())
+                       return false;
+
+               PlayingSound *sound = i->second;
+               alSourcef(sound->source_id, AL_GAIN, gain);
+               return true;
+       }
+
+       float getSoundGain(int id)
+       {
+               auto i = m_sounds_playing.find(id);
+               if (i == m_sounds_playing.end())
+                       return 0;
+
+               PlayingSound *sound = i->second;
+               ALfloat gain;
+               alGetSourcef(sound->source_id, AL_GAIN, &gain);
+               return gain;
+       }
+};
+
+std::shared_ptr<SoundManagerSingleton> createSoundManagerSingleton()
+{
+       return std::shared_ptr<SoundManagerSingleton>(new SoundManagerSingleton());
+}
+
+ISoundManager *createOpenALSoundManager(SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher)
+{
+       return new OpenALSoundManager(smg, fetcher);
+};
diff --git a/src/client/sound_openal.h b/src/client/sound_openal.h
new file mode 100644 (file)
index 0000000..f04ad7c
--- /dev/null
@@ -0,0 +1,31 @@
+/*
+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 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 Lesser General Public License for more details.
+
+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.
+*/
+
+#pragma once
+
+#include <memory>
+
+#include "sound.h"
+
+class SoundManagerSingleton;
+extern std::shared_ptr<SoundManagerSingleton> g_sound_manager_singleton;
+
+std::shared_ptr<SoundManagerSingleton> createSoundManagerSingleton();
+ISoundManager *createOpenALSoundManager(
+               SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher);
index 2e9f8f39daa73b211ea50f487c7b0857a0482a0b..1dec95839b1f6b41cb212deaef4b2ece4bbd7dae 100644 (file)
@@ -26,6 +26,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "util/numeric.h" // For IntervalLimiter
 #include "util/serialize.h"
 #include "util/basic_macros.h"
+#include "client/sound.h"
 #include "client/tile.h"
 #include "environment.h"
 #include "collision.h"
@@ -1177,7 +1178,7 @@ void GenericCAO::updateAnimationSpeed()
 {
        if (!m_animated_meshnode)
                return;
-        
+
        m_animated_meshnode->setAnimationSpeed(m_animation_speed);
 }
 
index fada349db7c44b9af6e7634d2cc70c0ee72570a1..685fb06517bec3436574fc96946c3ee8662d5d9a 100644 (file)
@@ -69,10 +69,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "script/scripting_client.h"
 
 #if USE_SOUND
-       #include "sound_openal.h"
+       #include "client/sound_openal.h"
+#else
+       #include "client/sound.h"
 #endif
-
-
 /*
        Text input system
 */
index 9d3b889a06280947d076a58e893cfbf2817ac30a..f86eb13cd470e49a2e9c77f47fd71a84cf93cc80 100644 (file)
@@ -27,7 +27,6 @@ class IItemDefManager;
 class NodeDefManager;
 class ICraftDefManager;
 class ITextureSource;
-class ISoundManager;
 class IShaderSource;
 class MtEventManager;
 class IRollbackManager;
index 00c3f85bcfa62eb09043440e810a60c958a19209..7654bf7b3285f1e65c77c1ab634db08ef4800a19 100644 (file)
@@ -31,7 +31,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "settings.h"
 #include "guiMainMenu.h"
 #include "sound.h"
-#include "sound_openal.h"
+#include "client/sound_openal.h"
 #include "clouds.h"
 #include "httpfetch.h"
 #include "log.h"
index 817d7601440bd324d8bc93d4501dba1d64d0448f..409ba94c498ae39f16606192633c2f2eeb75278b 100644 (file)
@@ -25,7 +25,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "irrlichttypes.h"
 #include "modalMenu.h"
 #include "guiFormSpecMenu.h"
-#include "sound.h"
+#include "client/sound.h"
 #include "client/tile.h"
 #include "util/enriched_string.h"
 
index 07a38e397d918a3bd8cc306e453b305fa8828da0..37b6493647ba626f615291281a49a6658cad1098 100644 (file)
@@ -32,6 +32,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "server.h"
 #include "util/strfnd.h"
 #include "client/clientevent.h"
+#include "client/sound.h"
 #include "network/clientopcodes.h"
 #include "network/connection.h"
 #include "script/scripting_client.h"
index 2d36e977c0fe24bc44179f93e5f1514cf76af6b9..8e802d2a2fc9bfefe76d00ec44d7e6f37dc92d29 100644 (file)
@@ -22,6 +22,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "chatmessage.h"
 #include "client.h"
 #include "client/clientevent.h"
+#include "client/sound.h"
 #include "clientenvironment.h"
 #include "common/c_content.h"
 #include "common/c_converter.h"
diff --git a/src/sound.cpp b/src/sound.cpp
deleted file mode 100644 (file)
index 7070650..0000000
+++ /dev/null
@@ -1,25 +0,0 @@
-/*
-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 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 Lesser General Public License for more details.
-
-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.
-*/
-
-#include "sound.h"
-
-// Global DummySoundManager singleton
-DummySoundManager dummySoundManager;
-
-
index 0ad34e5cdfb68e9f477c7305ce1f0baf0f92272f..81d918c81aee86ffeb5977104a8532eb143325f3 100644 (file)
@@ -23,14 +23,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <string>
 #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;
-};
-
 struct SimpleSoundSpec
 {
        SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
@@ -42,83 +34,8 @@ struct SimpleSoundSpec
 
        bool exists() const { return !name.empty(); }
 
-       std::string name = "";
+       std::string name;
        float gain = 1.0f;
        float fade = 0.0f;
        float pitch = 1.0f;
 };
-
-class ISoundManager
-{
-public:
-       virtual ~ISoundManager() = default;
-
-       // 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;
-
-       // 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,
-                       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;
-       virtual void stopSound(int sound) = 0;
-       virtual bool soundExists(int sound) = 0;
-       virtual void updateSoundPosition(int sound, v3f pos) = 0;
-       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;
-
-       int playSound(const SimpleSoundSpec &spec, bool loop)
-       {
-               return playSound(spec.name, loop, spec.gain, spec.fade, spec.pitch);
-       }
-       int playSoundAt(const SimpleSoundSpec &spec, bool loop, const v3f &pos)
-       {
-               return playSoundAt(spec.name, loop, spec.gain, pos, spec.pitch);
-       }
-};
-
-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, float fade,
-                       float pitch)
-       {
-               return 0;
-       }
-       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos,
-                       float pitch)
-       {
-               return 0;
-       }
-       void stopSound(int sound) {}
-       bool soundExists(int sound) { return false; }
-       void updateSoundPosition(int sound, v3f pos) {}
-       bool updateSoundGain(int id, float gain) { return false; }
-       float getSoundGain(int id) { return 0; }
-       void step(float dtime) {}
-       void fadeSound(int sound, float step, float gain) {}
-};
-
-// Global DummySoundManager singleton
-extern DummySoundManager dummySoundManager;
diff --git a/src/sound_openal.cpp b/src/sound_openal.cpp
deleted file mode 100644 (file)
index 853aba1..0000000
+++ /dev/null
@@ -1,711 +0,0 @@
-/*
-Minetest
-Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
-OpenAL support based on work by:
-Copyright (C) 2011 Sebastian 'Bahamada' Rühl
-Copyright (C) 2011 Cyriaque 'Cisoun' Skrapits <cysoun@gmail.com>
-Copyright (C) 2011 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-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 Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License along
-with this program; ifnot, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-*/
-
-#include "sound_openal.h"
-
-#if defined(_WIN32)
-       #include <al.h>
-       #include <alc.h>
-       //#include <alext.h>
-#elif defined(__APPLE__)
-       #include <OpenAL/al.h>
-       #include <OpenAL/alc.h>
-       //#include <OpenAL/alext.h>
-#else
-       #include <AL/al.h>
-       #include <AL/alc.h>
-       #include <AL/alext.h>
-#endif
-#include <cmath>
-#include <vorbis/vorbisfile.h>
-#include <cassert>
-#include "log.h"
-#include "util/numeric.h" // myrand()
-#include "porting.h"
-#include <vector>
-#include <fstream>
-#include <unordered_map>
-#include <unordered_set>
-
-#define BUFFER_SIZE 30000
-
-std::shared_ptr<SoundManagerSingleton> g_sound_manager_singleton;
-
-typedef std::unique_ptr<ALCdevice, void (*)(ALCdevice *p)> unique_ptr_alcdevice;
-typedef std::unique_ptr<ALCcontext, void(*)(ALCcontext *p)> unique_ptr_alccontext;
-
-static void delete_alcdevice(ALCdevice *p)
-{
-       if (p)
-               alcCloseDevice(p);
-}
-
-static void delete_alccontext(ALCcontext *p)
-{
-       if (p) {
-               alcMakeContextCurrent(nullptr);
-               alcDestroyContext(p);
-       }
-}
-
-static const char *alcErrorString(ALCenum err)
-{
-       switch (err) {
-       case ALC_NO_ERROR:
-               return "no error";
-       case ALC_INVALID_DEVICE:
-               return "invalid device";
-       case ALC_INVALID_CONTEXT:
-               return "invalid context";
-       case ALC_INVALID_ENUM:
-               return "invalid enum";
-       case ALC_INVALID_VALUE:
-               return "invalid value";
-       case ALC_OUT_OF_MEMORY:
-               return "out of memory";
-       default:
-               return "<unknown OpenAL error>";
-       }
-}
-
-static const char *alErrorString(ALenum err)
-{
-       switch (err) {
-       case AL_NO_ERROR:
-               return "no error";
-       case AL_INVALID_NAME:
-               return "invalid name";
-       case AL_INVALID_ENUM:
-               return "invalid enum";
-       case AL_INVALID_VALUE:
-               return "invalid value";
-       case AL_INVALID_OPERATION:
-               return "invalid operation";
-       case AL_OUT_OF_MEMORY:
-               return "out of memory";
-       default:
-               return "<unknown OpenAL error>";
-       }
-}
-
-static ALenum warn_if_error(ALenum err, const char *desc)
-{
-       if(err == AL_NO_ERROR)
-               return err;
-       warningstream<<desc<<": "<<alErrorString(err)<<std::endl;
-       return err;
-}
-
-void f3_set(ALfloat *f3, v3f v)
-{
-       f3[0] = v.X;
-       f3[1] = v.Y;
-       f3[2] = v.Z;
-}
-
-struct SoundBuffer
-{
-       ALenum format;
-       ALsizei freq;
-       ALuint buffer_id;
-       std::vector<char> buffer;
-};
-
-SoundBuffer *load_opened_ogg_file(OggVorbis_File *oggFile,
-               const std::string &filename_for_logging)
-{
-       int endian = 0; // 0 for Little-Endian, 1 for Big-Endian
-       int bitStream;
-       long bytes;
-       char array[BUFFER_SIZE]; // Local fixed size array
-       vorbis_info *pInfo;
-
-       SoundBuffer *snd = new SoundBuffer;
-
-       // Get some information about the OGG file
-       pInfo = ov_info(oggFile, -1);
-
-       // Check the number of channels... always use 16-bit samples
-       if(pInfo->channels == 1)
-               snd->format = AL_FORMAT_MONO16;
-       else
-               snd->format = AL_FORMAT_STEREO16;
-
-       // The frequency of the sampling rate
-       snd->freq = pInfo->rate;
-
-       // Keep reading until all is read
-       do
-       {
-               // Read up to a buffer's worth of decoded sound data
-               bytes = ov_read(oggFile, array, BUFFER_SIZE, endian, 2, 1, &bitStream);
-
-               if(bytes < 0)
-               {
-                       ov_clear(oggFile);
-                       infostream << "Audio: Error decoding "
-                               << filename_for_logging << std::endl;
-                       delete snd;
-                       return nullptr;
-               }
-
-               // Append to end of buffer
-               snd->buffer.insert(snd->buffer.end(), array, array + bytes);
-       } while (bytes > 0);
-
-       alGenBuffers(1, &snd->buffer_id);
-       alBufferData(snd->buffer_id, snd->format,
-                       &(snd->buffer[0]), snd->buffer.size(),
-                       snd->freq);
-
-       ALenum error = alGetError();
-
-       if(error != AL_NO_ERROR){
-               infostream << "Audio: OpenAL error: " << alErrorString(error)
-                               << "preparing sound buffer" << std::endl;
-       }
-
-       infostream << "Audio file "
-               << filename_for_logging << " loaded" << std::endl;
-
-       // Clean up!
-       ov_clear(oggFile);
-
-       return snd;
-}
-
-SoundBuffer *load_ogg_from_file(const std::string &path)
-{
-       OggVorbis_File oggFile;
-
-       // Try opening the given file.
-       // This requires libvorbis >= 1.3.2, as
-       // previous versions expect a non-const char *
-       if (ov_fopen(path.c_str(), &oggFile) != 0) {
-               infostream << "Audio: Error opening " << path
-                       << " for decoding" << std::endl;
-               return nullptr;
-       }
-
-       return load_opened_ogg_file(&oggFile, path);
-}
-
-struct BufferSource {
-       const char *buf;
-       size_t cur_offset;
-       size_t len;
-};
-
-size_t buffer_sound_read_func(void *ptr, size_t size, size_t nmemb, void *datasource)
-{
-       BufferSource *s = (BufferSource *)datasource;
-       size_t copied_size = MYMIN(s->len - s->cur_offset, size);
-       memcpy(ptr, s->buf + s->cur_offset, copied_size);
-       s->cur_offset += copied_size;
-       return copied_size;
-}
-
-int buffer_sound_seek_func(void *datasource, ogg_int64_t offset, int whence)
-{
-       BufferSource *s = (BufferSource *)datasource;
-       if (whence == SEEK_SET) {
-               if (offset < 0 || (size_t)MYMAX(offset, 0) >= s->len) {
-                       // offset out of bounds
-                       return -1;
-               }
-               s->cur_offset = offset;
-               return 0;
-       } else if (whence == SEEK_CUR) {
-               if ((size_t)MYMIN(-offset, 0) > s->cur_offset
-                               || s->cur_offset + offset > s->len) {
-                       // offset out of bounds
-                       return -1;
-               }
-               s->cur_offset += offset;
-               return 0;
-       }
-       // invalid whence param (SEEK_END doesn't have to be supported)
-       return -1;
-}
-
-long BufferSourceell_func(void *datasource)
-{
-       BufferSource *s = (BufferSource *)datasource;
-       return s->cur_offset;
-}
-
-static ov_callbacks g_buffer_ov_callbacks = {
-       &buffer_sound_read_func,
-       &buffer_sound_seek_func,
-       nullptr,
-       &BufferSourceell_func
-};
-
-SoundBuffer *load_ogg_from_buffer(const std::string &buf, const std::string &id_for_log)
-{
-       OggVorbis_File oggFile;
-
-       BufferSource s;
-       s.buf = buf.c_str();
-       s.cur_offset = 0;
-       s.len = buf.size();
-
-       if (ov_open_callbacks(&s, &oggFile, nullptr, 0, g_buffer_ov_callbacks) != 0) {
-               infostream << "Audio: Error opening " << id_for_log
-                       << " for decoding" << std::endl;
-               return nullptr;
-       }
-
-       return load_opened_ogg_file(&oggFile, id_for_log);
-}
-
-struct PlayingSound
-{
-       ALuint source_id;
-       bool loop;
-};
-
-class SoundManagerSingleton
-{
-public:
-       unique_ptr_alcdevice  m_device;
-       unique_ptr_alccontext m_context;
-public:
-       SoundManagerSingleton() :
-               m_device(nullptr, delete_alcdevice),
-               m_context(nullptr, delete_alccontext)
-       {
-               if (!(m_device = unique_ptr_alcdevice(alcOpenDevice(nullptr), delete_alcdevice)))
-                       throw std::runtime_error("Audio: Global Initialization: Device Open");
-
-               if (!(m_context = unique_ptr_alccontext(
-                               alcCreateContext(m_device.get(), nullptr), delete_alccontext))) {
-                       throw std::runtime_error("Audio: Global Initialization: Context Create");
-               }
-
-               if (!alcMakeContextCurrent(m_context.get()))
-                       throw std::runtime_error("Audio: Global Initialization: Context Current");
-
-               alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
-
-               if (alGetError() != AL_NO_ERROR)
-                       throw std::runtime_error("Audio: Global Initialization: OpenAL Error");
-
-               infostream << "Audio: Global Initialized: OpenAL " << alGetString(AL_VERSION)
-                       << ", using " << alcGetString(m_device.get(), ALC_DEVICE_SPECIFIER)
-                       << std::endl;
-       }
-
-       ~SoundManagerSingleton()
-       {
-               infostream << "Audio: Global Deinitialized." << std::endl;
-       }
-};
-
-class OpenALSoundManager: public ISoundManager
-{
-private:
-       OnDemandSoundFetcher *m_fetcher;
-       ALCdevice *m_device;
-       ALCcontext *m_context;
-       int m_next_id;
-       std::unordered_map<std::string, std::vector<SoundBuffer*>> m_buffers;
-       std::unordered_map<int, PlayingSound*> m_sounds_playing;
-       v3f m_listener_pos;
-       struct FadeState {
-               FadeState() = default;
-
-               FadeState(float step, float current_gain, float target_gain):
-                       step(step),
-                       current_gain(current_gain),
-                       target_gain(target_gain) {}
-               float step;
-               float current_gain;
-               float target_gain;
-       };
-
-       std::unordered_map<int, FadeState> m_sounds_fading;
-       float m_fade_delay;
-public:
-       OpenALSoundManager(SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher):
-               m_fetcher(fetcher),
-               m_device(smg->m_device.get()),
-               m_context(smg->m_context.get()),
-               m_next_id(1),
-               m_fade_delay(0)
-       {
-               infostream << "Audio: Initialized: OpenAL " << std::endl;
-       }
-
-       ~OpenALSoundManager()
-       {
-               infostream << "Audio: Deinitializing..." << std::endl;
-
-               std::unordered_set<int> source_del_list;
-
-               for (const auto &sp : m_sounds_playing)
-                       source_del_list.insert(sp.second->source_id);
-
-               for (const auto &id : source_del_list)
-                       deleteSound(id);
-
-               for (auto &buffer : m_buffers) {
-                       for (SoundBuffer *sb : buffer.second) {
-                               delete sb;
-                       }
-                       buffer.second.clear();
-               }
-               m_buffers.clear();
-
-               infostream << "Audio: Deinitialized." << std::endl;
-       }
-
-       void step(float dtime)
-       {
-               doFades(dtime);
-       }
-
-       void addBuffer(const std::string &name, SoundBuffer *buf)
-       {
-               std::unordered_map<std::string, std::vector<SoundBuffer*>>::iterator i =
-                               m_buffers.find(name);
-               if(i != m_buffers.end()){
-                       i->second.push_back(buf);
-                       return;
-               }
-               std::vector<SoundBuffer*> bufs;
-               bufs.push_back(buf);
-               m_buffers[name] = bufs;
-       }
-
-       SoundBuffer* getBuffer(const std::string &name)
-       {
-               std::unordered_map<std::string, std::vector<SoundBuffer*>>::iterator i =
-                               m_buffers.find(name);
-               if(i == m_buffers.end())
-                       return nullptr;
-               std::vector<SoundBuffer*> &bufs = i->second;
-               int j = myrand() % bufs.size();
-               return bufs[j];
-       }
-
-       PlayingSound* createPlayingSound(SoundBuffer *buf, bool loop,
-                       float volume, float pitch)
-       {
-               infostream << "OpenALSoundManager: Creating playing sound" << std::endl;
-               assert(buf);
-               PlayingSound *sound = new PlayingSound;
-               assert(sound);
-               warn_if_error(alGetError(), "before createPlayingSound");
-               alGenSources(1, &sound->source_id);
-               alSourcei(sound->source_id, AL_BUFFER, buf->buffer_id);
-               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, true);
-               alSource3f(sound->source_id, AL_POSITION, 0, 0, 0);
-               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
-               alSourcei(sound->source_id, AL_LOOPING, loop ? AL_TRUE : AL_FALSE);
-               volume = std::fmax(0.0f, volume);
-               alSourcef(sound->source_id, AL_GAIN, volume);
-               alSourcef(sound->source_id, AL_PITCH, pitch);
-               alSourcePlay(sound->source_id);
-               warn_if_error(alGetError(), "createPlayingSound");
-               return sound;
-       }
-
-       PlayingSound* createPlayingSoundAt(SoundBuffer *buf, bool loop,
-                       float volume, v3f pos, float pitch)
-       {
-               infostream << "OpenALSoundManager: Creating positional playing sound"
-                               << std::endl;
-               assert(buf);
-               PlayingSound *sound = new PlayingSound;
-               assert(sound);
-               warn_if_error(alGetError(), "before createPlayingSoundAt");
-               alGenSources(1, &sound->source_id);
-               alSourcei(sound->source_id, AL_BUFFER, buf->buffer_id);
-               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, false);
-               alSource3f(sound->source_id, AL_POSITION, pos.X, pos.Y, pos.Z);
-               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
-               // Use alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED) and set reference
-               // distance to clamp gain at <1 node distance, to avoid excessive
-               // volume when closer
-               alSourcef(sound->source_id, AL_REFERENCE_DISTANCE, 10.0f);
-               alSourcei(sound->source_id, AL_LOOPING, loop ? AL_TRUE : AL_FALSE);
-               // Multiply by 3 to compensate for reducing AL_REFERENCE_DISTANCE from
-               // the previous value of 30 to the new value of 10
-               volume = std::fmax(0.0f, volume * 3.0f);
-               alSourcef(sound->source_id, AL_GAIN, volume);
-               alSourcef(sound->source_id, AL_PITCH, pitch);
-               alSourcePlay(sound->source_id);
-               warn_if_error(alGetError(), "createPlayingSoundAt");
-               return sound;
-       }
-
-       int playSoundRaw(SoundBuffer *buf, bool loop, float volume, float pitch)
-       {
-               assert(buf);
-               PlayingSound *sound = createPlayingSound(buf, loop, volume, pitch);
-               if(!sound)
-                       return -1;
-               int id = m_next_id++;
-               m_sounds_playing[id] = sound;
-               return id;
-       }
-
-       int playSoundRawAt(SoundBuffer *buf, bool loop, float volume, const v3f &pos,
-                       float pitch)
-       {
-               assert(buf);
-               PlayingSound *sound = createPlayingSoundAt(buf, loop, volume, pos, pitch);
-               if(!sound)
-                       return -1;
-               int id = m_next_id++;
-               m_sounds_playing[id] = sound;
-               return id;
-       }
-
-       void deleteSound(int id)
-       {
-               std::unordered_map<int, PlayingSound*>::iterator i = m_sounds_playing.find(id);
-               if(i == m_sounds_playing.end())
-                       return;
-               PlayingSound *sound = i->second;
-
-               alDeleteSources(1, &sound->source_id);
-
-               delete sound;
-               m_sounds_playing.erase(id);
-       }
-
-       /* If buffer does not exist, consult the fetcher */
-       SoundBuffer* getFetchBuffer(const std::string &name)
-       {
-               SoundBuffer *buf = getBuffer(name);
-               if(buf)
-                       return buf;
-               if(!m_fetcher)
-                       return nullptr;
-               std::set<std::string> paths;
-               std::set<std::string> datas;
-               m_fetcher->fetchSounds(name, paths, datas);
-               for (const std::string &path : paths) {
-                       loadSoundFile(name, path);
-               }
-               for (const std::string &data : datas) {
-                       loadSoundData(name, data);
-               }
-               return getBuffer(name);
-       }
-
-       // Remove stopped sounds
-       void maintain()
-       {
-               verbosestream<<"OpenALSoundManager::maintain(): "
-                               <<m_sounds_playing.size()<<" playing sounds, "
-                               <<m_buffers.size()<<" sound names loaded"<<std::endl;
-               std::unordered_set<int> del_list;
-               for (const auto &sp : m_sounds_playing) {
-                       int id = sp.first;
-                       PlayingSound *sound = sp.second;
-                       // If not playing, remove it
-                       {
-                               ALint state;
-                               alGetSourcei(sound->source_id, AL_SOURCE_STATE, &state);
-                               if(state != AL_PLAYING){
-                                       del_list.insert(id);
-                               }
-                       }
-               }
-               if(!del_list.empty())
-                       verbosestream<<"OpenALSoundManager::maintain(): deleting "
-                                       <<del_list.size()<<" playing sounds"<<std::endl;
-               for (int i : del_list) {
-                       deleteSound(i);
-               }
-       }
-
-       /* Interface */
-
-       bool loadSoundFile(const std::string &name,
-                       const std::string &filepath)
-       {
-               SoundBuffer *buf = load_ogg_from_file(filepath);
-               if (buf)
-                       addBuffer(name, buf);
-               return false;
-       }
-
-       bool loadSoundData(const std::string &name,
-                       const std::string &filedata)
-       {
-               SoundBuffer *buf = load_ogg_from_buffer(filedata, name);
-               if (buf)
-                       addBuffer(name, buf);
-               return false;
-       }
-
-       void updateListener(v3f pos, v3f vel, v3f at, v3f up)
-       {
-               m_listener_pos = pos;
-               alListener3f(AL_POSITION, pos.X, pos.Y, pos.Z);
-               alListener3f(AL_VELOCITY, vel.X, vel.Y, vel.Z);
-               ALfloat f[6];
-               f3_set(f, at);
-               f3_set(f+3, -up);
-               alListenerfv(AL_ORIENTATION, f);
-               warn_if_error(alGetError(), "updateListener");
-       }
-
-       void setListenerGain(float gain)
-       {
-               alListenerf(AL_GAIN, gain);
-       }
-
-       int playSound(const std::string &name, bool loop, float volume, float fade, float pitch)
-       {
-               maintain();
-               if (name.empty())
-                       return 0;
-               SoundBuffer *buf = getFetchBuffer(name);
-               if(!buf){
-                       infostream << "OpenALSoundManager: \"" << name << "\" not found."
-                                       << std::endl;
-                       return -1;
-               }
-               int handle = -1;
-               if (fade > 0) {
-                       handle = playSoundRaw(buf, loop, 0.0f, pitch);
-                       fadeSound(handle, fade, volume);
-               } else {
-                       handle = playSoundRaw(buf, loop, volume, pitch);
-               }
-               return handle;
-       }
-
-       int playSoundAt(const std::string &name, bool loop, float volume, v3f pos, float pitch)
-       {
-               maintain();
-               if (name.empty())
-                       return 0;
-               SoundBuffer *buf = getFetchBuffer(name);
-               if(!buf){
-                       infostream << "OpenALSoundManager: \"" << name << "\" not found."
-                                       << std::endl;
-                       return -1;
-               }
-               return playSoundRawAt(buf, loop, volume, pos, pitch);
-       }
-
-       void stopSound(int sound)
-       {
-               maintain();
-               deleteSound(sound);
-       }
-
-       void fadeSound(int soundid, float step, float gain)
-       {
-               m_sounds_fading[soundid] = FadeState(step, getSoundGain(soundid), gain);
-       }
-
-       void doFades(float dtime)
-       {
-               m_fade_delay += dtime;
-
-               if (m_fade_delay < 0.1f)
-                       return;
-
-               float chkGain = 0;
-               for (std::unordered_map<int, FadeState>::iterator i = m_sounds_fading.begin();
-                               i != m_sounds_fading.end();) {
-                       if (i->second.step < 0.f)
-                               chkGain = -(i->second.current_gain);
-                       else
-                               chkGain = i->second.current_gain;
-
-                       if (chkGain < i->second.target_gain) {
-                               i->second.current_gain += (i->second.step * m_fade_delay);
-                               i->second.current_gain = rangelim(i->second.current_gain, 0, 1);
-
-                               updateSoundGain(i->first, i->second.current_gain);
-                               ++i;
-                       } else {
-                               if (i->second.target_gain <= 0.f)
-                                       stopSound(i->first);
-
-                               m_sounds_fading.erase(i++);
-                       }
-               }
-               m_fade_delay = 0;
-       }
-
-       bool soundExists(int sound)
-       {
-               maintain();
-               return (m_sounds_playing.count(sound) != 0);
-       }
-
-       void updateSoundPosition(int id, v3f pos)
-       {
-               std::unordered_map<int, PlayingSound*>::iterator i = m_sounds_playing.find(id);
-               if (i == m_sounds_playing.end())
-                       return;
-               PlayingSound *sound = i->second;
-
-               alSourcei(sound->source_id, AL_SOURCE_RELATIVE, false);
-               alSource3f(sound->source_id, AL_POSITION, pos.X, pos.Y, pos.Z);
-               alSource3f(sound->source_id, AL_VELOCITY, 0, 0, 0);
-               alSourcef(sound->source_id, AL_REFERENCE_DISTANCE, 30.0);
-       }
-
-       bool updateSoundGain(int id, float gain)
-       {
-               std::unordered_map<int, PlayingSound*>::iterator i = m_sounds_playing.find(id);
-               if (i == m_sounds_playing.end())
-                       return false;
-
-               PlayingSound *sound = i->second;
-               alSourcef(sound->source_id, AL_GAIN, gain);
-               return true;
-       }
-
-       float getSoundGain(int id)
-       {
-               std::unordered_map<int, PlayingSound*>::iterator i = m_sounds_playing.find(id);
-               if (i == m_sounds_playing.end())
-                       return 0;
-
-               PlayingSound *sound = i->second;
-               ALfloat gain;
-               alGetSourcef(sound->source_id, AL_GAIN, &gain);
-               return gain;
-       }
-};
-
-std::shared_ptr<SoundManagerSingleton> createSoundManagerSingleton()
-{
-       return std::shared_ptr<SoundManagerSingleton>(new SoundManagerSingleton());
-}
-
-ISoundManager *createOpenALSoundManager(SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher)
-{
-       return new OpenALSoundManager(smg, fetcher);
-};
diff --git a/src/sound_openal.h b/src/sound_openal.h
deleted file mode 100644 (file)
index f2cff4d..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
-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 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 Lesser General Public License for more details.
-
-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.
-*/
-
-#pragma once
-
-#include <memory>
-
-#include "sound.h"
-
-class SoundManagerSingleton;
-extern std::shared_ptr<SoundManagerSingleton> g_sound_manager_singleton;
-
-std::shared_ptr<SoundManagerSingleton> createSoundManagerSingleton();
-ISoundManager *createOpenALSoundManager(SoundManagerSingleton *smg, OnDemandSoundFetcher *fetcher);
index 150bddc567ff2fa8637d5724921fb03b5a6896bf..18215a94749558164d1ce262d0a3526c84ef8bfe 100644 (file)
@@ -19,6 +19,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "test.h"
 
+#include "client/sound.h"
 #include "nodedef.h"
 #include "itemdef.h"
 #include "gamedef.h"
index f522d46cd0b676c32b68772569938013a6b57eca..8e0f7fdeb126133b5019ab10112b024f5c5848a9 100644 (file)
@@ -7,6 +7,7 @@ src/chat.h
 src/chat_interface.h
 src/client/clientlauncher.cpp
 src/client/clientlauncher.h
+src/client/sound_openal.cpp
 src/client.cpp
 src/clientenvironment.cpp
 src/clientenvironment.h
@@ -328,8 +329,6 @@ src/shader.cpp
 src/shader.h
 src/sky.cpp
 src/sound.cpp
-src/sound_openal.cpp
-src/sound_openal.h
 src/staticobject.cpp
 src/staticobject.h
 src/subgame.cpp