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

enum grfspec_feature {

    43

	GSF_TRAIN,

    44

	GSF_ROAD,

    45

	GSF_SHIP,

    46

	GSF_AIRCRAFT,

    47

	GSF_STATION,

    48

};

    49

    50

    51

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

    52

    53

static const int _vehcounts[4] = {

    54

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    55

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    56

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    57

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    58

};

    59

    60

static const int _vehshifts[4] = {

    61

	/* GSF_TRAIN */    0,

    62

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    63

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    64

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    65

};

    66

    67

    84

enum grfmsg_severity {

    85

	GMS_NOTICE,

    86

	GMS_WARN,

    87

	GMS_ERROR,

    88

	GMS_FATAL,

    89

};

    90

    91

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

    92

{

    93

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

    94

	int export_severity = 0;

    95

	char buf[1024];

    96

	va_list va;

    97

    98

	va_start(va, str);

    99

	vsprintf(buf, str, va);

   100

	va_end(va);

   101

   102

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

   103

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

   104

}

   105

   106

   107

#define check_length(real, wanted, where) \

   108

do { \

   109

	if (real < wanted) { \

   110

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

   111

		return; \

   112

	} \

   113

} while (0)

   114

   115

   116

static byte INLINE grf_load_byte(byte **buf)

   117

{

   118

	return *(*buf)++;

   119

}

   120

   121

static uint16 grf_load_word(byte **buf)

   122

{

   123

	uint16 val;

   124

	byte *p = *buf;

   125

	val = p[0];

   126

	val |= p[1] << 8;

   127

	*buf = p + 2;

   128

	return val;

   129

}

   130

   131

static uint16 grf_load_dword(byte **buf)

   132

{

   133

	uint32 val;

   134

	byte *p = *buf;

   135

	val = p[0];

   136

	val |= p[1] << 8;

   137

	val |= p[2] << 16;

   138

	val |= p[3] << 24;

   139

	*buf = p + 4;

   140

	return val;

   141

}

   142

   143

   144

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   145

{

   146

	struct GRFFile *file;

   147

   148

	file = _first_grffile;

   149

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

   150

		file = file->next;

   151

   152

	return file;

   153

}

   154

   155

static struct GRFFile *GetFileByFilename(const char *filename)

   156

{

   157

	struct GRFFile *file;

   158

   159

	file = _first_grffile;

   160

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

   161

		file = file->next;

   162

   163

	return file;

   164

}

   165

   166

   167

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

   168

   169

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

   170

   171

static void dewagonize(int condition, int engine)

   172

{

   173

	EngineInfo *ei = &_engine_info[engine];

   174

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   175

   176

	if (condition != 0) {

   177

		ei->unk2 &= ~0x80;

   178

		rvi->flags &= ~2;

   179

	} else {

   180

		ei->unk2 |= 0x80;

   181

		rvi->flags |= 2;

   182

	}

   183

}

   184

   185

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

   186

