1

/* $Id$ */

     2

     3

/** @file heightmap.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "functions.h"

     9

#include "heightmap.h"

    10

#include "clear_map.h"

    11

#include "table/strings.h"

    12

#include "void_map.h"

    13

#include "debug.h"

    14

#include "gfx.h"

    15

#include "gui.h"

    16

#include "saveload.h"

    17

#include "bmp.h"

    18

#include "helpers.hpp"

    19

    20

/**

    21

 * Convert RGB colors to Grayscale using 29.9% Red, 58.7% Green, 11.4% Blue

    22

 *  (average luminosity formula) -- Dalestan

    23

 * This in fact is the NTSC Color Space -- TrueLight

    24

 */

    25

static inline byte RGBToGrayscale(byte red, byte green, byte blue)

    26

{

    27

	/* To avoid doubles and stuff, multiple it with a total of 65536 (16bits), then

    28

	 *  divide by it to normalize the value to a byte again. */

    29

	return ((red * 19595) + (green * 38470) + (blue * 7471)) / 65536;

    30

}

    31

    32

    33

#ifdef WITH_PNG

    34

    35

#include <png.h>

    36

    37

/**

    38

 * The PNG Heightmap loader.

    39

 */

    40

static void ReadHeightmapPNGImageData(byte *map, png_structp png_ptr, png_infop info_ptr)

    41

{

    42

	uint x, y;

    43

	byte gray_palette[256];

    44

	png_bytep *row_pointers = NULL;

    45

    46

	/* Get palette and convert it to grayscale */

    47

	if (info_ptr->color_type == PNG_COLOR_TYPE_PALETTE) {

    48

		int i;

    49

		int palette_size;

    50

		png_color *palette;

    51

		bool all_gray = true;

    52

    53

		png_get_PLTE(png_ptr, info_ptr, &palette, &palette_size);

    54

		for (i = 0; i < palette_size && (palette_size != 16 || all_gray); i++) {

    55

			all_gray &= palette[i].red == palette[i].green && palette[i].red == palette[i].blue;

    56

			gray_palette[i] = RGBToGrayscale(palette[i].red, palette[i].green, palette[i].blue);

    57

		}

    58

    59

		/**

    60

		 * For a non-gray palette of size 16 we assume that

    61

		 * the order of the palette determines the height;

    62

		 * the first entry is the sea (level 0), the second one

    63

		 * level 1, etc.

    64

		 */

    65

		if (palette_size == 16 && !all_gray) {

    66

			for (i = 0; i < palette_size; i++) {

    67

				gray_palette[i] = 256 * i / palette_size;

    68

			}

    69

		}

    70

	}

    71

    72

	row_pointers = png_get_rows(png_ptr, info_ptr);

    73

    74

	/* Read the raw image data and convert in 8-bit grayscale */

    75

	for (x = 0; x < info_ptr->width; x++) {

    76

		for (y = 0; y < info_ptr->height; y++) {

    77

			byte *pixel = &map[y * info_ptr->width + x];

    78

			uint x_offset = x * info_ptr->channels;

    79

    80

			if (info_ptr->color_type == PNG_COLOR_TYPE_PALETTE) {

    81

				*pixel = gray_palette[row_pointers[y][x_offset]];

    82

			} else if (info_ptr->channels == 3) {

    83

				*pixel = RGBToGrayscale(row_pointers[y][x_offset + 0],

    84

						row_pointers[y][x_offset + 1], row_pointers[y][x_offset + 2]);

    85

			} else {

    86

				*pixel = row_pointers[y][x_offset];

    87

			}

    88

		}

    89

	}

    90

}

    91

    92

/**

    93

 * Reads the heightmap and/or size of the heightmap from a PNG file.

    94

 * If map == NULL only the size of the PNG is read, otherwise a map

    95

 * with grayscale pixels is allocated and assigned to *map.

    96

 */

    97

static bool ReadHeightmapPNG(char *filename, uint *x, uint *y, byte **map)

    98

