1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

     5

#include <stdarg.h>

     6

     7

#include "openttd.h"

     8

#include "debug.h"

     9

#include "gfx.h"

    10

#include "fileio.h"

    11

#include "functions.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 "string.h"

    19

#include "table/strings.h"

    20

#include "bridge.h"

    21

#include "economy.h"

    22

#include "newgrf_engine.h"

    23

#include "vehicle.h"

    24

#include "newgrf_text.h"

    25

#include "table/sprites.h"

    26

#include "fontcache.h"

    27

#include "date.h"

    28

#include "currency.h"

    29

#include "sound.h"

    30

#include "newgrf_config.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_spritegroup.h"

    33

#include "helpers.hpp"

    34

#include "cargotype.h"

    35

    36

/* TTDPatch extended GRF format codec

    37

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

    38

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

    39

 *

    40

 * Contains portions of documentation by TTDPatch team.

    41

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

    42

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

    43

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

    44

    45

    46

static int _skip_sprites; // XXX

    47

static uint _file_index; // XXX

    48

SpriteID _signal_base;

    49

SpriteID _coast_base;

    50

    51

static GRFFile *_cur_grffile;

    52

GRFFile *_first_grffile;

    53

static SpriteID _cur_spriteid;

    54

static GrfLoadingStage _cur_stage;

    55

static uint32 _nfo_line;

    56

    57

static GRFConfig *_cur_grfconfig;

    58

    59

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

    60

static byte _misc_grf_features = 0;

    61

    62

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

    63

static uint32 _ttdpatch_flags[8];

    64

    65

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

    66

static byte *_preload_sprite = NULL;

    67

    68

/* Set if any vehicle is loaded which uses 2cc (two company colours) */

    69

bool _have_2cc = false;

    70

    71

/* Default cargo translation table. By default there are 27 possible cargo types */

    72

static const uint _default_cargo_max = 27;

    73

static CargoLabel _default_cargo_list[_default_cargo_max];

    74

    75

    76

typedef enum GrfDataType {

    77

	GDT_SOUND,

    78

} GrfDataType;

    79

    80

static byte _grf_data_blocks;

    81

static GrfDataType _grf_data_type;

    82

    83

    84

typedef enum grfspec_feature {

    85

	GSF_TRAIN,

    86

	GSF_ROAD,

    87

	GSF_SHIP,

    88

	GSF_AIRCRAFT,

    89

	GSF_STATION,

    90

	GSF_CANAL,

    91

	GSF_BRIDGE,

    92

	GSF_TOWNHOUSE,

    93

	GSF_GLOBALVAR,

    94

	GSF_INDUSTRYTILES,

    95

	GSF_INDUSTRIES,

    96

	GSF_CARGOS,

    97

	GSF_SOUNDFX,

    98

} grfspec_feature;

    99

   100

   101

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

   102

   103

static const int _vehcounts[4] = {

   104

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   105

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   106

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   107

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   108

};

   109

   110

static const int _vehshifts[4] = {

   111

	/* GSF_TRAIN */    0,

   112

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   113

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   114

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   115

};

   116

   117

enum {

   118

	MAX_STATIONS = 256,

   119

};

   120

   121

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   122

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   123

   124

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

   125

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   126

   127

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

   128

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

   129

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

   130

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

   131

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

   132

 * is no file information available during that time.

   133

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

   134

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

   135

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

   136

{

   137

	char buf[1024];

   138

	va_list va;

   139

   140

	va_start(va, str);

   141

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

   142

	va_end(va);

   143

   144

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

   145

}

   146

   147

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

   148

{

   149

	if (real >= wanted) return true;

   150

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

   151

	return false;

   152

}

   153

   154

static inline byte grf_load_byte(byte **buf)

   155

{

   156

	return *(*buf)++;

   157

}

   158

   159

static uint16 grf_load_word(byte **buf)

   160

{

   161

	uint16 val = grf_load_byte(buf);

   162

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

   163

}

   164

   165

static uint16 grf_load_extended(byte** buf)

   166

{

   167

	uint16 val;

   168

	val = grf_load_byte(buf);

   169

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

   170

	return val;

   171

}

   172

   173

static uint32 grf_load_dword(byte **buf)

   174

{

   175

	uint32 val = grf_load_word(buf);

   176

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

   177

}

   178

   179

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

   180

{

   181

	switch (size) {

   182

		case 1: return grf_load_byte(buf);

   183

		case 2: return grf_load_word(buf);

   184

		case 4: return grf_load_dword(buf);

   185

		default:

   186

			NOT_REACHED();

   187

			return 0;

   188

	}

   189

}

   190

   191

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

   192

