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

    30

struct GRFFile {

    31

	char *filename;

    32

	uint32 grfid;

    33

	uint16 flags;

    34

	uint16 sprite_offset;

    35

	struct GRFFile *next;

    36

    37

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

    38

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

    39

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

    40

	 * documentation, contributing to the global confusion.

    41

	 *

    42

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

    43

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

    44

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

    45

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

    46

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

    47

    48

	int spriteset_start;

    49

	int spriteset_numsets;

    50

	int spriteset_numents;

    51

	int spriteset_feature;

    52

    53

	int spritegroups_count;

    54

	struct SpriteGroup *spritegroups;

    55

    57

};

    58

    59

static struct GRFFile *_cur_grffile, *_first_grffile;

    60

static int _cur_spriteid;

    61

static int _cur_stage;

    62

    63

static int32 _paramlist[0x7f];

    64

static int _param_max;

    65

    66

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

    67

static uint32 _ttdpatch_flags[8];

    68

    69

    70

enum grfspec_feature {

    71

	GSF_TRAIN,

    72

	GSF_ROAD,

    73

	GSF_SHIP,

    74

	GSF_AIRCRAFT,

    75

	GSF_STATION,

    76

	GSF_BRIDGE,

    77

	GSF_TOWNHOUSE,

    78

};

    79

    80

    81

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

    82

    83

static const int _vehcounts[4] = {

    84

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    85

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    86

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    87

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    88

};

    89

    90

static const int _vehshifts[4] = {

    91

	/* GSF_TRAIN */    0,

    92

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    93

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    94

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    95

};

    96

    97

    98

/* Debugging messages policy:

    99

 *

   100

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

   101

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

   102

 *

   103

 * 0..2 - dedicated to grfmsg()

   104

 * 3

   105

 * 4

   106

 * 5

   107

 * 6 - action handler entry reporting - one per action

   108

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

   109

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

   110

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

   111

 */

   112

   113

   114

enum grfmsg_severity {

   115

	GMS_NOTICE,

   116

	GMS_WARN,

   117

	GMS_ERROR,

   118

	GMS_FATAL,

   119

};

   120

   121

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

   122

{

   123

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

   124

	int export_severity = 0;

   125

	char buf[1024];

   126

	va_list va;

   127

   128

	va_start(va, str);

   129

	vsprintf(buf, str, va);

   130

	va_end(va);

   131

   132

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

   133

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

   134

}

   135

   136

   137

#define check_length(real, wanted, where) \

   138

do { \

   139

	if (real < wanted) { \

   140

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

   141

		return; \

   142

	} \

   143

} while (0)

   144

   145

   146

static byte INLINE grf_load_byte(byte **buf)

   147

{

   148

	return *(*buf)++;

   149

}

   150

   151

static uint16 grf_load_word(byte **buf)

   152

{

   153

	uint16 val;

   154

	byte *p = *buf;

   155

	val = p[0];

   156

	val |= p[1] << 8;

   157

	*buf = p + 2;

   158

	return val;

   159

}

   160

   161

static uint16 grf_load_dword(byte **buf)

   162

{

   163

	uint32 val;

   164

	byte *p = *buf;

   165

	val = p[0];

   166

	val |= p[1] << 8;

   167

	val |= p[2] << 16;

   168

	val |= p[3] << 24;

   169

	*buf = p + 4;

   170

	return val;

   171

}

   172

   173

   174

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   175

{

   176

	struct GRFFile *file;

   177

   178

	file = _first_grffile;

   179

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

   180

		file = file->next;

   181

   182

	return file;

   183

}

   184

   185

static struct GRFFile *GetFileByFilename(const char *filename)

   186

{

   187

	struct GRFFile *file;

   188

   189

	file = _first_grffile;

   190

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

   191

		file = file->next;

   192

   193

	return file;

   194

}

   195

   196

   197

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

   198

   199

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

   200

   201

static void dewagonize(int condition, int engine)

   202

{

   203

	EngineInfo *ei = &_engine_info[engine];

   204

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   205

   206

	if (condition != 0) {

   207

		ei->unk2 &= ~0x80;

   208

		rvi->flags &= ~2;

   209

	} else {

   210

		ei->unk2 |= 0x80;

   211

		rvi->flags |= 2;

   212

	}

   213

}

   214

   215

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

   216

