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

#include "station.h"

    10

#include "sprite.h"

    11

#include "newgrf.h"

    12

    13

/* TTDPatch extended GRF format codec

    14

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

    15

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

    16

 *

    17

 * Contains portions of documentation by TTDPatch team.

    18

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

    19

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

    20

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

    21

    22

    23

extern int _skip_sprites;

    24

extern int _replace_sprites_count[16];

    25

extern int _replace_sprites_offset[16];

    26

extern int _traininfo_vehicle_pitch;

    27

    28

struct GRFFile *_cur_grffile, *_first_grffile;

    29

int _grffile_count;

    30

static int _cur_spriteid;

    31

static int _cur_stage;

    32

extern int _custom_sprites_base;

    33

    34

static int32 _paramlist[0x7f];

    35

static int _param_max;

    36

    37

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

    38

static uint32 _ttdpatch_flags[8];

    39

    40

    41

enum grfspec_feature {

    42

	GSF_TRAIN,

    43

	GSF_ROAD,

    44

	GSF_SHIP,

    45

	GSF_AIRCRAFT,

    46

	GSF_STATION,

    47

	GSF_BRIDGE,

    48

	GSF_TOWNHOUSE,

    49

};

    50

    51

    52

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

    53

    54

static const int _vehcounts[4] = {

    55

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    56

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    57

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    58

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    59

};

    60

    61

static const int _vehshifts[4] = {

    62

	/* GSF_TRAIN */    0,

    63

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    64

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    65

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    66

};

    67

    68

    69

/* Debugging messages policy:

    70

 *

    71

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

    72

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

    73

 *

    74

 * 0..2 - dedicated to grfmsg()

    75

 * 3

    76

 * 4

    77

 * 5

    78

 * 6 - action handler entry reporting - one per action

    79

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

    80

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

    81

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

    82

 */

    83

    84

    85

enum grfmsg_severity {

    86

	GMS_NOTICE,

    87

	GMS_WARN,

    88

	GMS_ERROR,

    89

	GMS_FATAL,

    90

};

    91

    92

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

    93

{

    94

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

    95

	int export_severity = 0;

    96

	char buf[1024];

    97

	va_list va;

    98

    99

	va_start(va, str);

   100

	vsprintf(buf, str, va);

   101

	va_end(va);

   102

   103

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

   104

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

   105

}

   106

   107

   108

#define check_length(real, wanted, where) \

   109

do { \

   110

	if (real < wanted) { \

   111

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

   112

		return; \

   113

	} \

   114

} while (0)

   115

   116

   117

static inline byte grf_load_byte(byte **buf)

   118

{

   119

	return *(*buf)++;

   120

}

   121

   122

static uint16 grf_load_word(byte **buf)

   123

{

   124

	uint16 val;

   125

	byte *p = *buf;

   126

	val = p[0];

   127

	val |= p[1] << 8;

   128

	*buf = p + 2;

   129

	return val;

   130

}

   131

   132

static uint16 grf_load_dword(byte **buf)

   133

{

   134

	uint32 val;

   135

	byte *p = *buf;

   136

	val = p[0];

   137

	val |= p[1] << 8;

   138

	val |= p[2] << 16;

   139

	val |= p[3] << 24;

   140

	*buf = p + 4;

   141

	return val;

   142

}

   143

   144

   145

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   146

{

   147

	struct GRFFile *file;

   148

   149

	file = _first_grffile;

   150

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

   151

		file = file->next;

   152

   153

	return file;

   154

}

   155

   156

static struct GRFFile *GetFileByFilename(const char *filename)

   157

{

   158

	struct GRFFile *file;

   159

   160

	file = _first_grffile;

   161

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

   162

		file = file->next;

   163

   164

	return file;

   165

}

   166

   167

   168

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

   169

   170

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

   171

   172

static void dewagonize(int condition, int engine)

   173

{

   174

	EngineInfo *ei = &_engine_info[engine];

   175

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   176

   177

	if (condition != 0) {

   178

		ei->unk2 &= ~0x80;

   179

		rvi->flags &= ~2;

   180

	} else {

   181

		ei->unk2 |= 0x80;

   182

		rvi->flags |= 2;

   183

	}

   184

}

   185

   186

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

   187

