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

    19

#include "economy.h"

    20

#include "newgrf_engine.h"

    21

    22

/* TTDPatch extended GRF format codec

    23

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

    24

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

    25

 *

    26

 * Contains portions of documentation by TTDPatch team.

    27

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

    28

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

    29

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

    30

    31

    32

uint16 _custom_sprites_base;

    33

static int _skip_sprites; // XXX

    34

static uint _file_index; // XXX

    35

extern int _traininfo_vehicle_pitch;

    36

    37

static GRFFile *_cur_grffile;

    38

GRFFile *_first_grffile;

    39

static int _cur_spriteid;

    40

static int _cur_stage;

    41

static int nfo_line;

    42

    43

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

    44

static uint32 _ttdpatch_flags[8];

    45

    46

    47

typedef enum grfspec_feature {

    48

	GSF_TRAIN,

    49

	GSF_ROAD,

    50

	GSF_SHIP,

    51

	GSF_AIRCRAFT,

    52

	GSF_STATION,

    53

	GSF_CANAL,

    54

	GSF_BRIDGE,

    55

	GSF_TOWNHOUSE,

    56

	GSF_GLOBALVAR,

    57

} grfspec_feature;

    58

    59

    60

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

    61

    62

static const int _vehcounts[4] = {

    63

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    64

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    65

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    66

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    67

};

    68

    69

static const int _vehshifts[4] = {

    70

	/* GSF_TRAIN */    0,

    71

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    72

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    73

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    74

};

    75

    76

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    77

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    78

    79

/* Debugging messages policy:

    80

 *

    81

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

    82

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

    83

 *

    84

 * 0..2 - dedicated to grfmsg()

    85

 * 3

    86

 * 4

    87

 * 5

    88

 * 6 - action handler entry reporting - one per action

    89

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

    90

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

    91

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

    92

 */

    93

    94

    95

typedef enum grfmsg_severity {

    96

	GMS_NOTICE,

    97

	GMS_WARN,

    98

	GMS_ERROR,

    99

	GMS_FATAL,

   100

} grfmsg_severity;

   101

   102

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

   103

{

   104

	static const char* const severitystr[] = {

   105

		"Notice",

   106

		"Warning",

   107

		"Error",

   108

		"Fatal"

   109

	};

   110

	int export_severity = 0;

   111

	char buf[1024];

   112

	va_list va;

   113

   114

	va_start(va, str);

   115

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

   116

	va_end(va);

   117

   118

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

   119

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

   120

}

   121

   122

   123

#define check_length(real, wanted, where) \

   124

do { \

   125

	if (real < wanted) { \

   126

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

   127

		       where, real, wanted); \

   128

		return; \

   129

	} \

   130

} while (0)

   131

   132

   133

static inline byte grf_load_byte(byte **buf)

   134

{

   135

	return *(*buf)++;

   136

}

   137

   138

static uint16 grf_load_word(byte **buf)

   139

{

   140

	uint16 val;

   141

	byte *p = *buf;

   142

	val = p[0];

   143

	val |= p[1] << 8;

   144

	*buf = p + 2;

   145

	return val;

   146

}

   147

   148

static uint16 grf_load_extended(byte** buf)

   149

{

   150

	uint16 val;

   151

	val = grf_load_byte(buf);

   152

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

   153

	return val;

   154

}

   155

   156

static uint32 grf_load_dword(byte **buf)

   157

{

   158

	uint32 val;

   159

	byte *p = *buf;

   160

	val = p[0];

   161

	val |= p[1] << 8;

   162

	val |= p[2] << 16;

   163

	val |= p[3] << 24;

   164

	*buf = p + 4;

   165

	return val;

   166

}

   167

   168

   169

static GRFFile *GetFileByGRFID(uint32 grfid)

   170

{

   171

	GRFFile *file;

   172

   173

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

   174

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

   175

	}

   176

	return file;

   177

}

   178

   179

static GRFFile *GetFileByFilename(const char *filename)

   180

{

   181

	GRFFile *file;

   182

   183

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

   184

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

   185

	}

   186

	return file;

   187

}

   188

   189

   190

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

   191

   192

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

   193

   194

static void dewagonize(int condition, int engine)

   195

{

   196

	EngineInfo *ei = &_engine_info[engine];

   197

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   198

   199

	if (condition != 0) {

   200

		ei->unk2 &= ~0x80;

   201

		rvi->flags &= ~2;

   202

	} else {

   203

		ei->unk2 |= 0x80;

   204

		rvi->flags |= 2;

   205

	}

   206

}

   207

   208

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

   209

