1

#include "stdafx.h"

     2

     3

#include <stdarg.h>

     4

     5

#include "openttd.h"

     6

#include "debug.h"

     7

#include "gfx.h"

     8

#include "fileio.h"

     9

#include "functions.h"

    10

#include "engine.h"

    11

#include "station.h"

    12

#include "sprite.h"

    13

#include "newgrf.h"

    14

#include "variables.h"

    15

    16

/* TTDPatch extended GRF format codec

    17

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

    18

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

    19

 *

    20

 * Contains portions of documentation by TTDPatch team.

    21

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

    22

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

    23

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

    24

    25

    26

extern int _skip_sprites;

    27

extern int _replace_sprites_count[16];

    28

extern int _replace_sprites_offset[16];

    29

extern int _traininfo_vehicle_pitch;

    30

    31

GRFFile *_cur_grffile;

    32

GRFFile *_first_grffile;

    33

int _grffile_count;

    34

static int _cur_spriteid;

    35

static int _cur_stage;

    36

extern uint16 _custom_sprites_base;

    37

    38

static int32 _paramlist[0x7f];

    39

static int _param_max;

    40

    41

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

    42

static uint32 _ttdpatch_flags[8];

    43

    44

    45

typedef enum grfspec_feature {

    46

	GSF_TRAIN,

    47

	GSF_ROAD,

    48

	GSF_SHIP,

    49

	GSF_AIRCRAFT,

    50

	GSF_STATION,

    51

	GSF_BRIDGE,

    52

	GSF_TOWNHOUSE,

    53

} grfspec_feature;

    54

    55

    56

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

    57

    58

static const int _vehcounts[4] = {

    59

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    60

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    61

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    62

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    63

};

    64

    65

static const int _vehshifts[4] = {

    66

	/* GSF_TRAIN */    0,

    67

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    68

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    69

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    70

};

    71

    72

    73

/* Debugging messages policy:

    74

 *

    75

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

    76

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

    77

 *

    78

 * 0..2 - dedicated to grfmsg()

    79

 * 3

    80

 * 4

    81

 * 5

    82

 * 6 - action handler entry reporting - one per action

    83

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

    84

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

    85

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

    86

 */

    87

    88

    89

typedef enum grfmsg_severity {

    90

	GMS_NOTICE,

    91

	GMS_WARN,

    92

	GMS_ERROR,

    93

	GMS_FATAL,

    94

} grfmsg_severity;

    95

    96

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

    97

{

    98

	static const char* const severitystr[] = {

    99

		"Notice",

   100

		"Warning",

   101

		"Error",

   102

		"Fatal"

   103

	};

   104

	int export_severity = 0;

   105

	char buf[1024];

   106

	va_list va;

   107

   108

	va_start(va, str);

   109

	vsnprintf(buf, sizeof(buf), str, va);

   110

	va_end(va);

   111

   112

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

   113

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

   114

}

   115

   116

   117

#define check_length(real, wanted, where) \

   118

do { \

   119

	if (real < wanted) { \

   120

		grfmsg(GMS_ERROR, "%s/%d: Invalid special sprite length %d (expected %d)!", \

   121

		       where, _cur_spriteid - _cur_grffile->sprite_offset, real, wanted); \

   122

		return; \

   123

	} \

   124

} while (0)

   125

   126

   127

static inline byte grf_load_byte(byte **buf)

   128

{

   129

	return *(*buf)++;

   130

}

   131

   132

static uint16 grf_load_word(byte **buf)

   133

{

   134

	uint16 val;

   135

	byte *p = *buf;

   136

	val = p[0];

   137

	val |= p[1] << 8;

   138

	*buf = p + 2;

   139

	return val;

   140

}

   141

   142

static uint16 grf_load_dword(byte **buf)

   143

