1

/* $Id$ */

     2

     3

/** @file newgrf.cpp */

     4

     5

#include "stdafx.h"

     6

     7

#include <stdarg.h>

     8

     9

#include "openttd.h"

    10

#include "debug.h"

    11

#include "fileio.h"

    12

#include "engine.h"

    13

#include "spritecache.h"

    14

#include "station.h"

    15

#include "sprite.h"

    16

#include "newgrf.h"

    17

#include "variables.h"

    18

#include "bridge.h"

    19

#include "town.h"

    20

#include "newgrf_engine.h"

    21

#include "newgrf_text.h"

    22

#include "fontcache.h"

    23

#include "currency.h"

    24

#include "landscape.h"

    25

#include "newgrf_config.h"

    26

#include "newgrf_house.h"

    27

#include "newgrf_sound.h"

    28

#include "newgrf_spritegroup.h"

    29

#include "cargotype.h"

    30

#include "industry.h"

    31

#include "newgrf_canal.h"

    32

#include "newgrf_commons.h"

    33

#include "newgrf_townname.h"

    34

#include "newgrf_industries.h"

    35

#include "gfxinit.h"

    36

#include "fios.h"

    37

#include "rail.h"

    38

#include "strings_func.h"

    39

#include "gfx_func.h"

    40

#include "date_func.h"

    41

#include "vehicle_func.h"

    42

#include "sound_func.h"

    43

#include "string_func.h"

    44

#include "road_func.h"

    45

#include "player_base.h"

    46

#include "settings_type.h"

    47

#include "map_func.h"

    48

    49

#include "table/strings.h"

    50

#include "table/sprites.h"

    51

#include "table/town_land.h"

    52

#include "table/build_industry.h"

    53

#include "table/landscape_sprite.h"

    54

    55

/* TTDPatch extended GRF format codec

    56

 * (c) Petr Baudis 2004 (GPL'd)

    57

 * Changes by Florian octo Forster are (c) by the OpenTTD development team.

    58

 *

    59

 * Contains portions of documentation by TTDPatch team.

    60

 * Thanks especially to Josef Drexler for the documentation as well as a lot

    61

 * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which

    62

 * served as subject to the initial testing of this codec. */

    63

    64

    65

static int _skip_sprites; // XXX

    66

static uint _file_index; // XXX

    67

    68

static GRFFile *_cur_grffile;

    69

GRFFile *_first_grffile;

    70

static SpriteID _cur_spriteid;

    71

static GrfLoadingStage _cur_stage;

    72

static uint32 _nfo_line;

    73

    74

static GRFConfig *_cur_grfconfig;

    75

    76

/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */

    77

static byte _misc_grf_features = 0;

    78

    79

/* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */

    80

static uint32 _ttdpatch_flags[8];

    81

    82

/* Used by Action 0x06 to preload a pseudo sprite and modify its content */

    83

static byte *_preload_sprite = NULL;

    84

    85

/* Indicates which are the newgrf features currently loaded ingame */

    86

GRFLoadedFeatures _loaded_newgrf_features;

    87

    88

enum GrfDataType {

    89

	GDT_SOUND,

    90

};

    91

    92

static byte _grf_data_blocks;

    93

static GrfDataType _grf_data_type;

    94

    95

    96

typedef void (*SpecialSpriteHandler)(byte *buf, int len);

    97

    98

static const uint _vehcounts[4] = {

    99

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   100

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   101

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   102

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   103

};

   104

   105

static const uint _vehshifts[4] = {

   106

	/* GSF_TRAIN */    0,

   107

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   108

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   109

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   110

};

   111

   112

enum {

   113

	MAX_STATIONS = 256,

   114

};

   115

   116

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   117

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   118

   119

/* Contains the GRF ID of the owner of a vehicle if it has been reserved */

   120

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   121

   122

/* Contains the GRF ID of the owner of a cargo if it has been reserved */

   123

static uint32 _grm_cargos[NUM_CARGO];

   124

   125

