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

struct GRFFile *_cur_grffile, *_first_grffile;

    30

int _grffile_count;

    31

static int _cur_spriteid;

    32

static int _cur_stage;

    33

extern int _custom_sprites_base;

    34

    35

static int32 _paramlist[0x7f];

    36

static int _param_max;

    37

    38

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

    39

static uint32 _ttdpatch_flags[8];

    40

    41

    42

enum grfspec_feature {

    43

	GSF_TRAIN,

    44

	GSF_ROAD,

    45

	GSF_SHIP,

    46

	GSF_AIRCRAFT,

    47

	GSF_STATION,

    48

	GSF_BRIDGE,

    49

	GSF_TOWNHOUSE,

    50

};

    51

    52

    53

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

    54

    55

static const int _vehcounts[4] = {

    56

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    57

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    58

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    59

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    60

};

    61

    62

static const int _vehshifts[4] = {

    63

	/* GSF_TRAIN */    0,

    64

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    65

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    66

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    67

};

    68

    69

    70

/* Debugging messages policy:

    71

 *

    72

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

    73

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

    74

 *

    75

 * 0..2 - dedicated to grfmsg()

    76

 * 3

    77

 * 4

    78

 * 5

    79

 * 6 - action handler entry reporting - one per action

    80

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

    81

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

    82

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

    83

 */

    84

    85

    86

enum grfmsg_severity {

    87

	GMS_NOTICE,

    88

	GMS_WARN,

    89

	GMS_ERROR,

    90

	GMS_FATAL,

    91

};

    92

    93

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

    94

{

    95

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

    96

	int export_severity = 0;

    97

	char buf[1024];

    98

	va_list va;

    99

   100

	va_start(va, str);

   101

	vsprintf(buf, str, va);

   102

	va_end(va);

   103

   104

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

   105

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

   106

}

   107

   108

   109

#define check_length(real, wanted, where) \

   110

do { \

   111

	if (real < wanted) { \

   112

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

   113

		return; \

   114

	} \

   115

} while (0)

   116

   117

   118

static inline byte grf_load_byte(byte **buf)

   119

{

   120

	return *(*buf)++;

   121

}

   122

   123

static uint16 grf_load_word(byte **buf)

   124

{

   125

	uint16 val;

   126

	byte *p = *buf;

   127

	val = p[0];

   128

	val |= p[1] << 8;

   129

	*buf = p + 2;

   130

	return val;

   131

}

   132

   133

static uint16 grf_load_dword(byte **buf)

   134

{

   135

	uint32 val;

   136

	byte *p = *buf;

   137

	val = p[0];

   138

	val |= p[1] << 8;

   139

	val |= p[2] << 16;

   140

	val |= p[3] << 24;

   141

	*buf = p + 4;

   142

	return val;

   143

}

   144

   145

   146

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   147

{

   148

	struct GRFFile *file;

   149

   150

	file = _first_grffile;

   151

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

   152

		file = file->next;

   153

   154

	return file;

   155

}

   156

   157

static struct GRFFile *GetFileByFilename(const char *filename)

   158

{

   159

	struct GRFFile *file;

   160

   161

	file = _first_grffile;

   162

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

   163

		file = file->next;

   164

   165

	return file;

   166

}

   167

   168

   169

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

   170

   171

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

   172

   173

static void dewagonize(int condition, int engine)

   174

{

   175

	EngineInfo *ei = &_engine_info[engine];

   176

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   177

   178

	if (condition != 0) {

   179

		ei->unk2 &= ~0x80;

   180

		rvi->flags &= ~2;

   181

	} else {

   182

		ei->unk2 |= 0x80;

   183

		rvi->flags |= 2;

   184

	}

   185

}

   186

   187

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

   188

