src/map.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 #ifndef MAP_HEADER
  21 #define MAP_HEADER
  22
  23 #include <jmutex.h>
  24 #include <jthread.h>
  25 #include <iostream>
  26 #include <malloc.h>
  27
  28 #ifdef _WIN32
  29         #include <windows.h>
  30         #define sleep_s(x) Sleep((x*1000))
  31 #else
  32         #include <unistd.h>
  33         #define sleep_s(x) sleep(x)
  34 #endif
  35
  36 #include "common_irrlicht.h"
  37 #include "heightmap.h"
  38 #include "loadstatus.h"
  39 #include "mapnode.h"
  40 #include "mapblock.h"
  41 #include "mapsector.h"
  42 #include "constants.h"
  43 #include "voxel.h"
  44
  45 class Map;
  46
  47 /*
  48         A cache for short-term fast access to map data
  49
  50         NOTE: This doesn't really make anything more efficient
  51         NOTE: Use VoxelManipulator, if possible
  52         TODO: Get rid of this?
  53         NOTE: CONFIRMED: THIS CACHE DOESN'T MAKE ANYTHING ANY FASTER
  54 */
  55 class MapBlockPointerCache : public NodeContainer
  56 {
  57 public:
  58         MapBlockPointerCache(Map *map);
  59         ~MapBlockPointerCache();
  60
  61         virtual u16 nodeContainerId() const
  62         {
  63                 return NODECONTAINER_ID_MAPBLOCKCACHE;
  64         }
  65
  66         MapBlock * getBlockNoCreate(v3s16 p);
  67
  68         // virtual from NodeContainer
  69         bool isValidPosition(v3s16 p)
  70         {
  71                 v3s16 blockpos = getNodeBlockPos(p);
  72                 MapBlock *blockref;
  73                 try{
  74                         blockref = getBlockNoCreate(blockpos);
  75                 }
  76                 catch(InvalidPositionException &e)
  77                 {
  78                         return false;
  79                 }
  80                 return true;
  81         }
  82
  83         // virtual from NodeContainer
  84         MapNode getNode(v3s16 p)
  85         {
  86                 v3s16 blockpos = getNodeBlockPos(p);
  87                 MapBlock * blockref = getBlockNoCreate(blockpos);
  88                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
  89
  90                 return blockref->getNodeNoCheck(relpos);
  91         }
  92
  93         // virtual from NodeContainer
  94         void setNode(v3s16 p, MapNode & n)
  95         {
  96                 v3s16 blockpos = getNodeBlockPos(p);
  97                 MapBlock * block = getBlockNoCreate(blockpos);
  98                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
  99                 block->setNodeNoCheck(relpos, n);
 100                 m_modified_blocks[blockpos] = block;
 101         }
 102
 103         core::map<v3s16, MapBlock*> m_modified_blocks;
 104
 105 private:
 106         Map *m_map;
 107         core::map<v3s16, MapBlock*> m_blocks;
 108
 109         u32 m_from_cache_count;
 110         u32 m_from_map_count;
 111 };
 112
 113 class CacheLock
 114 {
 115 public:
 116         CacheLock()
 117         {
 118                 m_count = 0;
 119                 m_count_mutex.Init();
 120                 m_cache_mutex.Init();
 121                 m_waitcache_mutex.Init();
 122         }
 123
 124         void cacheCreated()
 125         {
 126                 //dstream<<"cacheCreated() begin"<<std::endl;
 127                 JMutexAutoLock waitcachelock(m_waitcache_mutex);
 128                 JMutexAutoLock countlock(m_count_mutex);
 129
 130                 // If this is the first cache, grab the cache lock
 131                 if(m_count == 0)
 132                         m_cache_mutex.Lock();
 133
 134                 m_count++;
 135
 136                 //dstream<<"cacheCreated() end"<<std::endl;
 137         }
 138
 139         void cacheRemoved()
 140         {
 141                 //dstream<<"cacheRemoved() begin"<<std::endl;
 142                 JMutexAutoLock countlock(m_count_mutex);
 143
 144                 assert(m_count > 0);
 145
 146                 m_count--;
 147
 148                 // If this is the last one, release the cache lock
 149                 if(m_count == 0)
 150                         m_cache_mutex.Unlock();
 151
 152                 //dstream<<"cacheRemoved() end"<<std::endl;
 153         }
 154
 155         /*
 156                 This lock should be taken when removing stuff that can be
 157                 pointed by the cache.
 158
 159                 You'll want to grab this in a SharedPtr.
 160         */
 161         JMutexAutoLock * waitCaches()
 162         {
 163                 //dstream<<"waitCaches() begin"<<std::endl;
 164                 JMutexAutoLock waitcachelock(m_waitcache_mutex);
 165                 JMutexAutoLock *lock = new JMutexAutoLock(m_cache_mutex);
 166                 //dstream<<"waitCaches() end"<<std::endl;
 167                 return lock;
 168         }
 169
 170 private:
 171         // Count of existing caches
 172         u32 m_count;
 173         JMutex m_count_mutex;
 174         // This is locked always when there are some caches
 175         JMutex m_cache_mutex;
 176         // Locked so that when waitCaches() is called, no more caches are created
 177         JMutex m_waitcache_mutex;
 178 };
 179
 180 #define MAPTYPE_BASE 0
 181 #define MAPTYPE_SERVER 1
 182 #define MAPTYPE_CLIENT 2
 183
 184 class Map : public NodeContainer, public Heightmappish
 185 {
 186 protected:
 187
 188         std::ostream &m_dout;
 189
 190         core::map<v2s16, MapSector*> m_sectors;
 191         JMutex m_sector_mutex;
 192
 193         v3f m_camera_position;
 194         v3f m_camera_direction;
 195         JMutex m_camera_mutex;
 196
 197         // Be sure to set this to NULL when the cached sector is deleted
 198         MapSector *m_sector_cache;
 199         v2s16 m_sector_cache_p;
 200
 201         WrapperHeightmap m_hwrapper;
 202
 203 public:
 204
 205         v3s16 drawoffset; // for drawbox()
 206
 207         /*
 208                 Used by MapBlockPointerCache.
 209
 210                 waitCaches() can be called to remove all caches before continuing
 211         */
 212         CacheLock m_blockcachelock;
 213
 214         Map(std::ostream &dout);
 215         virtual ~Map();
 216
 217         virtual u16 nodeContainerId() const
 218         {
 219                 return NODECONTAINER_ID_MAP;
 220         }
 221
 222         virtual s32 mapType() const
 223         {
 224                 return MAPTYPE_BASE;
 225         }
 226
 227         void updateCamera(v3f pos, v3f dir)
 228         {
 229                 JMutexAutoLock lock(m_camera_mutex);
 230                 m_camera_position = pos;
 231                 m_camera_direction = dir;
 232         }
 233
 234         /*void StartUpdater()
 235         {
 236                 updater.Start();
 237         }
 238
 239         void StopUpdater()
 240         {
 241                 updater.setRun(false);
 242                 while(updater.IsRunning())
 243                         sleep_s(1);
 244         }
 245
 246         bool UpdaterIsRunning()
 247         {
 248                 return updater.IsRunning();
 249         }*/
 250
 251         static core::aabbox3d<f32> getNodeBox(v3s16 p)
 252         {
 253                 return core::aabbox3d<f32>(
 254                         (float)p.X * BS - 0.5*BS,
 255                         (float)p.Y * BS - 0.5*BS,
 256                         (float)p.Z * BS - 0.5*BS,
 257                         (float)p.X * BS + 0.5*BS,
 258                         (float)p.Y * BS + 0.5*BS,
 259                         (float)p.Z * BS + 0.5*BS
 260                 );
 261         }
 262
 263         //bool sectorExists(v2s16 p);
 264         MapSector * getSectorNoGenerate(v2s16 p2d);
 265         /*
 266                 This is overloaded by ClientMap and ServerMap to allow
 267                 their differing fetch methods.
 268         */
 269         virtual MapSector * emergeSector(v2s16 p) = 0;
 270
 271         // Returns InvalidPositionException if not found
 272         MapBlock * getBlockNoCreate(v3s16 p);
 273         //virtual MapBlock * getBlock(v3s16 p, bool generate=true);
 274
 275         // Returns InvalidPositionException if not found
 276         f32 getGroundHeight(v2s16 p, bool generate=false);
 277         void setGroundHeight(v2s16 p, f32 y, bool generate=false);
 278
 279         // Returns InvalidPositionException if not found
 280         bool isNodeUnderground(v3s16 p);
 281
 282         // virtual from NodeContainer
 283         bool isValidPosition(v3s16 p)
 284         {
 285                 v3s16 blockpos = getNodeBlockPos(p);
 286                 MapBlock *blockref;
 287                 try{
 288                         blockref = getBlockNoCreate(blockpos);
 289                 }
 290                 catch(InvalidPositionException &e)
 291                 {
 292                         return false;
 293                 }
 294                 return true;
 295                 /*v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
 296                 bool is_valid = blockref->isValidPosition(relpos);
 297                 return is_valid;*/
 298         }
 299
 300         // virtual from NodeContainer
 301         MapNode getNode(v3s16 p)
 302         {
 303                 v3s16 blockpos = getNodeBlockPos(p);
 304                 MapBlock * blockref = getBlockNoCreate(blockpos);
 305                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
 306
 307                 return blockref->getNodeNoCheck(relpos);
 308         }
 309
 310         // virtual from NodeContainer
 311         void setNode(v3s16 p, MapNode & n)
 312         {
 313                 v3s16 blockpos = getNodeBlockPos(p);
 314                 MapBlock * blockref = getBlockNoCreate(blockpos);
 315                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
 316                 blockref->setNodeNoCheck(relpos, n);
 317         }
 318
 319         /*MapNode getNodeGenerate(v3s16 p)
 320         {
 321                 v3s16 blockpos = getNodeBlockPos(p);
 322                 MapBlock * blockref = getBlock(blockpos);
 323                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
 324
 325                 return blockref->getNode(relpos);
 326         }*/
 327
 328         /*void setNodeGenerate(v3s16 p, MapNode & n)
 329         {
 330                 v3s16 blockpos = getNodeBlockPos(p);
 331                 MapBlock * blockref = getBlock(blockpos);
 332                 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
 333                 blockref->setNode(relpos, n);
 334         }*/
 335
 336         void unspreadLight(enum LightBank bank,
 337                         core::map<v3s16, u8> & from_nodes,
 338                         core::map<v3s16, bool> & light_sources,
 339                         core::map<v3s16, MapBlock*> & modified_blocks);
 340
 341         void unLightNeighbors(enum LightBank bank,
 342                         v3s16 pos, u8 lightwas,
 343                         core::map<v3s16, bool> & light_sources,
 344                         core::map<v3s16, MapBlock*> & modified_blocks);
 345
 346         void spreadLight(enum LightBank bank,
 347                         core::map<v3s16, bool> & from_nodes,
 348                         core::map<v3s16, MapBlock*> & modified_blocks);
 349
 350         void lightNeighbors(enum LightBank bank,
 351                         v3s16 pos,
 352                         core::map<v3s16, MapBlock*> & modified_blocks);
 353
 354         v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
 355
 356         s16 propagateSunlight(v3s16 start,
 357                         core::map<v3s16, MapBlock*> & modified_blocks);
 358
 359         void updateLighting(enum LightBank bank,
 360                         core::map<v3s16, MapBlock*>  & a_blocks,
 361                         core::map<v3s16, MapBlock*> & modified_blocks);
 362
 363         void updateLighting(core::map<v3s16, MapBlock*>  & a_blocks,
 364                         core::map<v3s16, MapBlock*> & modified_blocks);
 365
 366         /*
 367                 These handle lighting but not faces.
 368         */
 369         void addNodeAndUpdate(v3s16 p, MapNode n,
 370                         core::map<v3s16, MapBlock*> &modified_blocks);
 371         void removeNodeAndUpdate(v3s16 p,
 372                         core::map<v3s16, MapBlock*> &modified_blocks);
 373
 374         /*
 375                 Updates the faces of the given block and blocks on the
 376                 leading edge.
 377         */
 378         void updateMeshes(v3s16 blockpos, u32 daylight_factor);
 379
 380         void expireMeshes();
 381
 382         //core::aabbox3d<s16> getDisplayedBlockArea();
 383
 384         //bool updateChangedVisibleArea();
 385
 386         virtual void save(bool only_changed){assert(0);};
 387
 388         /*
 389                 Updates usage timers
 390         */
 391         void timerUpdate(float dtime);
 392
 393         // Takes cache into account
 394         // sector mutex should be locked when calling
 395         void deleteSectors(core::list<v2s16> &list, bool only_blocks);
 396
 397         // Returns count of deleted sectors
 398         u32 deleteUnusedSectors(float timeout, bool only_blocks=false,
 399                         core::list<v3s16> *deleted_blocks=NULL);
 400
 401         // For debug printing
 402         virtual void PrintInfo(std::ostream &out);
 403 };
 404
 405 // Master heightmap parameters
 406 struct HMParams
 407 {
 408         HMParams()
 409         {
 410                 blocksize = 64;
 411                 randmax = "constant 70.0";
 412                 randfactor = "constant 0.6";
 413                 base = "linear 0 80 0";
 414         }
 415         s16 blocksize;
 416         std::string randmax;
 417         std::string randfactor;
 418         std::string base;
 419 };
 420
 421 // Map parameters
 422 struct MapParams
 423 {
 424         MapParams()
 425         {
 426                 plants_amount = 1.0;
 427                 ravines_amount = 1.0;
 428                 //max_objects_in_block = 30;
 429         }
 430         float plants_amount;
 431         float ravines_amount;
 432         //u16 max_objects_in_block;
 433 };
 434
 435 class ServerMap : public Map
 436 {
 437 public:
 438         /*
 439                 savedir: directory to which map data should be saved
 440         */
 441         ServerMap(std::string savedir, HMParams hmp, MapParams mp);
 442         ~ServerMap();
 443
 444         s32 mapType() const
 445         {
 446                 return MAPTYPE_SERVER;
 447         }
 448
 449         /*
 450                 Forcefully get a sector from somewhere
 451         */
 452         MapSector * emergeSector(v2s16 p);
 453         /*
 454                 Forcefully get a block from somewhere.
 455
 456                 Exceptions:
 457                 - InvalidPositionException: possible if only_from_disk==true
 458
 459                 changed_blocks:
 460                 - All already existing blocks that were modified are added.
 461                         - If found on disk, nothing will be added.
 462                         - If generated, the new block will not be included.
 463
 464                 lighting_invalidated_blocks:
 465                 - All blocks that have heavy-to-calculate lighting changes
 466                   are added.
 467                         - updateLighting() should be called for these.
 468
 469                 - A block that is in changed_blocks may not be in
 470                   lighting_invalidated_blocks.
 471         */
 472         MapBlock * emergeBlock(
 473                         v3s16 p,
 474                         bool only_from_disk,
 475                         core::map<v3s16, MapBlock*> &changed_blocks,
 476                         core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
 477         );
 478
 479         void createDir(std::string path);
 480         void createSaveDir();
 481         // returns something like "xxxxxxxx"
 482         std::string getSectorSubDir(v2s16 pos);
 483         // returns something like "map/sectors/xxxxxxxx"
 484         std::string getSectorDir(v2s16 pos);
 485         std::string createSectorDir(v2s16 pos);
 486         // dirname: final directory name
 487         v2s16 getSectorPos(std::string dirname);
 488         v3s16 getBlockPos(std::string sectordir, std::string blockfile);
 489
 490         void save(bool only_changed);
 491         void loadAll();
 492
 493         void saveMasterHeightmap();
 494         void loadMasterHeightmap();
 495
 496         // The sector mutex should be locked when calling most of these
 497
 498         // This only saves sector-specific data such as the heightmap
 499         // (no MapBlocks)
 500         void saveSectorMeta(ServerMapSector *sector);
 501         MapSector* loadSectorMeta(std::string dirname);
 502
 503         // Full load of a sector including all blocks.
 504         // returns true on success, false on failure.
 505         bool loadSectorFull(v2s16 p2d);
 506         // If sector is not found in memory, try to load it from disk.
 507         // Returns true if sector now resides in memory
 508         //bool deFlushSector(v2s16 p2d);
 509
 510         void saveBlock(MapBlock *block);
 511         // This will generate a sector with getSector if not found.
 512         void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector);
 513
 514         // Gets from master heightmap
 515         void getSectorCorners(v2s16 p2d, s16 *corners);
 516
 517         // For debug printing
 518         virtual void PrintInfo(std::ostream &out);
 519
 520 private:
 521         UnlimitedHeightmap *m_heightmap;
 522         MapParams m_params;
 523
 524         std::string m_savedir;
 525         bool m_map_saving_enabled;
 526 };
 527
 528 class Client;
 529
 530 class ClientMap : public Map, public scene::ISceneNode
 531 {
 532 public:
 533         ClientMap(
 534                         Client *client,
 535                         scene::ISceneNode* parent,
 536                         scene::ISceneManager* mgr,
 537                         s32 id
 538         );
 539
 540         ~ClientMap();
 541
 542         s32 mapType() const
 543         {
 544                 return MAPTYPE_CLIENT;
 545         }
 546
 547         /*
 548                 Forcefully get a sector from somewhere
 549         */
 550         MapSector * emergeSector(v2s16 p);
 551
 552         void deSerializeSector(v2s16 p2d, std::istream &is);
 553
 554         /*
 555                 ISceneNode methods
 556         */
 557
 558         virtual void OnRegisterSceneNode();
 559
 560         virtual void render()
 561         {
 562                 video::IVideoDriver* driver = SceneManager->getVideoDriver();
 563                 driver->setTransform(video::ETS_WORLD, AbsoluteTransformation);
 564                 renderMap(driver, SceneManager->getSceneNodeRenderPass());
 565         }
 566
 567         virtual const core::aabbox3d<f32>& getBoundingBox() const
 568         {
 569                 return m_box;
 570         }
 571
 572         void renderMap(video::IVideoDriver* driver, s32 pass);
 573
 574         // Update master heightmap mesh
 575         void updateMesh();
 576
 577         // For debug printing
 578         virtual void PrintInfo(std::ostream &out);
 579
 580 private:
 581         Client *m_client;
 582
 583         core::aabbox3d<f32> m_box;
 584
 585         // This is the master heightmap mesh
 586         scene::SMesh *mesh;
 587         JMutex mesh_mutex;
 588 };
 589
 590 class MapVoxelManipulator : public VoxelManipulator
 591 {
 592 public:
 593         MapVoxelManipulator(Map *map);
 594         virtual ~MapVoxelManipulator();
 595
 596         virtual void clear()
 597         {
 598                 VoxelManipulator::clear();
 599                 m_loaded_blocks.clear();
 600         }
 601
 602         virtual void emerge(VoxelArea a, s32 caller_id=-1);
 603
 604         void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
 605
 606 private:
 607         Map *m_map;
 608         /*
 609                 NOTE: This might be used or not
 610                 bool is dummy value
 611                 SUGG: How 'bout an another VoxelManipulator for storing the
 612                       information about which block is loaded?
 613         */
 614         core::map<v3s16, bool> m_loaded_blocks;
 615 };
 616
 617 #endif
 618