{

   187

	EngineInfo *ei = &_engine_info[engine];

   188

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   189

	byte *buf = *bufp;

   190

	int i;

   191

	bool ret = false;

   192

   193

	switch (prop) {

   194

		case 0x05: {	/* Track type */

   195

			FOR_EACH_ENGINE {

   196

				uint8 tracktype = grf_load_byte(&buf);

   197

   198

				ei[i].railtype_climates &= 0xf;

   199

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

   200

			}

   201

		}	break;

   202

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

   203

			/* TODO */

   204

			FOR_EACH_ENGINE {

   205

				grf_load_byte(&buf);

   206

			}

   207

			ret = true;

   208

		}	break;

   209

		case 0x09: {	/* Speed */

   210

			FOR_EACH_ENGINE {

   211

				uint16 speed = grf_load_word(&buf);

   212

   213

				rvi[i].max_speed = speed;

   214

				dewagonize(speed, engine + i);

   215

			}

   216

		}	break;

   217

		case 0x0B: {	/* Power */

   218

			FOR_EACH_ENGINE {

   219

				uint16 power = grf_load_word(&buf);

   220

   221

				rvi[i].power = power;

   222

				dewagonize(power, engine + i);

   223

			}

   224

		}	break;

   225

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

   226

			FOR_EACH_ENGINE {

   227

				uint8 runcostfact = grf_load_byte(&buf);

   228

   229

				rvi[i].running_cost_base = runcostfact;

   230

				dewagonize(runcostfact, engine + i);

   231

			}

   232

		}	break;

   233

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

   234

			FOR_EACH_ENGINE {

   235

				uint32 base = grf_load_dword(&buf);

   236

   237

				switch (base) {

   238

				case 0x4C30:

   239

					rvi[i].engclass = 0;

   240

					break;

   241

				case 0x4C36:

   242

					rvi[i].engclass = 1;

   243

					break;

   244

				case 0x4C3C:

   245

					rvi[i].engclass = 2;

   246

					break;

   247

				}

   248

				dewagonize(base, engine + i);

   249

			}

   250

		}	break;

   251

		case 0x12: {	/* Sprite ID */

   252

			FOR_EACH_ENGINE {

   253

				uint8 spriteid = grf_load_byte(&buf);

   254

   255

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

   256

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

   257

				rvi[i].image_index = spriteid;

   258

			}

   259

		}	break;

   260

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

   261

			FOR_EACH_ENGINE {

   262

				uint8 dual = grf_load_byte(&buf);

   263

   264

				if (dual != 0) {

   265

					rvi[i].flags |= 1;

   266

				} else {

   267

					rvi[i].flags &= ~1;

   268

				}

   269

			}

   270

		}	break;

   271

		case 0x14: {	/* Cargo capacity */

   272

			FOR_EACH_ENGINE {

   273

				uint8 capacity = grf_load_byte(&buf);

   274

   275

				rvi[i].capacity = capacity;

   276

			}

   277

		}	break;

   278

		case 0x15: {	/* Cargo type */

   279

			FOR_EACH_ENGINE {

   280

				uint8 ctype = grf_load_byte(&buf);

   281

   282

				rvi[i].cargo_type = ctype;

   283

			}

   284

		}	break;

   285

		case 0x16: {	/* Weight */

   286

			FOR_EACH_ENGINE {

   287

				uint8 weight = grf_load_byte(&buf);

   288

   289

				rvi[i].weight = weight;

   290

			}

   291

		}	break;

   292

		case 0x17: {	/* Cost factor */

   293

			FOR_EACH_ENGINE {

   294

				uint8 cfactor = grf_load_byte(&buf);

   295

   296

				rvi[i].base_cost = cfactor;

   297

			}

   298

		}	break;

   299

		case 0x18: {	/* AI rank */

   300

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

   301

			FOR_EACH_ENGINE {

   302

				grf_load_byte(&buf);

   303

			}

   304

			ret = true;

   305

		}	break;

   306

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

   307

			/* TODO: What do the individual numbers mean?

   308

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

   309

			FOR_EACH_ENGINE {

   310

				uint8 traction = grf_load_byte(&buf);

   311

				int engclass;

   312

   313

				if (traction <= 0x07)

   314

					engclass = 0;

   315

				else if (traction <= 0x27)

   316

					engclass = 1;

   317

				else if (traction <= 0x31)

   318

					engclass = 2;

   319

				else

   320

					break;

   321

   322

				rvi[i].engclass = engclass;

   323

			}

   324

		}	break;

   325

   326

		/* TODO */

   327

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

   328

		case 0x1D:	/* Refit cargo */

   329

			FOR_EACH_ENGINE {

   330

				grf_load_word(&buf);

   331

			}

   332

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

   333

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

   334

			FOR_EACH_ENGINE {

   335

				grf_load_byte(&buf);

   336

			}

   337

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

   338

		case 0x1A:	/* Sort order */

   339

		case 0x1C:	/* Refit cost */

   340

		case 0x1E:	/* Callback */

   341

		case 0x1F:	/* Tractive effort */

   342

		case 0x21:	/* Shorter tenders */

   343

		case 0x22:	/* Visual */

   344

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

   345

			/* TODO */

   346

			FOR_EACH_ENGINE {

   347

				grf_load_byte(&buf);

   348

			}

   349

			ret = true;

   350

		}	break;

   351

		default:

   352

			ret = true;

   353

	}

   354

	*bufp = buf;

   355

	return ret;

   356

}

   357

   358

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

   359