{

   217

	EngineInfo *ei = &_engine_info[engine];

   218

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   219

	byte *buf = *bufp;

   220

	int i;

   221

	bool ret = false;

   222

   223

	switch (prop) {

   224

		case 0x05: {	/* Track type */

   225

			FOR_EACH_ENGINE {

   226

				uint8 tracktype = grf_load_byte(&buf);

   227

   228

				ei[i].railtype_climates &= 0xf;

   229

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

   230

			}

   231

		}	break;

   232

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

   233

			/* TODO */

   234

			FOR_EACH_ENGINE {

   235

				grf_load_byte(&buf);

   236

			}

   237

			ret = true;

   238

		}	break;

   239

		case 0x09: {	/* Speed */

   240

			FOR_EACH_ENGINE {

   241

				uint16 speed = grf_load_word(&buf);

   242

   243

				rvi[i].max_speed = speed;

   244

				dewagonize(speed, engine + i);

   245

			}

   246

		}	break;

   247

		case 0x0B: {	/* Power */

   248

			FOR_EACH_ENGINE {

   249

				uint16 power = grf_load_word(&buf);

   250

   251

				rvi[i].power = power;

   252

				dewagonize(power, engine + i);

   253

			}

   254

		}	break;

   255

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

   256

			FOR_EACH_ENGINE {

   257

				uint8 runcostfact = grf_load_byte(&buf);

   258

   259

				rvi[i].running_cost_base = runcostfact;

   260

				dewagonize(runcostfact, engine + i);

   261

			}

   262

		}	break;

   263

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

   264

			FOR_EACH_ENGINE {

   265

				uint32 base = grf_load_dword(&buf);

   266

   267

				switch (base) {

   268

				case 0x4C30:

   269

					rvi[i].engclass = 0;

   270

					break;

   271

				case 0x4C36:

   272

					rvi[i].engclass = 1;

   273

					break;

   274

				case 0x4C3C:

   275

					rvi[i].engclass = 2;

   276

					break;

   277

				}

   278

				dewagonize(base, engine + i);

   279

			}

   280

		}	break;

   281

		case 0x12: {	/* Sprite ID */

   282

			FOR_EACH_ENGINE {

   283

				uint8 spriteid = grf_load_byte(&buf);

   284

   285

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

   286

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

   287

				rvi[i].image_index = spriteid;

   288

			}

   289

		}	break;

   290

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

   291

			FOR_EACH_ENGINE {

   292

				uint8 dual = grf_load_byte(&buf);

   293

   294

				if (dual != 0) {

   295

					rvi[i].flags |= 1;

   296

				} else {

   297

					rvi[i].flags &= ~1;

   298

				}

   299

			}

   300

		}	break;

   301

		case 0x14: {	/* Cargo capacity */

   302

			FOR_EACH_ENGINE {

   303

				uint8 capacity = grf_load_byte(&buf);

   304

   305

				rvi[i].capacity = capacity;

   306

			}

   307

		}	break;

   308

		case 0x15: {	/* Cargo type */

   309

			FOR_EACH_ENGINE {

   310

				uint8 ctype = grf_load_byte(&buf);

   311

   312

				rvi[i].cargo_type = ctype;

   313

			}

   314

		}	break;

   315

		case 0x16: {	/* Weight */

   316

			FOR_EACH_ENGINE {

   317

				uint8 weight = grf_load_byte(&buf);

   318

   319

				rvi[i].weight = weight;

   320

			}

   321

		}	break;

   322

		case 0x17: {	/* Cost factor */

   323

			FOR_EACH_ENGINE {

   324

				uint8 cfactor = grf_load_byte(&buf);

   325

   326

				rvi[i].base_cost = cfactor;

   327

			}

   328

		}	break;

   329

		case 0x18: {	/* AI rank */

   330

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

   331

			FOR_EACH_ENGINE {

   332

				grf_load_byte(&buf);

   333

			}

   334

			ret = true;

   335

		}	break;

   336

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

   337

			/* TODO: What do the individual numbers mean?

   338

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

   339

			FOR_EACH_ENGINE {

   340

				uint8 traction = grf_load_byte(&buf);

   341

				int engclass;

   342

   343

				if (traction <= 0x07)

   344

					engclass = 0;

   345

				else if (traction <= 0x27)

   346

					engclass = 1;

   347

				else if (traction <= 0x31)

   348

					engclass = 2;

   349

				else

   350

					break;

   351

   352

				rvi[i].engclass = engclass;

   353

			}

   354

		}	break;

   355

   356

		/* TODO */

   357

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

   358

		case 0x1D:	/* Refit cargo */

   359

			FOR_EACH_ENGINE {

   360

				grf_load_word(&buf);

   361

			}

   362

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

   363

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

   364

			FOR_EACH_ENGINE {

   365

				grf_load_byte(&buf);

   366

			}

   367

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

   368

		case 0x1A:	/* Sort order */

   369

		case 0x1C:	/* Refit cost */

   370

		case 0x1E:	/* Callback */

   371

		case 0x1F:	/* Tractive effort */

   372

		case 0x21:	/* Shorter tenders */

   373

		case 0x22:	/* Visual */

   374

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

   375

			/* TODO */

   376

			FOR_EACH_ENGINE {

   377

				grf_load_byte(&buf);

   378

			}

   379

			ret = true;

   380

		}	break;

   381

		default:

   382

			ret = true;

   383

	}

   384

	*bufp = buf;

   385

	return ret;

   386

}

   387

   388

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

   389

