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) { \

   114

		return; \

   115

	} \

   116

} while (0)

   117

   118

   119

static inline byte grf_load_byte(byte **buf)

   120

{

   121

	return *(*buf)++;

   122

}

   123

   124

static uint16 grf_load_word(byte **buf)

   125

{

   126

	uint16 val;

   127

	byte *p = *buf;

   128

	val = p[0];

   129

	val |= p[1] << 8;

   130

	*buf = p + 2;

   131

	return val;

   132

}

   133

   134

static uint16 grf_load_dword(byte **buf)

   135

{

   136

	uint32 val;

   137

	byte *p = *buf;

   138

	val = p[0];

   139

	val |= p[1] << 8;

   140

	val |= p[2] << 16;

   141

	val |= p[3] << 24;

   142

	*buf = p + 4;

   143

	return val;

   144

}

   145

   146

   147

static struct GRFFile *GetFileByGRFID(uint32 grfid)

   148

{

   149

	struct GRFFile *file;

   150

   151

	file = _first_grffile;

   152

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

   153

		file = file->next;

   154

   155

	return file;

   156

}

   157

   158

static struct GRFFile *GetFileByFilename(const char *filename)

   159

{

   160

	struct GRFFile *file;

   161

   162

	file = _first_grffile;

   163

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

   164

		file = file->next;

   165

   166

	return file;

   167

}

   168

   169

   170

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

   171

   172

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

   173

   174

static void dewagonize(int condition, int engine)

   175

{

   176

	EngineInfo *ei = &_engine_info[engine];

   177

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   178

   179

	if (condition != 0) {

   180

		ei->unk2 &= ~0x80;

   181

		rvi->flags &= ~2;

   182

	} else {

   183

		ei->unk2 |= 0x80;

   184

		rvi->flags |= 2;

   185

	}

   186

}

   187

   188

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

   189

{

   190

	EngineInfo *ei = &_engine_info[engine];

   191

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   192

	byte *buf = *bufp;

   193

	int i;

   194

	bool ret = false;

   195

   196

	switch (prop) {

   197

		case 0x05: {	/* Track type */

   198

			FOR_EACH_OBJECT {

   199

				uint8 tracktype = grf_load_byte(&buf);

   200

   201

				ei[i].railtype_climates &= 0xf;

   202

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

   203

			}

   204

		}	break;

   205

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

   206

			/* TODO */

   207

			FOR_EACH_OBJECT {

   208

				grf_load_byte(&buf);

   209

			}

   210

			ret = true;

   211

		}	break;

   212

		case 0x09: {	/* Speed */

   213

			FOR_EACH_OBJECT {

   214

				uint16 speed = grf_load_word(&buf);

   215

   216

				rvi[i].max_speed = speed;

   217

				dewagonize(speed, engine + i);

   218

			}

   219

		}	break;

   220

		case 0x0B: {	/* Power */

   221

			FOR_EACH_OBJECT {

   222

				uint16 power = grf_load_word(&buf);

   223

   224

				rvi[i].power = power;

   225

				dewagonize(power, engine + i);

   226

			}

   227

		}	break;

   228

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

   229

			FOR_EACH_OBJECT {

   230

				uint8 runcostfact = grf_load_byte(&buf);

   231

   232

				rvi[i].running_cost_base = runcostfact;

   233

				dewagonize(runcostfact, engine + i);

   234

			}

   235

		}	break;

   236

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

   237

			FOR_EACH_OBJECT {

   238

				uint32 base = grf_load_dword(&buf);

   239

   240

				switch (base) {

   241

				case 0x4C30:

   242

					rvi[i].engclass = 0;

   243

					break;

   244

				case 0x4C36:

   245

					rvi[i].engclass = 1;

   246

					break;

   247

				case 0x4C3C:

   248

					rvi[i].engclass = 2;

   249

					break;

   250

				}

   251

				dewagonize(base, engine + i);

   252

			}

   253

		}	break;

   254

		case 0x12: {	/* Sprite ID */

   255

			FOR_EACH_OBJECT {

   256

				uint8 spriteid = grf_load_byte(&buf);

   257

   258

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

   259

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

   260

				rvi[i].image_index = spriteid;

   261

			}

   262

		}	break;

   263

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

   264

			FOR_EACH_OBJECT {

   265

				uint8 dual = grf_load_byte(&buf);

   266

   267

				if (dual != 0) {

   268

					rvi[i].flags |= 1;

   269

				} else {

   270

					rvi[i].flags &= ~1;

   271

				}

   272

			}

   273

		}	break;

   274

		case 0x14: {	/* Cargo capacity */

   275

			FOR_EACH_OBJECT {

   276

				uint8 capacity = grf_load_byte(&buf);

   277

   278

				rvi[i].capacity = capacity;

   279

			}

   280

		}	break;

   281

		case 0x15: {	/* Cargo type */

   282

			FOR_EACH_OBJECT {

   283

				uint8 ctype = grf_load_byte(&buf);

   284

   285

				rvi[i].cargo_type = ctype;

   286

			}

   287

		}	break;

   288

		case 0x16: {	/* Weight */

   289

			FOR_EACH_OBJECT {

   290

				uint8 weight = grf_load_byte(&buf);

   291

   292

				rvi[i].weight = weight;

   293

			}

   294

		}	break;

   295

		case 0x17: {	/* Cost factor */

   296

			FOR_EACH_OBJECT {

   297

				uint8 cfactor = grf_load_byte(&buf);

   298

   299

				rvi[i].base_cost = cfactor;

   300

			}

   301

		}	break;

   302

		case 0x18: {	/* AI rank */

   303

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

   304

			FOR_EACH_OBJECT {

   305

				grf_load_byte(&buf);

   306

			}

   307

			ret = true;

   308

		}	break;

   309

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

   310

			/* TODO: What do the individual numbers mean?

   311

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

   312

			FOR_EACH_OBJECT {

   313

				uint8 traction = grf_load_byte(&buf);

   314

				int engclass;

   315

   316

				if (traction <= 0x07)

   317

					engclass = 0;

   318

				else if (traction <= 0x27)

   319

					engclass = 1;

   320

				else if (traction <= 0x31)

   321

					engclass = 2;

   322

				else

   323

					break;

   324

   325

				rvi[i].engclass = engclass;

   326

			}

   327

		}	break;

   328

		case 0x1D: {	/* Refit cargo */

   329

			FOR_EACH_OBJECT {

   330

				uint32 refit_mask = grf_load_dword(&buf);

   331

   332

				_engine_refit_masks[engine + i] = refit_mask;

   333

			}

   334

		}	break;

   335

   336

		/* TODO */

   337

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

   338

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

   339

			FOR_EACH_OBJECT {

   340

				grf_load_byte(&buf);

   341

			}

   342

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

   343

		case 0x1A:	/* Sort order */

   344

		case 0x1C:	/* Refit cost */

   345

		case 0x1E:	/* Callback */

   346

		case 0x1F:	/* Tractive effort */

   347

		case 0x21:	/* Shorter tenders */

   348

		case 0x22:	/* Visual */

   349

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

   350

			/* TODO */

   351

			FOR_EACH_OBJECT {

   352

				grf_load_byte(&buf);

   353

			}

   354

			ret = true;

   355

		}	break;

   356

		default:

   357

			ret = true;

   358

	}

   359

	*bufp = buf;

   360

	return ret;

   361

}

   362

   363

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

   364

