src/mg_schematic.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2014 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   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 #include <fstream>
  21 #include "mg_schematic.h"
  22 #include "mapgen.h"
  23 #include "map.h"
  24 #include "mapblock.h"
  25 #include "log.h"
  26 #include "util/numeric.h"
  27 #include "util/serialize.h"
  28 #include "serialization.h"
  29 #include "filesys.h"
  30
  31 ///////////////////////////////////////////////////////////////////////////////
  32
  33
  34 SchematicManager::SchematicManager(IGameDef *gamedef) :
  35         ObjDefManager(gamedef, OBJDEF_SCHEMATIC)
  36 {
  37 }
  38
  39
  40 ///////////////////////////////////////////////////////////////////////////////
  41
  42
  43 Schematic::Schematic()
  44 {
  45         schemdata   = NULL;
  46         slice_probs = NULL;
  47         flags       = 0;
  48         size        = v3s16(0, 0, 0);
  49 }
  50
  51
  52 Schematic::~Schematic()
  53 {
  54         delete []schemdata;
  55         delete []slice_probs;
  56 }
  57
  58
  59 void Schematic::resolveNodeNames(NodeResolveInfo *nri)
  60 {
  61         m_ndef->getIdsFromResolveInfo(nri, c_nodes);
  62 }
  63
  64
  65 void Schematic::updateContentIds()
  66 {
  67         if (flags & SCHEM_CIDS_UPDATED)
  68                 return;
  69
  70         flags |= SCHEM_CIDS_UPDATED;
  71
  72         size_t bufsize = size.X * size.Y * size.Z;
  73         for (size_t i = 0; i != bufsize; i++)
  74                 schemdata[i].setContent(c_nodes[schemdata[i].getContent()]);
  75 }
  76
  77
  78 void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
  79         bool force_placement, INodeDefManager *ndef)
  80 {
  81         int xstride = 1;
  82         int ystride = size.X;
  83         int zstride = size.X * size.Y;
  84
  85         updateContentIds();
  86
  87         s16 sx = size.X;
  88         s16 sy = size.Y;
  89         s16 sz = size.Z;
  90
  91         int i_start, i_step_x, i_step_z;
  92         switch (rot) {
  93                 case ROTATE_90:
  94                         i_start  = sx - 1;
  95                         i_step_x = zstride;
  96                         i_step_z = -xstride;
  97                         SWAP(s16, sx, sz);
  98                         break;
  99                 case ROTATE_180:
 100                         i_start  = zstride * (sz - 1) + sx - 1;
 101                         i_step_x = -xstride;
 102                         i_step_z = -zstride;
 103                         break;
 104                 case ROTATE_270:
 105                         i_start  = zstride * (sz - 1);
 106                         i_step_x = -zstride;
 107                         i_step_z = xstride;
 108                         SWAP(s16, sx, sz);
 109                         break;
 110                 default:
 111                         i_start  = 0;
 112                         i_step_x = xstride;
 113                         i_step_z = zstride;
 114         }
 115
 116         s16 y_map = p.Y;
 117         for (s16 y = 0; y != sy; y++) {
 118                 if (slice_probs[y] != MTSCHEM_PROB_ALWAYS &&
 119                         myrand_range(1, 255) > slice_probs[y])
 120                         continue;
 121
 122                 for (s16 z = 0; z != sz; z++) {
 123                         u32 i = z * i_step_z + y * ystride + i_start;
 124                         for (s16 x = 0; x != sx; x++, i += i_step_x) {
 125                                 u32 vi = vm->m_area.index(p.X + x, y_map, p.Z + z);
 126                                 if (!vm->m_area.contains(vi))
 127                                         continue;
 128
 129                                 if (schemdata[i].getContent() == CONTENT_IGNORE)
 130                                         continue;
 131
 132                                 if (schemdata[i].param1 == MTSCHEM_PROB_NEVER)
 133                                         continue;
 134
 135                                 if (!force_placement) {
 136                                         content_t c = vm->m_data[vi].getContent();
 137                                         if (c != CONTENT_AIR && c != CONTENT_IGNORE)
 138                                                 continue;
 139                                 }
 140
 141                                 if (schemdata[i].param1 != MTSCHEM_PROB_ALWAYS &&
 142                                         myrand_range(1, 255) > schemdata[i].param1)
 143                                         continue;
 144
 145                                 vm->m_data[vi] = schemdata[i];
 146                                 vm->m_data[vi].param1 = 0;
 147
 148                                 if (rot)
 149                                         vm->m_data[vi].rotateAlongYAxis(ndef, rot);
 150                         }
 151                 }
 152                 y_map++;
 153         }
 154 }
 155
 156
 157 void Schematic::placeStructure(Map *map, v3s16 p, u32 flags, Rotation rot,
 158         bool force_placement, INodeDefManager *ndef)
 159 {
 160         assert(schemdata != NULL); // Pre-condition
 161         MMVManip *vm = new MMVManip(map);
 162
 163         if (rot == ROTATE_RAND)
 164                 rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
 165
 166         v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
 167                                 v3s16(size.Z, size.Y, size.X) : size;
 168
 169         if (flags & DECO_PLACE_CENTER_X)
 170                 p.X -= (s.X + 1) / 2;
 171         if (flags & DECO_PLACE_CENTER_Y)
 172                 p.Y -= (s.Y + 1) / 2;
 173         if (flags & DECO_PLACE_CENTER_Z)
 174                 p.Z -= (s.Z + 1) / 2;
 175
 176         v3s16 bp1 = getNodeBlockPos(p);
 177         v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
 178         vm->initialEmerge(bp1, bp2);
 179
 180         blitToVManip(p, vm, rot, force_placement, ndef);
 181
 182         std::map<v3s16, MapBlock *> lighting_modified_blocks;
 183         std::map<v3s16, MapBlock *> modified_blocks;
 184         vm->blitBackAll(&modified_blocks);
 185
 186         // TODO: Optimize this by using Mapgen::calcLighting() instead
 187         lighting_modified_blocks.insert(modified_blocks.begin(), modified_blocks.end());
 188         map->updateLighting(lighting_modified_blocks, modified_blocks);
 189
 190         MapEditEvent event;
 191         event.type = MEET_OTHER;
 192         for (std::map<v3s16, MapBlock *>::iterator
 193                 it = modified_blocks.begin();
 194                 it != modified_blocks.end(); ++it)
 195                 event.modified_blocks.insert(it->first);
 196
 197         map->dispatchEvent(&event);
 198 }
 199
 200
 201 bool Schematic::loadSchematicFromFile(const char *filename, INodeDefManager *ndef,
 202         StringMap *replace_names)
 203 {
 204         content_t cignore = CONTENT_IGNORE;
 205         bool have_cignore = false;
 206
 207         std::ifstream is(filename, std::ios_base::binary);
 208         if (!is.good()) {
 209                 errorstream << "loadSchematicFile: unable to open file '"
 210                         << filename << "'" << std::endl;
 211                 return false;
 212         }
 213
 214         u32 signature = readU32(is);
 215         if (signature != MTSCHEM_FILE_SIGNATURE) {
 216                 errorstream << "loadSchematicFile: invalid schematic "
 217                         "file" << std::endl;
 218                 return false;
 219         }
 220
 221         u16 version = readU16(is);
 222         if (version > MTSCHEM_FILE_VER_HIGHEST_READ) {
 223                 errorstream << "loadSchematicFile: unsupported schematic "
 224                         "file version" << std::endl;
 225                 return false;
 226         }
 227
 228         size = readV3S16(is);
 229
 230         delete []slice_probs;
 231         slice_probs = new u8[size.Y];
 232         for (int y = 0; y != size.Y; y++)
 233                 slice_probs[y] = (version >= 3) ? readU8(is) : MTSCHEM_PROB_ALWAYS;
 234
 235         NodeResolveInfo *nri = new NodeResolveInfo(this);
 236
 237         u16 nidmapcount = readU16(is);
 238         for (int i = 0; i != nidmapcount; i++) {
 239                 std::string name = deSerializeString(is);
 240                 if (name == "ignore") {
 241                         name = "air";
 242                         cignore = i;
 243                         have_cignore = true;
 244                 }
 245
 246                 std::map<std::string, std::string>::iterator it;
 247                 it = replace_names->find(name);
 248                 if (it != replace_names->end())
 249                         name = it->second;
 250
 251                 nri->nodenames.push_back(name);
 252         }
 253
 254         nri->nodelistinfo.push_back(NodeListInfo(nidmapcount, CONTENT_AIR));
 255         ndef->pendNodeResolve(nri);
 256
 257         size_t nodecount = size.X * size.Y * size.Z;
 258
 259         delete []schemdata;
 260         schemdata = new MapNode[nodecount];
 261
 262         MapNode::deSerializeBulk(is, SER_FMT_VER_HIGHEST_READ, schemdata,
 263                 nodecount, 2, 2, true);
 264
 265         if (version == 1) { // fix up the probability values
 266                 for (size_t i = 0; i != nodecount; i++) {
 267                         if (schemdata[i].param1 == 0)
 268                                 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
 269                         if (have_cignore && schemdata[i].getContent() == cignore)
 270                                 schemdata[i].param1 = MTSCHEM_PROB_NEVER;
 271                 }
 272         }
 273
 274         return true;
 275 }
 276
 277
 278 /*
 279         Minetest Schematic File Format
 280
 281         All values are stored in big-endian byte order.
 282         [u32] signature: 'MTSM'
 283         [u16] version: 3
 284         [u16] size X
 285         [u16] size Y
 286         [u16] size Z
 287         For each Y:
 288                 [u8] slice probability value
 289         [Name-ID table] Name ID Mapping Table
 290                 [u16] name-id count
 291                 For each name-id mapping:
 292                         [u16] name length
 293                         [u8[]] name
 294         ZLib deflated {
 295         For each node in schematic:  (for z, y, x)
 296                 [u16] content
 297         For each node in schematic:
 298                 [u8] probability of occurance (param1)
 299         For each node in schematic:
 300                 [u8] param2
 301         }
 302
 303         Version changes:
 304         1 - Initial version
 305         2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
 306         3 - Added y-slice probabilities; this allows for variable height structures
 307 */
 308 void Schematic::saveSchematicToFile(const char *filename, INodeDefManager *ndef)
 309 {
 310         std::ostringstream ss(std::ios_base::binary);
 311
 312         writeU32(ss, MTSCHEM_FILE_SIGNATURE);         // signature
 313         writeU16(ss, MTSCHEM_FILE_VER_HIGHEST_WRITE); // version
 314         writeV3S16(ss, size);                         // schematic size
 315
 316         for (int y = 0; y != size.Y; y++)             // Y slice probabilities
 317                 writeU8(ss, slice_probs[y]);
 318
 319         std::vector<content_t> usednodes;
 320         int nodecount = size.X * size.Y * size.Z;
 321         build_nnlist_and_update_ids(schemdata, nodecount, &usednodes);
 322
 323         u16 numids = usednodes.size();
 324         writeU16(ss, numids); // name count
 325         for (int i = 0; i != numids; i++)
 326                 ss << serializeString(ndef->get(usednodes[i]).name); // node names
 327
 328         // compressed bulk node data
 329         MapNode::serializeBulk(ss, SER_FMT_VER_HIGHEST_WRITE, schemdata,
 330                                 nodecount, 2, 2, true);
 331
 332         fs::safeWriteToFile(filename, ss.str());
 333 }
 334
 335
 336 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
 337         std::vector<content_t> *usednodes)
 338 {
 339         std::map<content_t, content_t> nodeidmap;
 340         content_t numids = 0;
 341
 342         for (u32 i = 0; i != nodecount; i++) {
 343                 content_t id;
 344                 content_t c = nodes[i].getContent();
 345
 346                 std::map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
 347                 if (it == nodeidmap.end()) {
 348                         id = numids;
 349                         numids++;
 350
 351                         usednodes->push_back(c);
 352                         nodeidmap.insert(std::make_pair(c, id));
 353                 } else {
 354                         id = it->second;
 355                 }
 356                 nodes[i].setContent(id);
 357         }
 358 }
 359
 360
 361 bool Schematic::getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2)
 362 {
 363         MMVManip *vm = new MMVManip(map);
 364
 365         v3s16 bp1 = getNodeBlockPos(p1);
 366         v3s16 bp2 = getNodeBlockPos(p2);
 367         vm->initialEmerge(bp1, bp2);
 368
 369         size = p2 - p1 + 1;
 370
 371         slice_probs = new u8[size.Y];
 372         for (s16 y = 0; y != size.Y; y++)
 373                 slice_probs[y] = MTSCHEM_PROB_ALWAYS;
 374
 375         schemdata = new MapNode[size.X * size.Y * size.Z];
 376
 377         u32 i = 0;
 378         for (s16 z = p1.Z; z <= p2.Z; z++)
 379         for (s16 y = p1.Y; y <= p2.Y; y++) {
 380                 u32 vi = vm->m_area.index(p1.X, y, z);
 381                 for (s16 x = p1.X; x <= p2.X; x++, i++, vi++) {
 382                         schemdata[i] = vm->m_data[vi];
 383                         schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
 384                 }
 385         }
 386
 387         delete vm;
 388         return true;
 389 }
 390
 391
 392 void Schematic::applyProbabilities(v3s16 p0,
 393         std::vector<std::pair<v3s16, u8> > *plist,
 394         std::vector<std::pair<s16, u8> > *splist)
 395 {
 396         for (size_t i = 0; i != plist->size(); i++) {
 397                 v3s16 p = (*plist)[i].first - p0;
 398                 int index = p.Z * (size.Y * size.X) + p.Y * size.X + p.X;
 399                 if (index < size.Z * size.Y * size.X) {
 400                         u8 prob = (*plist)[i].second;
 401                         schemdata[index].param1 = prob;
 402
 403                         // trim unnecessary node names from schematic
 404                         if (prob == MTSCHEM_PROB_NEVER)
 405                                 schemdata[index].setContent(CONTENT_AIR);
 406                 }
 407         }
 408
 409         for (size_t i = 0; i != splist->size(); i++) {
 410                 s16 y = (*splist)[i].first - p0.Y;
 411                 slice_probs[y] = (*splist)[i].second;
 412         }
 413 }