Biome API: Enable biome generation to lower world limit
[oweals/minetest.git] / src / mapgen_v5.cpp
1 /*
2 Minetest
3 Copyright (C) 2010-2013 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
21 #include "mapgen.h"
22 #include "voxel.h"
23 #include "noise.h"
24 #include "mapblock.h"
25 #include "mapnode.h"
26 #include "map.h"
27 #include "content_sao.h"
28 #include "nodedef.h"
29 #include "voxelalgorithms.h"
30 #include "profiler.h"
31 #include "settings.h" // For g_settings
32 #include "emerge.h"
33 #include "dungeongen.h"
34 #include "cavegen.h"
35 #include "treegen.h"
36 #include "mg_biome.h"
37 #include "mg_ore.h"
38 #include "mg_decoration.h"
39 #include "mapgen_v5.h"
40 #include "util/directiontables.h"
41
42
43 FlagDesc flagdesc_mapgen_v5[] = {
44         {NULL,         0}
45 };
46
47
48 MapgenV5::MapgenV5(int mapgenid, MapgenParams *params, EmergeManager *emerge)
49         : Mapgen(mapgenid, params, emerge)
50 {
51         this->m_emerge = emerge;
52         this->bmgr     = emerge->biomemgr;
53
54         // amount of elements to skip for the next index
55         // for noise/height/biome maps (not vmanip)
56         this->ystride = csize.X;
57         this->zstride = csize.X * (csize.Y + 2);
58
59         this->biomemap  = new u8[csize.X * csize.Z];
60         this->heightmap = new s16[csize.X * csize.Z];
61
62         MapgenV5Params *sp = (MapgenV5Params *)params->sparams;
63         this->spflags      = sp->spflags;
64
65         // Terrain noise
66         noise_filler_depth = new Noise(&sp->np_filler_depth, seed, csize.X, csize.Z);
67         noise_factor       = new Noise(&sp->np_factor,       seed, csize.X, csize.Z);
68         noise_height       = new Noise(&sp->np_height,       seed, csize.X, csize.Z);
69
70         // 3D terrain noise
71         noise_cave1        = new Noise(&sp->np_cave1,   seed, csize.X, csize.Y + 2, csize.Z);
72         noise_cave2        = new Noise(&sp->np_cave2,   seed, csize.X, csize.Y + 2, csize.Z);
73         noise_ground       = new Noise(&sp->np_ground,  seed, csize.X, csize.Y + 2, csize.Z);
74
75         // Biome noise
76         noise_heat         = new Noise(&params->np_biome_heat,     seed, csize.X, csize.Z);
77         noise_humidity     = new Noise(&params->np_biome_humidity, seed, csize.X, csize.Z);
78
79         //// Resolve nodes to be used
80         INodeDefManager *ndef = emerge->ndef;
81
82         c_stone                = ndef->getId("mapgen_stone");
83         c_water_source         = ndef->getId("mapgen_water_source");
84         c_lava_source          = ndef->getId("mapgen_lava_source");
85         c_desert_stone         = ndef->getId("mapgen_desert_stone");
86         c_ice                  = ndef->getId("mapgen_ice");
87         c_sandstone            = ndef->getId("mapgen_sandstone");
88
89         c_cobble               = ndef->getId("mapgen_cobble");
90         c_stair_cobble         = ndef->getId("mapgen_stair_cobble");
91         c_mossycobble          = ndef->getId("mapgen_mossycobble");
92         c_sandstonebrick       = ndef->getId("mapgen_sandstonebrick");
93         c_stair_sandstonebrick = ndef->getId("mapgen_stair_sandstonebrick");
94
95         if (c_ice == CONTENT_IGNORE)
96                 c_ice = CONTENT_AIR;
97         if (c_mossycobble == CONTENT_IGNORE)
98                 c_mossycobble = c_cobble;
99         if (c_stair_cobble == CONTENT_IGNORE)
100                 c_stair_cobble = c_cobble;
101         if (c_sandstonebrick == CONTENT_IGNORE)
102                 c_sandstonebrick = c_sandstone;
103         if (c_stair_sandstonebrick == CONTENT_IGNORE)
104                 c_stair_sandstonebrick = c_sandstone;
105 }
106
107
108 MapgenV5::~MapgenV5()
109 {
110         delete noise_filler_depth;
111         delete noise_factor;
112         delete noise_height;
113         delete noise_cave1;
114         delete noise_cave2;
115         delete noise_ground;
116
117         delete noise_heat;
118         delete noise_humidity;
119
120         delete[] heightmap;
121         delete[] biomemap;
122 }
123
124
125 MapgenV5Params::MapgenV5Params()
126 {
127         spflags = 0;
128
129         np_filler_depth = NoiseParams(0, 1,  v3f(150, 150, 150), 261,    4, 0.7,  2.0);
130         np_factor       = NoiseParams(0, 1,  v3f(250, 250, 250), 920381, 3, 0.45, 2.0);
131         np_height       = NoiseParams(0, 10, v3f(250, 250, 250), 84174,  4, 0.5,  2.0);
132         np_cave1        = NoiseParams(0, 12, v3f(50,  50,  50),  52534,  4, 0.5,  2.0);
133         np_cave2        = NoiseParams(0, 12, v3f(50,  50,  50),  10325,  4, 0.5,  2.0);
134         np_ground       = NoiseParams(0, 40, v3f(80,  80,  80),  983240, 4, 0.55, 2.0, NOISE_FLAG_EASED);
135 }
136
137
138 //#define CAVE_NOISE_SCALE 12.0
139 //#define CAVE_NOISE_THRESHOLD (1.5/CAVE_NOISE_SCALE) = 0.125
140
141
142 void MapgenV5Params::readParams(const Settings *settings)
143 {
144         settings->getFlagStrNoEx("mgv5_spflags", spflags, flagdesc_mapgen_v5);
145
146         settings->getNoiseParams("mgv5_np_filler_depth", np_filler_depth);
147         settings->getNoiseParams("mgv5_np_factor",       np_factor);
148         settings->getNoiseParams("mgv5_np_height",       np_height);
149         settings->getNoiseParams("mgv5_np_cave1",        np_cave1);
150         settings->getNoiseParams("mgv5_np_cave2",        np_cave2);
151         settings->getNoiseParams("mgv5_np_ground",       np_ground);
152 }
153
154
155 void MapgenV5Params::writeParams(Settings *settings) const
156 {
157         settings->setFlagStr("mgv5_spflags", spflags, flagdesc_mapgen_v5, (u32)-1);
158
159         settings->setNoiseParams("mgv5_np_filler_depth", np_filler_depth);
160         settings->setNoiseParams("mgv5_np_factor",       np_factor);
161         settings->setNoiseParams("mgv5_np_height",       np_height);
162         settings->setNoiseParams("mgv5_np_cave1",        np_cave1);
163         settings->setNoiseParams("mgv5_np_cave2",        np_cave2);
164         settings->setNoiseParams("mgv5_np_ground",       np_ground);
165 }
166
167
168 int MapgenV5::getGroundLevelAtPoint(v2s16 p)
169 {
170         //TimeTaker t("getGroundLevelAtPoint", NULL, PRECISION_MICRO);
171
172         float f = 0.55 + NoisePerlin2D(&noise_factor->np, p.X, p.Y, seed);
173         if (f < 0.01)
174                 f = 0.01;
175         else if (f >= 1.0)
176                 f *= 1.6;
177         float h = NoisePerlin2D(&noise_height->np, p.X, p.Y, seed);
178
179         s16 search_top = water_level + 15;
180         s16 search_base = water_level;
181
182         s16 level = -31000;
183         for (s16 y = search_top; y >= search_base; y--) {
184                 float n_ground = NoisePerlin3D(&noise_ground->np, p.X, y, p.Y, seed);
185                 if (n_ground * f > y - h) {
186                         if (y >= search_top - 7)
187                                 break;
188                         else
189                                 level = y;
190                                 break;
191                 }
192         }
193
194         //printf("getGroundLevelAtPoint: %dus\n", t.stop());
195         return level;
196 }
197
198
199 void MapgenV5::makeChunk(BlockMakeData *data)
200 {
201         // Pre-conditions
202         assert(data->vmanip);
203         assert(data->nodedef);
204         assert(data->blockpos_requested.X >= data->blockpos_min.X &&
205                 data->blockpos_requested.Y >= data->blockpos_min.Y &&
206                 data->blockpos_requested.Z >= data->blockpos_min.Z);
207         assert(data->blockpos_requested.X <= data->blockpos_max.X &&
208                 data->blockpos_requested.Y <= data->blockpos_max.Y &&
209                 data->blockpos_requested.Z <= data->blockpos_max.Z);
210
211         generating = true;
212         vm   = data->vmanip;
213         ndef = data->nodedef;
214         //TimeTaker t("makeChunk");
215
216         v3s16 blockpos_min = data->blockpos_min;
217         v3s16 blockpos_max = data->blockpos_max;
218         node_min = blockpos_min * MAP_BLOCKSIZE;
219         node_max = (blockpos_max + v3s16(1, 1, 1)) * MAP_BLOCKSIZE - v3s16(1, 1, 1);
220         full_node_min = (blockpos_min - 1) * MAP_BLOCKSIZE;
221         full_node_max = (blockpos_max + 2) * MAP_BLOCKSIZE - v3s16(1, 1, 1);
222
223         // Create a block-specific seed
224         blockseed = getBlockSeed2(full_node_min, seed);
225
226         // Make some noise
227         calculateNoise();
228
229         // Generate base terrain
230         s16 stone_surface_max_y = generateBaseTerrain();
231
232         // Create heightmap
233         updateHeightmap(node_min, node_max);
234
235         // Create biomemap at heightmap surface
236         bmgr->calcBiomes(csize.X, csize.Z, noise_heat->result,
237                 noise_humidity->result, heightmap, biomemap);
238
239         // Actually place the biome-specific nodes
240         MgStoneType stone_type = generateBiomes(noise_heat->result, noise_humidity->result);
241
242         // Generate caves
243         if ((flags & MG_CAVES) && (stone_surface_max_y >= node_min.Y))
244                 generateCaves(stone_surface_max_y);
245
246         // Generate dungeons and desert temples
247         if ((flags & MG_DUNGEONS) && (stone_surface_max_y >= node_min.Y)) {
248                 DungeonParams dp;
249
250                 dp.np_rarity  = nparams_dungeon_rarity;
251                 dp.np_density = nparams_dungeon_density;
252                 dp.np_wetness = nparams_dungeon_wetness;
253                 dp.c_water    = c_water_source;
254                 if (stone_type == STONE) {
255                         dp.c_cobble = c_cobble;
256                         dp.c_moss   = c_mossycobble;
257                         dp.c_stair  = c_stair_cobble;
258
259                         dp.diagonal_dirs = false;
260                         dp.mossratio     = 3.0;
261                         dp.holesize      = v3s16(1, 2, 1);
262                         dp.roomsize      = v3s16(0, 0, 0);
263                         dp.notifytype    = GENNOTIFY_DUNGEON;
264                 } else if (stone_type == DESERT_STONE) {
265                         dp.c_cobble = c_desert_stone;
266                         dp.c_moss   = c_desert_stone;
267                         dp.c_stair  = c_desert_stone;
268
269                         dp.diagonal_dirs = true;
270                         dp.mossratio     = 0.0;
271                         dp.holesize      = v3s16(2, 3, 2);
272                         dp.roomsize      = v3s16(2, 5, 2);
273                         dp.notifytype    = GENNOTIFY_TEMPLE;
274                 } else if (stone_type == SANDSTONE) {
275                         dp.c_cobble = c_sandstonebrick;
276                         dp.c_moss   = c_sandstonebrick;
277                         dp.c_stair  = c_sandstonebrick;
278
279                         dp.diagonal_dirs = false;
280                         dp.mossratio     = 0.0;
281                         dp.holesize      = v3s16(2, 2, 2);
282                         dp.roomsize      = v3s16(2, 0, 2);
283                         dp.notifytype    = GENNOTIFY_DUNGEON;
284                 }
285
286                 DungeonGen dgen(this, &dp);
287                 dgen.generate(blockseed, full_node_min, full_node_max);
288         }
289
290         // Generate the registered decorations
291         m_emerge->decomgr->placeAllDecos(this, blockseed, node_min, node_max);
292
293         // Generate the registered ores
294         m_emerge->oremgr->placeAllOres(this, blockseed, node_min, node_max);
295
296         // Sprinkle some dust on top after everything else was generated
297         dustTopNodes();
298
299         //printf("makeChunk: %dms\n", t.stop());
300
301         // Add top and bottom side of water to transforming_liquid queue
302         updateLiquid(&data->transforming_liquid, full_node_min, full_node_max);
303
304         // Calculate lighting
305         if (flags & MG_LIGHT) {
306                 calcLighting(node_min - v3s16(0, 1, 0), node_max + v3s16(0, 1, 0),
307                         full_node_min, full_node_max);
308         }
309
310         this->generating = false;
311 }
312
313
314 void MapgenV5::calculateNoise()
315 {
316         //TimeTaker t("calculateNoise", NULL, PRECISION_MICRO);
317         int x = node_min.X;
318         int y = node_min.Y - 1;
319         int z = node_min.Z;
320
321         noise_factor->perlinMap2D(x, z);
322         noise_height->perlinMap2D(x, z);
323         noise_ground->perlinMap3D(x, y, z);
324
325         if (flags & MG_CAVES) {
326                 noise_cave1->perlinMap3D(x, y, z);
327                 noise_cave2->perlinMap3D(x, y, z);
328         }
329
330         noise_filler_depth->perlinMap2D(x, z);
331         noise_heat->perlinMap2D(x, z);
332         noise_humidity->perlinMap2D(x, z);
333
334         //printf("calculateNoise: %dus\n", t.stop());
335 }
336
337
338 //bool is_cave(u32 index) {
339 //      double d1 = contour(noise_cave1->result[index]);
340 //      double d2 = contour(noise_cave2->result[index]);
341 //      return d1*d2 > CAVE_NOISE_THRESHOLD;
342 //}
343
344 //bool val_is_ground(v3s16 p, u32 index, u32 index2d) {
345 //      double f = 0.55 + noise_factor->result[index2d];
346 //      if(f < 0.01)
347 //              f = 0.01;
348 //      else if(f >= 1.0)
349 //              f *= 1.6;
350 //      double h = WATER_LEVEL + 10 * noise_height->result[index2d];
351 //      return (noise_ground->result[index] * f > (double)p.Y - h);
352 //}
353
354
355 int MapgenV5::generateBaseTerrain()
356 {
357         u32 index = 0;
358         u32 index2d = 0;
359         int stone_surface_max_y = -MAP_GENERATION_LIMIT;
360
361         for (s16 z=node_min.Z; z<=node_max.Z; z++) {
362                 for (s16 y=node_min.Y - 1; y<=node_max.Y + 1; y++) {
363                         u32 i = vm->m_area.index(node_min.X, y, z);
364                         for (s16 x=node_min.X; x<=node_max.X; x++, i++, index++, index2d++) {
365                                 if (vm->m_data[i].getContent() != CONTENT_IGNORE)
366                                         continue;
367
368                                 float f = 0.55 + noise_factor->result[index2d];
369                                 if (f < 0.01)
370                                         f = 0.01;
371                                 else if (f >= 1.0)
372                                         f *= 1.6;
373                                 float h = noise_height->result[index2d];
374
375                                 if (noise_ground->result[index] * f < y - h) {
376                                         if (y <= water_level)
377                                                 vm->m_data[i] = MapNode(c_water_source);
378                                         else
379                                                 vm->m_data[i] = MapNode(CONTENT_AIR);
380                                 } else {
381                                         vm->m_data[i] = MapNode(c_stone);
382                                         if (y > stone_surface_max_y)
383                                                 stone_surface_max_y = y;
384                                 }
385                         }
386                         index2d -= ystride;
387                 }
388                 index2d += ystride;
389         }
390
391         return stone_surface_max_y;
392 }
393
394
395 MgStoneType MapgenV5::generateBiomes(float *heat_map, float *humidity_map)
396 {
397         v3s16 em = vm->m_area.getExtent();
398         u32 index = 0;
399         MgStoneType stone_type = STONE;
400
401         for (s16 z = node_min.Z; z <= node_max.Z; z++)
402         for (s16 x = node_min.X; x <= node_max.X; x++, index++) {
403                 Biome *biome = NULL;
404                 u16 depth_top = 0;
405                 u16 base_filler = 0;
406                 u16 depth_water_top = 0;
407                 u32 vi = vm->m_area.index(x, node_max.Y, z);
408
409                 // Check node at base of mapchunk above, either a node of a previously
410                 // generated mapchunk or if not, a node of overgenerated base terrain.
411                 content_t c_above = vm->m_data[vi + em.X].getContent();
412                 bool air_above = c_above == CONTENT_AIR;
413                 bool water_above = c_above == c_water_source;
414
415                 // If there is air or water above enable top/filler placement, otherwise force
416                 // nplaced to stone level by setting a number exceeding any possible filler depth.
417                 u16 nplaced = (air_above || water_above) ? 0 : (u16)-1;
418
419                 for (s16 y = node_max.Y; y >= node_min.Y; y--) {
420                         content_t c = vm->m_data[vi].getContent();
421
422                         // Biome is recalculated each time an upper surface is detected while
423                         // working down a column. The selected biome then remains in effect for
424                         // all nodes below until the next surface and biome recalculation.
425                         // Biome is recalculated:
426                         // 1. At the surface of stone below air or water.
427                         // 2. At the surface of water below air.
428                         // 3. When stone or water is detected but biome has not yet been calculated.
429                         if ((c == c_stone && (air_above || water_above || !biome)) ||
430                                         (c == c_water_source && (air_above || !biome))) {
431                                 biome = bmgr->getBiome(heat_map[index], humidity_map[index], y);
432                                 depth_top = biome->depth_top;
433                                 base_filler = MYMAX(depth_top + biome->depth_filler
434                                                 + noise_filler_depth->result[index], 0);
435                                 depth_water_top = biome->depth_water_top;
436
437                                 // Detect stone type for dungeons during every biome calculation.
438                                 // This is more efficient than detecting per-node and will not
439                                 // miss any desert stone or sandstone biomes.
440                                 if (biome->c_stone == c_desert_stone)
441                                         stone_type = DESERT_STONE;
442                                 else if (biome->c_stone == c_sandstone)
443                                         stone_type = SANDSTONE;
444                         }
445
446                         if (c == c_stone) {
447                                 content_t c_below = vm->m_data[vi - em.X].getContent();
448
449                                 // If the node below isn't solid, make this node stone, so that
450                                 // any top/filler nodes above are structurally supported.
451                                 // This is done by aborting the cycle of top/filler placement
452                                 // immediately by forcing nplaced to stone level.
453                                 if (c_below == CONTENT_AIR || c_below == c_water_source)
454                                         nplaced = (u16)-1;
455
456                                 if (nplaced < depth_top) {
457                                         vm->m_data[vi] = MapNode(biome->c_top);
458                                         nplaced++;
459                                 } else if (nplaced < base_filler) {
460                                         vm->m_data[vi] = MapNode(biome->c_filler);
461                                         nplaced++;
462                                 } else {
463                                         vm->m_data[vi] = MapNode(biome->c_stone);
464                                 }
465
466                                 air_above = false;
467                                 water_above = false;
468                         } else if (c == c_water_source) {
469                                 vm->m_data[vi] = MapNode((y > (s32)(water_level - depth_water_top)) ?
470                                                 biome->c_water_top : biome->c_water);
471                                 nplaced = 0;  // Enable top/filler placement for next surface
472                                 air_above = false;
473                                 water_above = true;
474                         } else if (c == CONTENT_AIR) {
475                                 nplaced = 0;  // Enable top/filler placement for next surface
476                                 air_above = true;
477                                 water_above = false;
478                         } else {  // Possible various nodes overgenerated from neighbouring mapchunks
479                                 nplaced = (u16)-1;  // Disable top/filler placement
480                                 air_above = false;
481                                 water_above = false;
482                         }
483
484                         vm->m_area.add_y(em, vi, -1);
485                 }
486         }
487
488         return stone_type;
489 }
490
491
492 void MapgenV5::generateCaves(int max_stone_y)
493 {
494         u32 index = 0;
495         u32 index2d = 0;
496
497         for (s16 z=node_min.Z; z<=node_max.Z; z++) {
498                 for (s16 y=node_min.Y - 1; y<=node_max.Y + 1; y++) {
499                         u32 i = vm->m_area.index(node_min.X, y, z);
500                         for (s16 x=node_min.X; x<=node_max.X; x++, i++, index++, index2d++) {
501                                 float d1 = contour(noise_cave1->result[index]);
502                                 float d2 = contour(noise_cave2->result[index]);
503                                 if (d1*d2 > 0.125) {
504                                         Biome *biome = (Biome *)bmgr->getRaw(biomemap[index2d]);
505                                         content_t c = vm->m_data[i].getContent();
506                                         if (!ndef->get(c).is_ground_content || c == CONTENT_AIR ||
507                                                         (y <= water_level &&
508                                                         c != biome->c_stone &&
509                                                         c != c_stone))
510                                                 continue;
511
512                                         vm->m_data[i] = MapNode(CONTENT_AIR);
513                                 }
514                         }
515                         index2d -= ystride;
516                 }
517                 index2d += ystride;
518         }
519
520         if (node_max.Y > LARGE_CAVE_DEPTH)
521                 return;
522
523         PseudoRandom ps(blockseed + 21343);
524         u32 bruises_count = (ps.range(1, 4) == 1) ? ps.range(1, 2) : 0;
525         for (u32 i = 0; i < bruises_count; i++) {
526                 CaveV5 cave(this, &ps);
527                 cave.makeCave(node_min, node_max, max_stone_y);
528         }
529 }
530
531
532 void MapgenV5::dustTopNodes()
533 {
534         if (node_max.Y < water_level)
535                 return;
536
537         v3s16 em = vm->m_area.getExtent();
538         u32 index = 0;
539
540         for (s16 z = node_min.Z; z <= node_max.Z; z++)
541         for (s16 x = node_min.X; x <= node_max.X; x++, index++) {
542                 Biome *biome = (Biome *)bmgr->getRaw(biomemap[index]);
543
544                 if (biome->c_dust == CONTENT_IGNORE)
545                         continue;
546
547                 u32 vi = vm->m_area.index(x, full_node_max.Y, z);
548                 content_t c_full_max = vm->m_data[vi].getContent();
549                 s16 y_start;
550
551                 if (c_full_max == CONTENT_AIR) {
552                         y_start = full_node_max.Y - 1;
553                 } else if (c_full_max == CONTENT_IGNORE) {
554                         vi = vm->m_area.index(x, node_max.Y + 1, z);
555                         content_t c_max = vm->m_data[vi].getContent();
556
557                         if (c_max == CONTENT_AIR)
558                                 y_start = node_max.Y;
559                         else
560                                 continue;
561                 } else {
562                         continue;
563                 }
564
565                 vi = vm->m_area.index(x, y_start, z);
566                 for (s16 y = y_start; y >= node_min.Y - 1; y--) {
567                         if (vm->m_data[vi].getContent() != CONTENT_AIR)
568                                 break;
569
570                         vm->m_area.add_y(em, vi, -1);
571                 }
572
573                 content_t c = vm->m_data[vi].getContent();
574                 if (!ndef->get(c).buildable_to && c != CONTENT_IGNORE && c != biome->c_dust) {
575                         vm->m_area.add_y(em, vi, 1);
576                         vm->m_data[vi] = MapNode(biome->c_dust);
577                 }
578         }
579 }
580