{

   210

	EngineInfo *ei = &_engine_info[engine];

   211

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   212

	byte *buf = *bufp;

   213

	int i;

   214

	bool ret = false;

   215

   216

	switch (prop) {

   217

		case 0x05: { /* Track type */

   218

			FOR_EACH_OBJECT {

   219

				uint8 tracktype = grf_load_byte(&buf);

   220

   221

				ei[i].railtype = tracktype;

   222

			}

   223

		} break;

   224

		case 0x08: { /* AI passenger service */

   225

			/* TODO */

   226

			FOR_EACH_OBJECT {

   227

				grf_load_byte(&buf);

   228

			}

   229

			ret = true;

   230

		} break;

   231

		case 0x09: { /* Speed */

   232

			FOR_EACH_OBJECT {

   233

				uint16 speed = grf_load_word(&buf);

   234

				if (speed == 0xFFFF)

   235

					speed = 0;

   236

   237

				rvi[i].max_speed = speed;

   238

			}

   239

		} break;

   240

		case 0x0B: { /* Power */

   241

			FOR_EACH_OBJECT {

   242

				uint16 power = grf_load_word(&buf);

   243

   244

				if (rvi[i].flags & RVI_MULTIHEAD)

   245

					power /= 2;

   246

   247

				rvi[i].power = power;

   248

				dewagonize(power, engine + i);

   249

			}

   250

		} break;

   251

		case 0x0D: { /* Running cost factor */

   252

			FOR_EACH_OBJECT {

   253

				uint8 runcostfact = grf_load_byte(&buf);

   254

   255

				if (rvi[i].flags & RVI_MULTIHEAD)

   256

					runcostfact /= 2;

   257

   258

				rvi[i].running_cost_base = runcostfact;

   259

			}

   260

		} break;

   261

		case 0x0E: { /* Running cost base */

   262

			FOR_EACH_OBJECT {

   263

				uint32 base = grf_load_dword(&buf);

   264

   265

				switch (base) {

   266

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

   267

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

   268

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

   269

				}

   270

			}

   271

		} break;

   272

		case 0x12: { /* Sprite ID */

   273

			FOR_EACH_OBJECT {

   274

				uint8 spriteid = grf_load_byte(&buf);

   275

   276

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

   277

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

   278

				if (spriteid < 0xFD)

   279

					spriteid >>= 1;

   280

   281

				rvi[i].image_index = spriteid;

   282

			}

   283

		} break;

   284

		case 0x13: { /* Dual-headed */

   285

			FOR_EACH_OBJECT {

   286

				uint8 dual = grf_load_byte(&buf);

   287

   288

				if (dual != 0) {

   289

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

   290

						// adjust power and running cost if needed

   291

						rvi[i].power /= 2;

   292

						rvi[i].running_cost_base /= 2;

   293

					}

   294

					rvi[i].flags |= RVI_MULTIHEAD;

   295

				} else {

   296

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

   297

						// adjust power and running cost if needed

   298

						rvi[i].power *= 2;

   299

						rvi[i].running_cost_base *= 2;

   300

					}

   301

					rvi[i].flags &= ~RVI_MULTIHEAD;

   302

				}

   303

			}

   304

		} break;

   305

		case 0x14: { /* Cargo capacity */

   306

			FOR_EACH_OBJECT {

   307

				uint8 capacity = grf_load_byte(&buf);

   308

   309

				rvi[i].capacity = capacity;

   310

			}

   311

		} break;

   312

		case 0x15: { /* Cargo type */

   313

			FOR_EACH_OBJECT {

   314

				uint8 ctype = grf_load_byte(&buf);

   315

   316

				if (ctype < NUM_CARGO) {

   317

					rvi[i].cargo_type = ctype;

   318

				} else {

   319

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

   320

				}

   321

			}

   322

		} break;

   323

		case 0x16: { /* Weight */

   324

			FOR_EACH_OBJECT {

   325

				uint8 weight = grf_load_byte(&buf);

   326

   327

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

   328

			}

   329

		} break;

   330

		case 0x17: { /* Cost factor */

   331

			FOR_EACH_OBJECT {

   332

				uint8 cfactor = grf_load_byte(&buf);

   333

   334

				rvi[i].base_cost = cfactor;

   335

			}

   336

		} break;

   337

		case 0x18: { /* AI rank */

   338

			/* TODO: _railveh_score should be merged to _rail_vehicle_info. */

   339

			FOR_EACH_OBJECT {

   340

				grf_load_byte(&buf);

   341

			}

   342

			ret = true;

   343

		} break;

   344

		case 0x19: { /* Engine traction type */

   345

			/* What do the individual numbers mean?

   346

			 * 0x00 .. 0x07: Steam

   347

			 * 0x08 .. 0x27: Diesel

   348

			 * 0x28 .. 0x31: Electric

   349

			 * 0x32 .. 0x37: Monorail

   350

			 * 0x38 .. 0x41: Maglev

   351

			 */

   352

			FOR_EACH_OBJECT {

   353

				uint8 traction = grf_load_byte(&buf);

   354

				int engclass;

   355

   356

				if (traction <= 0x07)

   357

					engclass = 0;

   358

				else if (traction <= 0x27)

   359

					engclass = 1;

   360

				else if (traction <= 0x41)

   361

					engclass = 2;

   362

				else

   363

					break;

   364

   365

				rvi[i].engclass = engclass;

   366

			}

   367

		} break;

   368

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

   369

			FOR_EACH_OBJECT {

   370

				EngineID pos = grf_load_byte(&buf);

   371

   372

				if (pos < NUM_TRAIN_ENGINES) {

   373

					AlterRailVehListOrder(engine + i, pos);

   374

				} else {

   375

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

   376

				}

   377

			}

   378

			break;

   379

   380

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

   381

			FOR_EACH_OBJECT {

   382

				uint16 wag_power = grf_load_word(&buf);

   383

   384

				rvi[i].pow_wag_power = wag_power;

   385

			}

   386

		} break;

   387

		case 0x1D: { /* Refit cargo */

   388

			FOR_EACH_OBJECT {

   389

				uint32 refit_mask = grf_load_dword(&buf);

   390

   391

				_engine_info[engine + i].refit_mask = refit_mask;

   392

			}

   393

		} break;

   394

		case 0x1E: { /* Callback */

   395

			FOR_EACH_OBJECT {

   396

				byte callbacks = grf_load_byte(&buf);

   397

   398

				rvi[i].callbackmask = callbacks;

   399

			}

   400

		} break;

   401

		case 0x21: { /* Shorter vehicle */

   402

			FOR_EACH_OBJECT {

   403

				byte shorten_factor = grf_load_byte(&buf);

   404

   405

				rvi[i].shorten_factor = shorten_factor;

   406

			}

   407

		} break;

   408

		case 0x22: { /* Visual effect */

   409

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

   410

			FOR_EACH_OBJECT {

   411

				byte visual = grf_load_byte(&buf);

   412

   413

				rvi[i].visual_effect = visual;

   414

			}

   415

		} break;

   416

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

   417

			FOR_EACH_OBJECT {

   418

				byte wag_weight = grf_load_byte(&buf);

   419

   420

				rvi[i].pow_wag_weight = wag_weight;

   421

			}

   422

		} break;

   423

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

   424

			FOR_EACH_OBJECT {

   425

				byte weight = grf_load_byte(&buf);

   426

   427

				if (weight > 4) {

   428

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

   429

				} else {

   430

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

   431

				}

   432

			}

   433

		} break;

   434

		case 0x28: { /* Cargo classes allowed */

   435

			FOR_EACH_OBJECT {

   436

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

   437

			}

   438

		} break;

   439

		case 0x29: { /* Cargo classes disallowed */

   440

			FOR_EACH_OBJECT {

   441

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

   442

			}

   443

		} break;

   444

		/* TODO */

   445

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

   446

		case 0x1C:	/* Refit cost */

   447

		case 0x1F:	/* Tractive effort */

   448

		case 0x20:	/* Air drag */

   449

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

   450

		case 0x26:	/* Retire vehicle early */

   451

		case 0x27:	/* Miscellaneous flags */

   452

			{

   453

			/* TODO */

   454

			FOR_EACH_OBJECT {

   455

				grf_load_byte(&buf);

   456

			}

   457

			ret = true;

   458

		}	break;

   459

		default:

   460

			ret = true;

   461

	}

   462

	*bufp = buf;

   463

	return ret;

   464

}

   465

   466

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

   467