{

   144

	uint32 val;

   145

	byte *p = *buf;

   146

	val = p[0];

   147

	val |= p[1] << 8;

   148

	val |= p[2] << 16;

   149

	val |= p[3] << 24;

   150

	*buf = p + 4;

   151

	return val;

   152

}

   153

   154

   155

static GRFFile *GetFileByGRFID(uint32 grfid)

   156

{

   157

	GRFFile *file;

   158

   159

	for (file = _first_grffile; file != NULL; file = file->next) {

   160

		if (file->grfid == grfid) break;

   161

	}

   162

	return file;

   163

}

   164

   165

static GRFFile *GetFileByFilename(const char *filename)

   166

{

   167

	GRFFile *file;

   168

   169

	for (file = _first_grffile; file != NULL; file = file->next) {

   170

		if (strcmp(file->filename, filename) == 0) break;

   171

	}

   172

	return file;

   173

}

   174

   175

   176

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

   177

   178

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

   179

   180

static void dewagonize(int condition, int engine)

   181

{

   182

	EngineInfo *ei = &_engine_info[engine];

   183

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   184

   185

	if (condition != 0) {

   186

		ei->unk2 &= ~0x80;

   187

		rvi->flags &= ~2;

   188

	} else {

   189

		ei->unk2 |= 0x80;

   190

		rvi->flags |= 2;

   191

	}

   192

}

   193

   194

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

   195

