1

#include "stdafx.h"

     2

     3

#include <stdarg.h>

     4

     5

#include "ttd.h"

     6

#include "gfx.h"

     7

#include "fileio.h"

     8

#include "engine.h"

     9

    10

/* TTDPatch extended GRF format codec

    11

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

    12

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

    13

 *

    14

 * Contains portions of documentation by TTDPatch team.

    15

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

    16

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

    17

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

    18

    19

extern int _skip_sprites;

    20

extern int _replace_sprites_count[16];

    21

extern int _replace_sprites_offset[16];

    22

    23

struct GRFFile {

    24

	char *filename;

    25

	uint32 grfid;

    26

	uint16 flags;

    27

	uint16 sprite_offset;

    28

	struct GRFFile *next;

    29

};

    30

    31

static struct GRFFile *_cur_grffile, *_first_grffile;

    32

static int _cur_spriteid;

    33

static int _cur_stage;

    34

    35

static int32 _paramlist[0x7f];

    36

static int _param_max;

    37

    38

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

    39

static uint32 _ttdpatch_flags[8];

    40

    41

    42

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

    43

    44

static const int _vehshifts[4] = {

    45

	0,

    46

	ROAD_ENGINES_INDEX,

    47

	SHIP_ENGINES_INDEX,

    48

	AIRCRAFT_ENGINES_INDEX,

    49

};

    50

    51

    52

enum grfmsg_severity {

    53

	GMS_NOTICE,

    54

	GMS_WARN,

    55

	GMS_ERROR,

    56

	GMS_FATAL,

    57

};

    58

    59

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

    60

{

    61

	static const char * const severitystr[4] = { "Notice", "Warning", "Error", "Fatal" };

    62

	char buf[1024];

    63

	va_list va;

    64

    65

	va_start(va, str);

    66

	vsprintf(buf, str, va);

    67

	va_end(va);

    68

	DEBUG(grf, 2) ("[%s][%s] %s", _cur_grffile->filename, severitystr[severity], buf);

    69

}

    70

    71

    72

#define check_length(real, wanted, where) \

    73

do { \

    74

	if (real < wanted) { \

    75

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

    76

		return; \

    77

	} \

    78

} while (0)

    79

    80

    81

static byte INLINE grf_load_byte(byte **buf)

    82

{

    83

	return *(*buf)++;

    84

}

    85

    86

static uint16 grf_load_word(byte **buf)

    87

{

    88

	uint16 val;

    89

	byte *p = *buf;

    90

	val = p[0];

    91

	val |= p[1] << 8;

    92

	*buf = p + 2;

    93

	return val;

    94

}

    95

    96

static uint16 grf_load_dword(byte **buf)

    97

{

    98

	uint32 val;

    99

	byte *p = *buf;

   100

	val = p[0];

   101

	val |= p[1] << 8;

   102

	val |= p[2] << 16;

   103

	val |= p[3] << 24;

   104

	*buf = p + 4;

   105

	return val;

   106

}

   107

   108

   109

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   110

{

   111

	struct GRFFile *file;

   112

   113

	file = _first_grffile;

   114

	while ((file != NULL) && (file->grfid != grfid))

   115

		file = file->next;

   116

   117

	return file;

   118

}

   119

   120

static struct GRFFile *GetFileByFilename(const char *filename)

   121

{

   122

	struct GRFFile *file;

   123

   124

	file = _first_grffile;

   125

	while ((file != NULL) && strcmp(file->filename, filename))

   126

		file = file->next;

   127

   128

	return file;

   129

}

   130

   131

   132

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

   133

   134

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

   135

   136

static void dewagonize(int condition, int engine)

   137

{

   138

	EngineInfo *ei = &_engine_info[engine];

   139

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   140

   141

	if (condition) {

   142

		ei->unk2 &= ~0x80;

   143

		rvi->flags &= ~2;

   144

	} else {

   145

		ei->unk2 |= 0x80;

   146

		rvi->flags |= 2;

   147

	}

   148

}

   149

   150

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

   151

{

   152

	EngineInfo *ei = &_engine_info[engine];

   153

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   154

	byte *buf = *bufp;

   155

	int i;

   156

	bool ret = false;

   157

   158

	switch (prop) {

   159

		case 0x05: {	/* Track type */

   160

			FOR_EACH_ENGINE {

   161

				uint8 tracktype = grf_load_byte(&buf);

   162

   163

				ei[i].railtype_climates &= 0xf;

   164

				ei[i].railtype_climates |= tracktype << 4;

   165

			}

   166

		}	break;

   167

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

   168

			/* TODO */

   169

			FOR_EACH_ENGINE {

   170

				grf_load_byte(&buf);

   171

			}

   172

			ret = true;

   173

		}	break;

   174

		case 0x09: {	/* Speed */

   175

			FOR_EACH_ENGINE {

   176

				uint16 speed = grf_load_word(&buf);

   177

   178

				rvi[i].max_speed = speed;

   179

				dewagonize(speed, engine + i);

   180

			}

   181

		}	break;

   182

		case 0x0B: {	/* Power */

   183

			FOR_EACH_ENGINE {

   184

				uint16 power = grf_load_word(&buf);

   185

   186

				rvi[i].power = power;

   187

				dewagonize(power, engine + i);

   188

			}

   189

		}	break;

   190

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

   191

			FOR_EACH_ENGINE {

   192

				uint8 runcostfact = grf_load_byte(&buf);

   193

   194

				rvi[i].running_cost_base = runcostfact;

   195

				dewagonize(runcostfact, engine + i);

   196

			}

   197

		}	break;

   198

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

   199

			FOR_EACH_ENGINE {

   200

				uint32 base = grf_load_dword(&buf);

   201

   202

				switch (base) {

   203

				case 0x4C30:

   204

					rvi[i].engclass = 0;

   205

					break;

   206

				case 0x4C36:

   207

					rvi[i].engclass = 1;

   208

					break;

   209

				case 0x4C3C:

   210

					rvi[i].engclass = 2;

   211

					break;

   212

				}

   213

				dewagonize(base, engine + i);

   214

			}

   215

		}	break;

   216

		case 0x12: {	/* Sprite ID */

   217

			FOR_EACH_ENGINE {

   218

				uint8 spriteid = grf_load_byte(&buf);

   219

   220

				if (spriteid == 0xFD && rvi[i].image_index != 0xFD)

   221

					_engine_original_sprites[engine + i] = rvi[i].image_index;

   222

				rvi[i].image_index = spriteid;

   223

			}

   224

		}	break;

   225

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

   226

			FOR_EACH_ENGINE {

   227

				uint8 dual = grf_load_byte(&buf);

   228

   229

				if (dual) {

   230

					rvi[i].flags |= 1;

   231

				} else {

   232

					rvi[i].flags &= ~1;

   233

				}

   234

			}

   235

		}	break;

   236

		case 0x14: {	/* Cargo capacity */

   237

			FOR_EACH_ENGINE {

   238

				uint8 capacity = grf_load_byte(&buf);

   239

   240

				rvi[i].capacity = capacity;

   241

			}

   242

		}	break;

   243

		case 0x15: {	/* Cargo type */

   244

			FOR_EACH_ENGINE {

   245

				uint8 ctype = grf_load_byte(&buf);

   246

   247

				rvi[i].cargo_type = ctype;

   248

			}

   249

		}	break;

   250

		case 0x16: {	/* Weight */

   251

			FOR_EACH_ENGINE {

   252

				uint8 weight = grf_load_byte(&buf);

   253

   254

				rvi[i].weight = weight;

   255

			}

   256

		}	break;

   257

		case 0x17: {	/* Cost factor */

   258

			FOR_EACH_ENGINE {

   259

				uint8 cfactor = grf_load_byte(&buf);

   260

   261

				rvi[i].base_cost = cfactor;

   262

			}

   263

		}	break;

   264

		case 0x18: {	/* AI rank */

   265

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

   266

			FOR_EACH_ENGINE {

   267

				grf_load_byte(&buf);

   268

			}

   269

			ret = true;

   270

		}	break;

   271

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

   272

			/* TODO: What do the individual numbers mean?

   273

			 * XXX: And in what base are they, in fact? --pasky */

   274

			FOR_EACH_ENGINE {

   275

				uint8 traction = grf_load_byte(&buf);

   276

				int engclass;

   277

   278

				if (traction <= 0x07)

   279

					engclass = 0;

   280

				else if (traction <= 0x27)

   281

					engclass = 1;

   282

				else if (traction <= 0x31)

   283

					engclass = 2;

   284

				else

   285

					break;

   286

   287

				rvi[i].engclass = engclass;

   288

			}

   289

		}	break;

   290

   291

		/* TODO */

   292

		/* Fall-through for unimplemented four bytes long properties. */

   293

		case 0x1D:	/* Refit cargo */

   294

			FOR_EACH_ENGINE {

   295

				grf_load_word(&buf);

   296

			}

   297

		/* Fall-through for unimplemented two bytes long properties. */

   298

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

   299

			FOR_EACH_ENGINE {

   300

				grf_load_byte(&buf);

   301

			}

   302

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

   303

		case 0x1A:	/* Sort order */

   304

		case 0x1C:	/* Refit cost */

   305

		case 0x1E:	/* Callback */

   306

		case 0x1F:	/* Tractive effort */

   307

		case 0x21:	/* Shorter tenders */

   308

		case 0x22:	/* Visual */

   309

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

   310

			/* TODO */

   311

			FOR_EACH_ENGINE {

   312

				grf_load_byte(&buf);

   313

			}

   314

			ret = true;

   315

		}	break;

   316

		default:

   317

			ret = true;

   318

	}

   319

	*bufp = buf;

   320

	return ret;

   321

}

   322

   323

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

   324

