src/sound.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include <set>
  23 #include <string>
  24 #include "util/serialize.h"
  25 #include "irrlichttypes_bloated.h"
  26
  27 // This class describes the basic sound information for playback.
  28 // Positional handling is done separately.
  29
  30 struct SimpleSoundSpec
  31 {
  32         SimpleSoundSpec(const std::string &name = "", float gain = 1.0f,
  33                         bool loop = false, float fade = 0.0f, float pitch = 1.0f) :
  34                         name(name), gain(gain), fade(fade), pitch(pitch), loop(loop)
  35         {
  36         }
  37
  38         bool exists() const { return !name.empty(); }
  39
  40         void serialize(std::ostream &os, u16 protocol_version) const
  41         {
  42                 os << serializeString16(name);
  43                 writeF32(os, gain);
  44                 writeF32(os, pitch);
  45                 writeF32(os, fade);
  46         }
  47
  48         void deSerialize(std::istream &is, u16 protocol_version)
  49         {
  50                 name = deSerializeString16(is);
  51                 gain = readF32(is);
  52                 pitch = readF32(is);
  53                 fade = readF32(is);
  54         }
  55
  56         std::string name;
  57         float gain = 1.0f;
  58         float fade = 0.0f;
  59         float pitch = 1.0f;
  60         bool loop = false;
  61 };
  62
  63
  64 // The order must not be changed. This is sent over the network.
  65 enum class SoundLocation : u8 {
  66         Local,
  67         Position,
  68         Object
  69 };