{

   196

	EngineInfo *ei = &_engine_info[engine];

   197

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   198

	byte *buf = *bufp;

   199

	int i;

   200

	bool ret = false;

   201

   202

	switch (prop) {

   203

		case 0x05: { /* Track type */

   204

			FOR_EACH_OBJECT {

   205

				uint8 tracktype = grf_load_byte(&buf);

   206

   207

				ei[i].railtype_climates &= 0xf;

   208

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

   209

			}

   210

		} break;

   211

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

   212

			/* TODO */

   213

			FOR_EACH_OBJECT {

   214

				grf_load_byte(&buf);

   215

			}

   216

			ret = true;

   217

		} break;

   218

		case 0x09: { /* Speed */

   219

			FOR_EACH_OBJECT {

   220

				uint16 speed = grf_load_word(&buf);

   221

   222

				rvi[i].max_speed = speed;

   223

				dewagonize(speed, engine + i);

   224

			}

   225

		} break;

   226

		case 0x0B: { /* Power */

   227

			FOR_EACH_OBJECT {

   228

				uint16 power = grf_load_word(&buf);

   229

   230

				if (rvi[i].flags & RVI_MULTIHEAD)

   231

					power /= 2;

   232

   233

				rvi[i].power = power;

   234

				dewagonize(power, engine + i);

   235

			}

   236

		} break;

   237

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

   238

			FOR_EACH_OBJECT {

   239

				uint8 runcostfact = grf_load_byte(&buf);

   240

   241

				rvi[i].running_cost_base = runcostfact;

   242

				dewagonize(runcostfact, engine + i);

   243

			}

   244

		} break;

   245

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

   246

			FOR_EACH_OBJECT {

   247

				uint32 base = grf_load_dword(&buf);

   248

   249

				switch (base) {

   250

				case 0x4C30:

   251

					rvi[i].engclass = 0;

   252

					break;

   253

				case 0x4C36:

   254

					rvi[i].engclass = 1;

   255

					break;

   256

				case 0x4C3C:

   257

					rvi[i].engclass = 2;

   258

					break;

   259

				}

   260

				dewagonize(base, engine + i);

   261

			}

   262

		} break;

   263

		case 0x12: { /* Sprite ID */

   264

			FOR_EACH_OBJECT {

   265

				uint8 spriteid = grf_load_byte(&buf);

   266

   267

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

   268

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

   269

				rvi[i].image_index = spriteid;

   270

			}

   271

		} break;

   272

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

   273

			FOR_EACH_OBJECT {

   274

				uint8 dual = grf_load_byte(&buf);

   275

   276

				if (dual != 0) {

   277

					if (!(rvi[i].flags & RVI_MULTIHEAD)) // adjust power if needed

   278

						rvi[i].power /= 2;

   279

					rvi[i].flags |= RVI_MULTIHEAD;

   280

				} else {

   281

					if (rvi[i].flags & RVI_MULTIHEAD) // adjust power if needed

   282

						rvi[i].power *= 2;

   283

					rvi[i].flags &= ~RVI_MULTIHEAD;

   284

				}

   285

			}

   286

		} break;

   287

		case 0x14: { /* Cargo capacity */

   288

			FOR_EACH_OBJECT {

   289

				uint8 capacity = grf_load_byte(&buf);

   290

   291

				rvi[i].capacity = capacity;

   292

			}

   293

		} break;

   294

		case 0x15: { /* Cargo type */

   295

			FOR_EACH_OBJECT {

   296

				uint8 ctype = grf_load_byte(&buf);

   297

   298

				rvi[i].cargo_type = ctype;

   299

			}

   300

		} break;

   301

		case 0x16: { /* Weight */

   302

			FOR_EACH_OBJECT {

   303

				uint8 weight = grf_load_byte(&buf);

   304

   305

				rvi[i].weight = weight;

   306

			}

   307

		} break;

   308

		case 0x17: { /* Cost factor */

   309

			FOR_EACH_OBJECT {

   310

				uint8 cfactor = grf_load_byte(&buf);

   311

   312

				rvi[i].base_cost = cfactor;

   313

			}

   314

		} break;

   315

		case 0x18: { /* AI rank */

   316

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

   317

			FOR_EACH_OBJECT {

   318

				grf_load_byte(&buf);

   319

			}

   320

			ret = true;

   321

		} break;

   322

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

   323

			/* TODO: What do the individual numbers mean?

   324

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

   325

			FOR_EACH_OBJECT {

   326

				uint8 traction = grf_load_byte(&buf);

   327

				int engclass;

   328

   329

				if (traction <= 0x07)

   330

					engclass = 0;

   331

				else if (traction <= 0x27)

   332

					engclass = 1;

   333

				else if (traction <= 0x31)

   334

					engclass = 2;

   335

				else

   336

					break;

   337

   338

				rvi[i].engclass = engclass;

   339

			}

   340

		} break;

   341

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

   342

			FOR_EACH_OBJECT {

   343

				uint16 wag_power = grf_load_word(&buf);

   344

   345

				rvi[i].pow_wag_power = wag_power;

   346

			}

   347

		} break;

   348

		case 0x1D: { /* Refit cargo */

   349

			FOR_EACH_OBJECT {

   350

				uint32 refit_mask = grf_load_dword(&buf);

   351

   352

				_engine_refit_masks[engine + i] = refit_mask;

   353

			}

   354

		} break;

   355

		case 0x1E: { /* Callback */

   356

			FOR_EACH_OBJECT {

   357

				byte callbacks = grf_load_byte(&buf);

   358

   359

				rvi[i].callbackmask = callbacks;

   360

			}

   361

		} break;

   362

		case 0x21: { /* Shorter vehicle */

   363

			FOR_EACH_OBJECT {

   364

				byte shorten_factor = grf_load_byte(&buf);

   365

   366

				rvi[i].shorten_factor = shorten_factor;

   367

			}

   368

		} break;

   369

		case 0x22: { /* Visual effect */

   370

			// see note in engine.h about rvi->visual_effect

   371

			FOR_EACH_OBJECT {

   372

				byte visual = grf_load_byte(&buf);

   373

   374

				rvi[i].visual_effect = visual;

   375

			}

   376

		} break;

   377

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

   378

			FOR_EACH_OBJECT {

   379

				byte wag_weight = grf_load_byte(&buf);

   380

   381

				rvi[i].pow_wag_weight = wag_weight;

   382

			}

   383

		} break;

   384

		/* TODO */

   385

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

   386

		case 0x1A:	/* Sort order */

   387

		case 0x1C:	/* Refit cost */

   388

		case 0x1F:	/* Tractive effort */

   389

		case 0x20:	/* Air drag */

   390

		case 0x24:	/* High byte of vehicle weight */

   391

		case 0x25:	/* User-defined bit mask to set when checking veh. var. 42 */

   392

		case 0x26:	/* Retire vehicle early */

   393

			{

   394

			/* TODO */

   395

			FOR_EACH_OBJECT {

   396

				grf_load_byte(&buf);

   397

			}

   398

			ret = true;

   399

		}	break;

   400

		default:

   401

			ret = true;

   402

	}

   403

	*bufp = buf;

   404

	return ret;

   405

}

   406

   407

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

   408