/** DEBUG() function dedicated to newGRF debugging messages

   126

 * Function is essentialy the same as DEBUG(grf, severity, ...) with the

   127

 * addition of file:line information when parsing grf files.

   128

 * NOTE: for the above reason(s) grfmsg() should ONLY be used for

   129

 * loading/parsing grf files, not for runtime debug messages as there

   130

 * is no file information available during that time.

   131

 * @param severity debugging severity level, see debug.h

   132

 * @param str message in printf() format */

   133

void CDECL grfmsg(int severity, const char *str, ...)

   134

{

   135

	char buf[1024];

   136

	va_list va;

   137

   138

	va_start(va, str);

   139

	vsnprintf(buf, sizeof(buf), str, va);

   140

	va_end(va);

   141

   142

	DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf);

   143

}

   144

   145

static inline bool check_length(int real, int wanted, const char *str)

   146

{

   147

	if (real >= wanted) return true;

   148

	grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted);

   149

	return false;

   150

}

   151

   152

static inline byte grf_load_byte(byte **buf)

   153

{

   154

	return *(*buf)++;

   155

}

   156

   157

static uint16 grf_load_word(byte **buf)

   158

{

   159

	uint16 val = grf_load_byte(buf);

   160

	return val | (grf_load_byte(buf) << 8);

   161

}

   162

   163

static uint16 grf_load_extended(byte** buf)

   164

{

   165

	uint16 val;

   166

	val = grf_load_byte(buf);

   167

	if (val == 0xFF) val = grf_load_word(buf);

   168

	return val;

   169

}

   170

   171

static uint32 grf_load_dword(byte **buf)

   172

{

   173

	uint32 val = grf_load_word(buf);

   174

	return val | (grf_load_word(buf) << 16);

   175

}

   176

   177

static uint32 grf_load_var(byte size, byte **buf)

   178

{

   179

	switch (size) {

   180

		case 1: return grf_load_byte(buf);

   181

		case 2: return grf_load_word(buf);

   182

		case 4: return grf_load_dword(buf);

   183

		default:

   184

			NOT_REACHED();

   185

			return 0;

   186

	}

   187

}

   188

   189

static const char *grf_load_string(byte **buf, size_t max_len)

   190

{

   191

	const char *string   = *(const char **)buf;

   192

	size_t string_length = ttd_strnlen(string, max_len);

   193

   194

	if (string_length == max_len) {

   195

		/* String was not NUL terminated, so make sure it is now. */

   196

		(*buf)[string_length - 1] = '\0';

   197

		grfmsg(7, "String was not terminated with a zero byte.");

   198

	} else {

   199

		/* Increase the string length to include the NUL byte. */

   200

		string_length++;

   201

	}

   202

	*buf += string_length;

   203

   204

	return string;

   205

}

   206

   207

static GRFFile *GetFileByGRFID(uint32 grfid)

   208

{

   209

	GRFFile *file;

   210

   211

	for (file = _first_grffile; file != NULL; file = file->next) {

   212

		if (file->grfid == grfid) break;

   213

	}

   214

	return file;

   215

}

   216

   217

static GRFFile *GetFileByFilename(const char *filename)

   218

{

   219

	GRFFile *file;

   220

   221

	for (file = _first_grffile; file != NULL; file = file->next) {

   222

		if (strcmp(file->filename, filename) == 0) break;

   223

	}

   224

	return file;

   225

}

   226

   227

   228

/** Used when setting an object's property to map to the GRF's strings

   229

 * while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one

   230

 * @param grfid Id of the grf file

   231

 * @param str StringID that we want to have the equivalent in OoenTTD

   232

 * @return the properly adjusted StringID

   233

 */

   234

StringID MapGRFStringID(uint32 grfid, StringID str)

   235