{

   189

	EngineInfo *ei = &_engine_info[engine];

   190

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   191

	byte *buf = *bufp;

   192

	int i;

   193

	bool ret = false;

   194

   195

	switch (prop) {

   196

		case 0x05: {	/* Track type */

   197

			FOR_EACH_OBJECT {

   198

				uint8 tracktype = grf_load_byte(&buf);

   199

   200

				ei[i].railtype_climates &= 0xf;

   201

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

   202

			}

   203

		}	break;

   204

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

   205

			/* TODO */

   206

			FOR_EACH_OBJECT {

   207

				grf_load_byte(&buf);

   208

			}

   209

			ret = true;

   210

		}	break;

   211

		case 0x09: {	/* Speed */

   212

			FOR_EACH_OBJECT {

   213

				uint16 speed = grf_load_word(&buf);

   214

   215

				rvi[i].max_speed = speed;

   216

				dewagonize(speed, engine + i);

   217

			}

   218

		}	break;

   219

		case 0x0B: {	/* Power */

   220

			FOR_EACH_OBJECT {

   221

				uint16 power = grf_load_word(&buf);

   222

   223

				rvi[i].power = power;

   224

				dewagonize(power, engine + i);

   225

			}

   226

		}	break;

   227

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

   228

			FOR_EACH_OBJECT {

   229

				uint8 runcostfact = grf_load_byte(&buf);

   230

   231

				rvi[i].running_cost_base = runcostfact;

   232

				dewagonize(runcostfact, engine + i);

   233

			}

   234

		}	break;

   235

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

   236

			FOR_EACH_OBJECT {

   237

				uint32 base = grf_load_dword(&buf);

   238

   239

				switch (base) {

   240

				case 0x4C30:

   241

					rvi[i].engclass = 0;

   242

					break;

   243

				case 0x4C36:

   244

					rvi[i].engclass = 1;

   245

					break;

   246

				case 0x4C3C:

   247

					rvi[i].engclass = 2;

   248

					break;

   249

				}

   250

				dewagonize(base, engine + i);

   251

			}

   252

		}	break;

   253

		case 0x12: {	/* Sprite ID */

   254

			FOR_EACH_OBJECT {

   255

				uint8 spriteid = grf_load_byte(&buf);

   256

   257

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

   258

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

   259

				rvi[i].image_index = spriteid;

   260

			}

   261

		}	break;

   262

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

   263

			FOR_EACH_OBJECT {

   264

				uint8 dual = grf_load_byte(&buf);

   265

   266

				if (dual != 0) {

   267

					rvi[i].flags |= 1;

   268

				} else {

   269

					rvi[i].flags &= ~1;

   270

				}

   271

			}

   272

		}	break;

   273

		case 0x14: {	/* Cargo capacity */

   274

			FOR_EACH_OBJECT {

   275

				uint8 capacity = grf_load_byte(&buf);

   276

   277

				rvi[i].capacity = capacity;

   278

			}

   279

		}	break;

   280

		case 0x15: {	/* Cargo type */

   281

			FOR_EACH_OBJECT {

   282

				uint8 ctype = grf_load_byte(&buf);

   283

   284

				rvi[i].cargo_type = ctype;

   285

			}

   286

		}	break;

   287

		case 0x16: {	/* Weight */

   288

			FOR_EACH_OBJECT {

   289

				uint8 weight = grf_load_byte(&buf);

   290

   291

				rvi[i].weight = weight;

   292

			}

   293

		}	break;

   294

		case 0x17: {	/* Cost factor */

   295

			FOR_EACH_OBJECT {

   296

				uint8 cfactor = grf_load_byte(&buf);

   297

   298

				rvi[i].base_cost = cfactor;

   299

			}

   300

		}	break;

   301

		case 0x18: {	/* AI rank */

   302

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

   303

			FOR_EACH_OBJECT {

   304

				grf_load_byte(&buf);

   305

			}

   306

			ret = true;

   307

		}	break;

   308

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

   309

			/* TODO: What do the individual numbers mean?

   310

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

   311

			FOR_EACH_OBJECT {

   312

				uint8 traction = grf_load_byte(&buf);

   313

				int engclass;

   314

   315

				if (traction <= 0x07)

   316

					engclass = 0;

   317

				else if (traction <= 0x27)

   318

					engclass = 1;

   319

				else if (traction <= 0x31)

   320

					engclass = 2;

   321

				else

   322

					break;

   323

   324

				rvi[i].engclass = engclass;

   325

			}

   326

		}	break;

   327

		case 0x1D: {	/* Refit cargo */

   328

			FOR_EACH_OBJECT {

   329

				uint32 refit_mask = grf_load_dword(&buf);

   330

   331

				_engine_refit_masks[engine + i] = refit_mask;

   332

			}

   333

		}	break;

   334

   335

		/* TODO */

   336

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

   337

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

   338

			FOR_EACH_OBJECT {

   339

				grf_load_byte(&buf);

   340

			}

   341

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

   342

		case 0x1A:	/* Sort order */

   343

		case 0x1C:	/* Refit cost */

   344

		case 0x1E:	/* Callback */

   345

		case 0x1F:	/* Tractive effort */

   346

		case 0x21:	/* Shorter tenders */

   347

		case 0x22:	/* Visual */

   348

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

   349

			/* TODO */

   350

			FOR_EACH_OBJECT {

   351

				grf_load_byte(&buf);

   352

			}

   353

			ret = true;

   354

		}	break;

   355

		default:

   356

			ret = true;

   357

	}

   358

	*bufp = buf;

   359

	return ret;

   360

}

   361

   362

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

   363

