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

    34

/* TTDPatch extended GRF format codec

    35

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

    36

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

    37

 *

    38

 * Contains portions of documentation by TTDPatch team.

    39

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

    40

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

    41

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

    42

    43

    44

static int _skip_sprites; // XXX

    45

static uint _file_index; // XXX

    46

SpriteID _signal_base;

    47

SpriteID _coast_base;

    48

    49

static GRFFile *_cur_grffile;

    50

GRFFile *_first_grffile;

    51

static SpriteID _cur_spriteid;

    52

static GrfLoadingStage _cur_stage;

    53

static uint32 _nfo_line;

    54

    55

static GRFConfig *_cur_grfconfig;

    56

    57

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

    58

static byte _misc_grf_features = 0;

    59

    60

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

    61

static uint32 _ttdpatch_flags[8];

    62

    63

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

    64

static byte *_preload_sprite = NULL;

    65

    66

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

    67

bool _have_2cc = false;

    68

    69

    70

typedef enum GrfDataType {

    71

	GDT_SOUND,

    72

} GrfDataType;

    73

    74

static byte _grf_data_blocks;

    75

static GrfDataType _grf_data_type;

    76

    77

    78

typedef enum grfspec_feature {

    79

	GSF_TRAIN,

    80

	GSF_ROAD,

    81

	GSF_SHIP,

    82

	GSF_AIRCRAFT,

    83

	GSF_STATION,

    84

	GSF_CANAL,

    85

	GSF_BRIDGE,

    86

	GSF_TOWNHOUSE,

    87

	GSF_GLOBALVAR,

    88

	GSF_INDUSTRYTILES,

    89

	GSF_INDUSTRIES,

    90

	GSF_CARGOS,

    91

	GSF_SOUNDFX,

    92

} grfspec_feature;

    93

    94

    95

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

    96

    97

static const int _vehcounts[4] = {

    98

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    99

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   100

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   101

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   102

};

   103

   104

static const int _vehshifts[4] = {

   105

	/* GSF_TRAIN */    0,

   106

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   107

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   108

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   109

};

   110

   111

enum {

   112

	MAX_STATIONS = 256,

   113

};

   114

   115

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   116

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   117

   118

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

   119

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   120

   121

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

   122

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

   123

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

   124

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

   125

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

   126

 * is no file information available during that time.

   127

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

   128

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

   129

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

   130

{

   131

	char buf[1024];

   132

	va_list va;

   133

   134

	va_start(va, str);

   135

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

   136

	va_end(va);

   137

   138

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

   139

}

   140

   141

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

   142

{

   143

	if (real >= wanted) return;

   144

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

   145

}

   146

   147

static inline byte grf_load_byte(byte **buf)

   148

{

   149

	return *(*buf)++;

   150

}

   151

   152

static uint16 grf_load_word(byte **buf)

   153

{

   154

	uint16 val = grf_load_byte(buf);

   155

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

   156

}

   157

   158

static uint16 grf_load_extended(byte** buf)

   159

{

   160

	uint16 val;

   161

	val = grf_load_byte(buf);

   162

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

   163

	return val;

   164

}

   165

   166

static uint32 grf_load_dword(byte **buf)

   167

{

   168

	uint32 val = grf_load_word(buf);

   169

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

   170

}

   171

   172

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

   173

{

   174

	switch (size) {

   175

		case 1: return grf_load_byte(buf);

   176

		case 2: return grf_load_word(buf);

   177

		case 4: return grf_load_dword(buf);

   178

		default:

   179

			NOT_REACHED();

   180

			return 0;

   181

	}

   182

}

   183

   184

static GRFFile *GetFileByGRFID(uint32 grfid)

   185

{

   186

	GRFFile *file;

   187

   188

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

   189

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

   190

	}

   191

	return file;

   192

}

   193

   194

static GRFFile *GetFileByFilename(const char *filename)

   195