{

   236

	/* StringID table for TextIDs 0x4E->0x6D */

   237

	static StringID units_volume[] = {

   238

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   239

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   240

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   241

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   242

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   243

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   244

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   245

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   246

	};

   247

   248

	/* 0xD0 and 0xDC stand for all the TextIDs in the range

   249

	 * of 0xD000 (misc graphics texts) and 0xDC00 (misc persistent texts).

   250

	 * These strings are unique to each grf file, and thus require to be used with the

   251

	 * grfid in which they are declared */

   252

	switch (GB(str, 8, 8)) {

   253

		case 0xD0: case 0xD1: case 0xD2: case 0xD3:

   254

		case 0xDC:

   255

			return GetGRFStringID(grfid, str);

   256

   257

		case 0xD4: case 0xD5: case 0xD6: case 0xD7:

   258

			/* Strings embedded via 0x81 have 0x400 added to them (no real

   259

			 * explanation why...) */

   260

			return GetGRFStringID(grfid, str - 0x400);

   261

   262

		default: break;

   263

	}

   264

   265

#define TEXID_TO_STRINGID(begin, end, stringid) if (str >= begin && str <= end) return str + (stringid - begin)

   266

	/* We have some changes in our cargo strings, resulting in some missing. */

   267

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   268

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   269

	if (str >= 0x004E && str <= 0x006D) str = units_volume[str - 0x004E];

   270

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   271

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   272

   273

	/* Map building names according to our lang file changes. There are several

   274

	 * ranges of house ids, all of which need to be remapped to allow newgrfs

   275

	 * to use original house names. */

   276

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   277

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   278

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   279

   280

	/* Same thing for industries, since the introduction of 4 new strings above STR_482A_PRODUCTION_LAST_MONTH */

   281

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   282

#undef TEXTID_TO_STRINGID

   283

   284

	if (str == STR_NULL) return STR_EMPTY;

   285

   286

	return str;

   287

}

   288

   289

static uint8 MapDOSColour(uint8 colour)

   290

{

   291

	if (_use_dos_palette) return colour;

   292

   293

	if (colour < 10) {

   294

		static uint8 dos_to_win_colour_map[] = { 0, 215, 216, 136, 88, 106, 32, 33, 40, 245 };

   295

		return dos_to_win_colour_map[colour];

   296

	}

   297

   298

	if (colour >= 245 && colour < 254) return colour - 28;

   299

   300

	return colour;

   301

}

   302

   303

/** Map the colour modifiers of TTDPatch to those that Open is using.

   304

 * @param grf_sprite pointer to the structure been modified

   305

 */

   306

static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)

   307

{

   308

	if (HasBit(grf_sprite->pal, 14)) {

   309

		ClrBit(grf_sprite->pal, 14);

   310

		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);

   311

	}

   312

   313

	if (HasBit(grf_sprite->sprite, 14)) {

   314

		ClrBit(grf_sprite->sprite, 14);

   315

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);

   316

	}

   317

   318

	if (HasBit(grf_sprite->sprite, 15)) {

   319

		ClrBit(grf_sprite->sprite, 15);

   320

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);

   321

	}

   322

}

   323

   324

typedef bool (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len);

   325

   326

static void dewagonize(int condition, int engine)

   327

{

   328

	EngineInfo *ei = &_engine_info[engine];

   329

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   330

   331

	if (condition != 0) {

   332

		ei->unk2 &= ~0x80;

   333

		if (rvi->railveh_type == RAILVEH_WAGON)

   334

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   335

	} else {

   336

		ei->unk2 |= 0x80;

   337

		rvi->railveh_type = RAILVEH_WAGON;

   338

	}

   339

}

   340

   341

static bool RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)

   342

