Fix map deserialization and remove old serialization code
[oweals/minetest.git] / src / mapnode.cpp
index 484fcbe0af3a8fddd1aac23d2cbcc18a0fef8a0e..c616e011755a2adaa4b26d603cbedae38f76d70d 100644 (file)
@@ -3,259 +3,226 @@ Minetest-c55
 Copyright (C) 2010 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 General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+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 "common_irrlicht.h"
+#include "irrlichttypes_extrabloated.h"
 #include "mapnode.h"
-#ifndef SERVER
-#include "tile.h"
-#endif
 #include "porting.h"
+#include "main.h" // For g_settings
+#include "nodedef.h"
+#include "content_mapnode.h" // For mapnode_translate_*_internal
+#include "serialization.h" // For ser_ver_supported
+#include "util/serialize.h"
 #include <string>
-#include "mineral.h"
-// For g_settings
-#include "main.h"
-#include "content_mapnode.h"
-#include "nodemetadata.h"
+#include <sstream>
 
-ContentFeatures::~ContentFeatures()
+/*
+       MapNode
+*/
+
+// Create directly from a nodename
+// If name is unknown, sets CONTENT_IGNORE
+MapNode::MapNode(INodeDefManager *ndef, const std::string &name,
+               u8 a_param1, u8 a_param2)
 {
-       delete initial_metadata;
-#ifndef SERVER
-       delete special_material;
-       delete special_atlas;
-#endif
+       content_t id = CONTENT_IGNORE;
+       ndef->getId(name, id);
+       param0 = id;
+       param1 = a_param1;
+       param2 = a_param2;
 }
 
-#ifndef SERVER
-void ContentFeatures::setTexture(u16 i, std::string name, u8 alpha)
+void MapNode::setLight(enum LightBank bank, u8 a_light, INodeDefManager *nodemgr)
 {
-       used_texturenames[name] = true;
-       
-       if(g_texturesource)
+       // If node doesn't contain light data, ignore this
+       if(nodemgr->get(*this).param_type != CPT_LIGHT)
+               return;
+       if(bank == LIGHTBANK_DAY)
        {
-               tiles[i].texture = g_texturesource->getTexture(name);
+               param1 &= 0xf0;
+               param1 |= a_light & 0x0f;
        }
-       
-       if(alpha != 255)
+       else if(bank == LIGHTBANK_NIGHT)
        {
-               tiles[i].alpha = alpha;
-               tiles[i].material_type = MATERIAL_ALPHA_VERTEX;
+               param1 &= 0x0f;
+               param1 |= (a_light & 0x0f)<<4;
        }
-
-       if(inventory_texture == NULL)
-               setInventoryTexture(name);
+       else
+               assert(0);
 }
 
-void ContentFeatures::setInventoryTexture(std::string imgname)
+u8 MapNode::getLight(enum LightBank bank, INodeDefManager *nodemgr) const
 {
-       if(g_texturesource == NULL)
-               return;
-       
-       imgname += "^[forcesingle";
-       
-       inventory_texture = g_texturesource->getTextureRaw(imgname);
+       // Select the brightest of [light source, propagated light]
+       const ContentFeatures &f = nodemgr->get(*this);
+       u8 light = 0;
+       if(f.param_type == CPT_LIGHT)
+       {
+               if(bank == LIGHTBANK_DAY)
+                       light = param1 & 0x0f;
+               else if(bank == LIGHTBANK_NIGHT)
+                       light = (param1>>4)&0x0f;
+               else
+                       assert(0);
+       }
+       if(f.light_source > light)
+               light = f.light_source;
+       return light;
 }
 
