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

    11

/* TTDPatch extended GRF format codec

    12

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

    13

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

    14

 *

    15

 * Contains portions of documentation by TTDPatch team.

    16

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

    17

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

    18

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

    19

    20

extern int _skip_sprites;

    21

extern int _replace_sprites_count[16];

    22

extern int _replace_sprites_offset[16];

    23

    24

struct GRFFile {

    25

	char *filename;

    26

	uint32 grfid;

    27

	uint16 flags;

    28

	uint16 sprite_offset;

    29

	struct GRFFile *next;

    30

    31

	/* A sprite group contains all sprites of a given vehicle (or multiple

    32

	 * vehicles) when carrying given cargo. It consists of several sprite

    33

	 * sets.  Group ids are refered as "cargo id"s by TTDPatch

    34

	 * documentation, contributing to the global confusion.

    35

	 *

    36

	 * A sprite set contains all sprites of a given vehicle carrying given

    37

	 * cargo at a given *stage* - that is usually its load stage. Ie. you

    38

	 * can have a spriteset for an empty wagon, wagon full of coal,

    39

	 * half-filled wagon etc.  Each spriteset contains eight sprites (one

    40

	 * per direction) or four sprites if the vehicle is symmetric. */

    41

    42

	int spriteset_start;

    43

	int spriteset_numsets;

    44

	int spriteset_numents;

    45

	int spriteset_feature;

    46

    47

	int spritegroups_count;

    48

	struct SpriteGroup *spritegroups;

    49

    50

	struct StationSpec stations[256];

    51

};

    52

    53

static struct GRFFile *_cur_grffile, *_first_grffile;

    54

static int _cur_spriteid;

    55

static int _cur_stage;

    56

    57

static int32 _paramlist[0x7f];

    58

static int _param_max;

    59

    60

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

    61

static uint32 _ttdpatch_flags[8];

    62

    63

    64

enum grfspec_feature {

    65

	GSF_TRAIN,

    66

	GSF_ROAD,

    67

	GSF_SHIP,

    68

	GSF_AIRCRAFT,

    69

	GSF_STATION,

    70

	GSF_BRIDGE,

    71

	GSF_TOWNHOUSE,

    72

};

    73

    74

    75

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

    76

    77

static const int _vehcounts[4] = {

    78

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    79

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    80

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    81

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    82

};

    83

    84

static const int _vehshifts[4] = {

    85

	/* GSF_TRAIN */    0,

    86

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    87

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    88

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    89

};

    90

    91

    92

/* Debugging messages policy:

    93

 *

    94

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

    95

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

    96

 *

    97

 * 0..2 - dedicated to grfmsg()

    98

 * 3

    99

 * 4

   100

 * 5

   101

 * 6 - action handler entry reporting - one per action

   102

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

   103

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

   104

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

   105

 */

   106

   107

   108

enum grfmsg_severity {

   109

	GMS_NOTICE,

   110

	GMS_WARN,

   111

	GMS_ERROR,

   112

	GMS_FATAL,

   113

};

   114

   115

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

   116

{

   117

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

   118

	int export_severity = 0;

   119

	char buf[1024];

   120

	va_list va;

   121

   122

	va_start(va, str);

   123

	vsprintf(buf, str, va);

   124

	va_end(va);

   125

   126

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

   127

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

   128

}

   129

   130

   131

#define check_length(real, wanted, where) \

   132

do { \

   133

	if (real < wanted) { \

   134

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

   135

		return; \

   136

	} \

   137

} while (0)

   138

   139

   140

static byte INLINE grf_load_byte(byte **buf)

   141

{

   142

	return *(*buf)++;

   143

}

   144

   145

static uint16 grf_load_word(byte **buf)

   146

{

   147

	uint16 val;

   148

	byte *p = *buf;

   149

	val = p[0];

   150

	val |= p[1] << 8;

   151

	*buf = p + 2;

   152

	return val;

   153

}

   154

   155

static uint16 grf_load_dword(byte **buf)

   156

{

   157

	uint32 val;

   158

	byte *p = *buf;

   159

	val = p[0];

   160

	val |= p[1] << 8;

   161

	val |= p[2] << 16;

   162

	val |= p[3] << 24;

   163

	*buf = p + 4;

   164

	return val;

   165

}

   166

   167

   168

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   169

{

   170

	struct GRFFile *file;

   171

   172

	file = _first_grffile;

   173

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

   174

		file = file->next;

   175

   176

	return file;

   177

}

   178

   179

static struct GRFFile *GetFileByFilename(const char *filename)

   180

{

   181

	struct GRFFile *file;

   182

   183

	file = _first_grffile;

   184

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

   185

		file = file->next;

   186

   187

	return file;

   188

}

   189

   190

   191

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

   192

   193

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

   194

   195