{

   343

	byte *buf = *bufp;

   344

	bool ret = false;

   345

   346

	for (int i = 0; i < numinfo; i++) {

   347

		EngineInfo *ei       = &_engine_info[engine + i];

   348

		RailVehicleInfo *rvi = &_rail_vehicle_info[engine + i];

   349

   350

		switch (prop) {

   351

			case 0x05: { // Track type

   352

				uint8 tracktype = grf_load_byte(&buf);

   353

   354

				switch (tracktype) {

   355

					case 0: rvi->railtype = rvi->engclass >= 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   356

					case 1: rvi->railtype = RAILTYPE_MONO; break;

   357

					case 2: rvi->railtype = RAILTYPE_MAGLEV; break;

   358

					default:

   359

						grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);

   360

						break;

   361

				}

   362

			} break;

   363

   364

			case 0x08: // AI passenger service

   365

				/* Tells the AI that this engine is designed for

   366

				 * passenger services and shouldn't be used for freight. */

   367

				rvi->ai_passenger_only = grf_load_byte(&buf);

   368

				break;

   369

   370

			case 0x09: { // Speed (1 unit is 1 kmh)

   371

				uint16 speed = grf_load_word(&buf);

   372

				if (speed == 0xFFFF) speed = 0;

   373

   374

				rvi->max_speed = speed;

   375

			} break;

   376

   377

			case 0x0B: { // Power

   378

				uint16 power = grf_load_word(&buf);

   379

   380

				if (rvi->railveh_type == RAILVEH_MULTIHEAD) power /= 2;

   381

   382

				rvi->power = power;

   383

				dewagonize(power, engine + i);

   384

			} break;

   385

   386

			case 0x0D: { // Running cost factor

   387

				uint8 runcostfact = grf_load_byte(&buf);

   388

   389

				if (rvi->railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2;

   390

   391

				rvi->running_cost = runcostfact;

   392

			} break;

   393

   394

			case 0x0E: { // Running cost base

   395

				uint32 base = grf_load_dword(&buf);

   396

   397

				/* These magic numbers are used in GRFs to specify the base cost:

   398

				 * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts

   399

				 */

   400

				if (base == 0) {

   401

					rvi->running_cost_class = 0xFF;

   402

				} else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) {

   403

					grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base);

   404

				} else {

   405

					/* Convert the magic number to an index into the price data */

   406

					rvi->running_cost_class = (base - 0x4B34) / 6;

   407

				}

   408

			} break;

   409

   410

			case 0x12: { // Sprite ID

   411

				uint8 spriteid = grf_load_byte(&buf);

   412

   413

				/* TTD sprite IDs point to a location in a 16bit array, but we use it

   414

				 * as an array index, so we need it to be half the original value. */

   415

				if (spriteid < 0xFD) spriteid >>= 1;

   416

   417

				rvi->image_index = spriteid;

   418

			} break;

   419

   420

			case 0x13: { // Dual-headed

   421

				uint8 dual = grf_load_byte(&buf);

   422

   423

				if (dual != 0) {

   424

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   425

						// adjust power and running cost if needed

   426

						rvi->power /= 2;

   427

						rvi->running_cost /= 2;

   428

					}

   429

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   430

				} else {

   431

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   432

						// adjust power and running cost if needed

   433

						rvi->power *= 2;

   434

						rvi->running_cost *= 2;

   435

					}

   436

					rvi->railveh_type = rvi->power == 0 ?

   437

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   438

				}

   439

			} break;

   440

   441

			case 0x14: // Cargo capacity

   442

				rvi->capacity = grf_load_byte(&buf);

   443

				break;

   444

   445

			case 0x15: { // Cargo type

   446

				uint8 ctype = grf_load_byte(&buf);

   447

   448

				if (ctype < NUM_CARGO && HasBit(_cargo_mask, ctype)) {

   449

					rvi->cargo_type = ctype;

   450

				} else {

   451

					rvi->cargo_type = CT_INVALID;

   452

					grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);

   453

				}

   454

			} break;

   455

   456

			case 0x16: // Weight

   457

				SB(rvi->weight, 0, 8, grf_load_byte(&buf));

   458

				break;

   459

   460

			case 0x17: // Cost factor

   461

				rvi->base_cost = grf_load_byte(&buf);

   462

				break;

   463

   464

			case 0x18: // AI rank

   465

				rvi->ai_rank = grf_load_byte(&buf);

   466

				break;

   467

   468

			case 0x19: { // Engine traction type

   469

				/* What do the individual numbers mean?

   470

				 * 0x00 .. 0x07: Steam

   471

				 * 0x08 .. 0x27: Diesel

   472

				 * 0x28 .. 0x31: Electric

   473

				 * 0x32 .. 0x37: Monorail

   474

				 * 0x38 .. 0x41: Maglev

   475

				 */

   476

				uint8 traction = grf_load_byte(&buf);

   477

				EngineClass engclass;

   478

   479

				if (traction <= 0x07) {

   480

					engclass = EC_STEAM;

   481

				} else if (traction <= 0x27) {

   482

					engclass = EC_DIESEL;

   483

				} else if (traction <= 0x31) {

   484

					engclass = EC_ELECTRIC;

   485

				} else if (traction <= 0x37) {

   486

					engclass = EC_MONORAIL;

   487