-void ContentFeatures::setInventoryTextureCube(std::string top,
-               std::string left, std::string right)
+bool MapNode::getLightBanks(u8 &lightday, u8 &lightnight, INodeDefManager *nodemgr) const
 {
-       if(g_texturesource == NULL)
-               return;
-       
-       str_replace_char(top, '^', '&');
-       str_replace_char(left, '^', '&');
-       str_replace_char(right, '^', '&');
-
-       std::string imgname_full;
-       imgname_full += "[inventorycube{";
-       imgname_full += top;
-       imgname_full += "{";
-       imgname_full += left;
-       imgname_full += "{";
-       imgname_full += right;
-       inventory_texture = g_texturesource->getTextureRaw(imgname_full);
+       // Select the brightest of [light source, propagated light]
+       const ContentFeatures &f = nodemgr->get(*this);
+       if(f.param_type == CPT_LIGHT)
+       {
+               lightday = param1 & 0x0f;
+               lightnight = (param1>>4)&0x0f;
+       }
+       else
+       {
+               lightday = 0;
+               lightnight = 0;
+       }
+       if(f.light_source > lightday)
+               lightday = f.light_source;
+       if(f.light_source > lightnight)
+               lightnight = f.light_source;
+       return f.param_type == CPT_LIGHT || f.light_source != 0;
 }
-#endif
-
-struct ContentFeatures g_content_features[MAX_CONTENT+1];
 
-ContentFeatures & content_features(content_t i)
+u8 MapNode::getFaceDir(INodeDefManager *nodemgr) const
 {
-       return g_content_features[i];
+       const ContentFeatures &f = nodemgr->get(*this);
+       if(f.param_type_2 == CPT2_FACEDIR)
+               return getParam2() & 0x03;
+       return 0;
 }
-ContentFeatures & content_features(MapNode &n)
+
+u8 MapNode::getWallMounted(INodeDefManager *nodemgr) const
 {
-       return content_features(n.getContent());
+       const ContentFeatures &f = nodemgr->get(*this);
+       if(f.param_type_2 == CPT2_WALLMOUNTED)
+               return getParam2() & 0x07;
+       return 0;
 }
 
