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

    12

/* TTDPatch extended GRF format codec

    13

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

    14

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

    15

 *

    16

 * Contains portions of documentation by TTDPatch team.

    17

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

    18

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

    19

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

    20

    21

extern int _skip_sprites;

    22

extern int _replace_sprites_count[16];

    23

extern int _replace_sprites_offset[16];

    24

extern int _traininfo_vehicle_pitch;

    25

    26

struct GRFFile {

    27

	char *filename;

    28

	uint32 grfid;

    29

	uint16 flags;

    30

	uint16 sprite_offset;

    31

	struct GRFFile *next;

    32

    33

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

    34

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

    35

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

    36

	 * documentation, contributing to the global confusion.

    37

	 *

    38

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

    39

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

    40

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

    41

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

    42

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

    43

    44

	int spriteset_start;

    45

	int spriteset_numsets;

    46

	int spriteset_numents;

    47

	int spriteset_feature;

    48

    49

	int spritegroups_count;

    50

	struct SpriteGroup *spritegroups;

    51

    52

	struct StationSpec stations[256];

    53

};

    54

    55

static struct GRFFile *_cur_grffile, *_first_grffile;

    56

static int _cur_spriteid;

    57

static int _cur_stage;

    58

    59

static int32 _paramlist[0x7f];

    60

static int _param_max;

    61

    62

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

    63

static uint32 _ttdpatch_flags[8];

    64

    65

    66

enum grfspec_feature {

    67

	GSF_TRAIN,

    68

	GSF_ROAD,

    69

	GSF_SHIP,

    70

	GSF_AIRCRAFT,

    71

	GSF_STATION,

    72

	GSF_BRIDGE,

    73

	GSF_TOWNHOUSE,

    74

};

    75

    76

    77

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

    78

    79

static const int _vehcounts[4] = {

    80

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    81

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    82

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    83

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    84

};

    85

    86

static const int _vehshifts[4] = {

    87

	/* GSF_TRAIN */    0,

    88

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    89

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    90

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    91

};

    92

    93

    94

/* Debugging messages policy:

    95

 *

    96

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

    97

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

    98

 *

    99

 * 0..2 - dedicated to grfmsg()

   100

 * 3

   101

 * 4

   102

 * 5

   103

 * 6 - action handler entry reporting - one per action

   104

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

   105

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

   106

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

   107

 */

   108

   109

   110

enum grfmsg_severity {

   111

	GMS_NOTICE,

   112

	GMS_WARN,

   113

	GMS_ERROR,

   114

	GMS_FATAL,

   115

};

   116

   117

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

   118

{

   119

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

   120

	int export_severity = 0;

   121

	char buf[1024];

   122

	va_list va;

   123

   124

	va_start(va, str);

   125

	vsprintf(buf, str, va);

   126

	va_end(va);

   127

   128

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

   129

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

   130

}

   131

   132

   133

#define check_length(real, wanted, where) \

   134

do { \

   135

	if (real < wanted) { \

   136

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

   137

		return; \

   138

	} \

   139

} while (0)

   140

   141

   142

static byte INLINE grf_load_byte(byte **buf)

   143

{

   144

	return *(*buf)++;

   145

}

   146

   147

static uint16 grf_load_word(byte **buf)

   148

{

   149

	uint16 val;

   150

	byte *p = *buf;

   151

	val = p[0];

   152

	val |= p[1] << 8;

   153

	*buf = p + 2;

   154

	return val;

   155

}

   156

   157

static uint16 grf_load_dword(byte **buf)

   158

{

   159

	uint32 val;

   160

	byte *p = *buf;

   161

	val = p[0];

   162

	val |= p[1] << 8;

   163

	val |= p[2] << 16;

   164

	val |= p[3] << 24;

   165

	*buf = p + 4;

   166

	return val;

   167

}

   168

   169

   170

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   171

{

   172

	struct GRFFile *file;

   173

   174

	file = _first_grffile;

   175

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

   176

		file = file->next;

   177

   178

	return file;

   179

}

   180

   181

static struct GRFFile *GetFileByFilename(const char *filename)

   182

{

   183

	struct GRFFile *file;

   184

   185

	file = _first_grffile;

   186

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

   187

		file = file->next;

   188

   189

	return file;

   190

}

   191

   192

   193

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

   194

   195

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

   196

   197

static void dewagonize(int condition, int engine)

   198

{

   199

	EngineInfo *ei = &_engine_info[engine];

   200

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   201

   202

	if (condition != 0) {

   203

		ei->unk2 &= ~0x80;

   204

		rvi->flags &= ~2;

   205

	} else {

   206

		ei->unk2 |= 0x80;

   207

		rvi->flags |= 2;

   208

	}

   209

}

   210

   211

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

   212

