1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "variables.h"

     6

#include "functions.h"

     7

#include "heightmap.h"

     8

#include "clear_map.h"

     9

#include "table/strings.h"

    10

#include "void_map.h"

    11

#include "debug.h"

    12

#include "gfx.h"

    13

#include "gui.h"

    14

#include "saveload.h"

    15

#include "bmp.h"

    16

#include "helpers.hpp"

    17

    18

/**

    19

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

    20

 *  (average luminosity formula) -- Dalestan

    21

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

    22

 */

    23

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

    24

{

    25

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

    26

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

    27

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

    28

}

    29

    30

    31

#ifdef WITH_PNG

    32

    33

#include "png.h"

    34

    35

/**

    36

 * The PNG Heightmap loader.

    37

 */

    38

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

    39

{

    40

	uint x, y;

    41

	byte gray_palette[256];

    42

	png_bytep *row_pointers = NULL;

    43

    44

	/* Get palette and convert it to grayscale */

    45

	if (info_ptr->color_type == PNG_COLOR_TYPE_PALETTE) {

    46

		int i;

    47

		int palette_size;

    48

		png_color *palette;

    49

		bool all_gray = true;

    50

    51

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

    52

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

    53

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

    54

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

    55

		}

    56

    57

		/**

    58

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

    59

		 * the order of the palette determines the height;

    60

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

    61

		 * level 1, etc.

    62

		 */

    63

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

    64

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

    65

				gray_palette[i] = 256 * i / palette_size;

    66

			}

    67

		}

    68

	}

    69

    70

	row_pointers = png_get_rows(png_ptr, info_ptr);

    71

    72

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

    73

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

    74

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

    75

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

    76

			uint x_offset = x * info_ptr->channels;

    77

    78

			if (info_ptr->color_type == PNG_COLOR_TYPE_PALETTE) {

    79

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

    80

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

    81

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

    82

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

    83

			} else {

    84

				*pixel = row_pointers[y][x_offset];

    85

			}

    86

		}

    87

	}

    88

}

    89

    90

/**

    91

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

    92

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

    93

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

    94

 */

    95

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

    96

{

    97

	FILE *fp;

    98

	png_structp png_ptr = NULL;

    99

	png_infop info_ptr  = NULL;

   100

   101

	fp = fopen(filename, "rb");

   102

	if (fp == NULL) {

   103

		ShowErrorMessage(STR_PNGMAP_ERR_FILE_NOT_FOUND, STR_PNGMAP_ERROR, 0, 0);

   104

		return false;

   105

	}

   106

   107

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

   108

	if (png_ptr == NULL) {

   109

		ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   110

		fclose(fp);

   111

		return false;

   112

	}

   113

   114

	info_ptr = png_create_info_struct(png_ptr);

   115

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

   116

		ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   117

		fclose(fp);

   118

		png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   119

		return false;

   120

	}

   121

   122

	png_init_io(png_ptr, fp);

   123

   124

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

   125

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

   126

	png_set_packing(png_ptr);

   127

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

   128

   129

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

   130

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

   131

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

   132

		ShowErrorMessage(STR_PNGMAP_ERR_IMAGE_TYPE, STR_PNGMAP_ERROR, 0, 0);

   133

		fclose(fp);

   134

		png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   135

		return false;

   136

	}

   137

   138

	if (map != NULL) {

   139

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

   140

   141

		if (*map == NULL) {

   142

			ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_PNGMAP_ERROR, 0, 0);

   143

			fclose(fp);

   144

			png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   145

			return false;

   146

		}

   147

   148

		ReadHeightmapPNGImageData(*map, png_ptr, info_ptr);

   149

	}

   150

   151

	*x = info_ptr->width;

   152

	*y = info_ptr->height;

   153

   154

	fclose(fp);

   155

	png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

   156

	return true;

   157

}

   158

   159

#endif /* WITH_PNG */

   160

   161

   162

/**

   163

 * The BMP Heightmap loader.

   164

 */

   165

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

   166

{

   167

	uint x, y;

   168

	byte gray_palette[256];

   169

   170

	if (data->palette != NULL) {

   171

		uint i;

   172

		bool all_gray = true;

   173

   174

		if (info->palette_size != 2) {

   175

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

   176

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

   177

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

   178

			}

   179

   180

			/**

   181

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

   182

			 * the order of the palette determines the height;

   183

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

   184

			 * level 1, etc.

   185

			 */

   186

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

   187

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

   188

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

   189

				}

   190

			}

   191

		} else {

   192

			/**

   193

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

   194

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

   195

			 */

   196

			gray_palette[0] = 0;

   197

			gray_palette[1] = 16;

   198

		}

   199

	}

   200

   201

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

   202

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

   203

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

   204

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

   205

   206

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

   207

			if (info->bpp != 24) {

   208

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

   209

			} else {

   210

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

   211

				bitmap += 3;

   212

			}

   213

		}

   214

	}

   215

}

   216

   217

/**

   218

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

   219

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

   220

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

   221

 */

   222

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

   223

