cfc2c34b061a734fdbaacea11460bd36651adf7f
[oweals/minetest.git] / 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 "threading/mutex_auto_lock.h"
22 #include "threading/semaphore.h"
23 #include "clientmap.h"
24 #include "settings.h"
25 #include "nodedef.h"
26 #include "porting.h"
27 #include "util/numeric.h"
28 #include "util/string.h"
29 #include "mapblock.h"
30 #include <math.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         MutexAutoLock 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         MutexAutoLock 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);
124                 data->map_invalidated = false;
125         }
126 }
127
128 void MinimapUpdateThread::getMap(v3s16 pos, s16 size, s16 height)
129 {
130         v3s16 region(size, 0, size);
131         v3s16 pos_min(pos.X - size / 2, pos.Y - height / 2, pos.Z - size / 2);
132         v3s16 pos_max(pos_min.X + size - 1, pos.Y + height / 2, pos_min.Z + size - 1);
133         v3s16 blockpos_min = getNodeBlockPos(pos_min);
134         v3s16 blockpos_max = getNodeBlockPos(pos_max);
135
136 // clear the map
137         for (int z = 0; z < size; z++)
138         for (int x = 0; x < size; x++) {
139                 MinimapPixel &mmpixel = data->minimap_scan[x + z * size];
140                 mmpixel.air_count = 0;
141                 mmpixel.height = 0;
142                 mmpixel.n = MapNode(CONTENT_AIR);
143         }
144
145 // draw the map
146         v3s16 blockpos;
147         for (blockpos.Z = blockpos_min.Z; blockpos.Z <= blockpos_max.Z; ++blockpos.Z)
148         for (blockpos.Y = blockpos_min.Y; blockpos.Y <= blockpos_max.Y; ++blockpos.Y)
149         for (blockpos.X = blockpos_min.X; blockpos.X <= blockpos_max.X; ++blockpos.X) {
150                 std::map<v3s16, MinimapMapblock *>::const_iterator pblock =
151                         m_blocks_cache.find(blockpos);
152                 if (pblock == m_blocks_cache.end())
153                         continue;
154                 const MinimapMapblock &block = *pblock->second;
155
156                 v3s16 block_node_min(blockpos * MAP_BLOCKSIZE);
157                 v3s16 block_node_max(block_node_min + MAP_BLOCKSIZE - 1);
158                 // clip
159                 v3s16 range_min = componentwise_max(block_node_min, pos_min);
160                 v3s16 range_max = componentwise_min(block_node_max, pos_max);
161
162                 v3s16 pos;
163                 pos.Y = range_min.Y;
164                 for (pos.Z = range_min.Z; pos.Z <= range_max.Z; ++pos.Z)
165                 for (pos.X = range_min.X; pos.X <= range_max.X; ++pos.X) {
166                         v3s16 inblock_pos = pos - block_node_min;
167                         const MinimapPixel &in_pixel =
168                                 block.data[inblock_pos.Z * MAP_BLOCKSIZE + inblock_pos.X];
169
170                         v3s16 inmap_pos = pos - pos_min;
171                         MinimapPixel &out_pixel =
172                                 data->minimap_scan[inmap_pos.X + inmap_pos.Z * size];
173
174                         out_pixel.air_count += in_pixel.air_count;
175                         if (in_pixel.n.param0 != CONTENT_AIR) {
176                                 out_pixel.n = in_pixel.n;
177                                 out_pixel.height = inmap_pos.Y + in_pixel.height;
178                         }
179                 }
180         }
181 }
182
183 ////
184 //// Mapper
185 ////
186
187 Mapper::Mapper(IrrlichtDevice *device, Client *client)
188 {
189         this->client    = client;
190         this->driver    = device->getVideoDriver();
191         this->m_tsrc    = client->getTextureSource();
192         this->m_shdrsrc = client->getShaderSource();
193         this->m_ndef    = client->getNodeDefManager();
194
195         m_angle = 0.f;
196
197         // Initialize static settings
198         m_enable_shaders = g_settings->getBool("enable_shaders");
199         m_surface_mode_scan_height =
200                 g_settings->getBool("minimap_double_scan_height") ? 256 : 128;
201
202         // Initialize minimap data
203         data = new MinimapData;
204         data->mode              = MINIMAP_MODE_OFF;
205         data->is_radar          = false;
206         data->map_invalidated   = true;
207         data->heightmap_image   = NULL;
208         data->minimap_image     = NULL;
209         data->texture           = NULL;
210         data->heightmap_texture = NULL;
211         data->minimap_shape_round = g_settings->getBool("minimap_shape_round");
212
213         // Get round minimap textures
214         data->minimap_mask_round = driver->createImage(
215                 m_tsrc->getTexture("minimap_mask_round.png"),
216                 core::position2d<s32>(0, 0),
217                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
218         data->minimap_overlay_round = m_tsrc->getTexture("minimap_overlay_round.png");
219
220         // Get square minimap textures
221         data->minimap_mask_square = driver->createImage(
222                 m_tsrc->getTexture("minimap_mask_square.png"),
223                 core::position2d<s32>(0, 0),
224                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
225         data->minimap_overlay_square = m_tsrc->getTexture("minimap_overlay_square.png");
226
227         // Create player marker texture
228         data->player_marker = m_tsrc->getTexture("player_marker.png");
229         // Create object marker texture
230         data->object_marker_red = m_tsrc->getTexture("object_marker_red.png");
231
232         // Create mesh buffer for minimap
233         m_meshbuffer = getMinimapMeshBuffer();
234
235         // Initialize and start thread
236         m_minimap_update_thread = new MinimapUpdateThread();
237         m_minimap_update_thread->data = data;
238         m_minimap_update_thread->start();
239 }
240
241 Mapper::~Mapper()
242 {
243         m_minimap_update_thread->stop();
244         m_minimap_update_thread->wait();
245
246         m_meshbuffer->drop();
247
248         data->minimap_mask_round->drop();
249         data->minimap_mask_square->drop();
250
251         driver->removeTexture(data->texture);
252         driver->removeTexture(data->heightmap_texture);
253         driver->removeTexture(data->minimap_overlay_round);
254         driver->removeTexture(data->minimap_overlay_square);
255         driver->removeTexture(data->object_marker_red);
256
257         delete data;
258         delete m_minimap_update_thread;
259 }
260
261 void Mapper::addBlock(v3s16 pos, MinimapMapblock *data)
262 {
263         m_minimap_update_thread->enqueueBlock(pos, data);
264 }
265
266 MinimapMode Mapper::getMinimapMode()
267 {
268         return data->mode;
269 }
270
271 void Mapper::toggleMinimapShape()
272 {
273         MutexAutoLock lock(m_mutex);
274
275         data->minimap_shape_round = !data->minimap_shape_round;
276         g_settings->setBool("minimap_shape_round", data->minimap_shape_round);
277         m_minimap_update_thread->deferUpdate();
278 }
279
280 void Mapper::setMinimapMode(MinimapMode mode)
281 {
282         static const MinimapModeDef modedefs[MINIMAP_MODE_COUNT] = {
283                 {false, 0, 0},
284                 {false, m_surface_mode_scan_height, 256},
285                 {false, m_surface_mode_scan_height, 128},
286                 {false, m_surface_mode_scan_height, 64},
287                 {true, 32, 128},
288                 {true, 32, 64},
289                 {true, 32, 32}
290         };
291
292         if (mode >= MINIMAP_MODE_COUNT)
293                 return;
294
295         MutexAutoLock lock(m_mutex);
296
297         data->is_radar    = modedefs[mode].is_radar;
298         data->scan_height = modedefs[mode].scan_height;
299         data->map_size    = modedefs[mode].map_size;
300         data->mode        = mode;
301
302         m_minimap_update_thread->deferUpdate();
303 }
304
305 void Mapper::setPos(v3s16 pos)
306 {
307         bool do_update = false;
308
309         {
310                 MutexAutoLock lock(m_mutex);
311
312                 if (pos != data->old_pos) {
313                         data->old_pos = data->pos;
314                         data->pos = pos;
315                         do_update = true;
316                 }
317         }
318
319         if (do_update)
320                 m_minimap_update_thread->deferUpdate();
321 }
322
323 void Mapper::setAngle(f32 angle)
324 {
325         m_angle = angle;
326 }
327
328 void Mapper::blitMinimapPixelsToImageRadar(video::IImage *map_image)
329 {
330         for (s16 x = 0; x < data->map_size; x++)
331         for (s16 z = 0; z < data->map_size; z++) {
332                 MinimapPixel *mmpixel = &data->minimap_scan[x + z * data->map_size];
333
334                 video::SColor c(240, 0, 0, 0);
335                 if (mmpixel->air_count > 0)
336                         c.setGreen(core::clamp(core::round32(32 + mmpixel->air_count * 8), 0, 255));
337
338                 map_image->setPixel(x, data->map_size - z - 1, c);
339         }
340 }
341
342 void Mapper::blitMinimapPixelsToImageSurface(
343         video::IImage *map_image, video::IImage *heightmap_image)
344 {
345         for (s16 x = 0; x < data->map_size; x++)
346         for (s16 z = 0; z < data->map_size; z++) {
347                 MinimapPixel *mmpixel = &data->minimap_scan[x + z * data->map_size];
348
349                 const ContentFeatures &f = m_ndef->get(mmpixel->n);
350                 const TileDef *tile = &f.tiledef[0];
351                 // Color of the 0th tile (mostly this is the topmost)
352                 video::SColor tilecolor;
353                 if(tile->has_color)
354                         tilecolor = tile->color;
355                 else
356                         mmpixel->n.getColor(f, &tilecolor);
357                 tilecolor.setRed(tilecolor.getRed() * f.minimap_color.getRed() / 255);
358                 tilecolor.setGreen(tilecolor.getGreen() * f.minimap_color.getGreen()
359                         / 255);
360                 tilecolor.setBlue(tilecolor.getBlue() * f.minimap_color.getBlue() / 255);
361                 tilecolor.setAlpha(240);
362
363                 map_image->setPixel(x, data->map_size - z - 1, tilecolor);
364
365                 u32 h = mmpixel->height;
366                 heightmap_image->setPixel(x,data->map_size - z - 1,
367                         video::SColor(255, h, h, h));
368         }
369 }
370
371 video::ITexture *Mapper::getMinimapTexture()
372 {
373         // update minimap textures when new scan is ready
374         if (data->map_invalidated)
375                 return data->texture;
376
377         // create minimap and heightmap images in memory
378         core::dimension2d<u32> dim(data->map_size, data->map_size);
379         video::IImage *map_image       = driver->createImage(video::ECF_A8R8G8B8, dim);
380         video::IImage *heightmap_image = driver->createImage(video::ECF_A8R8G8B8, dim);
381         video::IImage *minimap_image   = driver->createImage(video::ECF_A8R8G8B8,
382                 core::dimension2d<u32>(MINIMAP_MAX_SX, MINIMAP_MAX_SY));
383
384         // Blit MinimapPixels to images
385         if (data->is_radar)
386                 blitMinimapPixelsToImageRadar(map_image);
387         else
388                 blitMinimapPixelsToImageSurface(map_image, heightmap_image);
389
390         map_image->copyToScaling(minimap_image);
391         map_image->drop();
392
393         video::IImage *minimap_mask = data->minimap_shape_round ?
394                 data->minimap_mask_round : data->minimap_mask_square;
395
396         if (minimap_mask) {
397                 for (s16 y = 0; y < MINIMAP_MAX_SY; y++)
398                 for (s16 x = 0; x < MINIMAP_MAX_SX; x++) {
399                         video::SColor mask_col = minimap_mask->getPixel(x, y);
400                         if (!mask_col.getAlpha())
401                                 minimap_image->setPixel(x, y, video::SColor(0,0,0,0));
402                 }
403         }
404
405         if (data->texture)
406                 driver->removeTexture(data->texture);
407         if (data->heightmap_texture)
408                 driver->removeTexture(data->heightmap_texture);
409
410         data->texture = driver->addTexture("minimap__", minimap_image);
411         data->heightmap_texture =
412                 driver->addTexture("minimap_heightmap__", heightmap_image);
413         minimap_image->drop();
414         heightmap_image->drop();
415
416         data->map_invalidated = true;
417
418         return data->texture;
419 }
420
421 v3f Mapper::getYawVec()
422 {
423         if (data->minimap_shape_round) {
424                 return v3f(
425                         cos(m_angle * core::DEGTORAD),
426                         sin(m_angle * core::DEGTORAD),
427                         1.0);
428         } else {
429                 return v3f(1.0, 0.0, 1.0);
430         }
431 }
432
433 scene::SMeshBuffer *Mapper::getMinimapMeshBuffer()
434 {
435         scene::SMeshBuffer *buf = new scene::SMeshBuffer();
436         buf->Vertices.set_used(4);
437         buf->Indices.set_used(6);
438         video::SColor c(255, 255, 255, 255);
439
440         buf->Vertices[0] = video::S3DVertex(-1, -1, 0, 0, 0, 1, c, 0, 1);
441         buf->Vertices[1] = video::S3DVertex(-1,  1, 0, 0, 0, 1, c, 0, 0);
442         buf->Vertices[2] = video::S3DVertex( 1,  1, 0, 0, 0, 1, c, 1, 0);
443         buf->Vertices[3] = video::S3DVertex( 1, -1, 0, 0, 0, 1, c, 1, 1);
444
445         buf->Indices[0] = 0;
446         buf->Indices[1] = 1;
447         buf->Indices[2] = 2;
448         buf->Indices[3] = 2;
449         buf->Indices[4] = 3;
450         buf->Indices[5] = 0;
451
452         return buf;
453 }
454
455 void Mapper::drawMinimap()
456 {
457         video::ITexture *minimap_texture = getMinimapTexture();
458         if (!minimap_texture)
459                 return;
460
461         updateActiveMarkers();
462         v2u32 screensize = porting::getWindowSize();
463         const u32 size = 0.25 * screensize.Y;
464
465         core::rect<s32> oldViewPort = driver->getViewPort();
466         core::matrix4 oldProjMat = driver->getTransform(video::ETS_PROJECTION);
467         core::matrix4 oldViewMat = driver->getTransform(video::ETS_VIEW);
468
469         driver->setViewPort(core::rect<s32>(
470                 screensize.X - size - 10, 10,
471                 screensize.X - 10, size + 10));
472         driver->setTransform(video::ETS_PROJECTION, core::matrix4());
473         driver->setTransform(video::ETS_VIEW, core::matrix4());
474
475         core::matrix4 matrix;
476         matrix.makeIdentity();
477
478         video::SMaterial &material = m_meshbuffer->getMaterial();
479         material.setFlag(video::EMF_TRILINEAR_FILTER, true);
480         material.Lighting = false;
481         material.TextureLayer[0].Texture = minimap_texture;
482         material.TextureLayer[1].Texture = data->heightmap_texture;
483
484         if (m_enable_shaders && !data->is_radar) {
485                 u16 sid = m_shdrsrc->getShader("minimap_shader", 1, 1);
486                 material.MaterialType = m_shdrsrc->getShaderInfo(sid).material;
487         } else {
488                 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
489         }
490
491         if (data->minimap_shape_round)
492                 matrix.setRotationDegrees(core::vector3df(0, 0, 360 - m_angle));
493
494         // Draw minimap
495         driver->setTransform(video::ETS_WORLD, matrix);
496         driver->setMaterial(material);
497         driver->drawMeshBuffer(m_meshbuffer);
498
499         // Draw overlay
500         video::ITexture *minimap_overlay = data->minimap_shape_round ?
501                 data->minimap_overlay_round : data->minimap_overlay_square;
502         material.TextureLayer[0].Texture = minimap_overlay;
503         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
504         driver->setMaterial(material);
505         driver->drawMeshBuffer(m_meshbuffer);
506
507         // If round minimap, draw player marker
508         if (!data->minimap_shape_round) {
509                 matrix.setRotationDegrees(core::vector3df(0, 0, m_angle));
510                 material.TextureLayer[0].Texture = data->player_marker;
511
512                 driver->setTransform(video::ETS_WORLD, matrix);
513                 driver->setMaterial(material);
514                 driver->drawMeshBuffer(m_meshbuffer);
515         }
516
517         // Reset transformations
518         driver->setTransform(video::ETS_VIEW, oldViewMat);
519         driver->setTransform(video::ETS_PROJECTION, oldProjMat);
520         driver->setViewPort(oldViewPort);
521
522         // Draw player markers
523         v2s32 s_pos(screensize.X - size - 10, 10);
524         core::dimension2di imgsize(data->object_marker_red->getOriginalSize());
525         core::rect<s32> img_rect(0, 0, imgsize.Width, imgsize.Height);
526         static const video::SColor col(255, 255, 255, 255);
527         static const video::SColor c[4] = {col, col, col, col};
528         f32 sin_angle = sin(m_angle * core::DEGTORAD);
529         f32 cos_angle = cos(m_angle * core::DEGTORAD);
530         s32 marker_size2 =  0.025 * (float)size;
531         for (std::list<v2f>::const_iterator
532                         i = m_active_markers.begin();
533                         i != m_active_markers.end(); ++i) {
534                 v2f posf = *i;
535                 if (data->minimap_shape_round) {
536                         f32 t1 = posf.X * cos_angle - posf.Y * sin_angle;
537                         f32 t2 = posf.X * sin_angle + posf.Y * cos_angle;
538                         posf.X = t1;
539                         posf.Y = t2;
540                 }
541                 posf.X = (posf.X + 0.5) * (float)size;
542                 posf.Y = (posf.Y + 0.5) * (float)size;
543                 core::rect<s32> dest_rect(
544                         s_pos.X + posf.X - marker_size2,
545                         s_pos.Y + posf.Y - marker_size2,
546                         s_pos.X + posf.X + marker_size2,
547                         s_pos.Y + posf.Y + marker_size2);
548                 driver->draw2DImage(data->object_marker_red, dest_rect,
549                         img_rect, &dest_rect, &c[0], true);
550         }
551 }
552
553 void Mapper::updateActiveMarkers ()
554 {
555         video::IImage *minimap_mask = data->minimap_shape_round ?
556                 data->minimap_mask_round : data->minimap_mask_square;
557
558         std::list<Nametag *> *nametags = client->getCamera()->getNametags();
559
560         m_active_markers.clear();
561
562         for (std::list<Nametag *>::const_iterator
563                         i = nametags->begin();
564                         i != nametags->end(); ++i) {
565                 Nametag *nametag = *i;
566                 v3s16 pos = floatToInt(nametag->parent_node->getPosition() +
567                         intToFloat(client->getCamera()->getOffset(), BS), BS);
568                 pos -= data->pos - v3s16(data->map_size / 2,
569                                 data->scan_height / 2,
570                                 data->map_size / 2);
571                 if (pos.X < 0 || pos.X > data->map_size ||
572                                 pos.Y < 0 || pos.Y > data->scan_height ||
573                                 pos.Z < 0 || pos.Z > data->map_size) {
574                         continue;
575                 }
576                 pos.X = ((float)pos.X / data->map_size) * MINIMAP_MAX_SX;
577                 pos.Z = ((float)pos.Z / data->map_size) * MINIMAP_MAX_SY;
578                 video::SColor mask_col = minimap_mask->getPixel(pos.X, pos.Z);
579                 if (!mask_col.getAlpha()) {
580                         continue;
581                 }
582                 m_active_markers.push_back(v2f(((float)pos.X / (float)MINIMAP_MAX_SX) - 0.5,
583                         (1.0 - (float)pos.Z / (float)MINIMAP_MAX_SY) - 0.5));
584         }
585 }
586
587 ////
588 //// MinimapMapblock
589 ////
590
591 void MinimapMapblock::getMinimapNodes(VoxelManipulator *vmanip, v3s16 pos)
592 {
593
594         for (s16 x = 0; x < MAP_BLOCKSIZE; x++)
595         for (s16 z = 0; z < MAP_BLOCKSIZE; z++) {
596                 s16 air_count = 0;
597                 bool surface_found = false;
598                 MinimapPixel *mmpixel = &data[z * MAP_BLOCKSIZE + x];
599
600                 for (s16 y = MAP_BLOCKSIZE -1; y >= 0; y--) {
601                         v3s16 p(x, y, z);
602                         MapNode n = vmanip->getNodeNoEx(pos + p);
603                         if (!surface_found && n.getContent() != CONTENT_AIR) {
604                                 mmpixel->height = y;
605                                 mmpixel->n = n;
606                                 surface_found = true;
607                         } else if (n.getContent() == CONTENT_AIR) {
608                                 air_count++;
609                         }
610                 }
611
612                 if (!surface_found)
613                         mmpixel->n = MapNode(CONTENT_AIR);
614
615                 mmpixel->air_count = air_count;
616         }
617 }