static void dewagonize(int condition, int engine)

   196

{

   197

	EngineInfo *ei = &_engine_info[engine];

   198

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   199

   200

	if (condition != 0) {

   201

		ei->unk2 &= ~0x80;

   202

		rvi->flags &= ~2;

   203

	} else {

   204

		ei->unk2 |= 0x80;

   205

		rvi->flags |= 2;

   206

	}

   207

}

   208

   209

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

   210

{

   211

	EngineInfo *ei = &_engine_info[engine];

   212

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   213

	byte *buf = *bufp;

   214

	int i;

   215

	bool ret = false;

   216

   217

	switch (prop) {

   218

		case 0x05: {	/* Track type */

   219

			FOR_EACH_ENGINE {

   220

				uint8 tracktype = grf_load_byte(&buf);

   221

   222

				ei[i].railtype_climates &= 0xf;

   223

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

   224

			}

   225

		}	break;

   226

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

   227

			/* TODO */

   228

			FOR_EACH_ENGINE {

   229

				grf_load_byte(&buf);

   230

			}

   231

			ret = true;

   232

		}	break;

   233

		case 0x09: {	/* Speed */

   234

			FOR_EACH_ENGINE {

   235

				uint16 speed = grf_load_word(&buf);

   236

   237

				rvi[i].max_speed = speed;

   238

				dewagonize(speed, engine + i);

   239

			}

   240

		}	break;

   241

		case 0x0B: {	/* Power */

   242

			FOR_EACH_ENGINE {

   243

				uint16 power = grf_load_word(&buf);

   244

   245

				rvi[i].power = power;

   246

				dewagonize(power, engine + i);

   247

			}

   248

		}	break;

   249

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

   250

			FOR_EACH_ENGINE {

   251

				uint8 runcostfact = grf_load_byte(&buf);

   252

   253

				rvi[i].running_cost_base = runcostfact;

   254

				dewagonize(runcostfact, engine + i);

   255

			}

   256

		}	break;

   257

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

   258

			FOR_EACH_ENGINE {

   259

				uint32 base = grf_load_dword(&buf);

   260

   261

				switch (base) {

   262

				case 0x4C30:

   263

					rvi[i].engclass = 0;

   264

					break;

   265

				case 0x4C36:

   266

					rvi[i].engclass = 1;

   267

					break;

   268

				case 0x4C3C:

   269

					rvi[i].engclass = 2;

   270

					break;

   271

				}

   272

				dewagonize(base, engine + i);

   273

			}

   274

		}	break;

   275

		case 0x12: {	/* Sprite ID */

   276

			FOR_EACH_ENGINE {

   277

				uint8 spriteid = grf_load_byte(&buf);

   278

   279

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

   280

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

   281

				rvi[i].image_index = spriteid;

   282

			}

   283

		}	break;

   284

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

   285

			FOR_EACH_ENGINE {

   286

				uint8 dual = grf_load_byte(&buf);

   287

   288

				if (dual != 0) {

   289

					rvi[i].flags |= 1;

   290

				} else {

   291

					rvi[i].flags &= ~1;

   292

				}

   293

			}

   294

		}	break;

   295

		case 0x14: {	/* Cargo capacity */

   296

			FOR_EACH_ENGINE {

   297

				uint8 capacity = grf_load_byte(&buf);

   298

   299

				rvi[i].capacity = capacity;

   300

			}

   301

		}	break;

   302

		case 0x15: {	/* Cargo type */

   303

			FOR_EACH_ENGINE {

   304

				uint8 ctype = grf_load_byte(&buf);

   305

   306

				rvi[i].cargo_type = ctype;

   307

			}

   308

		}	break;

   309

		case 0x16: {	/* Weight */

   310

			FOR_EACH_ENGINE {

   311

				uint8 weight = grf_load_byte(&buf);

   312

   313

				rvi[i].weight = weight;

   314

			}

   315

		}	break;

   316

		case 0x17: {	/* Cost factor */

   317

			FOR_EACH_ENGINE {

   318

				uint8 cfactor = grf_load_byte(&buf);

   319

   320

				rvi[i].base_cost = cfactor;

   321

			}

   322

		}	break;

   323

		case 0x18: {	/* AI rank */

   324

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

   325

			FOR_EACH_ENGINE {

   326

				grf_load_byte(&buf);

   327

			}

   328

			ret = true;

   329

		}	break;

   330

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

   331

			/* TODO: What do the individual numbers mean?

   332

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

   333

			FOR_EACH_ENGINE {

   334

				uint8 traction = grf_load_byte(&buf);

   335

				int engclass;

   336

   337

				if (traction <= 0x07)

   338

					engclass = 0;

   339

				else if (traction <= 0x27)

   340

					engclass = 1;

   341

				else if (traction <= 0x31)

   342

					engclass = 2;

   343

				else

   344

					break;

   345

   346

				rvi[i].engclass = engclass;

   347

			}

   348

		}	break;

   349

   350

		/* TODO */

   351

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

   352

		case 0x1D:	/* Refit cargo */

   353

			FOR_EACH_ENGINE {

   354

				grf_load_word(&buf);

   355

			}

   356

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

   357

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

   358

			FOR_EACH_ENGINE {

   359

				grf_load_byte(&buf);

   360

			}

   361

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

   362

		case 0x1A:	/* Sort order */

   363

		case 0x1C:	/* Refit cost */

   364

		case 0x1E:	/* Callback */

   365

		case 0x1F:	/* Tractive effort */

   366

		case 0x21:	/* Shorter tenders */

   367

		case 0x22:	/* Visual */

   368

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

   369

			/* TODO */

   370

			FOR_EACH_ENGINE {

   371

				grf_load_byte(&buf);

   372

			}

   373

			ret = true;

   374

		}	break;

   375

		default:

   376

			ret = true;

   377

	}

   378

	*bufp = buf;

   379

	return ret;

   380

}

   381

   382

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

   383