{

   188

	EngineInfo *ei = &_engine_info[engine];

   189

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   190

	byte *buf = *bufp;

   191

	int i;

   192

	bool ret = false;

   193

   194

	switch (prop) {

   195

		case 0x05: {	/* Track type */

   196

			FOR_EACH_OBJECT {

   197

				uint8 tracktype = grf_load_byte(&buf);

   198

   199

				ei[i].railtype_climates &= 0xf;

   200

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

   201

			}

   202

		}	break;

   203

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

   204

			/* TODO */

   205

			FOR_EACH_OBJECT {

   206

				grf_load_byte(&buf);

   207

			}

   208

			ret = true;

   209

		}	break;

   210

		case 0x09: {	/* Speed */

   211

			FOR_EACH_OBJECT {

   212

				uint16 speed = grf_load_word(&buf);

   213

   214

				rvi[i].max_speed = speed;

   215

				dewagonize(speed, engine + i);

   216

			}

   217

		}	break;

   218

		case 0x0B: {	/* Power */

   219

			FOR_EACH_OBJECT {

   220

				uint16 power = grf_load_word(&buf);

   221

   222

				rvi[i].power = power;

   223

				dewagonize(power, engine + i);

   224

			}

   225

		}	break;

   226

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

   227

			FOR_EACH_OBJECT {

   228

				uint8 runcostfact = grf_load_byte(&buf);

   229

   230

				rvi[i].running_cost_base = runcostfact;

   231

				dewagonize(runcostfact, engine + i);

   232

			}

   233

		}	break;

   234

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

   235

			FOR_EACH_OBJECT {

   236

				uint32 base = grf_load_dword(&buf);

   237

   238

				switch (base) {

   239

				case 0x4C30:

   240

					rvi[i].engclass = 0;

   241

					break;

   242

				case 0x4C36:

   243

					rvi[i].engclass = 1;

   244

					break;

   245

				case 0x4C3C:

   246

					rvi[i].engclass = 2;

   247

					break;

   248

				}

   249

				dewagonize(base, engine + i);

   250

			}

   251

		}	break;

   252

		case 0x12: {	/* Sprite ID */

   253

			FOR_EACH_OBJECT {

   254

				uint8 spriteid = grf_load_byte(&buf);

   255

   256

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

   257

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

   258

				rvi[i].image_index = spriteid;

   259

			}

   260

		}	break;

   261

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

   262

			FOR_EACH_OBJECT {

   263

				uint8 dual = grf_load_byte(&buf);

   264

   265

				if (dual != 0) {

   266

					rvi[i].flags |= 1;

   267

				} else {

   268

					rvi[i].flags &= ~1;

   269

				}

   270

			}

   271

		}	break;

   272

		case 0x14: {	/* Cargo capacity */

   273

			FOR_EACH_OBJECT {

   274

				uint8 capacity = grf_load_byte(&buf);

   275

   276

				rvi[i].capacity = capacity;

   277

			}

   278

		}	break;

   279

		case 0x15: {	/* Cargo type */

   280

			FOR_EACH_OBJECT {

   281

				uint8 ctype = grf_load_byte(&buf);

   282

   283

				rvi[i].cargo_type = ctype;

   284

			}

   285

		}	break;

   286

		case 0x16: {	/* Weight */

   287

			FOR_EACH_OBJECT {

   288

				uint8 weight = grf_load_byte(&buf);

   289

   290

				rvi[i].weight = weight;

   291

			}

   292

		}	break;

   293

		case 0x17: {	/* Cost factor */

   294

			FOR_EACH_OBJECT {

   295

				uint8 cfactor = grf_load_byte(&buf);

   296

   297

				rvi[i].base_cost = cfactor;

   298

			}

   299

		}	break;

   300

		case 0x18: {	/* AI rank */

   301

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

   302

			FOR_EACH_OBJECT {

   303

				grf_load_byte(&buf);

   304

			}

   305

			ret = true;

   306

		}	break;

   307

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

   308

			/* TODO: What do the individual numbers mean?

   309

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

   310

			FOR_EACH_OBJECT {

   311

				uint8 traction = grf_load_byte(&buf);

   312

				int engclass;

   313

   314

				if (traction <= 0x07)

   315

					engclass = 0;

   316

				else if (traction <= 0x27)

   317

					engclass = 1;

   318

				else if (traction <= 0x31)

   319

					engclass = 2;

   320

				else

   321

					break;

   322

   323

				rvi[i].engclass = engclass;

   324

			}

   325

		}	break;

   326

		case 0x1D: {	/* Refit cargo */

   327

			FOR_EACH_OBJECT {

   328

				uint32 refit_mask = grf_load_dword(&buf);

   329

   330

				_engine_refit_masks[engine + i] = refit_mask;

   331

			}

   332

		}	break;

   333

   334

		/* TODO */

   335

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

   336

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

   337

			FOR_EACH_OBJECT {

   338

				grf_load_byte(&buf);

   339

			}

   340

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

   341

		case 0x1A:	/* Sort order */

   342

		case 0x1C:	/* Refit cost */

   343

		case 0x1E:	/* Callback */

   344

		case 0x1F:	/* Tractive effort */

   345

		case 0x21:	/* Shorter tenders */

   346

		case 0x22:	/* Visual */

   347

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

   348

			/* TODO */

   349

			FOR_EACH_OBJECT {

   350

				grf_load_byte(&buf);

   351

			}

   352

			ret = true;

   353

		}	break;

   354

		default:

   355

			ret = true;

   356

	}

   357

	*bufp = buf;

   358

	return ret;

   359

}

   360

   361

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

   362