{

   224

	FILE *f;

   225

	BmpInfo info;

   226

	BmpData data;

   227

	BmpBuffer buffer;

   228

   229

	// Init BmpData

   230

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

   231

   232

	f = fopen(filename, "rb");

   233

	if (f == NULL) {

   234

		ShowErrorMessage(STR_PNGMAP_ERR_FILE_NOT_FOUND, STR_BMPMAP_ERROR, 0, 0);

   235

		return false;

   236

	}

   237

   238

	BmpInitializeBuffer(&buffer, f);

   239

   240

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

   241

		ShowErrorMessage(STR_BMPMAP_ERR_IMAGE_TYPE, STR_BMPMAP_ERROR, 0, 0);

   242

		fclose(f);

   243

		BmpDestroyData(&data);

   244

		return false;

   245

	}

   246

   247

	if (map != NULL) {

   248

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

   249

			ShowErrorMessage(STR_BMPMAP_ERR_IMAGE_TYPE, STR_BMPMAP_ERROR, 0, 0);

   250

			fclose(f);

   251

			BmpDestroyData(&data);

   252

			return false;

   253

		}

   254

   255

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

   256

		if (*map == NULL) {

   257

			ShowErrorMessage(STR_PNGMAP_ERR_MISC, STR_BMPMAP_ERROR, 0, 0);

   258

			fclose(f);

   259

			BmpDestroyData(&data);

   260

			return false;

   261

		}

   262

   263

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

   264

   265

	}

   266

   267

	BmpDestroyData(&data);

   268

   269

	*x = info.width;

   270

	*y = info.height;

   271

   272

	fclose(f);

   273

	return true;

   274

}

   275

   276

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

   277

{

   278

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

   279

	const uint num_div = 16384;

   280

   281

	uint width, height;

   282

	uint row, col;

   283

	uint row_pad = 0, col_pad = 0;

   284

	uint img_scale;

   285

	uint img_row, img_col;

   286

	TileIndex tile;

   287

   288

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

   289

	switch (_patches.heightmap_rotation) {

   290

		default: NOT_REACHED();

   291

		case HM_COUNTER_CLOCKWISE:

   292

			width   = MapSizeX();

   293

			height  = MapSizeY();

   294

			break;

   295

		case HM_CLOCKWISE:

   296

			width   = MapSizeY();

   297

			height  = MapSizeX();

   298

			break;

   299

	}

   300

   301

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

   302

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

   303

		img_scale = (width * num_div) / img_width;

   304

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

   305

	} else {

   306

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

   307

		img_scale = (height * num_div) / img_height;

   308

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

   309

	}

   310

   311

	/* Form the landscape */

   312

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

   313

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

   314

			switch (_patches.heightmap_rotation) {

   315

				default: NOT_REACHED();

   316

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

   317

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

   318

			}

   319

   320

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

   321

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

   322

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

   323

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

   324

				SetTileHeight(tile, 0);

   325

			} else {

   326

				/* Use nearest neighbor resizing to scale map data.

   327

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

   328

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

   329

				switch (_patches.heightmap_rotation) {

   330

					default: NOT_REACHED();

   331

					case HM_COUNTER_CLOCKWISE:

   332

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

   333

						break;

   334

					case HM_CLOCKWISE:

   335

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

   336

						break;

   337

				}

   338

   339

				assert(img_row < img_height);

   340

				assert(img_col < img_width);

   341

   342

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

   343

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

   344

			}

   345

			MakeClear(tile, CLEAR_GRASS, 3);

   346

		}

   347

	}

   348

}

   349

   350

/**

   351

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

   352

 * more than 1 in height

   353

 */

   354

static void FixSlopes(void)

   355

{

   356

	uint width, height;

   357

	uint row, col;

   358

	byte current_tile;

   359

   360

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

   361

	width   = MapSizeX();

   362

	height  = MapSizeY();

   363

   364

	/* Top and left edge */

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

			}

   372

   373

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

   374

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

   375

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

   376

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

   377

			}

   378

		}

   379

	}

   380

   381

	/* Bottom and right edge */

   382

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

   383

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

   384

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

   385

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

   386

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

   387

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

   388

			}

   389

   390

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

   391

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

   392

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

   393

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

   394

			}

   395

		}

   396

	}

   397

}

   398

   399

/**

   400

 * Reads the heightmap with the correct file reader

   401

 */

   402

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

   403

{

   404

	switch (_file_to_saveload.mode) {

   405

		default: NOT_REACHED();

   406

#ifdef WITH_PNG

   407

		case SL_PNG:

   408

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

   409

#endif /* WITH_PNG */

   410

		case SL_BMP:

   411

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

   412

	}

   413

}

   414

   415

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

   416

{

   417

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

   418

}

   419

   420

void LoadHeightmap(char *filename)

   421

{

   422

	uint x, y;

   423

	byte *map = NULL;

   424

   425

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

   426

		free(map);

   427

		return;

   428

	}

   429

   430

	GrayscaleToMapHeights(x, y, map);

   431

	free(map);

   432

   433

	FixSlopes();

   434

	MarkWholeScreenDirty();

   435

}

   436

   437

void FlatEmptyWorld(byte tile_height)

   438

{

   439

	uint width, height;

   440

	uint row, col;

   441

   442

	width  = MapSizeX();

   443

	height = MapSizeY();

   444

   445

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

   446

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

   447

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

   448

		}

   449

	}

   450

   451

	FixSlopes();

   452

	MarkWholeScreenDirty();

   453

}