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

    35

/* TTDPatch extended GRF format codec

    36

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

    37

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

    38

 *

    39

 * Contains portions of documentation by TTDPatch team.

    40

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

    41

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

    42

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

    43

    44

    45

static int _skip_sprites; // XXX

    46

static uint _file_index; // XXX

    47

SpriteID _signal_base;

    48

SpriteID _coast_base;

    49

    50

static GRFFile *_cur_grffile;

    51

GRFFile *_first_grffile;

    52

static SpriteID _cur_spriteid;

    53

static GrfLoadingStage _cur_stage;

    54

static uint32 _nfo_line;

    55

    56

static GRFConfig *_cur_grfconfig;

    57

    58

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

    59

static byte _misc_grf_features = 0;

    60

    61

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

    62

static uint32 _ttdpatch_flags[8];

    63

    64

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

    65

static byte *_preload_sprite = NULL;

    66

    67

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

    68

bool _have_2cc = false;

    69

    70

    71

typedef enum GrfDataType {

    72

	GDT_SOUND,

    73

} GrfDataType;

    74

    75

static byte _grf_data_blocks;

    76

static GrfDataType _grf_data_type;

    77

    78

    79

typedef enum grfspec_feature {

    80

	GSF_TRAIN,

    81

	GSF_ROAD,

    82

	GSF_SHIP,

    83

	GSF_AIRCRAFT,

    84

	GSF_STATION,

    85

	GSF_CANAL,

    86

	GSF_BRIDGE,

    87

	GSF_TOWNHOUSE,

    88

	GSF_GLOBALVAR,

    89

	GSF_INDUSTRYTILES,

    90

	GSF_INDUSTRIES,

    91

	GSF_CARGOS,

    92

	GSF_SOUNDFX,

    93

} grfspec_feature;

    94

    95

    96

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

    97

    98

static const int _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 int _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

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

   123

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

   124

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

   125

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

   126

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

   127

 * is no file information available during that time.

   128

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

   129

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

   130

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

   131

{

   132

	char buf[1024];

   133

	va_list va;

   134

   135

	va_start(va, str);

   136

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

   137

	va_end(va);

   138

   139

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

   140

}

   141

   142

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

   143

{

   144

	if (real >= wanted) return true;

   145

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

   146

	return false;

   147

}

   148

   149

static inline byte grf_load_byte(byte **buf)

   150

{

   151

	return *(*buf)++;

   152

}

   153

   154

static uint16 grf_load_word(byte **buf)

   155

{

   156

	uint16 val = grf_load_byte(buf);

   157

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

   158

}

   159

   160

static uint16 grf_load_extended(byte** buf)

   161

{

   162

	uint16 val;

   163

	val = grf_load_byte(buf);

   164

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

   165

	return val;

   166

}

   167

   168

static uint32 grf_load_dword(byte **buf)

   169

{

   170

	uint32 val = grf_load_word(buf);

   171

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

   172

}

   173

   174

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

   175

{

   176

	switch (size) {

   177

		case 1: return grf_load_byte(buf);

   178

		case 2: return grf_load_word(buf);

   179

		case 4: return grf_load_dword(buf);

   180

		default:

   181

			NOT_REACHED();

   182

			return 0;

   183

	}

   184

}

   185

   186

static GRFFile *GetFileByGRFID(uint32 grfid)

   187

{

   188

	GRFFile *file;

   189

   190

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

   191

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

   192

	}

   193

	return file;

   194

}

   195

   196

static GRFFile *GetFileByFilename(const char *filename)

   197

{

   198

	GRFFile *file;

   199

   200

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

   201

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

   202

	}

   203

	return file;

   204

}

   205

   206

   207

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

   208

   209

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

   210

   211

static void dewagonize(int condition, int engine)

   212

{

   213

	EngineInfo *ei = &_engine_info[engine];

   214

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   215

   216

	if (condition != 0) {

   217

		ei->unk2 &= ~0x80;

   218

		rvi->railveh_type = RAILVEH_SINGLEHEAD;

   219

	} else {

   220

		ei->unk2 |= 0x80;

   221

		rvi->railveh_type = RAILVEH_WAGON;

   222

	}

   223

}

   224

   225

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

   226

{

   227

	EngineInfo *ei = &_engine_info[engine];

   228

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   229

	byte *buf = *bufp;

   230

	int i;

   231

	bool ret = false;

   232

   233

	switch (prop) {

   234

		case 0x05: /* Track type */

   235

			FOR_EACH_OBJECT {

   236

				uint8 tracktype = grf_load_byte(&buf);

   237

   238

				switch (tracktype) {

   239

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

   240

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

   241

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

   242

					default:

   243

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

   244

						break;

   245

				}

   246

			}

   247

			break;

   248

   249

		case 0x08: /* AI passenger service */

   250

			/* TODO */

   251

			FOR_EACH_OBJECT grf_load_byte(&buf);

   252

			ret = true;

   253

			break;

   254

   255

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

   256

			FOR_EACH_OBJECT {

   257

				uint16 speed = grf_load_word(&buf);

   258

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

   259

   260

				rvi[i].max_speed = speed;

   261

			}

   262

			break;

   263

   264

		case 0x0B: /* Power */

   265

			FOR_EACH_OBJECT {

   266

				uint16 power = grf_load_word(&buf);

   267

   268

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

   269

   270

				rvi[i].power = power;

   271

				dewagonize(power, engine + i);

   272

			}

   273

			break;

   274

   275

		case 0x0D: /* Running cost factor */

   276

			FOR_EACH_OBJECT {

   277

				uint8 runcostfact = grf_load_byte(&buf);

   278

   279

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

   280

   281

				rvi[i].running_cost_base = runcostfact;

   282

			}

   283

			break;

   284

   285

		case 0x0E: /* Running cost base */

   286

			FOR_EACH_OBJECT {

   287

				uint32 base = grf_load_dword(&buf);

   288

   289

				switch (base) {

   290

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

   291

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

   292

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

   293

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

   294

					default:

   295

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

   296

						break;

   297

				}

   298

			}

   299

			break;

   300

   301

		case 0x12: /* Sprite ID */

   302

			FOR_EACH_OBJECT {

   303

				uint8 spriteid = grf_load_byte(&buf);

   304

   305

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

   306

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

   307

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

   308

   309

				rvi[i].image_index = spriteid;

   310

			}

   311

			break;

   312

   313

		case 0x13: /* Dual-headed */

   314

			FOR_EACH_OBJECT {

   315

				uint8 dual = grf_load_byte(&buf);

   316

   317

				if (dual != 0) {

   318

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

   319

						// adjust power and running cost if needed

   320

						rvi[i].power /= 2;

   321

						rvi[i].running_cost_base /= 2;

   322

					}

   323

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   324

				} else {

   325

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

   326

						// adjust power and running cost if needed

   327

						rvi[i].power *= 2;

   328

						rvi[i].running_cost_base *= 2;

   329

					}

   330

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

   331

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   332

				}

   333

			}

   334

			break;

   335

   336

		case 0x14: /* Cargo capacity */

   337

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

   338

			break;

   339

   340

		case 0x15: /* Cargo type */

   341

			FOR_EACH_OBJECT {

   342

				uint8 ctype = grf_load_byte(&buf);

   343

   344

				if (ctype < NUM_CARGO) {

   345

					rvi[i].cargo_type = ctype;

   346

				} else {

   347

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

   348

				}

   349

			}

   350

			break;

   351

   352

		case 0x16: /* Weight */

   353

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

   354

			break;

   355

   356

		case 0x17: /* Cost factor */

   357

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

   358

			break;

   359

   360

		case 0x18: /* AI rank */

   361

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

   362

			break;

   363

   364

		case 0x19: /* Engine traction type */

   365

			/* What do the individual numbers mean?

   366

			 * 0x00 .. 0x07: Steam

   367

			 * 0x08 .. 0x27: Diesel

   368

			 * 0x28 .. 0x31: Electric

   369

			 * 0x32 .. 0x37: Monorail

   370

			 * 0x38 .. 0x41: Maglev

   371

			 */

   372

			FOR_EACH_OBJECT {

   373

				uint8 traction = grf_load_byte(&buf);

   374

				int engclass;

   375

   376

				if (traction <= 0x07) {

   377

					engclass = 0;

   378

				} else if (traction <= 0x27) {

   379

					engclass = 1;

   380

				} else if (traction <= 0x31) {

   381

					engclass = 2;

   382

				} else if (traction <= 0x41) {

   383

					engclass = 2;

   384

				} else {

   385

					break;

   386

				}

   387

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

   388

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

   389

   390

				rvi[i].engclass = engclass;

   391

			}

   392

			break;

   393

   394

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

   395

			FOR_EACH_OBJECT {

   396

				EngineID pos = grf_load_byte(&buf);

   397

   398

				if (pos < NUM_TRAIN_ENGINES) {

   399

					AlterRailVehListOrder(engine + i, pos);

   400

				} else {

   401

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

   402

				}

   403

			}

   404

			break;

   405

   406

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

   407

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

   408

			break;

   409

   410

		case 0x1C: /* Refit cost */

   411

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

   412

			break;

   413

   414

		case 0x1D: /* Refit cargo */

   415

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

   416

			break;

   417

   418

		case 0x1E: /* Callback */

   419

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

   420

			break;

   421

   422

		case 0x1F: /* Tractive effort coefficient */

   423

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

   424

			break;

   425

   426

		case 0x21: /* Shorter vehicle */

   427

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

   428

			break;

   429

   430

		case 0x22: /* Visual effect */

   431

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

   432

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

   433

			break;

   434

   435

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

   436

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

   437

			break;

   438

   439

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

   440

			FOR_EACH_OBJECT {

   441

				byte weight = grf_load_byte(&buf);

   442

   443

				if (weight > 4) {

   444

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

   445

				} else {

   446

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

   447

				}

   448

			}

   449

			break;

   450

   451

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

   452

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

   453

			break;

   454

   455

		case 0x27: /* Miscellaneous flags */

   456

			FOR_EACH_OBJECT {

   457

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

   458

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

   459

			}

   460

			break;

   461

   462

		case 0x28: /* Cargo classes allowed */

   463

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

   464

			break;

   465

   466

		case 0x29: /* Cargo classes disallowed */

   467

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

   468

			break;

   469

   470

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

   471

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

   472

			break;

   473

   474

		/* TODO */

   475

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

   476

		case 0x20: /* Air drag */

   477

		case 0x26: /* Retire vehicle early */

   478

			/* TODO */

   479

			FOR_EACH_OBJECT grf_load_byte(&buf);

   480

			ret = true;

   481

			break;

   482

   483

		default:

   484

			ret = true;

   485

			break;

   486

	}

   487

	*bufp = buf;

   488

	return ret;

   489

}

   490

   491

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

   492

{

   493

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

   494

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];