-/*
-       See mapnode.h for description.
-*/
-void init_mapnode()
+v3s16 MapNode::getWallMountedDir(INodeDefManager *nodemgr) const
 {
-       if(g_texturesource == NULL)
+       switch(getWallMounted(nodemgr))
        {
-               dstream<<"INFO: Initial run of init_mapnode with "
-                               "g_texturesource=NULL. If this segfaults, "
-                               "there is a bug with something not checking for "
-                               "the NULL value."<<std::endl;
+       case 0: default: return v3s16(0,1,0);
+       case 1: return v3s16(0,-1,0);
+       case 2: return v3s16(1,0,0);
+       case 3: return v3s16(-1,0,0);
+       case 4: return v3s16(0,0,1);
+       case 5: return v3s16(0,0,-1);
        }
-       else
+}
+
+static std::vector<aabb3f> transformNodeBox(const MapNode &n,
+               const NodeBox &nodebox, INodeDefManager *nodemgr)
+{
+       std::vector<aabb3f> boxes;
+       if(nodebox.type == NODEBOX_FIXED)
        {
-               dstream<<"INFO: Full run of init_mapnode with "
-                               "g_texturesource!=NULL"<<std::endl;
+               const std::vector<aabb3f> &fixed = nodebox.fixed;
+               int facedir = n.getFaceDir(nodemgr);
+               for(std::vector<aabb3f>::const_iterator
+                               i = fixed.begin();
+                               i != fixed.end(); i++)
+               {
+                       aabb3f box = *i;
+                       if(facedir == 1)
+                       {
+                               box.MinEdge.rotateXZBy(-90);
+                               box.MaxEdge.rotateXZBy(-90);
+                               box.repair();
+                       }
+                       else if(facedir == 2)
+                       {
+                               box.MinEdge.rotateXZBy(180);
+                               box.MaxEdge.rotateXZBy(180);
+                               box.repair();
+                       }
+                       else if(facedir == 3)
+                       {
+                               box.MinEdge.rotateXZBy(90);
+                               box.MaxEdge.rotateXZBy(90);
+                               box.repair();
+                       }
+                       boxes.push_back(box);
+               }
        }
-
-       /*// Read some settings
-       bool new_style_water = g_settings.getBool("new_style_water");
-       bool new_style_leaves = g_settings.getBool("new_style_leaves");*/
-
-       /*
-               Initialize content feature table
-       */
-
-#ifndef SERVER
-       /*
-               Set initial material type to same in all tiles, so that the
-               same material can be used in more stuff.
-               This is set according to the leaves because they are the only
-               differing material to which all materials can be changed to
-               get this optimization.
-       */
-       u8 initial_material_type = MATERIAL_ALPHA_SIMPLE;
-       /*if(new_style_leaves)
-               initial_material_type = MATERIAL_ALPHA_SIMPLE;
-       else
-               initial_material_type = MATERIAL_ALPHA_NONE;*/
-       for(u16 i=0; i<MAX_CONTENT+1; i++)
+       else if(nodebox.type == NODEBOX_WALLMOUNTED)
        {
-               ContentFeatures *f = &g_content_features[i];
-               // Re-initialize
-               f->reset();
+               v3s16 dir = n.getWallMountedDir(nodemgr);
 
-               for(u16 j=0; j<6; j++)
-                       f->tiles[j].material_type = initial_material_type;
+               // top
+               if(dir == v3s16(0,1,0))
+               {
+                       boxes.push_back(nodebox.wall_top);
+               }
+               // bottom
+               else if(dir == v3s16(0,-1,0))
+               {
+                       boxes.push_back(nodebox.wall_bottom);
+               }
+               // side
+               else
+               {
+                       v3f vertices[2] =
+                       {
+                               nodebox.wall_side.MinEdge,
+                               nodebox.wall_side.MaxEdge
+                       };
+
+                       for(s32 i=0; i<2; i++)
+                       {
+                               if(dir == v3s16(-1,0,0))
+                                       vertices[i].rotateXZBy(0);
+                               if(dir == v3s16(1,0,0))
+                                       vertices[i].rotateXZBy(180);
+                               if(dir == v3s16(0,0,-1))
+                                       vertices[i].rotateXZBy(90);
+                               if(dir == v3s16(0,0,1))
+                                       vertices[i].rotateXZBy(-90);
+                       }
+
+                       aabb3f box = aabb3f(vertices[0]);
+                       box.addInternalPoint(vertices[1]);
+                       boxes.push_back(box);
+               }
        }
-#endif
-
-       /*
-               Initially set every block to be shown as an unknown block.
-               Don't touch CONTENT_IGNORE or CONTENT_AIR.
-       */
-       for(u16 i=0; i<MAX_CONTENT+1; i++)
+       else // NODEBOX_REGULAR
        {
-               if(i == CONTENT_IGNORE || i == CONTENT_AIR)
-                       continue;
-               ContentFeatures *f = &g_content_features[i];
-               f->setAllTextures("unknown_block.png");
-               f->dug_item = std::string("MaterialItem2 ")+itos(i)+" 1";
+               boxes.push_back(aabb3f(-BS/2,-BS/2,-BS/2,BS/2,BS/2,BS/2));
        }
-
-       /*
-               Initialize mapnode content
-       */
-       content_mapnode_init();
-       
-}
-
-v3s16 facedir_rotate(u8 facedir, v3s16 dir)
-{
-       /*
-               Face 2 (normally Z-) direction:
-               facedir=0: Z-
-               facedir=1: X-
-               facedir=2: Z+
-               facedir=3: X+
-       */
-       v3s16 newdir;
-       if(facedir==0) // Same
-               newdir = v3s16(dir.X, dir.Y, dir.Z);
-       else if(facedir == 1) // Face is taken from rotXZccv(-90)
-               newdir = v3s16(-dir.Z, dir.Y, dir.X);
-       else if(facedir == 2) // Face is taken from rotXZccv(180)
-               newdir = v3s16(-dir.X, dir.Y, -dir.Z);
-       else if(facedir == 3) // Face is taken from rotXZccv(90)
-               newdir = v3s16(dir.Z, dir.Y, -dir.X);
-       else
-               newdir = dir;
-       return newdir;
+       return boxes;
 }
 