{

   193

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

   194

	size_t string_length = ttd_strnlen(string, max_len);

   195

   196

	if (string_length == max_len) {

   197

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

   198

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

   199

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

   200

	} else {

   201

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

   202

		string_length++;

   203

	}

   204

	*buf += string_length;

   205

   206

	return string;

   207

}

   208

   209

static GRFFile *GetFileByGRFID(uint32 grfid)

   210

{

   211

	GRFFile *file;

   212

   213

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

   214

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

   215

	}

   216

	return file;

   217

}

   218

   219

static GRFFile *GetFileByFilename(const char *filename)

   220

{

   221

	GRFFile *file;

   222

   223

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

   224

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

   225

	}

   226

	return file;

   227

}

   228

   229

   230

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

   231

   232

#define FOR_EACH_OBJECT for (i = 0; i < numinfo; i++)

   233

   234

static void dewagonize(int condition, int engine)

   235

{

   236

	EngineInfo *ei = &_engine_info[engine];

   237

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   238

   239

	if (condition != 0) {

   240

		ei->unk2 &= ~0x80;

   241

		if (rvi->railveh_type == RAILVEH_WAGON)

   242

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   243

	} else {

   244

		ei->unk2 |= 0x80;

   245

		rvi->railveh_type = RAILVEH_WAGON;

   246

	}

   247

}

   248

   249

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

   250

