1

#include "stdafx.h"

     2

     3

#include <stdarg.h>

     4

     5

#include "ttd.h"

     6

#include "debug.h"

     7

#include "gfx.h"

     8

#include "fileio.h"

     9

#include "engine.h"

    10

#include "station.h"

    11

#include "sprite.h"

    12

#include "newgrf.h"

    13

    14

/* TTDPatch extended GRF format codec

    15

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

    16

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

    17

 *

    18

 * Contains portions of documentation by TTDPatch team.

    19

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

    20

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

    21

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

    22

    23

    24

extern int _skip_sprites;

    25

extern int _replace_sprites_count[16];

    26

extern int _replace_sprites_offset[16];

    27

extern int _traininfo_vehicle_pitch;

    28

    29

GRFFile *_cur_grffile;

    30

GRFFile *_first_grffile;

    31

int _grffile_count;

    32

static int _cur_spriteid;

    33

static int _cur_stage;

    34

extern uint16 _custom_sprites_base;

    35

    36

static int32 _paramlist[0x7f];

    37

static int _param_max;

    38

    39

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

    40

static uint32 _ttdpatch_flags[8];

    41

    42

    43

typedef enum grfspec_feature {

    44

	GSF_TRAIN,

    45

	GSF_ROAD,

    46

	GSF_SHIP,

    47

	GSF_AIRCRAFT,

    48

	GSF_STATION,

    49

	GSF_BRIDGE,

    50

	GSF_TOWNHOUSE,

    51

} grfspec_feature;

    52

    53

    54

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

    55

    56

static const int _vehcounts[4] = {

    57

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    58

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    59

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    60

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    61

};

    62

    63

static const int _vehshifts[4] = {

    64

	/* GSF_TRAIN */    0,

    65

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    66

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    67

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    68

};

    69

    70

    71

/* Debugging messages policy:

    72

 *

    73

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

    74

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

    75

 *

    76

 * 0..2 - dedicated to grfmsg()

    77

 * 3

    78

 * 4

    79

 * 5

    80

 * 6 - action handler entry reporting - one per action

    81

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

    82

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

    83

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

    84

 */

    85

    86

    87

typedef enum grfmsg_severity {

    88

	GMS_NOTICE,

    89

	GMS_WARN,

    90

	GMS_ERROR,

    91

	GMS_FATAL,

    92

} grfmsg_severity;

    93

    94

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

    95

{

    96

	static const char* const severitystr[] = {

    97

		"Notice",

    98

		"Warning",

    99

		"Error",

   100

		"Fatal"

   101

	};

   102

	int export_severity = 0;

   103

	char buf[1024];

   104

	va_list va;

   105

   106

	va_start(va, str);

   107

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

   108

	va_end(va);

   109

   110

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

   111

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

   112

}

   113

   114

   115

#define check_length(real, wanted, where) \

   116

do { \

   117

	if (real < wanted) { \

   118

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

   119

		       where, _cur_spriteid - _cur_grffile->sprite_offset, real, wanted); \

   120

		return; \

   121

	} \

   122

} while (0)

   123

   124

   125

static inline byte grf_load_byte(byte **buf)

   126

{

   127

	return *(*buf)++;

   128

}

   129

   130

static uint16 grf_load_word(byte **buf)

   131

{

   132

	uint16 val;

   133

	byte *p = *buf;

   134

	val = p[0];

   135

	val |= p[1] << 8;

   136

	*buf = p + 2;

   137

	return val;

   138

}

   139

   140

static uint16 grf_load_dword(byte **buf)

   141

{

   142

	uint32 val;

   143

	byte *p = *buf;

   144

	val = p[0];

   145

	val |= p[1] << 8;

   146

	val |= p[2] << 16;

   147

	val |= p[3] << 24;

   148

	*buf = p + 4;

   149

	return val;

   150

}

   151

   152

   153

static GRFFile *GetFileByGRFID(uint32 grfid)

   154

{

   155

	GRFFile *file;

   156

   157

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

   158

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

   159

	}

   160

	return file;

   161

}

   162

   163

static GRFFile *GetFileByFilename(const char *filename)

   164

{

   165

	GRFFile *file;

   166

   167

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

   168

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

   169

	}

   170

	return file;

   171

}

   172

   173

   174

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

   175

   176

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

   177

   178

static void dewagonize(int condition, int engine)

   179

{

   180

	EngineInfo *ei = &_engine_info[engine];

   181

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   182

   183

	if (condition != 0) {

   184

		ei->unk2 &= ~0x80;

   185

		rvi->flags &= ~2;

   186

	} else {

   187

		ei->unk2 |= 0x80;

   188

		rvi->flags |= 2;

   189

	}

   190

}

   191

   192

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

   193