{

   390

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   391

	byte *buf = *bufp;

   392

	int i;

   393

	bool ret = false;

   394

   395

	switch (prop) {

   396

		case 0x08: {	/* Speed */

   397

			FOR_EACH_ENGINE {

   398

				uint8 speed = grf_load_byte(&buf);

   399

   400

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

   401

			}

   402

		}	break;

   403

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

   404

			FOR_EACH_ENGINE {

   405

				uint8 runcost = grf_load_byte(&buf);

   406

   407

				rvi[i].running_cost = runcost;

   408

			}

   409

		}	break;

   410

		case 0x0A:	/* Running cost base */

   411

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

   412

			FOR_EACH_ENGINE {

   413

				grf_load_byte(&buf);

   414

			}

   415

			ret = true;

   416

			break;

   417

		case 0x0E: {	/* Sprite ID */

   418

			FOR_EACH_ENGINE {

   419

				uint8 spriteid = grf_load_byte(&buf);

   420

   421

				if (spriteid == 0xFF)

   422

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

   423

   424

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

   425

				// in not having it here for the future.

   426

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

   427

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

   428

   429

				rvi[i].image_index = spriteid;

   430

			}

   431

		}	break;

   432

		case 0x0F: {	/* Cargo capacity */

   433

			FOR_EACH_ENGINE {

   434

				uint16 capacity = grf_load_word(&buf);

   435

   436

				rvi[i].capacity = capacity;

   437

			}

   438

		}	break;

   439

		case 0x10: { /* Cargo type */

   440

			FOR_EACH_ENGINE {

   441

				uint8 cargo = grf_load_byte(&buf);

   442

   443

				rvi[i].cargo_type = cargo;

   444

			}

   445

		}	break;

   446

		case 0x11: {	/* Cost factor */

   447

			FOR_EACH_ENGINE {

   448

				uint8 cost_factor = grf_load_byte(&buf);

   449

   450

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

   451

			}

   452

		}	break;

   453

		case 0x12: {	/* SFX */

   454

			FOR_EACH_ENGINE {

   455

				uint8 sfx = grf_load_byte(&buf);

   456

   457

				rvi[i].sfx = sfx;

   458

			}

   459

		}	break;

   460

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

   461

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

   462

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

   463

			/* TODO: Support for road vehicles realistic power

   464

			 * computations (called rvpower in TTDPatch) is just

   465

			 * missing in OTTD yet. --pasky */

   466

			FOR_EACH_ENGINE {

   467

				grf_load_byte(&buf);

   468

			}

   469

			ret = true;

   470

			break;

   471

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

   472

			FOR_EACH_ENGINE {

   473

				uint32 refit_mask = grf_load_dword(&buf);

   474

   475

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   476

			}

   477

		}	break;

   478

		case 0x17:      /* Callback */

   479

		case 0x18:      /* Tractive effort */

   480

			/* TODO */

   481

			FOR_EACH_ENGINE {

   482

				grf_load_byte(&buf);

   483

			}

   484

			ret = true;

   485

			break;

   486

		default:

   487

			ret = true;

   488

	}

   489

   490

	*bufp = buf;

   491

	return ret;

   492

}

   493

   494

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

   495

{

   496

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   497

	byte *buf = *bufp;

   498

	int i;

   499

	bool ret = false;

   500

   501

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