{

   325

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   326

	byte *buf = *bufp;

   327

	int i;

   328

	bool ret = false;

   329

   330

	//printf("e %x prop %x?\n", engine, prop);

   331

	switch (prop) {

   332

		case 0x08: {	/* Sprite ID */

   333

			FOR_EACH_ENGINE {

   334

				uint8 spriteid = grf_load_byte(&buf);

   335

   336

				if (spriteid == 0xFF)

   337

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

   338

   339

				// This is currently not used but there's no reason

   340

				// in not having it here for the future.

   341

				if (spriteid == 0xFD && svi[i].image_index != 0xFD)

   342

					_engine_original_sprites[SHIP_ENGINES_INDEX + engine + i] = svi[i].image_index;

   343

   344

				svi[i].image_index = spriteid;

   345

			}

   346

		}	break;

   347

		case 0x09: {	/* Refittable */

   348

			FOR_EACH_ENGINE {

   349

				uint8 refittable = grf_load_byte(&buf);

   350

   351

				svi[i].refittable = refittable;

   352

			}

   353

		}	break;

   354

		case 0x0A: {	/* Cost factor */

   355

			FOR_EACH_ENGINE {

   356

				uint8 cost_factor = grf_load_byte(&buf);

   357

   358

				svi[i].base_cost = cost_factor; // ?? is it base_cost?

   359

			}

   360

		}	break;

   361

		case 0x0B: {	/* Speed */

   362

			FOR_EACH_ENGINE {

   363

				uint8 speed = grf_load_byte(&buf);

   364

   365

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

   366

			}

   367

		}	break;

   368

		case 0x0C: { /* Cargo type */

   369

			FOR_EACH_ENGINE {

   370

				uint8 cargo = grf_load_byte(&buf);

   371

   372

				// XXX: Need to consult this with patchman yet.

   373

#if 0

   374

				// Documentation claims this is already the

   375

				// per-landscape cargo type id, but newships.grf

   376

				// assume otherwise.

   377

				cargo = local_cargo_id_ctype[cargo];

   378

#endif

   379

				svi[i].cargo_type = cargo;

   380

			}

   381

		}	break;

   382

		case 0x0D: {	/* Cargo capacity */

   383

			FOR_EACH_ENGINE {

   384

				uint16 capacity = grf_load_word(&buf);

   385

   386

				svi[i].capacity = capacity;

   387

			}

   388

		}	break;

   389

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

   390

			FOR_EACH_ENGINE {

   391

				uint8 runcost = grf_load_byte(&buf);

   392

   393

				svi[i].running_cost = runcost;

   394

			}

   395

		} break;

   396

		case 0x10: {	/* SFX */

   397

			FOR_EACH_ENGINE {

   398

				uint8 sfx = grf_load_byte(&buf);

   399

   400

				svi[i].sfx = sfx;

   401

			}

   402

		}	break;

   403

		case 0x11: {	/* Cargos available for refitting */

   404

			FOR_EACH_ENGINE {

   405

				uint32 refit_mask = grf_load_dword(&buf);

   406

   407

				_engine_refit_masks[SHIP_ENGINES_INDEX + engine + i] = refit_mask;

   408

			}

   409

		}	break;

   410

		case 0x12: { /* Callback TODO */

   411

			ret = true;

   412

		}	break;

   413

		default:

   414

			ret = true;

   415

	}

   416

   417

	*bufp = buf;

   418

	return ret;

   419

}

   420

   421