{

   365

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   366

	byte *buf = *bufp;

   367

	int i;

   368

	bool ret = false;

   369

   370

	switch (prop) {

   371

		case 0x08: {	/* Speed */

   372

			FOR_EACH_OBJECT {

   373

				uint8 speed = grf_load_byte(&buf);

   374

   375

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

   376

			}

   377

		}	break;

   378

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

   379

			FOR_EACH_OBJECT {

   380

				uint8 runcost = grf_load_byte(&buf);

   381

   382

				rvi[i].running_cost = runcost;

   383

			}

   384

		}	break;

   385

		case 0x0A:	/* Running cost base */

   386

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

   387

			FOR_EACH_OBJECT {

   388

				grf_load_byte(&buf);

   389

			}

   390

			ret = true;

   391

			break;

   392

		case 0x0E: {	/* Sprite ID */

   393

			FOR_EACH_OBJECT {

   394

				uint8 spriteid = grf_load_byte(&buf);

   395

   396

				if (spriteid == 0xFF)

   397

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

   398

   399

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

   400

				// in not having it here for the future.

   401

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

   402

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

   403

   404

				rvi[i].image_index = spriteid;

   405

			}

   406

		}	break;

   407

		case 0x0F: {	/* Cargo capacity */

   408

			FOR_EACH_OBJECT {

   409

				uint16 capacity = grf_load_word(&buf);

   410

   411

				rvi[i].capacity = capacity;

   412

			}

   413

		}	break;

   414

		case 0x10: { /* Cargo type */

   415

			FOR_EACH_OBJECT {

   416

				uint8 cargo = grf_load_byte(&buf);

   417

   418

				rvi[i].cargo_type = cargo;

   419

			}

   420

		}	break;

   421

		case 0x11: {	/* Cost factor */

   422

			FOR_EACH_OBJECT {

   423

				uint8 cost_factor = grf_load_byte(&buf);

   424

   425

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

   426

			}

   427

		}	break;

   428

		case 0x12: {	/* SFX */

   429

			FOR_EACH_OBJECT {

   430

				uint8 sfx = grf_load_byte(&buf);

   431

   432

				rvi[i].sfx = sfx;

   433

			}

   434

		}	break;

   435

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

   436

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

   437

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

   438

			/* TODO: Support for road vehicles realistic power

   439

			 * computations (called rvpower in TTDPatch) is just

   440

			 * missing in OTTD yet. --pasky */

   441

			FOR_EACH_OBJECT {

   442

				grf_load_byte(&buf);

   443

			}

   444

			ret = true;

   445

			break;

   446

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

   447

			FOR_EACH_OBJECT {

   448

				uint32 refit_mask = grf_load_dword(&buf);

   449

   450

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   451

			}

   452

		}	break;

   453

		case 0x17:      /* Callback */

   454

		case 0x18:      /* Tractive effort */

   455

			/* TODO */

   456

			FOR_EACH_OBJECT {

   457

				grf_load_byte(&buf);

   458

			}

   459

			ret = true;

   460

			break;

   461

		default:

   462

			ret = true;

   463

	}

   464

   465

	*bufp = buf;

   466

	return ret;

   467

}

   468

   469

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

   470

{

   471

	ShipVehicleInfo *svi = &_ship_vehicle_info[engine];

   472

	byte *buf = *bufp;

   473

	int i;

   474

	bool ret = false;

   475

   476

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

   477

	switch (prop) {

   478

		case 0x08: {	/* Sprite ID */

   479

			FOR_EACH_OBJECT {

   480

				uint8 spriteid = grf_load_byte(&buf);

   481

   482

				if (spriteid == 0xFF)

   483

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

   484

   485

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

   486

				// in not having it here for the future.

   487

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

   488

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

   489

   490

				svi[i].image_index = spriteid;

   491

			}

   492

		}	break;

   493

		case 0x09: {	/* Refittable */

   494

			FOR_EACH_OBJECT {

   495

				uint8 refittable = grf_load_byte(&buf);

   496

   497

				svi[i].refittable = refittable;

   498

			}