-#ifndef SERVER
-TileSpec MapNode::getTile(v3s16 dir)
+std::vector<aabb3f> MapNode::getNodeBoxes(INodeDefManager *nodemgr) const
 {
-       if(content_features(*this).param_type == CPT_FACEDIR_SIMPLE)
-               dir = facedir_rotate(param1, dir);
-       
-       TileSpec spec;
-       
-       s32 dir_i = -1;
-       
-       if(dir == v3s16(0,0,0))
-               dir_i = -1;
-       else if(dir == v3s16(0,1,0))
-               dir_i = 0;
-       else if(dir == v3s16(0,-1,0))
-               dir_i = 1;
-       else if(dir == v3s16(1,0,0))
-               dir_i = 2;
-       else if(dir == v3s16(-1,0,0))
-               dir_i = 3;
-       else if(dir == v3s16(0,0,1))
-               dir_i = 4;
-       else if(dir == v3s16(0,0,-1))
-               dir_i = 5;
-       
-       if(dir_i == -1)
-               // Non-directional
-               spec = content_features(*this).tiles[0];
-       else 
-               spec = content_features(*this).tiles[dir_i];
-       
-       /*
-               If it contains some mineral, change texture id
-       */
-       if(content_features(*this).param_type == CPT_MINERAL && g_texturesource)
-       {
-               u8 mineral = getMineral();
-               std::string mineral_texture_name = mineral_block_texture(mineral);
-               if(mineral_texture_name != "")
-               {
-                       u32 orig_id = spec.texture.id;
-                       std::string texture_name = g_texturesource->getTextureName(orig_id);
-                       //texture_name += "^blit:";
-                       texture_name += "^";
-                       texture_name += mineral_texture_name;
-                       u32 new_id = g_texturesource->getTextureId(texture_name);
-                       spec.texture = g_texturesource->getTexture(new_id);
-               }
-       }
-
-       return spec;
+       const ContentFeatures &f = nodemgr->get(*this);
+       return transformNodeBox(*this, f.node_box, nodemgr);
 }
-#endif
 
-u8 MapNode::getMineral()
+std::vector<aabb3f> MapNode::getSelectionBoxes(INodeDefManager *nodemgr) const
 {
-       if(content_features(*this).param_type == CPT_MINERAL)
-       {
-               return param1 & 0x0f;
-       }
-
-       return MINERAL_NONE;
+       const ContentFeatures &f = nodemgr->get(*this);
+       return transformNodeBox(*this, f.selection_box, nodemgr);
 }
 
 u32 MapNode::serializedLength(u8 version)
