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

extern int _custom_sprites_base;

    59

    60

static int32 _paramlist[0x7f];

    61

static int _param_max;

    62

    63

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

    64

static uint32 _ttdpatch_flags[8];

    65

    66

    67

enum grfspec_feature {

    68

	GSF_TRAIN,

    69

	GSF_ROAD,

    70

	GSF_SHIP,

    71

	GSF_AIRCRAFT,

    72

	GSF_STATION,

    73

	GSF_BRIDGE,

    74

	GSF_TOWNHOUSE,

    75

};

    76

    77

    78

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

    79

    80

static const int _vehcounts[4] = {

    81

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    82

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    83

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    84

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    85

};

    86

    87

static const int _vehshifts[4] = {

    88

	/* GSF_TRAIN */    0,

    89

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    90

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    91

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    92

};

    93

    94

    95

/* Debugging messages policy:

    96

 *

    97

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

    98

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

    99

 *

   100

 * 0..2 - dedicated to grfmsg()

   101

 * 3

   102

 * 4

   103

 * 5

   104

 * 6 - action handler entry reporting - one per action

   105

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

   106

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

   107

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

   108

 */

   109

   110

   111

enum grfmsg_severity {

   112

	GMS_NOTICE,

   113

	GMS_WARN,

   114

	GMS_ERROR,

   115

	GMS_FATAL,

   116

};

   117

   118

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

   119

{

   120

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

   121

	int export_severity = 0;

   122

	char buf[1024];

   123

	va_list va;

   124

   125

	va_start(va, str);

   126

	vsprintf(buf, str, va);

   127

	va_end(va);

   128

   129

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

   130

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

   131

}

   132

   133

   134

#define check_length(real, wanted, where) \

   135

do { \

   136

	if (real < wanted) { \

   137

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

   138

		return; \

   139

	} \

   140

} while (0)

   141

   142

   143

static byte INLINE grf_load_byte(byte **buf)

   144

{

   145

	return *(*buf)++;

   146

}

   147

   148

static uint16 grf_load_word(byte **buf)

   149

{

   150

	uint16 val;

   151

	byte *p = *buf;

   152

	val = p[0];

   153

	val |= p[1] << 8;

   154

	*buf = p + 2;

   155

	return val;

   156

}

   157

   158

static uint16 grf_load_dword(byte **buf)

   159

{

   160

	uint32 val;

   161

	byte *p = *buf;

   162

	val = p[0];

   163

	val |= p[1] << 8;

   164

	val |= p[2] << 16;

   165

	val |= p[3] << 24;

   166

	*buf = p + 4;

   167

	return val;

   168

}

   169

   170

   171

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   172

{

   173

	struct GRFFile *file;

   174

   175

	file = _first_grffile;

   176

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

   177

		file = file->next;

   178

   179

	return file;

   180

}

   181

   182

static struct GRFFile *GetFileByFilename(const char *filename)

   183

{

   184

	struct GRFFile *file;

   185

   186

	file = _first_grffile;

   187

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

   188

		file = file->next;

   189

   190

	return file;

   191

}

   192

   193

   194

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

   195

   196

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

   197

   198

static void dewagonize(int condition, int engine)

   199

{

   200

	EngineInfo *ei = &_engine_info[engine];

   201

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   202

   203

	if (condition != 0) {

   204

		ei->unk2 &= ~0x80;

   205

		rvi->flags &= ~2;

   206

	} else {

   207

		ei->unk2 |= 0x80;

   208

		rvi->flags |= 2;

   209

	}

   210

}

   211

   212

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

   213