{

   194

	EngineInfo *ei = &_engine_info[engine];

   195

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   196

	byte *buf = *bufp;

   197

	int i;

   198

	bool ret = false;

   199

   200

	switch (prop) {

   201

		case 0x05: {	/* Track type */

   202

			FOR_EACH_OBJECT {

   203

				uint8 tracktype = grf_load_byte(&buf);

   204

   205

				ei[i].railtype_climates &= 0xf;

   206

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

   207

			}

   208

		}	break;

   209

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

   210

			/* TODO */

   211

			FOR_EACH_OBJECT {

   212

				grf_load_byte(&buf);

   213

			}

   214

			ret = true;

   215

		}	break;

   216

		case 0x09: {	/* Speed */

   217

			FOR_EACH_OBJECT {

   218

				uint16 speed = grf_load_word(&buf);

   219

   220

				rvi[i].max_speed = speed;

   221

				dewagonize(speed, engine + i);

   222

			}

   223

		}	break;

   224

		case 0x0B: {	/* Power */

   225

			FOR_EACH_OBJECT {

   226

				uint16 power = grf_load_word(&buf);

   227

   228

				rvi[i].power = power;

   229

				dewagonize(power, engine + i);

   230

			}

   231

		}	break;

   232

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

   233

			FOR_EACH_OBJECT {

   234

				uint8 runcostfact = grf_load_byte(&buf);

   235

   236

				rvi[i].running_cost_base = runcostfact;

   237

				dewagonize(runcostfact, engine + i);

   238

			}

   239

		}	break;

   240

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

   241

			FOR_EACH_OBJECT {

   242

				uint32 base = grf_load_dword(&buf);

   243

   244

				switch (base) {

   245

				case 0x4C30:

   246

					rvi[i].engclass = 0;

   247

					break;

   248

				case 0x4C36:

   249

					rvi[i].engclass = 1;

   250

					break;

   251

				case 0x4C3C:

   252

					rvi[i].engclass = 2;

   253

					break;

   254

				}

   255

				dewagonize(base, engine + i);

   256

			}

   257

		}	break;

   258

		case 0x12: {	/* Sprite ID */

   259

			FOR_EACH_OBJECT {

   260

				uint8 spriteid = grf_load_byte(&buf);

   261

   262

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

   263

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

   264

				rvi[i].image_index = spriteid;

   265

			}

   266

		}	break;

   267

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

   268

			FOR_EACH_OBJECT {

   269

				uint8 dual = grf_load_byte(&buf);

   270

   271

				if (dual != 0) {

   272

					rvi[i].flags |= 1;

   273

				} else {

   274

					rvi[i].flags &= ~1;

   275

				}

   276

			}

   277

		}	break;

   278

		case 0x14: {	/* Cargo capacity */

   279

			FOR_EACH_OBJECT {

   280

				uint8 capacity = grf_load_byte(&buf);

   281

   282

				rvi[i].capacity = capacity;

   283

			}

   284

		}	break;

   285

		case 0x15: {	/* Cargo type */

   286

			FOR_EACH_OBJECT {

   287

				uint8 ctype = grf_load_byte(&buf);

   288

   289

				rvi[i].cargo_type = ctype;

   290

			}

   291

		}	break;

   292

		case 0x16: {	/* Weight */

   293

			FOR_EACH_OBJECT {

   294

				uint8 weight = grf_load_byte(&buf);

   295

   296

				rvi[i].weight = weight;

   297

			}

   298

		}	break;

   299

		case 0x17: {	/* Cost factor */

   300

			FOR_EACH_OBJECT {

   301

				uint8 cfactor = grf_load_byte(&buf);

   302

   303

				rvi[i].base_cost = cfactor;

   304

			}

   305

		}	break;

   306

		case 0x18: {	/* AI rank */

   307

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

   308

			FOR_EACH_OBJECT {

   309

				grf_load_byte(&buf);

   310

			}

   311

			ret = true;

   312

		}	break;

   313

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

   314

			/* TODO: What do the individual numbers mean?

   315

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

   316

			FOR_EACH_OBJECT {

   317

				uint8 traction = grf_load_byte(&buf);

   318

				int engclass;

   319

   320

				if (traction <= 0x07)

   321

					engclass = 0;

   322

				else if (traction <= 0x27)

   323

					engclass = 1;

   324

				else if (traction <= 0x31)

   325

					engclass = 2;

   326

				else

   327

					break;

   328

   329

				rvi[i].engclass = engclass;

   330

			}

   331

		}	break;

   332

		case 0x1D: {	/* Refit cargo */

   333

			FOR_EACH_OBJECT {

   334

				uint32 refit_mask = grf_load_dword(&buf);

   335

   336

				_engine_refit_masks[engine + i] = refit_mask;

   337

			}

   338

		}	break;

   339

   340

		/* TODO */

   341

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

   342

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

   343

			FOR_EACH_OBJECT {

   344

				grf_load_byte(&buf);

   345

			}

   346

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

   347

		case 0x1A:	/* Sort order */

   348

		case 0x1C:	/* Refit cost */

   349

		case 0x1E:	/* Callback */

   350

		case 0x1F:	/* Tractive effort */

   351

		case 0x21:	/* Shorter tenders */

   352

		case 0x22:	/* Visual */

   353

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

   354

			/* TODO */

   355

			FOR_EACH_OBJECT {

   356

				grf_load_byte(&buf);

   357

			}

   358

			ret = true;

   359

		}	break;

   360

		default:

   361

			ret = true;

   362

	}

   363

	*bufp = buf;

   364

	return ret;

   365

}

   366

   367

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

   368

