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 "bridge.h"

    20

#include "economy.h"

    21

#include "newgrf_engine.h"

    22

#include "vehicle.h"

    23

#include "newgrf_text.h"

    24

    25

#include "newgrf_spritegroup.h"

    26

    27

/* TTDPatch extended GRF format codec

    28

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

    29

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

    30

 *

    31

 * Contains portions of documentation by TTDPatch team.

    32

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

    33

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

    34

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

    35

    36

    37

uint16 _custom_sprites_base;

    38

static int _skip_sprites; // XXX

    39

static uint _file_index; // XXX

    40

extern int _traininfo_vehicle_pitch;

    41

SpriteID _signal_base = 0;

    42

    43

static GRFFile *_cur_grffile;

    44

GRFFile *_first_grffile;

    45

GRFConfig *_first_grfconfig;

    46

static int _cur_spriteid;

    47

static int _cur_stage;

    48

static uint32 _nfo_line;

    49

    50

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

    51

static uint32 _ttdpatch_flags[8];

    52

    53

    54

typedef enum grfspec_feature {

    55

	GSF_TRAIN,

    56

	GSF_ROAD,

    57

	GSF_SHIP,

    58

	GSF_AIRCRAFT,

    59

	GSF_STATION,

    60

	GSF_CANAL,

    61

	GSF_BRIDGE,

    62

	GSF_TOWNHOUSE,

    63

	GSF_GLOBALVAR,

    64

	GSF_INDUSTRYTILES,

    65

	GSF_INDUSTRIES,

    66

	GSF_CARGOS,

    67

	GSF_SOUNDFX,

    68

} grfspec_feature;

    69

    70

    71

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

    72

    73

static const int _vehcounts[4] = {

    74

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    75

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    76

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    77

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    78

};

    79

    80

static const int _vehshifts[4] = {

    81

	/* GSF_TRAIN */    0,

    82

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    83

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    84

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    85

};

    86

    87

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    88

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    89

    90

/* Debugging messages policy:

    91

 *

    92

 * These should be the severities used for direct DEBUG() calls

    93

 * (there is room for exceptions, but you have to have a good cause):

    94

 *

    95

 * 0..2 - dedicated to grfmsg()

    96

 * 3

    97

 * 4

    98

 * 5

    99

 * 6 - action handler entry reporting - one per action

   100

 * 7 - basic action progress reporting - in loops, only single one allowed

   101

 * 8 - more detailed progress reporting - less important stuff, in deep loops etc

   102

 * 9 - extremely detailed progress reporting - detailed reports inside of deep loops and so

   103

 */

   104

   105

   106

typedef enum grfmsg_severity {

   107

	GMS_NOTICE,

   108

	GMS_WARN,

   109

	GMS_ERROR,

   110

	GMS_FATAL,

   111

} grfmsg_severity;

   112

   113

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

   114

{

   115

	static const char* const severitystr[] = {

   116

		"Notice",

   117

		"Warning",

   118

		"Error",

   119

		"Fatal"

   120

	};

   121

	int export_severity = 0;

   122

	char buf[1024];

   123

	va_list va;

   124

   125

	va_start(va, str);

   126

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

   127

	va_end(va);

   128

   129

	export_severity = 2 - (severity == GMS_FATAL ? 2 : severity);

   130

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

   131

}

   132

   133

   134

#define check_length(real, wanted, where) \

   135

do { \

   136

	if (real < wanted) { \

   137

		grfmsg(GMS_ERROR, "%s: Invalid special sprite length %d (expected %d)!", \

   138

		       where, real, wanted); \

   139

		return; \

   140

	} \

   141

} while (0)

   142

   143

   144

static inline byte grf_load_byte(byte **buf)

   145

{

   146

	return *(*buf)++;

   147

}

   148

   149

static uint16 grf_load_word(byte **buf)

   150

{

   151

	uint16 val;

   152

	byte *p = *buf;

   153

	val = p[0];

   154

	val |= p[1] << 8;

   155

	*buf = p + 2;

   156

	return val;

   157

}

   158

   159

static uint16 grf_load_extended(byte** buf)

   160

{

   161

	uint16 val;

   162

	val = grf_load_byte(buf);

   163

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

   164

	return val;

   165

}

   166

   167

static uint32 grf_load_dword(byte **buf)

   168