{

   214

	EngineInfo *ei = &_engine_info[engine];

   215

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   216

	byte *buf = *bufp;

   217

	int i;

   218

	bool ret = false;

   219

   220

	switch (prop) {

   221

		case 0x05: {	/* Track type */

   222

			FOR_EACH_OBJECT {

   223

				uint8 tracktype = grf_load_byte(&buf);

   224

   225

				ei[i].railtype_climates &= 0xf;

   226

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

   227

			}

   228

		}	break;

   229

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

   230

			/* TODO */

   231

			FOR_EACH_OBJECT {

   232

				grf_load_byte(&buf);

   233

			}

   234

			ret = true;

   235

		}	break;

   236

		case 0x09: {	/* Speed */

   237

			FOR_EACH_OBJECT {

   238

				uint16 speed = grf_load_word(&buf);

   239

   240

				rvi[i].max_speed = speed;

   241

				dewagonize(speed, engine + i);

   242

			}

   243

		}	break;

   244

		case 0x0B: {	/* Power */

   245

			FOR_EACH_OBJECT {

   246

				uint16 power = grf_load_word(&buf);

   247

   248

				rvi[i].power = power;

   249

				dewagonize(power, engine + i);

   250

			}

   251

		}	break;

   252

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

   253

			FOR_EACH_OBJECT {

   254

				uint8 runcostfact = grf_load_byte(&buf);

   255

   256

				rvi[i].running_cost_base = runcostfact;

   257

				dewagonize(runcostfact, engine + i);

   258

			}

   259

		}	break;

   260

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

   261

			FOR_EACH_OBJECT {

   262

				uint32 base = grf_load_dword(&buf);

   263

   264

				switch (base) {

   265

				case 0x4C30:

   266

					rvi[i].engclass = 0;

   267

					break;

   268

				case 0x4C36:

   269

					rvi[i].engclass = 1;

   270

					break;

   271

				case 0x4C3C:

   272

					rvi[i].engclass = 2;

   273

					break;

   274

				}

   275

				dewagonize(base, engine + i);

   276

			}

   277

		}	break;

   278

		case 0x12: {	/* Sprite ID */

   279

			FOR_EACH_OBJECT {

   280

				uint8 spriteid = grf_load_byte(&buf);

   281

   282

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

   283

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

   284

				rvi[i].image_index = spriteid;

   285

			}

   286

		}	break;

   287

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

   288

			FOR_EACH_OBJECT {

   289

				uint8 dual = grf_load_byte(&buf);

   290

   291

				if (dual != 0) {

   292

					rvi[i].flags |= 1;

   293

				} else {

   294

					rvi[i].flags &= ~1;

   295

				}

   296

			}

   297

		}	break;

   298

		case 0x14: {	/* Cargo capacity */

   299

			FOR_EACH_OBJECT {

   300

				uint8 capacity = grf_load_byte(&buf);

   301

   302

				rvi[i].capacity = capacity;

   303

			}

   304

		}	break;

   305

		case 0x15: {	/* Cargo type */

   306

			FOR_EACH_OBJECT {

   307

				uint8 ctype = grf_load_byte(&buf);

   308

   309

				rvi[i].cargo_type = ctype;

   310

			}

   311

		}	break;

   312

		case 0x16: {	/* Weight */

   313

			FOR_EACH_OBJECT {

   314

				uint8 weight = grf_load_byte(&buf);

   315

   316

				rvi[i].weight = weight;

   317

			}

   318

		}	break;

   319

		case 0x17: {	/* Cost factor */

   320

			FOR_EACH_OBJECT {

   321

				uint8 cfactor = grf_load_byte(&buf);

   322

   323

				rvi[i].base_cost = cfactor;

   324

			}

   325

		}	break;

   326

		case 0x18: {	/* AI rank */

   327

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

   328

			FOR_EACH_OBJECT {

   329

				grf_load_byte(&buf);

   330

			}

   331

			ret = true;

   332

		}	break;

   333

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

   334

			/* TODO: What do the individual numbers mean?

   335

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

   336

			FOR_EACH_OBJECT {

   337

				uint8 traction = grf_load_byte(&buf);

   338

				int engclass;

   339

   340

				if (traction <= 0x07)

   341

					engclass = 0;

   342

				else if (traction <= 0x27)

   343

					engclass = 1;

   344

				else if (traction <= 0x31)

   345

					engclass = 2;

   346

				else

   347

					break;

   348

   349

				rvi[i].engclass = engclass;

   350

			}

   351

		}	break;

   352

		case 0x1D: {	/* Refit cargo */

   353

			FOR_EACH_OBJECT {

   354

				uint32 refit_mask = grf_load_dword(&buf);

   355

   356

				_engine_refit_masks[engine + i] = refit_mask;

   357

			}

   358

		}	break;

   359

   360

		/* TODO */

   361

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

   362

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

   363

			FOR_EACH_OBJECT {

   364

				grf_load_byte(&buf);

   365

			}

   366

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

   367

		case 0x1A:	/* Sort order */

   368

		case 0x1C:	/* Refit cost */

   369

		case 0x1E:	/* Callback */

   370

		case 0x1F:	/* Tractive effort */

   371

		case 0x21:	/* Shorter tenders */

   372

		case 0x22:	/* Visual */

   373

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

   374

			/* TODO */

   375

			FOR_EACH_OBJECT {

   376

				grf_load_byte(&buf);

   377

			}

   378

			ret = true;

   379

		}	break;

   380

		default:

   381

			ret = true;

   382

	}

   383

	*bufp = buf;

   384

	return ret;

   385

}

   386

   387

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

   388