{

   364

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   365

	byte *buf = *bufp;

   366

	int i;

   367

	bool ret = false;

   368

   369

	switch (prop) {

   370

		case 0x08: {	/* Speed */

   371

			FOR_EACH_OBJECT {

   372

				uint8 speed = grf_load_byte(&buf);

   373

   374

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

   375

			}

   376

		}	break;

   377

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

   378

			FOR_EACH_OBJECT {

   379

				uint8 runcost = grf_load_byte(&buf);

   380

   381

				rvi[i].running_cost = runcost;

   382

			}

   383

		}	break;

   384

		case 0x0A:	/* Running cost base */

   385

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

   386

			FOR_EACH_OBJECT {

   387

				grf_load_byte(&buf);

   388

			}

   389

			ret = true;

   390

			break;

   391

		case 0x0E: {	/* Sprite ID */

   392

			FOR_EACH_OBJECT {

   393

				uint8 spriteid = grf_load_byte(&buf);

   394

   395

				if (spriteid == 0xFF)

   396

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

   397

   398

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

   399

				// in not having it here for the future.

   400

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

   401

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

   402

   403

				rvi[i].image_index = spriteid;

   404

			}

   405

		}	break;

   406

		case 0x0F: {	/* Cargo capacity */

   407

			FOR_EACH_OBJECT {

   408

				uint16 capacity = grf_load_word(&buf);

   409

   410

				rvi[i].capacity = capacity;

   411

			}

   412

		}	break;

   413

		case 0x10: { /* Cargo type */

   414

			FOR_EACH_OBJECT {

   415

				uint8 cargo = grf_load_byte(&buf);

   416

   417

				rvi[i].cargo_type = cargo;

   418

			}

   419

		}	break;

   420

		case 0x11: {	/* Cost factor */

   421

			FOR_EACH_OBJECT {

   422

				uint8 cost_factor = grf_load_byte(&buf);

   423

   424

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

   425

			}

   426

		}	break;

   427

		case 0x12: {	/* SFX */

   428

			FOR_EACH_OBJECT {

   429

				uint8 sfx = grf_load_byte(&buf);

   430

   431

				rvi[i].sfx = sfx;

   432

			}

   433

		}	break;

   434

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

   435

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

   436

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

   437

			/* TODO: Support for road vehicles realistic power

   438

			 * computations (called rvpower in TTDPatch) is just

   439

			 * missing in OTTD yet. --pasky */

   440

			FOR_EACH_OBJECT {

   441

				grf_load_byte(&buf);

   442

			}

   443

			ret = true;

   444

			break;

   445

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

   446

			FOR_EACH_OBJECT {

   447

				uint32 refit_mask = grf_load_dword(&buf);

   448

   449

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   450

			}

   451

		}	break;

   452

		case 0x17:      /* Callback */

   453

		case 0x18:      /* Tractive effort */

   454

			/* TODO */

   455

			FOR_EACH_OBJECT {

   456

				grf_load_byte(&buf);

   457

			}

   458

			ret = true;

   459

			break;

   460

		default:

   461

			ret = true;

   462

	}

   463

   464

	*bufp = buf;

   465

	return ret;

   466

}

   467

   468

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

   469

{

   470

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   471

	byte *buf = *bufp;

   472

	int i;

   473

	bool ret = false;

   474

   475

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

   476

	switch (prop) {

   477

		case 0x08: {	/* Sprite ID */

   478

			FOR_EACH_OBJECT {

   479

				uint8 spriteid = grf_load_byte(&buf);

   480

   481

				if (spriteid == 0xFF)

   482

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

   483

   484

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

   485

				// in not having it here for the future.

   486

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

   487

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

   488

   489

				svi[i].image_index = spriteid;

   490

			}

   491

		}	break;

   492

		case 0x09: {	/* Refittable */

   493

			FOR_EACH_OBJECT {

   494

				uint8 refittable = grf_load_byte(&buf);

   495

   496

				svi[i].refittable = refittable;

   497

			}

   498

		}	break;

   499