{

   409

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   410

	byte *buf = *bufp;

   411

	int i;

   412

	bool ret = false;

   413

   414

	switch (prop) {

   415

		case 0x08: { /* Speed */

   416

			FOR_EACH_OBJECT {

   417

				uint8 speed = grf_load_byte(&buf);

   418

   419

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

   420

			}

   421

		} break;

   422

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

   423

			FOR_EACH_OBJECT {

   424

				uint8 runcost = grf_load_byte(&buf);

   425

   426

				rvi[i].running_cost = runcost;

   427

			}

   428

		} break;

   429

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

   430

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

   431

			FOR_EACH_OBJECT {

   432

				grf_load_dword(&buf);

   433

			}

   434

			ret = true;

   435

		} break;

   436

		case 0x0E: { /* Sprite ID */

   437

			FOR_EACH_OBJECT {

   438

				uint8 spriteid = grf_load_byte(&buf);

   439

   440

				if (spriteid == 0xFF)

   441

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

   442

   443

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

   444

				// in not having it here for the future.

   445

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

   446

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

   447

   448

				rvi[i].image_index = spriteid;

   449

			}

   450

		} break;

   451

		case 0x0F: { /* Cargo capacity */

   452

			FOR_EACH_OBJECT {

   453

				uint16 capacity = grf_load_byte(&buf);

   454

   455

				rvi[i].capacity = capacity;

   456

			}

   457

		} break;

   458

		case 0x10: { /* Cargo type */

   459

			FOR_EACH_OBJECT {

   460

				uint8 cargo = grf_load_byte(&buf);

   461

   462

				rvi[i].cargo_type = cargo;

   463

			}

   464

		} break;

   465

		case 0x11: { /* Cost factor */

   466

			FOR_EACH_OBJECT {

   467

				uint8 cost_factor = grf_load_byte(&buf);

   468

   469

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

   470

			}

   471

		} break;

   472

		case 0x12: { /* SFX */

   473

			FOR_EACH_OBJECT {

   474

				uint8 sfx = grf_load_byte(&buf);

   475

   476

				rvi[i].sfx = sfx;

   477

			}

   478

		} break;

   479

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

   480

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

   481

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

   482

			/* TODO: Support for road vehicles realistic power

   483

			 * computations (called rvpower in TTDPatch) is just

   484

			 * missing in OTTD yet. --pasky */

   485

			FOR_EACH_OBJECT {

   486

				grf_load_byte(&buf);

   487

			}

   488

			ret = true;

   489

			break;

   490

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

   491

			FOR_EACH_OBJECT {

   492

				uint32 refit_mask = grf_load_dword(&buf);

   493

   494

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   495

			}

   496

		} break;

   497

		case 0x17:      /* Callback */

   498

		case 0x18:      /* Tractive effort */

   499

		case 0x19:      /* Air drag */

   500

		case 0x1A:      /* Refit cost */

   501

		case 0x1B:      /* Retire vehicle early */

   502

			{

   503

			/* TODO */

   504

			FOR_EACH_OBJECT {

   505

				grf_load_byte(&buf);

   506

			}

   507

			ret = true;

   508

			break;

   509

		}

   510

		default:

   511

			ret = true;

   512

	}