{

   213

	EngineInfo *ei = &_engine_info[engine];

   214

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   215

	byte *buf = *bufp;

   216

	int i;

   217

	bool ret = false;

   218

   219

	switch (prop) {

   220

		case 0x05: {	/* Track type */

   221

			FOR_EACH_ENGINE {

   222

				uint8 tracktype = grf_load_byte(&buf);

   223

   224

				ei[i].railtype_climates &= 0xf;

   225

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

   226

			}

   227

		}	break;

   228

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

   229

			/* TODO */

   230

			FOR_EACH_ENGINE {

   231

				grf_load_byte(&buf);

   232

			}

   233

			ret = true;

   234

		}	break;

   235

		case 0x09: {	/* Speed */

   236

			FOR_EACH_ENGINE {

   237

				uint16 speed = grf_load_word(&buf);

   238

   239

				rvi[i].max_speed = speed;

   240

				dewagonize(speed, engine + i);

   241

			}

   242

		}	break;

   243

		case 0x0B: {	/* Power */

   244

			FOR_EACH_ENGINE {

   245

				uint16 power = grf_load_word(&buf);

   246

   247

				rvi[i].power = power;

   248

				dewagonize(power, engine + i);

   249

			}

   250

		}	break;

   251

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

   252

			FOR_EACH_ENGINE {

   253

				uint8 runcostfact = grf_load_byte(&buf);

   254

   255

				rvi[i].running_cost_base = runcostfact;

   256

				dewagonize(runcostfact, engine + i);

   257

			}

   258

		}	break;

   259

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

   260

			FOR_EACH_ENGINE {

   261

				uint32 base = grf_load_dword(&buf);

   262

   263

				switch (base) {

   264

				case 0x4C30:

   265

					rvi[i].engclass = 0;

   266

					break;

   267

				case 0x4C36:

   268

					rvi[i].engclass = 1;

   269

					break;

   270

				case 0x4C3C:

   271

					rvi[i].engclass = 2;

   272

					break;

   273

				}

   274

				dewagonize(base, engine + i);

   275

			}

   276

		}	break;

   277

		case 0x12: {	/* Sprite ID */

   278

			FOR_EACH_ENGINE {

   279

				uint8 spriteid = grf_load_byte(&buf);

   280

   281

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

   282

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

   283

				rvi[i].image_index = spriteid;

   284

			}

   285

		}	break;

   286

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

   287

			FOR_EACH_ENGINE {

   288

				uint8 dual = grf_load_byte(&buf);

   289

   290

				if (dual != 0) {

   291

					rvi[i].flags |= 1;

   292

				} else {

   293

					rvi[i].flags &= ~1;

   294

				}

   295

			}

   296

		}	break;

   297

		case 0x14: {	/* Cargo capacity */

   298

			FOR_EACH_ENGINE {

   299

				uint8 capacity = grf_load_byte(&buf);

   300

   301

				rvi[i].capacity = capacity;

   302

			}

   303

		}	break;

   304

		case 0x15: {	/* Cargo type */

   305

			FOR_EACH_ENGINE {

   306

				uint8 ctype = grf_load_byte(&buf);

   307

   308

				rvi[i].cargo_type = ctype;

   309

			}

   310

		}	break;

   311

		case 0x16: {	/* Weight */

   312

			FOR_EACH_ENGINE {

   313

				uint8 weight = grf_load_byte(&buf);

   314

   315

				rvi[i].weight = weight;

   316

			}

   317

		}	break;

   318

		case 0x17: {	/* Cost factor */

   319

			FOR_EACH_ENGINE {

   320

				uint8 cfactor = grf_load_byte(&buf);

   321

   322

				rvi[i].base_cost = cfactor;

   323

			}

   324

		}	break;

   325

		case 0x18: {	/* AI rank */

   326

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

   327

			FOR_EACH_ENGINE {

   328

				grf_load_byte(&buf);

   329

			}

   330

			ret = true;

   331

		}	break;

   332

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

   333

			/* TODO: What do the individual numbers mean?

   334

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

   335

			FOR_EACH_ENGINE {

   336

				uint8 traction = grf_load_byte(&buf);

   337

				int engclass;

   338

   339

				if (traction <= 0x07)

   340

					engclass = 0;

   341

				else if (traction <= 0x27)

   342

					engclass = 1;

   343

				else if (traction <= 0x31)

   344

					engclass = 2;

   345

				else

   346

					break;

   347

   348

				rvi[i].engclass = engclass;

   349

			}

   350

		}	break;

   351

   352

		/* TODO */

   353

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

   354

		case 0x1D:	/* Refit cargo */

   355

			FOR_EACH_ENGINE {

   356

				grf_load_word(&buf);

   357

			}

   358

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

   359

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

   360

			FOR_EACH_ENGINE {

   361

				grf_load_byte(&buf);

   362

			}

   363

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

   364

		case 0x1A:	/* Sort order */

   365

		case 0x1C:	/* Refit cost */

   366

		case 0x1E:	/* Callback */

   367

		case 0x1F:	/* Tractive effort */

   368

		case 0x21:	/* Shorter tenders */

   369

		case 0x22:	/* Visual */

   370

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

   371

			/* TODO */

   372

			FOR_EACH_ENGINE {

   373

				grf_load_byte(&buf);

   374

			}

   375

			ret = true;

   376

		}	break;

   377

		default:

   378

			ret = true;

   379

	}

   380

	*bufp = buf;

   381

	return ret;

   382

}

   383

   384

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

   385

