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"

    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

    72

typedef enum GrfDataType {

    73

	GDT_SOUND,

    74

} GrfDataType;

    75

    76

static byte _grf_data_blocks;

    77

static GrfDataType _grf_data_type;

    78

    79

    80

typedef enum grfspec_feature {

    81

	GSF_TRAIN,

    82

	GSF_ROAD,

    83

	GSF_SHIP,

    84

	GSF_AIRCRAFT,

    85

	GSF_STATION,

    86

	GSF_CANAL,

    87

	GSF_BRIDGE,

    88

	GSF_TOWNHOUSE,

    89

	GSF_GLOBALVAR,

    90

	GSF_INDUSTRYTILES,

    91

	GSF_INDUSTRIES,

    92

	GSF_CARGOS,

    93

	GSF_SOUNDFX,

    94

} grfspec_feature;

    95

    96

    97

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

    98

    99

static const int _vehcounts[4] = {

   100

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   101

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   102

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   103

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   104

};

   105

   106

static const int _vehshifts[4] = {

   107

	/* GSF_TRAIN */    0,

   108

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   109

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   110

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   111

};

   112

   113

enum {

   114

	MAX_STATIONS = 256,

   115

};

   116

   117

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   118

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   119

   120

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

   121

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   122

   123

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

   124

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

   125

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

   126

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

   127

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

   128

 * is no file information available during that time.

   129

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

   130

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

   131

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

   132

{

   133

	char buf[1024];

   134

	va_list va;

   135

   136

	va_start(va, str);

   137

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

   138

	va_end(va);

   139

   140

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

   141

}

   142

   143

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

   144

{

   145

	if (real >= wanted) return true;

   146

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

   147

	return false;

   148

}

   149

   150

static inline byte grf_load_byte(byte **buf)

   151

{

   152

	return *(*buf)++;

   153

}

   154

   155

static uint16 grf_load_word(byte **buf)

   156

{

   157

	uint16 val = grf_load_byte(buf);

   158

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

   159

}

   160

   161

static uint16 grf_load_extended(byte** buf)

   162

{

   163

	uint16 val;

   164

	val = grf_load_byte(buf);

   165

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

   166

	return val;

   167

}

   168

   169

static uint32 grf_load_dword(byte **buf)

   170

{

   171

	uint32 val = grf_load_word(buf);

   172

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

   173

}

   174

   175

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

   176

{

   177

	switch (size) {

   178

		case 1: return grf_load_byte(buf);

   179

		case 2: return grf_load_word(buf);

   180

		case 4: return grf_load_dword(buf);

   181

		default:

   182

			NOT_REACHED();

   183

			return 0;

   184

	}

   185

}

   186

   187

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

   188

{

   189

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

   190

	size_t string_length = ttd_strnlen(string, max_len);

   191

   192

	if (string_length == max_len) {

   193

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

   194

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

   195

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

   196

	} else {

   197

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

   198

		string_length++;

   199

	}

   200

	*buf += string_length;

   201

   202

	return string;

   203

}

   204

   205

static GRFFile *GetFileByGRFID(uint32 grfid)

   206

{

   207

	GRFFile *file;

   208

   209

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

   210

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

   211

	}

   212

	return file;

   213

}

   214

   215

static GRFFile *GetFileByFilename(const char *filename)

   216

{

   217

	GRFFile *file;

   218

   219

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

   220

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

   221

	}

   222

	return file;

   223

}

   224

   225

   226

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

   227

   228

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

   229

   230

static void dewagonize(int condition, int engine)

   231

{

   232

	EngineInfo *ei = &_engine_info[engine];

   233

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   234

   235

	if (condition != 0) {

   236

		ei->unk2 &= ~0x80;

   237

		if (rvi->railveh_type == RAILVEH_WAGON)

   238

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   239

	} else {

   240

		ei->unk2 |= 0x80;

   241

		rvi->railveh_type = RAILVEH_WAGON;

   242

	}

   243

}

   244

   245

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

   246