{

   363

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   364

	byte *buf = *bufp;

   365

	int i;

   366

	bool ret = false;

   367

   368

	switch (prop) {

   369

		case 0x08: {	/* Speed */

   370

			FOR_EACH_OBJECT {

   371

				uint8 speed = grf_load_byte(&buf);

   372

   373

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

   374

			}

   375

		}	break;

   376

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

   377

			FOR_EACH_OBJECT {

   378

				uint8 runcost = grf_load_byte(&buf);

   379

   380

				rvi[i].running_cost = runcost;

   381

			}

   382

		}	break;

   383

		case 0x0A:	/* Running cost base */

   384

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

   385

			FOR_EACH_OBJECT {

   386

				grf_load_byte(&buf);

   387

			}

   388

			ret = true;

   389

			break;

   390

		case 0x0E: {	/* Sprite ID */

   391

			FOR_EACH_OBJECT {

   392

				uint8 spriteid = grf_load_byte(&buf);

   393

   394

				if (spriteid == 0xFF)

   395

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

   396

   397

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

   398

				// in not having it here for the future.

   399

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

   400

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

   401

   402

				rvi[i].image_index = spriteid;

   403

			}

   404

		}	break;

   405

		case 0x0F: {	/* Cargo capacity */

   406

			FOR_EACH_OBJECT {

   407

				uint16 capacity = grf_load_word(&buf);

   408

   409

				rvi[i].capacity = capacity;

   410

			}

   411

		}	break;

   412

		case 0x10: { /* Cargo type */

   413

			FOR_EACH_OBJECT {

   414

				uint8 cargo = grf_load_byte(&buf);

   415

   416

				rvi[i].cargo_type = cargo;

   417

			}

   418

		}	break;

   419

		case 0x11: {	/* Cost factor */

   420

			FOR_EACH_OBJECT {

   421

				uint8 cost_factor = grf_load_byte(&buf);

   422

   423

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

   424

			}

   425

		}	break;

   426

		case 0x12: {	/* SFX */

   427

			FOR_EACH_OBJECT {

   428

				uint8 sfx = grf_load_byte(&buf);

   429

   430

				rvi[i].sfx = sfx;

   431

			}

   432

		}	break;

   433

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

   434

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

   435

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

   436

			/* TODO: Support for road vehicles realistic power

   437

			 * computations (called rvpower in TTDPatch) is just

   438

			 * missing in OTTD yet. --pasky */

   439

			FOR_EACH_OBJECT {

   440

				grf_load_byte(&buf);

   441

			}

   442

			ret = true;

   443

			break;

   444

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

   445

			FOR_EACH_OBJECT {

   446

				uint32 refit_mask = grf_load_dword(&buf);

   447

   448

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   449

			}

   450

		}	break;

   451

		case 0x17:      /* Callback */

   452

		case 0x18:      /* Tractive effort */

   453

			/* TODO */

   454

			FOR_EACH_OBJECT {

   455

				grf_load_byte(&buf);

   456

			}

   457

			ret = true;

   458

			break;

   459

		default:

   460

			ret = true;

   461

	}

   462

   463

	*bufp = buf;

   464

	return ret;

   465

}

   466

   467

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

   468

{

   469

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   470

	byte *buf = *bufp;

   471

	int i;

   472

	bool ret = false;

   473

   474

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

   475

	switch (prop) {

   476

		case 0x08: {	/* Sprite ID */

   477

			FOR_EACH_OBJECT {

   478

				uint8 spriteid = grf_load_byte(&buf);

   479

   480

				if (spriteid == 0xFF)

   481

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

   482

   483

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

   484

				// in not having it here for the future.

   485

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

   486

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

   487

   488

				svi[i].image_index = spriteid;

   489

			}

   490

		}	break;

   491

		case 0x09: {	/* Refittable */

   492

			FOR_EACH_OBJECT {

   493

				uint8 refittable = grf_load_byte(&buf);

   494

   495

				svi[i].refittable = refittable;

   496

			}

   497

		}	break;

   498

		case 0x0A: {	/* Cost factor */

   499

			FOR_EACH_OBJECT {

   500

				uint8 cost_factor = grf_load_byte(&buf);

   501

   502

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

   503

			}

   504

		}	break;

   505

		case 0x0B: {	/* Speed */

   506

			FOR_EACH_OBJECT {

   507

				uint8 speed = grf_load_byte(&buf);

   508

   509

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

   510

			}

   511

		}	break;

   512

		case 0x0C: { /* Cargo type */

   513

			FOR_EACH_OBJECT {

   514

				uint8 cargo = grf_load_byte(&buf);

   515

   516

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

   517

#if 0

   518

				// Documentation claims this is already the

   519

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

   520

				// assume otherwise.

   521

				cargo = local_cargo_id_ctype[cargo];

   522

#endif

   523

				svi[i].cargo_type = cargo;

   524

			}

   525

		}	break;

   526

		case 0x0D: {	/* Cargo capacity */

   527

			FOR_EACH_OBJECT {

   528

				uint16 capacity = grf_load_word(&buf);

   529