{

    99

	FILE *fp;

   100

	png_structp png_ptr = NULL;

   101

	png_infop info_ptr  = NULL;

   102

   103

	fp = fopen(filename, "rb");

   104

	if (fp == NULL) {

   105

		ShowErrorMessage(STR_PNGMAP_ERR_FILE_NOT_FOUND, STR_PNGMAP_ERROR, 0, 0);

   106

		return false;

   107

	}

   108

   109

	png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);

   110

	if (png_ptr == NULL) {

   111

		ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   112

		fclose(fp);

   113

		return false;

   114

	}

   115

   116

	info_ptr = png_create_info_struct(png_ptr);

   117

	if (info_ptr == NULL || setjmp(png_jmpbuf(png_ptr))) {

   118

		ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   119

		fclose(fp);

   120

		png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   121

		return false;

   122

	}

   123

   124

	png_init_io(png_ptr, fp);

   125

   126

	/* Allocate memory and read image, without alpha or 16-bit samples

   127

	 * (result is either 8-bit indexed/grayscale or 24-bit RGB) */

   128

	png_set_packing(png_ptr);

   129

	png_read_png(png_ptr, info_ptr, PNG_TRANSFORM_PACKING | PNG_TRANSFORM_STRIP_ALPHA | PNG_TRANSFORM_STRIP_16, NULL);

   130

   131

	/* Maps of wrong color-depth are not used.

   132

	 * (this should have been taken care of by stripping alpha and 16-bit samples on load) */

   133

	if ((info_ptr->channels != 1) && (info_ptr->channels != 3) && (info_ptr->bit_depth != 8)) {

   134

		ShowErrorMessage(STR_PNGMAP_ERR_IMAGE_TYPE, STR_PNGMAP_ERROR, 0, 0);

   135

		fclose(fp);

   136

		png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   137

		return false;

   138

	}

   139

   140

	if (map != NULL) {

   141

		*map = MallocT<byte>(info_ptr->width * info_ptr->height);

   142

   143

		if (*map == NULL) {

   144

			ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   145

			fclose(fp);

   146

			png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   147

			return false;

   148

		}

   149

   150

		ReadHeightmapPNGImageData(*map, png_ptr, info_ptr);

   151

	}

   152

   153

	*x = info_ptr->width;

   154

	*y = info_ptr->height;

   155

   156

	fclose(fp);

   157

	png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   158

	return true;

   159

}

   160

   161

#endif /* WITH_PNG */

   162

   163

   164

/**

   165

 * The BMP Heightmap loader.

   166

 */

   167

static void ReadHeightmapBMPImageData(byte *map, BmpInfo *info, BmpData *data)

   168

{

   169

	uint x, y;

   170

	byte gray_palette[256];

   171

   172

	if (data->palette != NULL) {

   173

		uint i;

   174

		bool all_gray = true;

   175

   176

		if (info->palette_size != 2) {

   177

			for (i = 0; i < info->palette_size && (info->palette_size != 16 || all_gray); i++) {

   178

				all_gray &= data->palette[i].r == data->palette[i].g && data->palette[i].r == data->palette[i].b;

   179

				gray_palette[i] = RGBToGrayscale(data->palette[i].r, data->palette[i].g, data->palette[i].b);

   180

			}

   181

   182

			/**

   183

			 * For a non-gray palette of size 16 we assume that

   184

			 * the order of the palette determines the height;

   185

			 * the first entry is the sea (level 0), the second one

   186

			 * level 1, etc.

   187

			 */

   188

			if (info->palette_size == 16 && !all_gray) {

   189

				for (i = 0; i < info->palette_size; i++) {

   190

					gray_palette[i] = 256 * i / info->palette_size;

   191

				}

   192

			}

   193

		} else {

   194

			/**

   195

			 * For a palette of size 2 we assume that the order of the palette determines the height;

   196

			 * the first entry is the sea (level 0), the second one is the land (level 1)

   197

			 */

   198

			gray_palette[0] = 0;

   199

			gray_palette[1] = 16;

   200

		}

   201

	}

   202

   203

	/* Read the raw image data and convert in 8-bit grayscale */

   204

	for (y = 0; y < info->height; y++) {

   205

		byte *pixel = &map[y * info->width];

   206

		byte *bitmap = &data->bitmap[y * info->width * (info->bpp == 24 ? 3 : 1)];

   207

   208

		for (x = 0; x < info->width; x++) {

   209

			if (info->bpp != 24) {

   210

				*pixel++ = gray_palette[*bitmap++];

   211

			} else {

   212

				*pixel++ = RGBToGrayscale(*bitmap, *(bitmap + 1), *(bitmap + 2));

   213

				bitmap += 3;

   214

			}

   215

		}

   216

	}

   217

}

   218

   219

/**

   220

 * Reads the heightmap and/or size of the heightmap from a BMP file.

   221

 * If map == NULL only the size of the BMP is read, otherwise a map

   222

 * with grayscale pixels is allocated and assigned to *map.

   223

 */

   224

static bool ReadHeightmapBMP(char *filename, uint *x, uint *y, byte **map)

   225