#undef shift_buf

   422

   423

/* Action 0x00 */

   424

static void VehicleChangeInfo(byte *buf, int len)

   425

{

   426

	byte *bufend = buf + len;

   427

	int i;

   428

   429

	/* <00> <feature> <num-props> <num-info> <id> (<property <new-info>)...

   430

	 *

   431

	 * B feature       0, 1, 2 or 3 for trains, road vehicles, ships or planes

   432

	 *                 4 for defining new train station sets

   433

	 * B num-props     how many properties to change per vehicle/station

   434

	 * B num-info      how many vehicles/stations to change

   435

	 * B id            ID of first vehicle/station to change, if num-info is

   436

	 *                 greater than one, this one and the following

   437

	 *                 vehicles/stations will be changed

   438

	 * B property      what property to change, depends on the feature

   439

	 * V new-info      new bytes of info (variable size; depends on properties) */

   440

	/* TODO: Only trains and ships are supported for now. */

   441

   442

	static const VCI_Handler handler[5] = {

   443

		RailVehicleChangeInfo,

   444

		NULL,

   445

		ShipVehicleChangeInfo,

   446

		NULL,

   447

		NULL,

   448

	};

   449

   450

	uint8 feature;

   451

	uint8 numprops;

   452

	uint8 numinfo;

   453

	byte engine;

   454

	EngineInfo *ei;

   455

   456

	check_length(len, 6, "VehicleChangeInfo");

   457

	feature = buf[1];

   458

	numprops = buf[2];

   459

	numinfo = buf[3];

   460

	engine = buf[4];

   461

   462

	if (feature != 0 && feature != 2) {

   463

		grfmsg(GMS_WARN, "VehicleChangeInfo: Unsupported vehicle type %x, skipping.", feature);

   464

		return;

   465

	}

   466

   467

	ei = &_engine_info[engine + _vehshifts[feature]];

   468

   469

	buf += 5;

   470

   471

	while (numprops-- && buf < bufend) {

   472

		uint8 prop = grf_load_byte(&buf);

   473

   474

		switch (prop) {

   475

		case 0x00: { /* Introduction date */

   476

			FOR_EACH_ENGINE {

   477

				uint16 date = grf_load_word(&buf);

   478

   479

				ei[i].base_intro = date;

   480

			}

   481

		}	break;

   482

		case 0x02: { /* Decay speed */

   483

			FOR_EACH_ENGINE {

   484

				uint8 decay = grf_load_byte(&buf);

   485

   486

				ei[i].unk2 &= 0x80;

   487

				ei[i].unk2 |= decay & 0x7f;

   488

			}

   489

		}	break;

   490

		case 0x03: { /* Vehicle life */

   491

			FOR_EACH_ENGINE {

   492

				uint8 life = grf_load_byte(&buf);

   493

   494

				ei[i].lifelength = life;

   495

			}

   496

		}	break;

   497

		case 0x04: { /* Model life */

   498

			FOR_EACH_ENGINE {

   499

				uint8 life = grf_load_byte(&buf);

   500

   501

				ei[i].base_life = life;

   502

			}

   503

		}	break;

   504

		case 0x06: { /* Climates available */

   505

			FOR_EACH_ENGINE {