{

   251

	EngineInfo *ei = &_engine_info[engine];

   252

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   253

	byte *buf = *bufp;

   254

	int i;

   255

	bool ret = false;

   256

   257

	switch (prop) {

   258

		case 0x05: /* Track type */

   259

			FOR_EACH_OBJECT {

   260

				uint8 tracktype = grf_load_byte(&buf);

   261

   262

				switch (tracktype) {

   263

					case 0: rvi[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   264

					case 1: rvi[i].railtype = RAILTYPE_MONO; break;

   265

					case 2: rvi[i].railtype = RAILTYPE_MAGLEV; break;

   266

					default:

   267

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

   268

						break;

   269

				}

   270

			}

   271

			break;

   272

   273

		case 0x08: /* AI passenger service */

   274

			/* TODO */

   275

			FOR_EACH_OBJECT grf_load_byte(&buf);

   276

			ret = true;

   277

			break;

   278

   279

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

   280

			FOR_EACH_OBJECT {

   281

				uint16 speed = grf_load_word(&buf);

   282

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

   283

   284

				rvi[i].max_speed = speed;

   285

			}

   286

			break;

   287

   288

		case 0x0B: /* Power */

   289

			FOR_EACH_OBJECT {

   290

				uint16 power = grf_load_word(&buf);

   291

   292

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) power /= 2;

   293

   294

				rvi[i].power = power;

   295

				dewagonize(power, engine + i);

   296

			}

   297

			break;

   298

   299

		case 0x0D: /* Running cost factor */

   300

			FOR_EACH_OBJECT {

   301

				uint8 runcostfact = grf_load_byte(&buf);

   302

   303

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2;

   304

   305

				rvi[i].running_cost_base = runcostfact;

   306

			}

   307

			break;

   308

   309

		case 0x0E: /* Running cost base */

   310

			FOR_EACH_OBJECT {

   311

				uint32 base = grf_load_dword(&buf);

   312

   313

				switch (base) {

   314

					case 0x4C30: rvi[i].running_cost_class = 0; break;

   315

					case 0x4C36: rvi[i].running_cost_class = 1; break;

   316

					case 0x4C3C: rvi[i].running_cost_class = 2; break;

   317

					case 0: break; /* Used by wagons */

   318

					default:

   319

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

   320

						break;

   321

				}

   322

			}

   323

			break;

   324

   325

		case 0x12: /* Sprite ID */

   326

			FOR_EACH_OBJECT {

   327

				uint8 spriteid = grf_load_byte(&buf);

   328

   329

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

   330

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

   331

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

   332

   333

				rvi[i].image_index = spriteid;

   334

			}

   335

			break;

   336

   337

		case 0x13: /* Dual-headed */

   338

			FOR_EACH_OBJECT {

   339

				uint8 dual = grf_load_byte(&buf);

   340

   341

				if (dual != 0) {

   342

					if (rvi[i].railveh_type != RAILVEH_MULTIHEAD) {

   343

						// adjust power and running cost if needed

   344

						rvi[i].power /= 2;

   345

						rvi[i].running_cost_base /= 2;

   346

					}

   347

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   348

				} else {

   349

					if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) {

   350

						// adjust power and running cost if needed

   351

						rvi[i].power *= 2;

   352

						rvi[i].running_cost_base *= 2;

   353

					}

   354

					rvi[i].railveh_type = rvi[i].power == 0 ?

   355

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   356

				}

   357

			}

   358

			break;

   359

   360

		case 0x14: /* Cargo capacity */

   361

			FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf);

   362

			break;

   363

   364

		case 0x15: /* Cargo type */

   365

			FOR_EACH_OBJECT {

   366

				uint8 ctype = grf_load_byte(&buf);

   367

   368

				if (ctype < NUM_CARGO) {

   369

					rvi[i].cargo_type = ctype;

   370

				} else {

   371

					rvi[i].cargo_type = CT_INVALID;

   372

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

   373

				}

   374

			}

   375

			break;

   376

   377

		case 0x16: /* Weight */

   378

			FOR_EACH_OBJECT SB(rvi[i].weight, 0, 8, grf_load_byte(&buf));

   379

			break;

   380

   381

		case 0x17: /* Cost factor */

   382

			FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf);

   383

			break;

   384

   385

		case 0x18: /* AI rank */

   386

			FOR_EACH_OBJECT rvi[i].ai_rank = grf_load_byte(&buf);

   387

			break;

   388

   389

		case 0x19: /* Engine traction type */

   390

			/* What do the individual numbers mean?

   391

			 * 0x00 .. 0x07: Steam

   392

			 * 0x08 .. 0x27: Diesel

   393

			 * 0x28 .. 0x31: Electric

   394

			 * 0x32 .. 0x37: Monorail

   395

			 * 0x38 .. 0x41: Maglev

   396

			 */

   397

			FOR_EACH_OBJECT {

   398

				uint8 traction = grf_load_byte(&buf);

   399

				int engclass;

   400

   401

				if (traction <= 0x07) {

   402

					engclass = 0;

   403

				} else if (traction <= 0x27) {

   404

					engclass = 1;

   405

				} else if (traction <= 0x31) {

   406

					engclass = 2;

   407

				} else if (traction <= 0x41) {

   408

					engclass = 2;

   409

				} else {

   410

					break;

   411

				}

   412

				if (rvi[i].railtype == RAILTYPE_RAIL     && engclass == 2) rvi[i].railtype = RAILTYPE_ELECTRIC;

   413

				if (rvi[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) rvi[i].railtype = RAILTYPE_RAIL;

   414

   415

				rvi[i].engclass = engclass;

   416

			}

   417

			break;

   418

   419

		case 0x1A: /* Alter purchase list sort order */

   420

			FOR_EACH_OBJECT {

   421

				EngineID pos = grf_load_byte(&buf);

   422

   423

				if (pos < NUM_TRAIN_ENGINES) {

   424

					AlterRailVehListOrder(engine + i, pos);

   425

				} else {

   426

					grfmsg(2, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring", pos);

   427

				}

   428

			}

   429

			break;

   430

   431

		case 0x1B: /* Powered wagons power bonus */

   432

			FOR_EACH_OBJECT rvi[i].pow_wag_power = grf_load_word(&buf);

   433

			break;

   434

   435

		case 0x1C: /* Refit cost */

   436

			FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf);

   437

			break;

   438

   439

		case 0x1D: /* Refit cargo */

   440

			FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf);

   441

			break;

   442

   443

		case 0x1E: /* Callback */

   444

			FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf);

   445

			break;

   446

   447

		case 0x1F: /* Tractive effort coefficient */

   448

			FOR_EACH_OBJECT rvi[i].tractive_effort = grf_load_byte(&buf);

   449

			break;

   450

   451

		case 0x21: /* Shorter vehicle */

   452

			FOR_EACH_OBJECT rvi[i].shorten_factor = grf_load_byte(&buf);

   453

			break;

   454

   455

		case 0x22: /* Visual effect */

   456

			// see note in engine.h about rvi->visual_effect

   457

			FOR_EACH_OBJECT rvi[i].visual_effect = grf_load_byte(&buf);

   458

			break;

   459

   460

		case 0x23: /* Powered wagons weight bonus */

   461

			FOR_EACH_OBJECT rvi[i].pow_wag_weight = grf_load_byte(&buf);

   462

			break;

   463

   464

		case 0x24: /* High byte of vehicle weight */

   465

			FOR_EACH_OBJECT {

   466

				byte weight = grf_load_byte(&buf);

   467

   468

				if (weight > 4) {

   469

					grfmsg(2, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8);

   470

				} else {

   471

					SB(rvi[i].weight, 8, 8, weight);

   472

				}

   473

			}

   474

			break;

   475

   476

		case 0x25: /* User-defined bit mask to set when checking veh. var. 42 */

   477

			FOR_EACH_OBJECT rvi[i].user_def_data = grf_load_byte(&buf);

   478

			break;

   479

   480

		case 0x27: /* Miscellaneous flags */

   481

			FOR_EACH_OBJECT {

   482

				ei[i].misc_flags = grf_load_byte(&buf);

   483

				if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true;

   484

			}

   485

			break;

   486

   487

		case 0x28: /* Cargo classes allowed */

   488