{

   389

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   390

	byte *buf = *bufp;

   391

	int i;

   392

	bool ret = false;

   393

   394

	switch (prop) {

   395

		case 0x08: {	/* Speed */

   396

			FOR_EACH_OBJECT {

   397

				uint8 speed = grf_load_byte(&buf);

   398

   399

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

   400

			}

   401

		}	break;

   402

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

   403

			FOR_EACH_OBJECT {

   404

				uint8 runcost = grf_load_byte(&buf);

   405

   406

				rvi[i].running_cost = runcost;

   407

			}

   408

		}	break;

   409

		case 0x0A:	/* Running cost base */

   410

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

   411

			FOR_EACH_OBJECT {

   412

				grf_load_byte(&buf);

   413

			}

   414

			ret = true;

   415

			break;

   416

		case 0x0E: {	/* Sprite ID */

   417

			FOR_EACH_OBJECT {

   418

				uint8 spriteid = grf_load_byte(&buf);

   419

   420

				if (spriteid == 0xFF)

   421

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

   422

   423

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

   424

				// in not having it here for the future.

   425

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

   426

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

   427

   428

				rvi[i].image_index = spriteid;

   429

			}

   430

		}	break;

   431

		case 0x0F: {	/* Cargo capacity */

   432

			FOR_EACH_OBJECT {

   433

				uint16 capacity = grf_load_word(&buf);

   434

   435

				rvi[i].capacity = capacity;

   436

			}

   437

		}	break;

   438

		case 0x10: { /* Cargo type */

   439

			FOR_EACH_OBJECT {

   440

				uint8 cargo = grf_load_byte(&buf);

   441

   442

				rvi[i].cargo_type = cargo;

   443

			}

   444

		}	break;

   445

		case 0x11: {	/* Cost factor */

   446

			FOR_EACH_OBJECT {

   447

				uint8 cost_factor = grf_load_byte(&buf);

   448

   449

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

   450

			}

   451

		}	break;

   452

		case 0x12: {	/* SFX */

   453

			FOR_EACH_OBJECT {

   454

				uint8 sfx = grf_load_byte(&buf);

   455

   456

				rvi[i].sfx = sfx;

   457

			}

   458

		}	break;

   459

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

   460

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

   461

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

   462

			/* TODO: Support for road vehicles realistic power

   463

			 * computations (called rvpower in TTDPatch) is just

   464

			 * missing in OTTD yet. --pasky */

   465

			FOR_EACH_OBJECT {

   466

				grf_load_byte(&buf);

   467

			}

   468

			ret = true;

   469

			break;

   470

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

   471

			FOR_EACH_OBJECT {

   472

				uint32 refit_mask = grf_load_dword(&buf);

   473

   474

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   475

			}

   476

		}	break;

   477

		case 0x17:      /* Callback */

   478

		case 0x18:      /* Tractive effort */

   479

			/* TODO */

   480

			FOR_EACH_OBJECT {

   481

				grf_load_byte(&buf);

   482

			}

   483

			ret = true;

   484

			break;

   485

		default:

   486

			ret = true;

   487

	}

   488

   489

	*bufp = buf;

   490

	return ret;

   491

}

   492

   493

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

   494

{

   495

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   496

	byte *buf = *bufp;

   497

	int i;

   498

	bool ret = false;

   499