{

   247

	EngineInfo *ei = &_engine_info[engine];

   248

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   249

	byte *buf = *bufp;

   250

	int i;

   251

	bool ret = false;

   252

   253

	switch (prop) {

   254

		case 0x05: /* Track type */

   255

			FOR_EACH_OBJECT {

   256

				uint8 tracktype = grf_load_byte(&buf);

   257

   258

				switch (tracktype) {

   259

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

   260

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

   261

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

   262

					default:

   263

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

   264

						break;

   265

				}

   266

			}

   267

			break;

   268

   269

		case 0x08: /* AI passenger service */

   270

			/* TODO */

   271

			FOR_EACH_OBJECT grf_load_byte(&buf);

   272

			ret = true;

   273

			break;

   274

   275

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

   276

			FOR_EACH_OBJECT {

   277

				uint16 speed = grf_load_word(&buf);

   278

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

   279

   280

				rvi[i].max_speed = speed;

   281

			}

   282

			break;

   283

   284

		case 0x0B: /* Power */

   285

			FOR_EACH_OBJECT {

   286

				uint16 power = grf_load_word(&buf);

   287

   288

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

   289

   290

				rvi[i].power = power;

   291

				dewagonize(power, engine + i);

   292

			}

   293

			break;

   294

   295

		case 0x0D: /* Running cost factor */

   296

			FOR_EACH_OBJECT {

   297

				uint8 runcostfact = grf_load_byte(&buf);

   298

   299

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

   300

   301

				rvi[i].running_cost_base = runcostfact;

   302

			}

   303

			break;

   304

   305

		case 0x0E: /* Running cost base */

   306

			FOR_EACH_OBJECT {

   307

				uint32 base = grf_load_dword(&buf);

   308

   309

				switch (base) {

   310

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

   311

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

   312

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

   313

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

   314

					default:

   315

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

   316

						break;

   317

				}

   318

			}

   319

			break;

   320

   321

		case 0x12: /* Sprite ID */

   322

			FOR_EACH_OBJECT {

   323

				uint8 spriteid = grf_load_byte(&buf);

   324

   325

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

   326

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

   327

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

   328

   329

				rvi[i].image_index = spriteid;

   330

			}

   331

			break;

   332

   333

		case 0x13: /* Dual-headed */

   334

			FOR_EACH_OBJECT {

   335

				uint8 dual = grf_load_byte(&buf);

   336

   337

				if (dual != 0) {

   338

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

   339

						// adjust power and running cost if needed

   340

						rvi[i].power /= 2;

   341

						rvi[i].running_cost_base /= 2;

   342

					}

   343

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   344

				} else {

   345

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

   346

						// adjust power and running cost if needed

   347

						rvi[i].power *= 2;

   348

						rvi[i].running_cost_base *= 2;

   349

					}

   350

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

   351

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   352

				}

   353

			}

   354

			break;

   355

   356

		case 0x14: /* Cargo capacity */

   357

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

   358

			break;

   359

   360

		case 0x15: /* Cargo type */

   361

			FOR_EACH_OBJECT {

   362

				uint8 ctype = grf_load_byte(&buf);

   363

   364

				if (ctype < NUM_CARGO) {

   365

					rvi[i].cargo_type = ctype;

   366

				} else {

   367

					grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, ignoring", ctype);

   368

				}

   369

			}

   370

			break;

   371

   372

		case 0x16: /* Weight */

   373

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

   374

			break;

   375

   376

		case 0x17: /* Cost factor */

   377

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

   378

			break;

   379

   380

		case 0x18: /* AI rank */

   381

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

   382

			break;

   383

   384

		case 0x19: /* Engine traction type */

   385

			/* What do the individual numbers mean?

   386

			 * 0x00 .. 0x07: Steam

   387

			 * 0x08 .. 0x27: Diesel

   388

			 * 0x28 .. 0x31: Electric

   389

			 * 0x32 .. 0x37: Monorail

   390

			 * 0x38 .. 0x41: Maglev

   391

			 */

   392

			FOR_EACH_OBJECT {

   393

				uint8 traction = grf_load_byte(&buf);

   394

				int engclass;

   395

   396

				if (traction <= 0x07) {

   397

					engclass = 0;

   398

				} else if (traction <= 0x27) {

   399

					engclass = 1;

   400

				} else if (traction <= 0x31) {

   401

					engclass = 2;

   402

				} else if (traction <= 0x41) {

   403

					engclass = 2;

   404

				} else {

   405

					break;

   406

				}

   407

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

   408

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

   409

   410

				rvi[i].engclass = engclass;

   411

			}

   412

			break;

   413

   414

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

   415

			FOR_EACH_OBJECT {

   416

				EngineID pos = grf_load_byte(&buf);

   417

   418

				if (pos < NUM_TRAIN_ENGINES) {

   419

					AlterRailVehListOrder(engine + i, pos);

   420

				} else {

   421

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

   422

				}

   423

			}

   424

			break;

   425

   426

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

   427

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

   428

			break;

   429

   430

		case 0x1C: /* Refit cost */

   431

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

   432

			break;

   433

   434

		case 0x1D: /* Refit cargo */

   435

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

   436

			break;

   437

   438

		case 0x1E: /* Callback */

   439

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

   440

			break;

   441

   442

		case 0x1F: /* Tractive effort coefficient */

   443

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

   444

			break;

   445

   446

		case 0x21: /* Shorter vehicle */

   447

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

   448

			break;

   449

   450

		case 0x22: /* Visual effect */

   451

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

   452

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

   453

			break;

   454

   455

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

   456

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

   457

			break;

   458

   459

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

   460

			FOR_EACH_OBJECT {

   461

				byte weight = grf_load_byte(&buf);

   462

   463

				if (weight > 4) {

   464

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

   465

				} else {

   466

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

   467

				}

   468

			}

   469

			break;

   470

   471

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

   472

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

   473

			break;

   474

   475

		case 0x27: /* Miscellaneous flags */

   476

			FOR_EACH_OBJECT {

   477

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

   478

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

   479

			}

   480

			break;

   481

   482

		case 0x28: /* Cargo classes allowed */

   483

			FOR_EACH_OBJECT cargo_allowed[engine + i] = grf_load_word(&buf);

   484

			break;

   485

   486

		case 0x29: /* Cargo classes disallowed */

   487

			FOR_EACH_OBJECT cargo_disallowed[engine + i] = grf_load_word(&buf);

   488

			break;

   489

   490

		case 0x2A: /* Long format introduction date (days since year 0) */

   491

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

   492

			break;

   493

   494