src/minimap.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2015 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 #include "minimap.h"
  21 #include <math.h>
  22 #include "logoutputbuffer.h"
  23 #include "jthread/jmutexautolock.h"
  24 #include "jthread/jsemaphore.h"
  25 #include "clientmap.h"
  26 #include "settings.h"
  27 #include "nodedef.h"
  28 #include "porting.h"
  29 #include "util/numeric.h"
  30 #include "util/string.h"
  31
  32
  33 ////
  34 //// MinimapUpdateThread
  35 ////
  36
  37 MinimapUpdateThread::~MinimapUpdateThread()
  38 {
  39         for (std::map<v3s16, MinimapMapblock *>::iterator
  40                         it = m_blocks_cache.begin();
  41                         it != m_blocks_cache.end(); ++it) {
  42                 delete it->second;
  43         }
  44
  45         for (std::deque<QueuedMinimapUpdate>::iterator
  46                         it = m_update_queue.begin();
  47                         it != m_update_queue.end(); ++it) {
  48                 QueuedMinimapUpdate &q = *it;
  49                 delete q.data;
  50         }
  51 }
  52
  53 bool MinimapUpdateThread::pushBlockUpdate(v3s16 pos, MinimapMapblock *data)
  54 {
  55         JMutexAutoLock lock(m_queue_mutex);
  56
  57         // Find if block is already in queue.
  58         // If it is, update the data and quit.
  59         for (std::deque<QueuedMinimapUpdate>::iterator
  60                         it = m_update_queue.begin();
  61                         it != m_update_queue.end(); ++it) {
  62                 QueuedMinimapUpdate &q = *it;
  63                 if (q.pos == pos) {
  64                         delete q.data;
  65                         q.data = data;
  66                         return false;
  67                 }
  68         }
  69
  70         // Add the block
  71         QueuedMinimapUpdate q;
  72         q.pos  = pos;
  73         q.data = data;
  74         m_update_queue.push_back(q);
  75
  76         return true;
  77 }
  78
  79 bool MinimapUpdateThread::popBlockUpdate(QueuedMinimapUpdate *update)
  80 {
  81         JMutexAutoLock lock(m_queue_mutex);
  82
  83         if (m_update_queue.empty())
  84                 return false;
  85
  86         *update = m_update_queue.front();
  87         m_update_queue.pop_front();
  88
  89         return true;
  90 }
  91
  92 void MinimapUpdateThread::enqueueBlock(v3s16 pos, MinimapMapblock *data)
  93 {
  94         pushBlockUpdate(pos, data);
  95         deferUpdate();
  96 }
  97
  98
  99 void MinimapUpdateThread::doUpdate()
 100 {
 101         QueuedMinimapUpdate update;
 102
 103         while (popBlockUpdate(&update)) {
 104                 if (update.data) {
 105                         // Swap two values in the map using single lookup
 106                         std::pair<std::map<v3s16, MinimapMapblock*>::iterator, bool>
 107                             result = m_blocks_cache.insert(std::make_pair(update.pos, update.data));
 108                         if (result.second == false) {
 109                                 delete result.first->second;
 110                                 result.first->second = update.data;
 111                         }
 112                 } else {
 113                         std::map<v3s16, MinimapMapblock *>::iterator it;
 114                         it = m_blocks_cache.find(update.pos);
 115                         if (it != m_blocks_cache.end()) {
 116                                 delete it->second;
 117                                 m_blocks_cache.erase(it);
 118                         }
 119                 }
 120         }
 121
 122         if (data->map_invalidated && data->mode != MINIMAP_MODE_OFF) {
 123                 getMap(data->pos, data->map_size, data->scan_height, data->is_radar);
 124                 data->map_invalidated = false;
 125         }
 126 }
 127
 128 MinimapPixel *MinimapUpdateThread::getMinimapPixel(v3s16 pos,
 129         s16 scan_height, s16 *pixel_height)
 130 {
 131         s16 height = scan_height - MAP_BLOCKSIZE;
 132         v3s16 blockpos_max, blockpos_min, relpos;
 133
 134         getNodeBlockPosWithOffset(
 135                 v3s16(pos.X, pos.Y - scan_height / 2, pos.Z),
 136                 blockpos_min, relpos);
 137         getNodeBlockPosWithOffset(
 138                 v3s16(pos.X, pos.Y + scan_height / 2, pos.Z),
 139                 blockpos_max, relpos);
 140
 141         for (s16 i = blockpos_max.Y; i > blockpos_min.Y - 1; i--) {
 142                 std::map<v3s16, MinimapMapblock *>::iterator it =
 143                         m_blocks_cache.find(v3s16(blockpos_max.X, i, blockpos_max.Z));
 144                 if (it != m_blocks_cache.end()) {
 145                         MinimapMapblock *mmblock = it->second;
 146                         MinimapPixel *pixel = &mmblock->data[relpos.Z * MAP_BLOCKSIZE + relpos.X];
 147                         if (pixel->id != CONTENT_AIR) {
 148                                 *pixel_height = height + pixel->height;
 149                                 return pixel;
 150                         }
 151                 }
 152
 153                 height -= MAP_BLOCKSIZE;
 154         }
 155
 156         return NULL;
 157 }
 158
 159 s16 MinimapUpdateThread::getAirCount(v3s16 pos, s16 height)
 160 {
 161         s16 air_count = 0;
 162         v3s16 blockpos_max, blockpos_min, relpos;
 163
 164         getNodeBlockPosWithOffset(
 165                 v3s16(pos.X, pos.Y - height / 2, pos.Z),
 166                 blockpos_min, relpos);
 167         getNodeBlockPosWithOffset(
 168                 v3s16(pos.X, pos.Y + height / 2, pos.Z),
 169                 blockpos_max, relpos);
 170
 171         for (s16 i = blockpos_max.Y; i > blockpos_min.Y - 1; i--) {
 172                 std::map<v3s16, MinimapMapblock *>::iterator it =
 173                         m_blocks_cache.find(v3s16(blockpos_max.X, i, blockpos_max.Z));
 174                 if (it != m_blocks_cache.end()) {
 175                         MinimapMapblock *mmblock = it->second;
 176                         MinimapPixel *pixel = &mmblock->data[relpos.Z * MAP_BLOCKSIZE + relpos.X];
 177                         air_count += pixel->air_count;
 178                 }
 179         }
 180
 181         return air_count;
 182 }
 183
 184 void MinimapUpdateThread::getMap(v3s16 pos, s16 size, s16 height, bool is_radar)
 185 {
 186         v3s16 p = v3s16(pos.X - size / 2, pos.Y, pos.Z - size / 2);
 187
 188         for (s16 x = 0; x < size; x++)
 189         for (s16 z = 0; z < size; z++) {
 190                 u16 id = CONTENT_AIR;
 191                 MinimapPixel *mmpixel = &data->minimap_scan[x + z * size];
 192
 193                 if (!is_radar) {
 194                         s16 pixel_height = 0;
 195                         MinimapPixel *cached_pixel =
 196                                 getMinimapPixel(v3s16(p.X + x, p.Y, p.Z + z), height, &pixel_height);
 197                         if (cached_pixel) {
 198                                 id = cached_pixel->id;
 199                                 mmpixel->height = pixel_height;
 200                         }
 201                 } else {
 202                         mmpixel->air_count = getAirCount(v3s16(p.X + x, p.Y, p.Z + z), height);
 203                 }
 204
 205                 mmpixel->id = id;
 206         }
 207 }
 208
 209 ////
 210 //// Mapper
 211 ////
 212
 213 Mapper::Mapper(IrrlichtDevice *device, Client *client)
 214 {
 215         this->driver    = device->getVideoDriver();
 216         this->m_tsrc    = client->getTextureSource();
 217         this->m_shdrsrc = client->getShaderSource();
 218         this->m_ndef    = client->getNodeDefManager();
 219
 220         // Initialize static settings
 221         m_enable_shaders = g_settings->getBool("enable_shaders");
 222         m_surface_mode_scan_height =
 223                 g_settings->getBool("minimap_double_scan_height") ? 256 : 128;
 224
 225         // Initialize minimap data
 226         data = new MinimapData;
 227         data->mode            = MINIMAP_MODE_OFF;
 228         data->is_radar        = false;
 229         data->map_invalidated = true;
 230         data->heightmap_image = NULL;
 231         data->minimap_image   = NULL;
 232         data->texture         = NULL;
 233         data->minimap_shape_round = g_settings->getBool("minimap_shape_round");
 234
 235         // Get round minimap textures
 236         data->minimap_mask_round = driver->createImage(
 237                 m_tsrc->getTexture("minimap_mask_round.png"),
 238                 core::position2d<s32>(0, 0),
 239                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
 240         data->minimap_overlay_round = m_tsrc->getTexture("minimap_overlay_round.png");
 241
 242         // Get square minimap textures
 243         data->minimap_mask_square = driver->createImage(
 244                 m_tsrc->getTexture("minimap_mask_square.png"),
 245                 core::position2d<s32>(0, 0),
 246                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
 247         data->minimap_overlay_square = m_tsrc->getTexture("minimap_overlay_square.png");
 248
 249         // Create player marker texture
 250         data->player_marker = m_tsrc->getTexture("player_marker.png");
 251
 252         // Create mesh buffer for minimap
 253         m_meshbuffer = getMinimapMeshBuffer();
 254
 255         // Initialize and start thread
 256         m_minimap_update_thread = new MinimapUpdateThread();
 257         m_minimap_update_thread->data = data;
 258         m_minimap_update_thread->Start();
 259 }
 260
 261 Mapper::~Mapper()
 262 {
 263         m_minimap_update_thread->Stop();
 264         m_minimap_update_thread->Wait();
 265
 266         m_meshbuffer->drop();
 267
 268         data->minimap_mask_round->drop();
 269         data->minimap_mask_square->drop();
 270
 271         driver->removeTexture(data->texture);
 272         driver->removeTexture(data->heightmap_texture);
 273         driver->removeTexture(data->minimap_overlay_round);
 274         driver->removeTexture(data->minimap_overlay_square);
 275
 276         delete data;
 277         delete m_minimap_update_thread;
 278 }
 279
 280 void Mapper::addBlock(v3s16 pos, MinimapMapblock *data)
 281 {
 282         m_minimap_update_thread->enqueueBlock(pos, data);
 283 }
 284
 285 MinimapMode Mapper::getMinimapMode()
 286 {
 287         return data->mode;
 288 }
 289
 290 void Mapper::toggleMinimapShape()
 291 {
 292         JMutexAutoLock lock(m_mutex);
 293
 294         data->minimap_shape_round = !data->minimap_shape_round;
 295         g_settings->setBool("minimap_shape_round", data->minimap_shape_round);
 296         m_minimap_update_thread->deferUpdate();
 297 }
 298
 299 void Mapper::setMinimapMode(MinimapMode mode)
 300 {
 301         static const MinimapModeDef modedefs[MINIMAP_MODE_COUNT] = {
 302                 {false, 0, 0},
 303                 {false, m_surface_mode_scan_height, 256},
 304                 {false, m_surface_mode_scan_height, 128},
 305                 {false, m_surface_mode_scan_height, 64},
 306                 {true, 32, 128},
 307                 {true, 32, 64},
 308                 {true, 32, 32}
 309         };
 310
 311         if (mode >= MINIMAP_MODE_COUNT)
 312                 return;
 313
 314         JMutexAutoLock lock(m_mutex);
 315
 316         data->is_radar    = modedefs[mode].is_radar;
 317         data->scan_height = modedefs[mode].scan_height;
 318         data->map_size    = modedefs[mode].map_size;
 319         data->mode        = mode;
 320
 321         m_minimap_update_thread->deferUpdate();
 322 }
 323
 324 void Mapper::setPos(v3s16 pos)
 325 {
 326         bool do_update = false;
 327
 328         {
 329                 JMutexAutoLock lock(m_mutex);
 330
 331                 if (pos != data->old_pos) {
 332                         data->old_pos = data->pos;
 333                         data->pos = pos;
 334                         do_update = true;
 335                 }
 336         }
 337
 338         if (do_update)
 339                 m_minimap_update_thread->deferUpdate();
 340 }
 341
 342 void Mapper::setAngle(f32 angle)
 343 {
 344         m_angle = angle;
 345 }
 346
 347 void Mapper::blitMinimapPixelsToImageRadar(video::IImage *map_image)
 348 {
 349         for (s16 x = 0; x < data->map_size; x++)
 350         for (s16 z = 0; z < data->map_size; z++) {
 351                 MinimapPixel *mmpixel = &data->minimap_scan[x + z * data->map_size];
 352
 353                 video::SColor c(240, 0, 0, 0);
 354                 if (mmpixel->air_count > 0)
 355                         c.setGreen(core::clamp(core::round32(32 + mmpixel->air_count * 8), 0, 255));
 356
 357                 map_image->setPixel(x, data->map_size - z - 1, c);
 358         }
 359 }
 360
 361 void Mapper::blitMinimapPixelsToImageSurface(
 362         video::IImage *map_image, video::IImage *heightmap_image)
 363 {
 364         for (s16 x = 0; x < data->map_size; x++)
 365         for (s16 z = 0; z < data->map_size; z++) {
 366                 MinimapPixel *mmpixel = &data->minimap_scan[x + z * data->map_size];
 367
 368                 video::SColor c = m_ndef->get(mmpixel->id).minimap_color;
 369                 c.setAlpha(240);
 370
 371                 map_image->setPixel(x, data->map_size - z - 1, c);
 372
 373                 u32 h = mmpixel->height;
 374                 heightmap_image->setPixel(x,data->map_size - z - 1,
 375                         video::SColor(255, h, h, h));
 376         }
 377 }
 378
 379 video::ITexture *Mapper::getMinimapTexture()
 380 {
 381         // update minimap textures when new scan is ready
 382         if (data->map_invalidated)
 383                 return data->texture;
 384
 385         // create minimap and heightmap images in memory
 386         core::dimension2d<u32> dim(data->map_size, data->map_size);
 387         video::IImage *map_image       = driver->createImage(video::ECF_A8R8G8B8, dim);
 388         video::IImage *heightmap_image = driver->createImage(video::ECF_A8R8G8B8, dim);
 389         video::IImage *minimap_image   = driver->createImage(video::ECF_A8R8G8B8,
 390                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
 391
 392         // Blit MinimapPixels to images
 393         if (data->is_radar)
 394                 blitMinimapPixelsToImageRadar(map_image);
 395         else
 396                 blitMinimapPixelsToImageSurface(map_image, heightmap_image);
 397
 398         map_image->copyToScaling(minimap_image);
 399         map_image->drop();
 400
 401         video::IImage *minimap_mask = data->minimap_shape_round ?
 402                 data->minimap_mask_round : data->minimap_mask_square;
 403
 404         if (minimap_mask) {
 405                 for (s16 y = 0; y < MINIMAP_MAX_SY; y++)
 406                 for (s16 x = 0; x < MINIMAP_MAX_SX; x++) {
 407                         video::SColor mask_col = minimap_mask->getPixel(x, y);
 408                         if (!mask_col.getAlpha())
 409                                 minimap_image->setPixel(x, y, video::SColor(0,0,0,0));
 410                 }
 411         }
 412
 413         if (data->texture)
 414                 driver->removeTexture(data->texture);
 415         if (data->heightmap_texture)
 416                 driver->removeTexture(data->heightmap_texture);
 417
 418         data->texture = driver->addTexture("minimap__", minimap_image);
 419         data->heightmap_texture =
 420                 driver->addTexture("minimap_heightmap__", heightmap_image);
 421         minimap_image->drop();
 422         heightmap_image->drop();
 423
 424         data->map_invalidated = true;
 425
 426         return data->texture;
 427 }
 428
 429 v3f Mapper::getYawVec()
 430 {
 431         if (data->minimap_shape_round) {
 432                 return v3f(
 433                         cos(m_angle * core::DEGTORAD),
 434                         sin(m_angle * core::DEGTORAD),
 435                         1.0);
 436         } else {
 437                 return v3f(1.0, 0.0, 1.0);
 438         }
 439 }
 440
 441 scene::SMeshBuffer *Mapper::getMinimapMeshBuffer()
 442 {
 443         scene::SMeshBuffer *buf = new scene::SMeshBuffer();
 444         buf->Vertices.set_used(4);
 445         buf->Indices.set_used(6);
 446         video::SColor c(255, 255, 255, 255);
 447
 448         buf->Vertices[0] = video::S3DVertex(-1, -1, 0, 0, 0, 1, c, 0, 1);
 449         buf->Vertices[1] = video::S3DVertex(-1,  1, 0, 0, 0, 1, c, 0, 0);
 450         buf->Vertices[2] = video::S3DVertex( 1,  1, 0, 0, 0, 1, c, 1, 0);
 451         buf->Vertices[3] = video::S3DVertex( 1, -1, 0, 0, 0, 1, c, 1, 1);
 452
 453         buf->Indices[0] = 0;
 454         buf->Indices[1] = 1;
 455         buf->Indices[2] = 2;
 456         buf->Indices[3] = 2;
 457         buf->Indices[4] = 3;
 458         buf->Indices[5] = 0;
 459
 460         return buf;
 461 }
 462
 463 void Mapper::drawMinimap()
 464 {
 465         video::ITexture *minimap_texture = getMinimapTexture();
 466         if (!minimap_texture)
 467                 return;
 468
 469         v2u32 screensize = porting::getWindowSize();
 470         const u32 size = 0.25 * screensize.Y;
 471
 472         core::rect<s32> oldViewPort = driver->getViewPort();
 473         core::matrix4 oldProjMat = driver->getTransform(video::ETS_PROJECTION);
 474         core::matrix4 oldViewMat = driver->getTransform(video::ETS_VIEW);
 475
 476         driver->setViewPort(core::rect<s32>(
 477                 screensize.X - size - 10, 10,
 478                 screensize.X - 10, size + 10));
 479         driver->setTransform(video::ETS_PROJECTION, core::matrix4());
 480         driver->setTransform(video::ETS_VIEW, core::matrix4());
 481
 482         core::matrix4 matrix;
 483         matrix.makeIdentity();
 484
 485         video::SMaterial &material = m_meshbuffer->getMaterial();
 486         material.setFlag(video::EMF_TRILINEAR_FILTER, true);
 487         material.Lighting = false;
 488         material.TextureLayer[0].Texture = minimap_texture;
 489         material.TextureLayer[1].Texture = data->heightmap_texture;
 490
 491         if (m_enable_shaders && !data->is_radar) {
 492                 u16 sid = m_shdrsrc->getShader("minimap_shader", 1, 1);
 493                 material.MaterialType = m_shdrsrc->getShaderInfo(sid).material;
 494         } else {
 495                 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 496         }
 497
 498         if (data->minimap_shape_round)
 499                 matrix.setRotationDegrees(core::vector3df(0, 0, 360 - m_angle));
 500
 501         // Draw minimap
 502         driver->setTransform(video::ETS_WORLD, matrix);
 503         driver->setMaterial(material);
 504         driver->drawMeshBuffer(m_meshbuffer);
 505
 506         // Draw overlay
 507         video::ITexture *minimap_overlay = data->minimap_shape_round ?
 508                 data->minimap_overlay_round : data->minimap_overlay_square;
 509         material.TextureLayer[0].Texture = minimap_overlay;
 510         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 511         driver->setMaterial(material);
 512         driver->drawMeshBuffer(m_meshbuffer);
 513
 514         // If round minimap, draw player marker
 515         if (!data->minimap_shape_round) {
 516                 matrix.setRotationDegrees(core::vector3df(0, 0, m_angle));
 517                 material.TextureLayer[0].Texture = data->player_marker;
 518
 519                 driver->setTransform(video::ETS_WORLD, matrix);
 520                 driver->setMaterial(material);
 521                 driver->drawMeshBuffer(m_meshbuffer);
 522         }
 523
 524         // Reset transformations
 525         driver->setTransform(video::ETS_VIEW, oldViewMat);
 526         driver->setTransform(video::ETS_PROJECTION, oldProjMat);
 527         driver->setViewPort(oldViewPort);
 528 }
 529
 530 ////
 531 //// MinimapMapblock
 532 ////
 533
 534 void MinimapMapblock::getMinimapNodes(VoxelManipulator *vmanip, v3s16 pos)
 535 {
 536
 537         for (s16 x = 0; x < MAP_BLOCKSIZE; x++)
 538         for (s16 z = 0; z < MAP_BLOCKSIZE; z++) {
 539                 s16 air_count = 0;
 540                 bool surface_found = false;
 541                 MinimapPixel *mmpixel = &data[z * MAP_BLOCKSIZE + x];
 542
 543                 for (s16 y = MAP_BLOCKSIZE -1; y >= 0; y--) {
 544                         v3s16 p(x, y, z);
 545                         MapNode n = vmanip->getNodeNoEx(pos + p);
 546                         if (!surface_found && n.getContent() != CONTENT_AIR) {
 547                                 mmpixel->height = y;
 548                                 mmpixel->id = n.getContent();
 549                                 surface_found = true;
 550                         } else if (n.getContent() == CONTENT_AIR) {
 551                                 air_count++;
 552                         }
 553                 }
 554
 555                 if (!surface_found)
 556                         mmpixel->id = CONTENT_AIR;
 557
 558                 mmpixel->air_count = air_count;
 559         }
 560 }