@@ -274,56 +241,167 @@ void MapNode::serialize(u8 *dest, u8 version)
 {
        if(!ser_ver_supported(version))
                throw VersionMismatchException("ERROR: MapNode format not supported");
+       
+       // Can't do this anymore; we have 16-bit dynamically allocated node IDs
+       // in memory; conversion just won't work in this direction.
+       if(version < 24)
+               throw SerializationError("MapNode::serialize: serialization to "
+                               "version < 24 not possible");
                
-       // Translate to wanted version
-       MapNode n_foreign = mapnode_translate_from_internal(*this, version);
-
-       u8 actual_param0 = n_foreign.param0;
-
-       // Convert special values from new version to old
-       if(version <= 18)
+       writeU16(dest+0, param0);
+       writeU8(dest+2, param1);
+       writeU8(dest+3, param2);
+}
+void MapNode::deSerialize(u8 *source, u8 version)
+{
+       if(!ser_ver_supported(version))
+               throw VersionMismatchException("ERROR: MapNode format not supported");
+               
+       if(version <= 21)
        {
-               // In these versions, CONTENT_IGNORE and CONTENT_AIR
-               // are 255 and 254
-               if(actual_param0 == CONTENT_IGNORE)
-                       actual_param0 = 255;
-               else if(actual_param0 == CONTENT_AIR)
-                       actual_param0 = 254;
+               deSerialize_pre22(source, version);
+               return;
        }
 
-       if(version == 0)
-       {
-               dest[0] = actual_param0;
+       if(version >= 24){
+               param0 = readU16(source+0);
+               param1 = readU8(source+2);
+               param2 = readU8(source+3);
        }
-       else if(version <= 9)
+       else{
+               param0 = readU8(source+0);
+               param1 = readU8(source+1);
+               param2 = readU8(source+2);
+               if(param0 > 0x7F){
+                       param0 |= ((param2&0xF0)<<4);
+                       param2 &= 0x0F;
+               }
+       }
+}
+void MapNode::serializeBulk(std::ostream &os, int version,
+               const MapNode *nodes, u32 nodecount,
+               u8 content_width, u8 params_width, bool compressed)
+{
+       if(!ser_ver_supported(version))
+               throw VersionMismatchException("ERROR: MapNode format not supported");
+
+       assert(content_width == 2);
+       assert(params_width == 2);
+
+       // Can't do this anymore; we have 16-bit dynamically allocated node IDs
+       // in memory; conversion just won't work in this direction.
+       if(version < 24)
+               throw SerializationError("MapNode::serializeBulk: serialization to "
+                               "version < 24 not possible");
+
+       SharedBuffer<u8> databuf(nodecount * (content_width + params_width));
+
+       // Serialize content
+       for(u32 i=0; i<nodecount; i++)
+               writeU16(&databuf[i*2], nodes[i].param0);
+
+       // Serialize param1
+       u32 start1 = content_width * nodecount;
+       for(u32 i=0; i<nodecount; i++)
+               writeU8(&databuf[start1 + i], nodes[i].param1);
+
+       // Serialize param2
+       u32 start2 = (content_width + 1) * nodecount;
+       for(u32 i=0; i<nodecount; i++)
+               writeU8(&databuf[start2 + i], nodes[i].param2);
+
+       /*
+               Compress data to output stream
+       */
+
+       if(compressed)
        {
-               dest[0] = actual_param0;
-               dest[1] = n_foreign.param1;
+               compressZlib(databuf, os);
        }
        else
        {
-               dest[0] = actual_param0;
-               dest[1] = n_foreign.param1;
-               dest[2] = n_foreign.param2;
+               os.write((const char*) &databuf[0], databuf.getSize());
        }
 }
-void MapNode::deSerialize(u8 *source, u8 version)
+
+// Deserialize bulk node data
+void MapNode::deSerializeBulk(std::istream &is, int version,
+               MapNode *nodes, u32 nodecount,
+               u8 content_width, u8 params_width, bool compressed)
 {
        if(!ser_ver_supported(version))
                throw VersionMismatchException("ERROR: MapNode format not supported");
-               
-       if(version == 0)
+
+       assert(version >= 22);
+       assert(content_width == 1 || content_width == 2);
+       assert(params_width == 2);
+
+       // Uncompress or read data
+       u32 len = nodecount * (content_width + params_width);
+       SharedBuffer<u8> databuf(len);
+       if(compressed)
        {
-               param0 = source[0];
+               std::ostringstream os(std::ios_base::binary);
+               decompressZlib(is, os);
+               std::string s = os.str();
+               if(s.size() != len)
+                       throw SerializationError("deSerializeBulkNodes: "
+                                       "decompress resulted in invalid size");
+               memcpy(&databuf[0], s.c_str(), len);
+       }
+       else
+       {
+               is.read((char*) &databuf[0], len);
+               if(is.eof() || is.fail())
+                       throw SerializationError("deSerializeBulkNodes: "
+                                       "failed to read bulk node data");
        }
-       else if(version == 1)
+
+       // Deserialize content
+       if(content_width == 1)
+       {
+               for(u32 i=0; i<nodecount; i++)
+                       nodes[i].param0 = readU8(&databuf[i]);
+       }
+       else if(content_width == 2)
+       {
+               for(u32 i=0; i<nodecount; i++)
+                       nodes[i].param0 = readU16(&databuf[i*2]);
+       }
+
+       // Deserialize param1
+       u32 start1 = content_width * nodecount;
+       for(u32 i=0; i<nodecount; i++)
+               nodes[i].param1 = readU8(&databuf[start1 + i]);
+
+       // Deserialize param2
+       u32 start2 = (content_width + 1) * nodecount;
+       if(content_width == 1)
+       {
+               for(u32 i=0; i<nodecount; i++) {
+                       nodes[i].param2 = readU8(&databuf[start2 + i]);
+                       if(nodes[i].param0 > 0x7F){
+                               nodes[i].param0 <<= 4;
+                               nodes[i].param0 |= (nodes[i].param2&0xF0)>>4;
+                               nodes[i].param2 &= 0x0F;
+                       }
+               }
+       }
+       else if(content_width == 2)
+       {
+               for(u32 i=0; i<nodecount; i++)
+                       nodes[i].param2 = readU8(&databuf[start2 + i]);
+       }
+}
+
+/*
+       Legacy serialization
+*/
+void MapNode::deSerialize_pre22(u8 *source, u8 version)
+{
+       if(version <= 1)
        {
                param0 = source[0];
-               // This version doesn't support saved lighting
-               if(light_propagates() || light_source() > 0)
-                       param1 = 0;
-               else
-                       param1 = source[1];
        }
        else if(version <= 9)
        {
@@ -335,21 +413,19 @@ void MapNode::deSerialize(u8 *source, u8 version)
                param0 = source[0];
                param1 = source[1];
                param2 = source[2];
+               if(param0 > 0x7f){
+                       param0 <<= 4;
+                       param0 |= (param2&0xf0)>>4;
+                       param2 &= 0x0f;
+               }
        }
        
        // Convert special values from old version to new
-       if(version <= 18)
+       if(version <= 19)
        {
                // In these versions, CONTENT_IGNORE and CONTENT_AIR
                // are 255 and 254
-               if(param0 == 255)
-                       param0 = CONTENT_IGNORE;
-               else if(param0 == 254)
-                       param0 = CONTENT_AIR;
-       }
-       // version 19 is fucked up with sometimes the old values and sometimes not
-       if(version == 19)
-       {
+               // Version 19 is fucked up with sometimes the old values and sometimes not
                if(param0 == 255)
                        param0 = CONTENT_IGNORE;
                else if(param0 == 254)
@@ -359,55 +435,3 @@ void MapNode::deSerialize(u8 *source, u8 version)
        // Translate to our known version
        *this = mapnode_translate_to_internal(*this, version);
 }
-
-/*
-       Gets lighting value at face of node
-       
-       Parameters must consist of air and !air.
-       Order doesn't matter.
-
-       If either of the nodes doesn't exist, light is 0.
-       
-       parameters:
-               daynight_ratio: 0...1000
-               n: getNodeParent(p)
-               n2: getNodeParent(p + face_dir)
-               face_dir: axis oriented unit vector from p to p2
-       
-       returns encoded light value.
-*/
-u8 getFaceLight(u32 daynight_ratio, MapNode n, MapNode n2,
-               v3s16 face_dir)
-{
-       try{
-               u8 light;
-               u8 l1 = n.getLightBlend(daynight_ratio);
-               u8 l2 = n2.getLightBlend(daynight_ratio);
-               if(l1 > l2)
-                       light = l1;
-               else
-                       light = l2;
-
-               // Make some nice difference to different sides
-
-               // This makes light come from a corner
-               /*if(face_dir.X == 1 || face_dir.Z == 1 || face_dir.Y == -1)
-                       light = diminish_light(diminish_light(light));
-               else if(face_dir.X == -1 || face_dir.Z == -1)
-                       light = diminish_light(light);*/
-               
-               // All neighboring faces have different shade (like in minecraft)
-               if(face_dir.X == 1 || face_dir.X == -1 || face_dir.Y == -1)
-                       light = diminish_light(diminish_light(light));
-               else if(face_dir.Z == 1 || face_dir.Z == -1)
-                       light = diminish_light(light);
-
-               return light;
-       }
-       catch(InvalidPositionException &e)
-       {
-               return 0;
-       }
-}
-
-