]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/mg_schematic.cpp
Sound: Add pitch option (#5960)
[dragonfireclient.git] / src / mg_schematic.cpp
index 6215bce945fb0484c640963af0011c5a6f9ad579..3cea3c321e66d26e08ee4f261922f14ebda6335c 100644 (file)
@@ -1,6 +1,7 @@
 /*
 Minetest
-Copyright (C) 2010-2014 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+Copyright (C) 2014-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+Copyright (C) 2015-2017 paramat
 
 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
@@ -18,8 +19,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 */
 
 #include <fstream>
+#include <typeinfo>
 #include "mg_schematic.h"
-#include "gamedef.h"
+#include "server.h"
 #include "mapgen.h"
 #include "emerge.h"
 #include "map.h"
@@ -29,20 +31,21 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "util/serialize.h"
 #include "serialization.h"
 #include "filesys.h"
+#include "voxelalgorithms.h"
 
 ///////////////////////////////////////////////////////////////////////////////
 
 
-SchematicManager::SchematicManager(IGameDef *gamedef) :
-       ObjDefManager(gamedef, OBJDEF_SCHEMATIC)
+SchematicManager::SchematicManager(Server *server) :
+       ObjDefManager(server, OBJDEF_SCHEMATIC)
 {
-       m_gamedef = gamedef;
+       m_server = server;
 }
 
 
 void SchematicManager::clear()
 {
-       EmergeManager *emerge = m_gamedef->getEmergeManager();
+       EmergeManager *emerge = m_server->getEmergeManager();
 
        // Remove all dangling references in Decorations
        DecorationManager *decomgr = emerge->decomgr;
@@ -53,7 +56,7 @@ void SchematicManager::clear()
                        DecoSchematic *dschem = dynamic_cast<DecoSchematic *>(deco);
                        if (dschem)
                                dschem->schematic = NULL;
-               } catch(std::bad_cast) {
+               } catch (std::bad_cast) {
                }
        }
 
@@ -93,9 +96,10 @@ void Schematic::resolveNodeNames()
 }
 
 