{

   226

	FILE *f;

   227

	BmpInfo info;

   228

	BmpData data;

   229

	BmpBuffer buffer;

   230

   231

	/* Init BmpData */

   232

	memset(&data, 0, sizeof(data));

   233

   234

	f = fopen(filename, "rb");

   235

	if (f == NULL) {

   236

		ShowErrorMessage(STR_PNGMAP_ERR_FILE_NOT_FOUND, STR_BMPMAP_ERROR, 0, 0);

   237

		return false;

   238

	}

   239

   240

	BmpInitializeBuffer(&buffer, f);

   241

   242

	if (!BmpReadHeader(&buffer, &info, &data)) {

   243

		ShowErrorMessage(STR_BMPMAP_ERR_IMAGE_TYPE, STR_BMPMAP_ERROR, 0, 0);

   244

		fclose(f);

   245

		BmpDestroyData(&data);

   246

		return false;

   247

	}

   248

   249

	if (map != NULL) {

   250

		if (!BmpReadBitmap(&buffer, &info, &data)) {

   251

			ShowErrorMessage(STR_BMPMAP_ERR_IMAGE_TYPE, STR_BMPMAP_ERROR, 0, 0);

   252

			fclose(f);

   253

			BmpDestroyData(&data);

   254

			return false;

   255

		}

   256

   257

		*map = MallocT<byte>(info.width * info.height);

   258

		if (*map == NULL) {

   259

			ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_BMPMAP_ERROR, 0, 0);

   260

			fclose(f);

   261

			BmpDestroyData(&data);

   262

			return false;

   263

		}

   264

   265

		ReadHeightmapBMPImageData(*map, &info, &data);

   266

   267

	}

   268

   269

	BmpDestroyData(&data);

   270

   271

	*x = info.width;

   272

	*y = info.height;

   273

   274

	fclose(f);

   275

	return true;

   276

}

   277

   278

/**

   279

 * Converts a given grayscale map to something that fits in OTTD map system

   280

 * and create a map of that data.

   281

 * @param img_width  the with of the image in pixels/tiles

   282

 * @param img_height the height of the image in pixels/tiles

   283

 * @param map        the input map

   284

 */

   285

static void GrayscaleToMapHeights(uint img_width, uint img_height, byte *map)

   286

{

   287

	/* Defines the detail of the aspect ratio (to avoid doubles) */

   288

	const uint num_div = 16384;

   289

   290

	uint width, height;

   291

	uint row, col;

   292

	uint row_pad = 0, col_pad = 0;

   293

	uint img_scale;

   294

	uint img_row, img_col;

   295

	TileIndex tile;

   296

   297

	/* Get map size and calculate scale and padding values */

   298

	switch (_patches.heightmap_rotation) {

   299

		default: NOT_REACHED();

   300

		case HM_COUNTER_CLOCKWISE:

   301

			width   = MapSizeX();

   302

			height  = MapSizeY();

   303

			break;

   304

		case HM_CLOCKWISE:

   305

			width   = MapSizeY();

   306

			height  = MapSizeX();

   307

			break;

   308

	}

   309

   310

	if ((img_width * num_div) / img_height > ((width * num_div) / height)) {

   311

		/* Image is wider than map - center vertically */

   312

		img_scale = (width * num_div) / img_width;

   313

		row_pad = (1 + height - ((img_height * img_scale) / num_div)) / 2;

   314

	} else {

   315

		/* Image is taller than map - center horizontally */

   316

		img_scale = (height * num_div) / img_height;

   317

		col_pad = (1 + width - ((img_width * img_scale) / num_div)) / 2;

   318

	}

   319

   320

	/* Form the landscape */

   321

	for (row = 0; row < height - 1; row++) {

   322

		for (col = 0; col < width - 1; col++) {

   323

			switch (_patches.heightmap_rotation) {

   324

				default: NOT_REACHED();

   325

				case HM_COUNTER_CLOCKWISE: tile = TileXY(col, row); break;

   326

				case HM_CLOCKWISE:         tile = TileXY(row, col); break;

   327

			}

   328

   329

			/* Check if current tile is within the 1-pixel map edge or padding regions */

   330

			if ((DistanceFromEdge(tile) <= 1) ||

   331

					(row < row_pad) || (row >= (height - row_pad - 1)) ||

   332

					(col < col_pad) || (col >= (width  - col_pad - 1))) {

   333

				SetTileHeight(tile, 0);

   334

			} else {

   335

				/* Use nearest neighbor resizing to scale map data.

   336

				 *  We rotate the map 45 degrees (counter)clockwise */

   337

				img_row = (((row - row_pad) * num_div) / img_scale);

   338

				switch (_patches.heightmap_rotation) {

   339

					default: NOT_REACHED();

   340

					case HM_COUNTER_CLOCKWISE:

   341

						img_col = (((width - 1 - col - col_pad) * num_div) / img_scale);

   342

						break;

   343

					case HM_CLOCKWISE:

   344

						img_col = (((col - col_pad) * num_div) / img_scale);

   345

						break;

   346

				}

   347

   348

				assert(img_row < img_height);

   349

				assert(img_col < img_width);

   350

   351

				/* Color scales from 0 to 255, OpenTTD height scales from 0 to 15 */

   352

				SetTileHeight(tile, map[img_row * img_width + img_col] / 16);

   353

			}

   354

			MakeClear(tile, CLEAR_GRASS, 3);

   355

		}

   356

	}

   357

}

   358

   359