{

   386

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   387

	byte *buf = *bufp;

   388

	int i;

   389

	bool ret = false;

   390

   391

	switch (prop) {

   392

		case 0x08: {	/* Speed */

   393

			FOR_EACH_ENGINE {

   394

				uint8 speed = grf_load_byte(&buf);

   395

   396

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

   397

			}

   398

		}	break;

   399

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

   400

			FOR_EACH_ENGINE {

   401

				uint8 runcost = grf_load_byte(&buf);

   402

   403

				rvi[i].running_cost = runcost;

   404

			}

   405

		}	break;

   406

		case 0x0A:	/* Running cost base */

   407

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

   408

			FOR_EACH_ENGINE {

   409

				grf_load_byte(&buf);

   410

			}

   411

			ret = true;

   412

			break;

   413

		case 0x0E: {	/* Sprite ID */

   414

			FOR_EACH_ENGINE {

   415

				uint8 spriteid = grf_load_byte(&buf);

   416

   417

				if (spriteid == 0xFF)

   418

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

   419

   420

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

   421

				// in not having it here for the future.

   422

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

   423

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

   424

   425

				rvi[i].image_index = spriteid;

   426

			}

   427

		}	break;

   428

		case 0x0F: {	/* Cargo capacity */

   429

			FOR_EACH_ENGINE {

   430

				uint16 capacity = grf_load_word(&buf);

   431

   432

				rvi[i].capacity = capacity;

   433

			}

   434

		}	break;

   435

		case 0x10: { /* Cargo type */

   436

			FOR_EACH_ENGINE {

   437

				uint8 cargo = grf_load_byte(&buf);

   438

   439

				rvi[i].cargo_type = cargo;

   440

			}

   441

		}	break;

   442

		case 0x11: {	/* Cost factor */

   443

			FOR_EACH_ENGINE {

   444

				uint8 cost_factor = grf_load_byte(&buf);

   445

   446

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

   447

			}

   448

		}	break;

   449

		case 0x12: {	/* SFX */

   450

			FOR_EACH_ENGINE {

   451

				uint8 sfx = grf_load_byte(&buf);

   452

   453

				rvi[i].sfx = sfx;

   454

			}

   455

		}	break;

   456

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

   457

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

   458

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

   459

			/* TODO: Support for road vehicles realistic power

   460

			 * computations (called rvpower in TTDPatch) is just

   461

			 * missing in OTTD yet. --pasky */

   462

			FOR_EACH_ENGINE {

   463

				grf_load_byte(&buf);

   464

			}

   465

			ret = true;

   466

			break;

   467

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

   468

			FOR_EACH_ENGINE {

   469

				uint32 refit_mask = grf_load_dword(&buf);

   470

   471

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   472

			}

   473

		}	break;

   474

		case 0x17:      /* Callback */

   475

		case 0x18:      /* Tractive effort */

   476

			/* TODO */

   477

			FOR_EACH_ENGINE {

   478

				grf_load_byte(&buf);

   479

			}

   480

			ret = true;

   481

			break;

   482

		default:

   483

			ret = true;

   484

	}

   485

   486

	*bufp = buf;

   487

	return ret;

   488

}

   489

   490

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

   491

{

   492

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   493

	byte *buf = *bufp;

   494

	int i;

   495

	bool ret = false;

   496

   497

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

   498

	switch (prop) {

   499

		case 0x08: {	/* Sprite ID */

   500

			FOR_EACH_ENGINE {

   501

				uint8 spriteid = grf_load_byte(&buf);