-void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
-       bool force_placement, INodeDefManager *ndef)
+void Schematic::blitToVManip(MMVManip *vm, v3s16 p, Rotation rot, bool force_place)
 {
+       sanity_check(m_ndef != NULL);
+
        int xstride = 1;
        int ystride = size.X;
        int zstride = size.X * size.Y;
@@ -131,8 +135,8 @@ void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
 
        s16 y_map = p.Y;
        for (s16 y = 0; y != sy; y++) {
-               if (slice_probs[y] != MTSCHEM_PROB_ALWAYS &&
-                       myrand_range(1, 255) > slice_probs[y])
+               if ((slice_probs[y] != MTSCHEM_PROB_ALWAYS) &&
+                       (slice_probs[y] <= myrand_range(1, MTSCHEM_PROB_ALWAYS)))
                        continue;
 
                for (s16 z = 0; z != sz; z++) {
@@ -145,24 +149,27 @@ void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
                                if (schemdata[i].getContent() == CONTENT_IGNORE)
                                        continue;
 
-                               if (schemdata[i].param1 == MTSCHEM_PROB_NEVER)
+                               u8 placement_prob     = schemdata[i].param1 & MTSCHEM_PROB_MASK;
+                               bool force_place_node = schemdata[i].param1 & MTSCHEM_FORCE_PLACE;
+
+                               if (placement_prob == MTSCHEM_PROB_NEVER)
                                        continue;
 
-                               if (!force_placement) {
+                               if (!force_place && !force_place_node) {
                                        content_t c = vm->m_data[vi].getContent();
                                        if (c != CONTENT_AIR && c != CONTENT_IGNORE)
                                                continue;
                                }
 
-                               if (schemdata[i].param1 != MTSCHEM_PROB_ALWAYS &&
-                                       myrand_range(1, 255) > schemdata[i].param1)
+                               if ((placement_prob != MTSCHEM_PROB_ALWAYS) &&
+                                       (placement_prob <= myrand_range(1, MTSCHEM_PROB_ALWAYS)))
                                        continue;
 
                                vm->m_data[vi] = schemdata[i];
                                vm->m_data[vi].param1 = 0;
 
                                if (rot)
-                                       vm->m_data[vi].rotateAlongYAxis(ndef, rot);
+                                       vm->m_data[vi].rotateAlongYAxis(m_ndef, rot);
                        }
                }
                y_map++;
@@ -170,18 +177,21 @@ void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
 }
 
 
-void Schematic::placeStructure(Map *map, v3s16 p, u32 flags, Rotation rot,
-       bool force_placement, INodeDefManager *ndef)
+bool Schematic::placeOnVManip(MMVManip *vm, v3s16 p, u32 flags,
+       Rotation rot, bool force_place)
 {
-       assert(schemdata != NULL); // Pre-condition
-       MMVManip *vm = new MMVManip(map);
+       assert(vm != NULL);
+       assert(schemdata != NULL);
+       sanity_check(m_ndef != NULL);
 
+       //// Determine effective rotation and effective schematic dimensions
        if (rot == ROTATE_RAND)
                rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
 
        v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
-                               v3s16(size.Z, size.Y, size.X) : size;
+               v3s16(size.Z, size.Y, size.X) : size;
 
+       //// Adjust placement position if necessary
        if (flags & DECO_PLACE_CENTER_X)
                p.X -= (s.X + 1) / 2;
        if (flags & DECO_PLACE_CENTER_Y)
@@ -189,63 +199,99 @@ void Schematic::placeStructure(Map *map, v3s16 p, u32 flags, Rotation rot,
        if (flags & DECO_PLACE_CENTER_Z)
                p.Z -= (s.Z + 1) / 2;
 
-       v3s16 bp1 = getNodeBlockPos(p);
-       v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
-       vm->initialEmerge(bp1, bp2);
+       blitToVManip(vm, p, rot, force_place);
 
-       blitToVManip(p, vm, rot, force_placement, ndef);
+       return vm->m_area.contains(VoxelArea(p, p + s - v3s16(1,1,1)));
+}
 
+void Schematic::placeOnMap(ServerMap *map, v3s16 p, u32 flags,
+       Rotation rot, bool force_place)
+{
        std::map<v3s16, MapBlock *> lighting_modified_blocks;
        std::map<v3s16, MapBlock *> modified_blocks;
-       vm->blitBackAll(&modified_blocks);
+       std::map<v3s16, MapBlock *>::iterator it;
+
+       assert(map != NULL);
+       assert(schemdata != NULL);
+       sanity_check(m_ndef != NULL);
+
+       //// Determine effective rotation and effective schematic dimensions
+       if (rot == ROTATE_RAND)
+               rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
+
+       v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
+                       v3s16(size.Z, size.Y, size.X) : size;
+
+       //// Adjust placement position if necessary
+       if (flags & DECO_PLACE_CENTER_X)
+               p.X -= (s.X + 1) / 2;
+       if (flags & DECO_PLACE_CENTER_Y)
+               p.Y -= (s.Y + 1) / 2;
+       if (flags & DECO_PLACE_CENTER_Z)
+               p.Z -= (s.Z + 1) / 2;
+
+       //// Create VManip for effected area, emerge our area, modify area
+       //// inside VManip, then blit back.
+       v3s16 bp1 = getNodeBlockPos(p);
+       v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
+
+       MMVManip vm(map);
+       vm.initialEmerge(bp1, bp2);
+
+       blitToVManip(&vm, p, rot, force_place);
 
-       // TODO: Optimize this by using Mapgen::calcLighting() instead
-       lighting_modified_blocks.insert(modified_blocks.begin(), modified_blocks.end());
-       map->updateLighting(lighting_modified_blocks, modified_blocks);
+       voxalgo::blit_back_with_light(map, &vm, &modified_blocks);
 
+       //// Carry out post-map-modification actions
+
+       //// Create & dispatch map modification events to observers
        MapEditEvent event;
        event.type = MEET_OTHER;
-       for (std::map<v3s16, MapBlock *>::iterator
-               it = modified_blocks.begin();
-               it != modified_blocks.end(); ++it)
+       for (it = modified_blocks.begin(); it != modified_blocks.end(); ++it)
                event.modified_blocks.insert(it->first);
 
        map->dispatchEvent(&event);
 }
 
 
-bool Schematic::deserializeFromMts(std::istream *is, std::vector<std::string> *names)
+bool Schematic::deserializeFromMts(std::istream *is,
+       std::vector<std::string> *names)
 {
        std::istream &ss = *is;
        content_t cignore = CONTENT_IGNORE;
        bool have_cignore = false;
 
+       //// Read signature
        u32 signature = readU32(ss);
        if (signature != MTSCHEM_FILE_SIGNATURE) {
-               errorstream << "Schematic::deserializeFromMts: invalid schematic "
+               errorstream << __FUNCTION__ << ": invalid schematic "
                        "file" << std::endl;
                return false;
        }
 
+       //// Read version
        u16 version = readU16(ss);
        if (version > MTSCHEM_FILE_VER_HIGHEST_READ) {
-               errorstream << "Schematic::deserializeFromMts: unsupported schematic "
+               errorstream << __FUNCTION__ << ": unsupported schematic "
                        "file version" << std::endl;
                return false;
        }
 
+       //// Read size
        size = readV3S16(ss);
 
+       //// Read Y-slice probability values
        delete []slice_probs;
        slice_probs = new u8[size.Y];
        for (int y = 0; y != size.Y; y++)
-               slice_probs[y] = (version >= 3) ? readU8(ss) : MTSCHEM_PROB_ALWAYS;
+               slice_probs[y] = (version >= 3) ? readU8(ss) : MTSCHEM_PROB_ALWAYS_OLD;
 
+       //// Read node names
        u16 nidmapcount = readU16(ss);
        for (int i = 0; i != nidmapcount; i++) {
                std::string name = deSerializeString(ss);
 
-               // Instances of "ignore" from ver 1 are converted to air (and instances
+               // Instances of "ignore" from v1 are converted to air (and instances
                // are fixed to have MTSCHEM_PROB_NEVER later on).
                if (name == "ignore") {
                        name = "air";
@@ -256,6 +302,7 @@ bool Schematic::deserializeFromMts(std::istream *is, std::vector<std::string> *n
                names->push_back(name);
        }
 
+       //// Read node data
        size_t nodecount = size.X * size.Y * size.Z;
 
        delete []schemdata;
@@ -264,21 +311,30 @@ bool Schematic::deserializeFromMts(std::istream *is, std::vector<std::string> *n
        MapNode::deSerializeBulk(ss, SER_FMT_VER_HIGHEST_READ, schemdata,
                nodecount, 2, 2, true);
 
-       // fix any probability values for nodes that were ignore
-       if (version == 1) {
+       // Fix probability values for nodes that were ignore; removed in v2
+       if (version < 2) {
                for (size_t i = 0; i != nodecount; i++) {
                        if (schemdata[i].param1 == 0)
-                               schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
+                               schemdata[i].param1 = MTSCHEM_PROB_ALWAYS_OLD;
                        if (have_cignore && schemdata[i].getContent() == cignore)
                                schemdata[i].param1 = MTSCHEM_PROB_NEVER;
                }
        }
 
+       // Fix probability values for probability range truncation introduced in v4
+       if (version < 4) {
+               for (s16 y = 0; y != size.Y; y++)
+                       slice_probs[y] >>= 1;
+               for (size_t i = 0; i != nodecount; i++)
+                       schemdata[i].param1 >>= 1;
+       }
+
        return true;
 }
 
 
-bool Schematic::serializeToMts(std::ostream *os)
+bool Schematic::serializeToMts(std::ostream *os,
+       const std::vector<std::string> &names)
 {
        std::ostream &ss = *os;
 
@@ -289,31 +345,31 @@ bool Schematic::serializeToMts(std::ostream *os)
        for (int y = 0; y != size.Y; y++)             // Y slice probabilities
                writeU8(ss, slice_probs[y]);
 
-       std::vector<content_t> usednodes;
-       int nodecount = size.X * size.Y * size.Z;
-       build_nnlist_and_update_ids(schemdata, nodecount, &usednodes);
-
-       u16 numids = usednodes.size();
-       writeU16(ss, numids); // name count
-       for (int i = 0; i != numids; i++)
-               ss << serializeString(getNodeName(usednodes[i])); // node names
+       writeU16(ss, names.size()); // name count
+       for (size_t i = 0; i != names.size(); i++)
+               ss << serializeString(names[i]); // node names
 
        // compressed bulk node data
        MapNode::serializeBulk(ss, SER_FMT_VER_HIGHEST_WRITE,
-               schemdata, nodecount, 2, 2, true);
+               schemdata, size.X * size.Y * size.Z, 2, 2, true);
 
        return true;
 }
 
 
-bool Schematic::serializeToLua(std::ostream *os, bool use_comments)
+bool Schematic::serializeToLua(std::ostream *os,
+       const std::vector<std::string> &names, bool use_comments, u32 indent_spaces)
 {
        std::ostream &ss = *os;
 
+       std::string indent("\t");
+       if (indent_spaces > 0)
+               indent.assign(indent_spaces, ' ');
+
        //// Write header
        {
                ss << "schematic = {" << std::endl;
-               ss << "\tsize = "
+               ss << indent << "size = "
                        << "{x=" << size.X
                        << ", y=" << size.Y
                        << ", z=" << size.Z
@@ -322,41 +378,51 @@ bool Schematic::serializeToLua(std::ostream *os, bool use_comments)
 
        //// Write y-slice probabilities
        {
-               ss << "\tyslice_prob = {" << std::endl;
+               ss << indent << "yslice_prob = {" << std::endl;
 
                for (u16 y = 0; y != size.Y; y++) {
-                       ss << "\t\t{"
+                       u8 probability = slice_probs[y] & MTSCHEM_PROB_MASK;
+
+                       ss << indent << indent << "{"
                                << "ypos=" << y
-                               << ", prob=" << (u16)slice_probs[y]
+                               << ", prob=" << (u16)probability * 2
                                << "}," << std::endl;
                }
 
-               ss << "\t}," << std::endl;
+               ss << indent << "}," << std::endl;
        }
 
        //// Write node data
        {
-               ss << "\tdata = {" << std::endl;
+               ss << indent << "data = {" << std::endl;
 
                u32 i = 0;
                for (u16 z = 0; z != size.Z; z++)
                for (u16 y = 0; y != size.Y; y++) {
                        if (use_comments) {
                                ss << std::endl
-                                       << "\t\t-- z=" << z
+                                       << indent << indent
+                                       << "-- z=" << z
                                        << ", y=" << y << std::endl;
                        }
 
                        for (u16 x = 0; x != size.X; x++, i++) {
-                               ss << "\t\t{"
-                                       << "name=\"" << getNodeName(schemdata[i].getContent())
-                                       << "\", param1=" << (u16)schemdata[i].param1
-                                       << ", param2=" << (u16)schemdata[i].param2
-                                       << "}," << std::endl;
+                               u8 probability   = schemdata[i].param1 & MTSCHEM_PROB_MASK;
+                               bool force_place = schemdata[i].param1 & MTSCHEM_FORCE_PLACE;
+
+                               ss << indent << indent << "{"
+                                       << "name=\"" << names[schemdata[i].getContent()]
+                                       << "\", prob=" << (u16)probability * 2
+                                       << ", param2=" << (u16)schemdata[i].param2;
+
+                               if (force_place)
+                                       ss << ", force_place=true";
+
+                               ss << "}," << std::endl;
                        }
                }
 
-               ss << "\t}," << std::endl;
+               ss << indent << "}," << std::endl;
        }
 
        ss << "}" << std::endl;
@@ -366,12 +432,11 @@ bool Schematic::serializeToLua(std::ostream *os, bool use_comments)
 
 
 bool Schematic::loadSchematicFromFile(const std::string &filename,
-       INodeDefManager *ndef, StringMap *replace_names,
-       NodeResolveMethod resolve_method)
+       INodeDefManager *ndef, StringMap *replace_names)
 {
        std::ifstream is(filename.c_str(), std::ios_base::binary);
        if (!is.good()) {
-               errorstream << "Schematic::loadSchematicFile: unable to open file '"
+               errorstream << __FUNCTION__ << ": unable to open file '"
                        << filename << "'" << std::endl;
                return false;
        }
@@ -380,27 +445,60 @@ bool Schematic::loadSchematicFromFile(const std::string &filename,
        if (!deserializeFromMts(&is, &m_nodenames))
                return false;
 
+       m_nnlistsizes.push_back(m_nodenames.size() - origsize);
+
+       name = filename;
+
        if (replace_names) {
-               for (size_t i = origsize; i != m_nodenames.size(); i++) {
-                       std::string &name = m_nodenames[i];
-                       StringMap::iterator it = replace_names->find(name);
+               for (size_t i = origsize; i < m_nodenames.size(); i++) {
+                       std::string &node_name = m_nodenames[i];
+                       StringMap::iterator it = replace_names->find(node_name);
                        if (it != replace_names->end())
-                               name = it->second;
+                               node_name = it->second;
                }
        }
 
-       m_nnlistsizes.push_back(m_nodenames.size() - origsize);
-
-       ndef->pendNodeResolve(this, resolve_method);
+       if (ndef)
+               ndef->pendNodeResolve(this);
 
        return true;
 }
 
 
-bool Schematic::saveSchematicToFile(const std::string &filename)
+bool Schematic::saveSchematicToFile(const std::string &filename,
+       INodeDefManager *ndef)
 {
+       MapNode *orig_schemdata = schemdata;
+       std::vector<std::string> ndef_nodenames;
+       std::vector<std::string> *names;
+
+       if (m_resolve_done && ndef == NULL)
+               ndef = m_ndef;
+
+       if (ndef) {
+               names = &ndef_nodenames;
+
+               u32 volume = size.X * size.Y * size.Z;
+               schemdata = new MapNode[volume];
+               for (u32 i = 0; i != volume; i++)
+                       schemdata[i] = orig_schemdata[i];
+
+               generate_nodelist_and_update_ids(schemdata, volume, names, ndef);
+       } else { // otherwise, use the names we have on hand in the list
+               names = &m_nodenames;
+       }
+
        std::ostringstream os(std::ios_base::binary);
-       serializeToMts(&os);
+       bool status = serializeToMts(&os, *names);
+
+       if (ndef) {
+               delete []schemdata;
+               schemdata = orig_schemdata;
+       }
+
+       if (!status)
+               return false;
+
        return fs::safeWriteToFile(filename, os.str());
 }
 
@@ -460,22 +558,22 @@ void Schematic::applyProbabilities(v3s16 p0,
 }
 
 
-void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
-       std::vector<content_t> *usednodes)
+void generate_nodelist_and_update_ids(MapNode *nodes, size_t nodecount,
+       std::vector<std::string> *usednodes, INodeDefManager *ndef)
 {
-       std::map<content_t, content_t> nodeidmap;
+       std::unordered_map<content_t, content_t> nodeidmap;
        content_t numids = 0;
 
-       for (u32 i = 0; i != nodecount; i++) {
+       for (size_t i = 0; i != nodecount; i++) {
                content_t id;
                content_t c = nodes[i].getContent();
 
-               std::map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
+               std::unordered_map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
                if (it == nodeidmap.end()) {
                        id = numids;
                        numids++;
 
-                       usednodes->push_back(c);
+                       usednodes->push_back(ndef->get(c).name);
                        nodeidmap.insert(std::make_pair(c, id));
                } else {
                        id = it->second;