{

   384

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   385

	byte *buf = *bufp;

   386

	int i;

   387

	bool ret = false;

   388

   389

	switch (prop) {

   390

		case 0x08: {	/* Speed */

   391

			FOR_EACH_ENGINE {

   392

				uint8 speed = grf_load_byte(&buf);

   393

   394

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

   395

			}

   396

		}	break;

   397

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

   398

			FOR_EACH_ENGINE {

   399

				uint8 runcost = grf_load_byte(&buf);

   400

   401

				rvi[i].running_cost = runcost;

   402

			}

   403

		}	break;

   404

		case 0x0A:	/* Running cost base */

   405

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

   406

			FOR_EACH_ENGINE {

   407

				grf_load_byte(&buf);

   408

			}

   409

			ret = true;

   410

			break;

   411

		case 0x0E: {	/* Sprite ID */

   412

			FOR_EACH_ENGINE {

   413

				uint8 spriteid = grf_load_byte(&buf);

   414

   415

				if (spriteid == 0xFF)

   416

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

   417

   418

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

   419

				// in not having it here for the future.

   420

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

   421

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

   422

   423

				rvi[i].image_index = spriteid;

   424

			}

   425

		}	break;

   426

		case 0x0F: {	/* Cargo capacity */

   427

			FOR_EACH_ENGINE {

   428

				uint16 capacity = grf_load_word(&buf);

   429

   430

				rvi[i].capacity = capacity;

   431

			}

   432

		}	break;

   433

		case 0x10: { /* Cargo type */

   434

			FOR_EACH_ENGINE {

   435

				uint8 cargo = grf_load_byte(&buf);

   436

   437

				rvi[i].cargo_type = cargo;

   438

			}

   439

		}	break;

   440

		case 0x11: {	/* Cost factor */

   441

			FOR_EACH_ENGINE {

   442

				uint8 cost_factor = grf_load_byte(&buf);

   443

   444

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

   445

			}

   446

		}	break;

   447

		case 0x12: {	/* SFX */

   448

			FOR_EACH_ENGINE {

   449

				uint8 sfx = grf_load_byte(&buf);

   450

   451

				rvi[i].sfx = sfx;

   452

			}

   453

		}	break;

   454

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

   455

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

   456

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

   457

			/* TODO: Support for road vehicles realistic power

   458

			 * computations (called rvpower in TTDPatch) is just

   459

			 * missing in OTTD yet. --pasky */

   460

			FOR_EACH_ENGINE {

   461

				grf_load_byte(&buf);

   462

			}

   463

			ret = true;

   464

			break;

   465

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

   466

			FOR_EACH_ENGINE {

   467

				uint32 refit_mask = grf_load_dword(&buf);

   468

   469

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   470

			}

   471

		}	break;

   472

		case 0x17:      /* Callback */

   473

		case 0x18:      /* Tractive effort */

   474

			/* TODO */

   475

			FOR_EACH_ENGINE {

   476

				grf_load_byte(&buf);

   477

			}

   478

			ret = true;

   479

			break;

   480

		default:

   481

			ret = true;

   482

	}

   483

   484

	*bufp = buf;

   485

	return ret;

   486

}

   487

   488

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

   489

{

   490

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   491

	byte *buf = *bufp;

   492

	int i;

   493

	bool ret = false;

   494

   495

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

   496

	switch (prop) {

   497

		case 0x08: {	/* Sprite ID */

   498

			FOR_EACH_ENGINE {

   499

				uint8 spriteid = grf_load_byte(&buf);

   500

   501

				if (spriteid == 0xFF)