{

   369

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   370

	byte *buf = *bufp;

   371

	int i;

   372

	bool ret = false;

   373

   374

	switch (prop) {

   375

		case 0x08: {	/* Speed */

   376

			FOR_EACH_OBJECT {

   377

				uint8 speed = grf_load_byte(&buf);

   378

   379

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

   380

			}

   381

		}	break;

   382

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

   383

			FOR_EACH_OBJECT {

   384

				uint8 runcost = grf_load_byte(&buf);

   385

   386

				rvi[i].running_cost = runcost;

   387

			}

   388

		}	break;

   389

		case 0x0A:	/* Running cost base */

   390

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

   391

			FOR_EACH_OBJECT {

   392

				grf_load_byte(&buf);

   393

			}

   394

			ret = true;

   395

			break;

   396

		case 0x0E: {	/* Sprite ID */

   397

			FOR_EACH_OBJECT {

   398

				uint8 spriteid = grf_load_byte(&buf);

   399

   400

				if (spriteid == 0xFF)

   401

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

   402

   403

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

   404

				// in not having it here for the future.

   405

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

   406

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

   407

   408

				rvi[i].image_index = spriteid;

   409

			}

   410

		}	break;

   411

		case 0x0F: {	/* Cargo capacity */

   412

			FOR_EACH_OBJECT {

   413

				uint16 capacity = grf_load_word(&buf);

   414

   415

				rvi[i].capacity = capacity;

   416

			}

   417

		}	break;

   418

		case 0x10: { /* Cargo type */

   419

			FOR_EACH_OBJECT {

   420

				uint8 cargo = grf_load_byte(&buf);

   421

   422

				rvi[i].cargo_type = cargo;

   423

			}

   424

		}	break;

   425

		case 0x11: {	/* Cost factor */

   426

			FOR_EACH_OBJECT {

   427

				uint8 cost_factor = grf_load_byte(&buf);

   428

   429

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

   430

			}

   431

		}	break;

   432

		case 0x12: {	/* SFX */

   433

			FOR_EACH_OBJECT {

   434

				uint8 sfx = grf_load_byte(&buf);

   435

   436

				rvi[i].sfx = sfx;

   437

			}

   438

		}	break;

   439

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

   440

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

   441

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

   442

			/* TODO: Support for road vehicles realistic power

   443

			 * computations (called rvpower in TTDPatch) is just

   444

			 * missing in OTTD yet. --pasky */

   445

			FOR_EACH_OBJECT {

   446

				grf_load_byte(&buf);

   447

			}

   448

			ret = true;

   449

			break;

   450

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

   451

			FOR_EACH_OBJECT {

   452

				uint32 refit_mask = grf_load_dword(&buf);

   453

   454

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   455

			}

   456

		}	break;

   457

		case 0x17:      /* Callback */

   458

		case 0x18:      /* Tractive effort */

   459

			/* TODO */

   460

			FOR_EACH_OBJECT {

   461

				grf_load_byte(&buf);

   462

			}

   463

			ret = true;

   464

			break;

   465

		default:

   466

			ret = true;

   467

	}

   468

   469

	*bufp = buf;

   470

	return ret;

   471

}

   472

   473

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

   474

{

   475

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   476

	byte *buf = *bufp;

   477

	int i;

   478

	bool ret = false;

   479

   480

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

   481

	switch (prop) {

   482

		case 0x08: {	/* Sprite ID */

   483

			FOR_EACH_OBJECT {

   484

				uint8 spriteid = grf_load_byte(&buf);

   485

   486

				if (spriteid == 0xFF)

   487

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

   488

   489

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

   490

				// in not having it here for the future.

   491

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

   492

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

   493

   494

				svi[i].image_index = spriteid;

   495

			}

   496

		}	break;

   497

		case 0x09: {	/* Refittable */

   498

			FOR_EACH_OBJECT {

   499

				uint8 refittable = grf_load_byte(&buf);

   500

   501

				svi[i].refittable = refittable;

   502

			}

   503

		}	break;

   504

		case 0x0A: {	/* Cost factor */

   505

			FOR_EACH_OBJECT {

   506

				uint8 cost_factor = grf_load_byte(&buf);

   507

   508

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

   509

			}

   510

		}	break;

   511

		case 0x0B: {	/* Speed */

   512

			FOR_EACH_OBJECT {

   513

				uint8 speed = grf_load_byte(&buf);

   514

   515

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

   516

			}

   517

		}	break;

   518

		case 0x0C: { /* Cargo type */

   519

			FOR_EACH_OBJECT {

   520

				uint8 cargo = grf_load_byte(&buf);

   521

   522

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

   523

#if 0

   524

				// Documentation claims this is already the

   525