/**

   360

 * This function takes care of the fact that land in OpenTTD can never differ

   361

 * more than 1 in height

   362

 */

   363

static void FixSlopes()

   364

{

   365

	uint width, height;

   366

	uint row, col;

   367

	byte current_tile;

   368

   369

	/* Adjust height difference to maximum one horizontal/vertical change. */

   370

	width   = MapSizeX();

   371

	height  = MapSizeY();

   372

   373

	/* Top and left edge */

   374

	for (row = 1; row < height - 2; row++) {

   375

		for (col = 1; col < width - 2; col++) {

   376

			/* Find lowest tile; either the top or left one */

   377

			current_tile = TileHeight(TileXY(col - 1, row)); // top edge

   378

			if (TileHeight(TileXY(col, row - 1)) < current_tile) {

   379

				current_tile = TileHeight(TileXY(col, row - 1)); // left edge

   380

			}

   381

   382

			/* Does the height differ more than one? */

   383

			if (TileHeight(TileXY(col, row)) >= (uint)current_tile + 2) {

   384

				/* Then change the height to be no more than one */

   385

				SetTileHeight(TileXY(col, row), current_tile + 1);

   386

			}

   387

		}

   388

	}

   389

   390

	/* Bottom and right edge */

   391

	for (row = height - 2; row > 0; row--) {

   392

		for (col = width - 2; col > 0; col--) {

   393

			/* Find lowest tile; either the bottom and right one */

   394

			current_tile = TileHeight(TileXY(col + 1, row)); // bottom edge

   395

			if (TileHeight(TileXY(col, row + 1)) < current_tile) {

   396

				current_tile = TileHeight(TileXY(col, row + 1)); // right edge

   397

			}

   398

   399

			/* Does the height differ more than one? */

   400

			if (TileHeight(TileXY(col, row)) >= (uint)current_tile + 2) {

   401

				/* Then change the height to be no more than one */

   402

				SetTileHeight(TileXY(col, row), current_tile + 1);

   403

			}

   404

		}

   405

	}

   406

}

   407

   408

/**

   409

 * Reads the heightmap with the correct file reader

   410

 */

   411

static bool ReadHeightMap(char *filename, uint *x, uint *y, byte **map)

   412

{

   413

	switch (_file_to_saveload.mode) {

   414

		default: NOT_REACHED();

   415

#ifdef WITH_PNG

   416

		case SL_PNG:

   417

			return ReadHeightmapPNG(filename, x, y, map);

   418

#endif /* WITH_PNG */

   419

		case SL_BMP:

   420

			return ReadHeightmapBMP(filename, x, y, map);

   421

	}

   422

}

   423

   424

bool GetHeightmapDimensions(char *filename, uint *x, uint *y)

   425

{

   426

	return ReadHeightMap(filename, x, y, NULL);

   427

}

   428

   429

void LoadHeightmap(char *filename)

   430

{

   431

	uint x, y;

   432

	byte *map = NULL;

   433

   434

	if (!ReadHeightMap(filename, &x, &y, &map)) {

   435

		free(map);

   436

		return;

   437

	}

   438

   439

	GrayscaleToMapHeights(x, y, map);

   440

	free(map);

   441

   442

	FixSlopes();

   443

	MarkWholeScreenDirty();

   444

}

   445

   446

void FlatEmptyWorld(byte tile_height)

   447

{

   448

	uint width, height;

   449

	uint row, col;

   450

   451

	width  = MapSizeX();

   452

	height = MapSizeY();

   453

   454

	for (row = 2; row < height - 2; row++) {

   455

		for (col = 2; col < width - 2; col++) {

   456

			SetTileHeight(TileXY(col, row), tile_height);

   457

		}

   458

	}

   459

   460

	FixSlopes();

   461

	MarkWholeScreenDirty();

   462

}