{

   360

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   361

	byte *buf = *bufp;

   362

	int i;

   363

	bool ret = false;

   364

   365

	switch (prop) {

   366

		case 0x08: {	/* Speed */

   367

			FOR_EACH_ENGINE {

   368

				uint8 speed = grf_load_byte(&buf);

   369

   370

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

   371

			}

   372

		}	break;

   373

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

   374

			FOR_EACH_ENGINE {

   375

				uint8 runcost = grf_load_byte(&buf);

   376

   377

				rvi[i].running_cost = runcost;

   378

			}

   379

		}	break;

   380

		case 0x0A:	/* Running cost base */

   381

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

   382

			FOR_EACH_ENGINE {

   383

				grf_load_byte(&buf);

   384

			}

   385

			ret = true;

   386

			break;

   387

		case 0x0E: {	/* Sprite ID */

   388

			FOR_EACH_ENGINE {

   389

				uint8 spriteid = grf_load_byte(&buf);

   390

   391

				if (spriteid == 0xFF)

   392

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

   393

   394

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

   395

				// in not having it here for the future.

   396

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

   397

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

   398

   399

				rvi[i].image_index = spriteid;

   400

			}

   401

		}	break;

   402

		case 0x0F: {	/* Cargo capacity */

   403

			FOR_EACH_ENGINE {

   404

				uint16 capacity = grf_load_word(&buf);

   405

   406

				rvi[i].capacity = capacity;

   407

			}

   408

		}	break;

   409

		case 0x10: { /* Cargo type */

   410

			FOR_EACH_ENGINE {

   411

				uint8 cargo = grf_load_byte(&buf);

   412

   413

				rvi[i].cargo_type = cargo;

   414

			}

   415

		}	break;

   416

		case 0x11: {	/* Cost factor */

   417

			FOR_EACH_ENGINE {

   418

				uint8 cost_factor = grf_load_byte(&buf);

   419

   420

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

   421

			}

   422

		}	break;

   423

		case 0x12: {	/* SFX */

   424

			FOR_EACH_ENGINE {

   425

				uint8 sfx = grf_load_byte(&buf);

   426

   427

				rvi[i].sfx = sfx;

   428

			}

   429

		}	break;

   430

		case 0x13:      /* Power in 10hp */

   431

		case 0x14:      /* Weight in 1/4 tons */

   432

		case 0x15:      /* Speed in mph*0.8 */

   433

			/* TODO: Support for road vehicles realistic power

   434

			 * computations (called rvpower in TTDPatch) is just

   435

			 * missing in OTTD yet. --pasky */

   436

			FOR_EACH_ENGINE {

   437

				grf_load_byte(&buf);

   438

			}

   439

			ret = true;

   440

			break;

   441

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

   442

			FOR_EACH_ENGINE {

   443

				uint32 refit_mask = grf_load_dword(&buf);

   444

   445

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   446

			}

   447

		}	break;

   448

		case 0x17:      /* Callback */

   449

		case 0x18:      /* Tractive effort */

   450

			/* TODO */

   451

			FOR_EACH_ENGINE {

   452

				grf_load_byte(&buf);

   453

			}

   454

			ret = true;

   455

			break;

   456

		default:

   457

			ret = true;

   458

	}

   459

   460

	*bufp = buf;

   461

	return ret;

   462

}

   463

   464

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

   465

{

   466

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   467

	byte *buf = *bufp;

   468

	int i;

   469

	bool ret = false;

   470

   471

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

   472

	switch (prop) {

   473

		case 0x08: {	/* Sprite ID */

   474

			FOR_EACH_ENGINE {

   475

				uint8 spriteid = grf_load_byte(&buf);

   476

   477

				if (spriteid == 0xFF)

   478

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

   479

   480

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

   481

				// in not having it here for the future.

   482

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

   483

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

   484

   485

				svi[i].image_index = spriteid;

   486

			}

   487

		}	break;

   488

		case 0x09: {	/* Refittable */

   489

			FOR_EACH_ENGINE {

   490

				uint8 refittable = grf_load_byte(&buf);

   491

   492

				svi[i].refittable = refittable;

   493

			}

   494

		}	break;

   495

		case 0x0A: {	/* Cost factor */

   496

			FOR_EACH_ENGINE {

   497

				uint8 cost_factor = grf_load_byte(&buf);

   498

   499

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

   500

			}

   501

		}	break;

   502

		case 0x0B: {	/* Speed */