{

   196

	GRFFile *file;

   197

   198

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

   199

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

   200

	}

   201

	return file;

   202

}

   203

   204

   205

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

   206

   207

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

   208

   209

static void dewagonize(int condition, int engine)

   210

{

   211

	EngineInfo *ei = &_engine_info[engine];

   212

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   213

   214

	if (condition != 0) {

   215

		ei->unk2 &= ~0x80;

   216

		rvi->flags &= ~2;

   217

	} else {

   218

		ei->unk2 |= 0x80;

   219

		rvi->flags |= 2;

   220

	}

   221

}

   222

   223

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

   224

{

   225

	EngineInfo *ei = &_engine_info[engine];

   226

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   227

	byte *buf = *bufp;

   228

	int i;

   229

	bool ret = false;

   230

   231

	switch (prop) {

   232

		case 0x05: /* Track type */

   233

			FOR_EACH_OBJECT {

   234

				uint8 tracktype = grf_load_byte(&buf);

   235

   236

				switch (tracktype) {

   237

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

   238

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

   239

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

   240

					default:

   241

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

   242

						break;

   243

				}

   244

			}

   245

			break;

   246

   247

		case 0x08: /* AI passenger service */

   248

			/* TODO */

   249

			FOR_EACH_OBJECT grf_load_byte(&buf);

   250

			ret = true;

   251

			break;

   252

   253

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

   254

			FOR_EACH_OBJECT {

   255

				uint16 speed = grf_load_word(&buf);

   256

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

   257

   258

				rvi[i].max_speed = speed;

   259

			}

   260

			break;

   261

   262

		case 0x0B: /* Power */

   263

			FOR_EACH_OBJECT {

   264

				uint16 power = grf_load_word(&buf);

   265

   266

				if (rvi[i].flags & RVI_MULTIHEAD) power /= 2;

   267

   268

				rvi[i].power = power;

   269

				dewagonize(power, engine + i);

   270

			}

   271

			break;

   272

   273

		case 0x0D: /* Running cost factor */

   274

			FOR_EACH_OBJECT {

   275

				uint8 runcostfact = grf_load_byte(&buf);

   276

   277

				if (rvi[i].flags & RVI_MULTIHEAD) runcostfact /= 2;

   278

   279

				rvi[i].running_cost_base = runcostfact;

   280

			}

   281

			break;

   282

   283

		case 0x0E: /* Running cost base */

   284

			FOR_EACH_OBJECT {

   285

				uint32 base = grf_load_dword(&buf);

   286

   287

				switch (base) {

   288

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

   289

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

   290

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

   291

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

   292

					default:

   293

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

   294

						break;

   295

				}

   296

			}

   297

			break;

   298

   299

		case 0x12: /* Sprite ID */

   300

			FOR_EACH_OBJECT {

   301

				uint8 spriteid = grf_load_byte(&buf);

   302

   303

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

   304

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

   305

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

   306

   307

				rvi[i].image_index = spriteid;

   308

			}

   309

			break;

   310

   311

		case 0x13: /* Dual-headed */

   312

			FOR_EACH_OBJECT {

   313

				uint8 dual = grf_load_byte(&buf);

   314

   315

				if (dual != 0) {

   316

					if (!(rvi[i].flags & RVI_MULTIHEAD)) {

   317

						// adjust power and running cost if needed

   318

						rvi[i].power /= 2;

   319

						rvi[i].running_cost_base /= 2;

   320

					}

   321

					rvi[i].flags |= RVI_MULTIHEAD;

   322

				} else {

   323

					if (rvi[i].flags & RVI_MULTIHEAD) {

   324

						// adjust power and running cost if needed

   325

						rvi[i].power *= 2;

   326

						rvi[i].running_cost_base *= 2;

   327

					}

   328

					rvi[i].flags &= ~RVI_MULTIHEAD;

   329

				}

   330

			}

   331

			break;

   332

   333

		case 0x14: /* Cargo capacity */

   334

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

   335

			break;

   336

   337

		case 0x15: /* Cargo type */

   338

			FOR_EACH_OBJECT {

   339

				uint8 ctype = grf_load_byte(&buf);

   340

   341

				if (ctype < NUM_CARGO) {

   342

					rvi[i].cargo_type = ctype;

   343

				} else {

   344

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

   345

				}

   346

			}

   347

			break;

   348

   349

		case 0x16: /* Weight */

   350

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

   351

			break;

   352

   353

		case 0x17: /* Cost factor */

   354

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

   355

			break;

   356

   357

		case 0x18: /* AI rank */

   358

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

   359

			break;

   360

   361

		case 0x19: /* Engine traction type */

   362

			/* What do the individual numbers mean?

   363

			 * 0x00 .. 0x07: Steam

   364

			 * 0x08 .. 0x27: Diesel

   365

			 * 0x28 .. 0x31: Electric

   366

			 * 0x32 .. 0x37: Monorail

   367

			 * 0x38 .. 0x41: Maglev

   368

			 */

   369

			FOR_EACH_OBJECT {

   370

				uint8 traction = grf_load_byte(&buf);

   371

				int engclass;

   372

   373

				if (traction <= 0x07) {

   374

					engclass = 0;

   375

				} else if (traction <= 0x27) {

   376

					engclass = 1;

   377

				} else if (traction <= 0x31) {

   378

					engclass = 2;

   379

				} else if (traction <= 0x41) {

   380

					engclass = 2;

   381

				} else {

   382

					break;

   383

				}

   384

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

   385

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

   386

   387

				rvi[i].engclass = engclass;

   388

			}

   389

			break;

   390

   391

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

   392

			FOR_EACH_OBJECT {

   393

				EngineID pos = grf_load_byte(&buf);

   394

   395

				if (pos < NUM_TRAIN_ENGINES) {

   396

					AlterRailVehListOrder(engine + i, pos);

   397

				} else {

   398

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

   399

				}

   400

			}

   401

			break;

   402

   403

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

   404

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

   405

			break;

   406

   407

		case 0x1C: /* Refit cost */

   408

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

   409

			break;

   410

   411

		case 0x1D: /* Refit cargo */

   412

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

   413

			break;

   414

   415

		case 0x1E: /* Callback */

   416

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

   417

			break;

   418

   419

		case 0x1F: /* Tractive effort coefficient */

   420

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

   421

			break;

   422

   423

		case 0x21: /* Shorter vehicle */

   424

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

   425

			break;

   426

   427

		case 0x22: /* Visual effect */

   428

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

   429

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

   430

			break;

   431

   432

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

   433

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

   434

			break;

   435

   436

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

   437

			FOR_EACH_OBJECT {

   438

				byte weight = grf_load_byte(&buf);

   439

   440

				if (weight > 4) {

   441

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

   442

				} else {

   443

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

   444

				}

   445

			}

   446

			break;

   447

   448

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

   449

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

   450

			break;

   451

   452

		case 0x27: /* Miscellaneous flags */

   453

			FOR_EACH_OBJECT {

   454

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

   455

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

   456

			}

   457

			break;

   458

   459

		case 0x28: /* Cargo classes allowed */

   460

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

   461

			break;

   462

   463

		case 0x29: /* Cargo classes disallowed */

   464

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

   465

			break;

   466

   467

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

   468

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

   469

			break;

   470

   471

		/* TODO */

   472

		/* Fall-through for unimplemented one byte long properties. */

   473

		case 0x20: /* Air drag */

   474

		case 0x26: /* Retire vehicle early */

   475

			/* TODO */

   476

			FOR_EACH_OBJECT grf_load_byte(&buf);

   477

			ret = true;

   478

			break;

   479

   480

		default:

   481

			ret = true;

   482

			break;

   483

	}

   484

	*bufp = buf;

   485

	return ret;

   486

}

   487

   488

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

   489

{

   490

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

   491

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   492

	byte *buf = *bufp;

   493

	int i;

   494

	bool ret = false;

   495