{

   468

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   469

	byte *buf = *bufp;

   470

	int i;

   471

	bool ret = false;

   472

   473

	switch (prop) {

   474

		case 0x08: { /* Speed */

   475

			FOR_EACH_OBJECT {

   476

				uint8 speed = grf_load_byte(&buf);

   477

   478

				rvi[i].max_speed = speed; // ?? units

   479

			}

   480

		} break;

   481

		case 0x09: { /* Running cost factor */

   482

			FOR_EACH_OBJECT {

   483

				uint8 runcost = grf_load_byte(&buf);

   484

   485

				rvi[i].running_cost = runcost;

   486

			}

   487

		} break;

   488

		case 0x0A: { /* Running cost base */

   489

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

   490

			FOR_EACH_OBJECT {

   491

				grf_load_dword(&buf);

   492

			}

   493

			ret = true;

   494

		} break;

   495

		case 0x0E: { /* Sprite ID */

   496

			FOR_EACH_OBJECT {

   497

				uint8 spriteid = grf_load_byte(&buf);

   498

   499

				if (spriteid == 0xFF)

   500

					spriteid = 0xFD; // cars have different custom id in the GRF file

   501

   502

				if (spriteid < 0xFD)

   503

					spriteid >>= 1;

   504

   505

				rvi[i].image_index = spriteid;