{

   169

	uint32 val;

   170

	byte *p = *buf;

   171

	val = p[0];

   172

	val |= p[1] << 8;

   173

	val |= p[2] << 16;

   174

	val |= p[3] << 24;

   175

	*buf = p + 4;

   176

	return val;

   177

}

   178

   179

   180

static GRFFile *GetFileByGRFID(uint32 grfid)

   181

{

   182

	GRFFile *file;

   183

   184

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

   185

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

   186

	}

   187

	return file;

   188

}

   189

   190

static GRFFile *GetFileByFilename(const char *filename)

   191

{

   192

	GRFFile *file;

   193

   194

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

   195

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

   196

	}

   197

	return file;

   198

}

   199

   200

   201

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

   202

   203

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

   204

   205

static void dewagonize(int condition, int engine)

   206

{

   207

	EngineInfo *ei = &_engine_info[engine];

   208

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   209

   210

	if (condition != 0) {

   211

		ei->unk2 &= ~0x80;

   212

		rvi->flags &= ~2;

   213

	} else {

   214

		ei->unk2 |= 0x80;

   215

		rvi->flags |= 2;

   216

	}

   217

}

   218

   219

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

   220

{

   221

	EngineInfo *ei = &_engine_info[engine];

   222

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   223

	byte *buf = *bufp;

   224

	int i;

   225

	bool ret = false;

   226

   227

	switch (prop) {

   228

		case 0x05: /* Track type */

   229

			FOR_EACH_OBJECT {

   230

				uint8 tracktype = grf_load_byte(&buf);

   231

   232

				switch (tracktype) {

   233

					case 0: ei[i].railtype = RAILTYPE_RAIL; break;

   234

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

   235

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

   236

					default:

   237

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

   238

						break;

   239

				}

   240

			}

   241

			break;

   242

   243

		case 0x08: /* AI passenger service */

   244

			/* TODO */

   245

			FOR_EACH_OBJECT grf_load_byte(&buf);

   246

			ret = true;

   247

			break;

   248

   249

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

   250

			FOR_EACH_OBJECT {

   251

				uint16 speed = grf_load_word(&buf);

   252

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

   253

   254

				rvi[i].max_speed = speed;

   255

			}

   256

			break;

   257

   258

		case 0x0B: /* Power */

   259

			FOR_EACH_OBJECT {

   260

				uint16 power = grf_load_word(&buf);

   261

   262

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

   263

   264

				rvi[i].power = power;

   265

				dewagonize(power, engine + i);

   266

			}

   267

			break;

   268

   269

		case 0x0D: /* Running cost factor */

   270

			FOR_EACH_OBJECT {

   271

				uint8 runcostfact = grf_load_byte(&buf);

   272

   273

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

   274

   275

				rvi[i].running_cost_base = runcostfact;

   276

			}

   277

			break;

   278

   279

		case 0x0E: /* Running cost base */

   280

			FOR_EACH_OBJECT {

   281

				uint32 base = grf_load_dword(&buf);

   282

   283

				switch (base) {

   284

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

   285

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

   286

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

   287

				}

   288

			}

   289

			break;

   290

   291

		case 0x12: /* Sprite ID */

   292

			FOR_EACH_OBJECT {

   293

				uint8 spriteid = grf_load_byte(&buf);

   294

   295

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

   296

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

   297

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

   298

   299

				rvi[i].image_index = spriteid;

   300

			}

   301

			break;

   302

   303

		case 0x13: /* Dual-headed */

   304

			FOR_EACH_OBJECT {

   305

				uint8 dual = grf_load_byte(&buf);

   306

   307

				if (dual != 0) {

   308

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

   309

						// adjust power and running cost if needed

   310

						rvi[i].power /= 2;

   311

						rvi[i].running_cost_base /= 2;

   312

					}

   313

					rvi[i].flags |= RVI_MULTIHEAD;

   314

				} else {

   315

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

   316

						// adjust power and running cost if needed

   317

						rvi[i].power *= 2;

   318

						rvi[i].running_cost_base *= 2;

   319

					}

   320

					rvi[i].flags &= ~RVI_MULTIHEAD;

   321

				}

   322

			}

   323

			break;

   324

   325

		case 0x14: /* Cargo capacity */

   326

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

   327

			break;

   328

   329

		case 0x15: /* Cargo type */

   330

			FOR_EACH_OBJECT {

   331

				uint8 ctype = grf_load_byte(&buf);

   332

   333

				if (ctype < NUM_CARGO) {

   334

					rvi[i].cargo_type = ctype;

   335

				} else {

   336

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

   337

				}

   338

			}

   339

			break;

   340

   341

		case 0x16: /* Weight */

   342

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

   343

			break;

   344

   345

		case 0x17: /* Cost factor */

   346

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

   347

			break;

   348

   349

		case 0x18: /* AI rank */

   350

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

   351

			break;

   352

   353

		case 0x19: /* Engine traction type */

   354

			/* What do the individual numbers mean?

   355

			 * 0x00 .. 0x07: Steam

   356

			 * 0x08 .. 0x27: Diesel

   357

			 * 0x28 .. 0x31: Electric

   358

			 * 0x32 .. 0x37: Monorail

   359

			 * 0x38 .. 0x41: Maglev

   360

			 */

   361

			FOR_EACH_OBJECT {

   362

				uint8 traction = grf_load_byte(&buf);

   363

				int engclass;

   364

   365

				if (traction <= 0x07) {

   366

					engclass = 0;

   367

				} else if (traction <= 0x27) {

   368

					engclass = 1;

   369

				} else if (traction <= 0x31) {

   370

					engclass = 2;

   371

					ei[i].railtype = RAILTYPE_ELECTRIC;

   372

				} else if (traction <= 0x41) {

   373

					engclass = 2;

   374

				} else {

   375

					break;

   376

				}

   377

   378

				rvi[i].engclass = engclass;

   379

			}

   380

			break;

   381

   382

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

   383

			FOR_EACH_OBJECT {

   384

				EngineID pos = grf_load_byte(&buf);

   385

   386

				if (pos < NUM_TRAIN_ENGINES) {

   387

					AlterRailVehListOrder(engine + i, pos);

   388

				} else {

   389

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

   390

				}

   391

			}

   392

			break;

   393

   394

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

   395

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

   396

			break;

   397

   398

		case 0x1D: /* Refit cargo */

   399

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

   400

			break;

   401

   402

		case 0x1E: /* Callback */

   403

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

   404

			break;

   405

   406

		case 0x21: /* Shorter vehicle */

   407

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

   408

			break;

   409

   410

		case 0x22: /* Visual effect */

   411

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

   412

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

   413

			break;

   414

   415

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

   416

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

   417

			break;

   418

   419

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

   420

			FOR_EACH_OBJECT {

   421

				byte weight = grf_load_byte(&buf);

   422

   423

				if (weight > 4) {

   424

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

   425

				} else {

   426

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

   427

				}

   428

			}

   429

			break;

   430

   431

		case 0x27: /* Miscellaneous flags */

   432

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

   433

			break;

   434

   435

		case 0x28: /* Cargo classes allowed */

   436

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

   437

			break;

   438

   439

		case 0x29: /* Cargo classes disallowed */

   440

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

   441

			break;

   442

   443

		/* TODO */

   444

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

   445

		case 0x1C: /* Refit cost */

   446

		case 0x1F: /* Tractive effort */

   447

		case 0x20: /* Air drag */

   448

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

   449

		case 0x26: /* Retire vehicle early */

   450

			/* TODO */

   451

			FOR_EACH_OBJECT grf_load_byte(&buf);

   452

			ret = true;

   453

			break;

   454

   455

		default:

   456

			ret = true;

   457

			break;

   458

	}

   459

	*bufp = buf;

   460

	return ret;

   461

}

   462

   463

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

   464

{

   465

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

   466

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   467

	byte *buf = *bufp;

   468

	int i;

   469

	bool ret = false;

   470

   471

	switch (prop) {

   472

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

   473

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

   474

			break;

   475

   476

		case 0x09: /* Running cost factor */

   477

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

   478

			break;

   479

   480

		case 0x0A: /* Running cost base */

   481

			/* TODO: I have no idea. --pasky */

   482

			FOR_EACH_OBJECT grf_load_dword(&buf);

   483

			ret = true;

   484

			break;

   485

   486

		case 0x0E: /* Sprite ID */

   487

			FOR_EACH_OBJECT {

   488

				uint8 spriteid = grf_load_byte(&buf);

   489

   490

				// cars have different custom id in the GRF file

   491

				if (spriteid == 0xFF) spriteid = 0xFD;

   492

   493

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

   494

   495

				rvi[i].image_index = spriteid;

   496

			}

   497

			break;

   498

   499

		case 0x0F: /* Cargo capacity */

   500

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

   501