1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

     5

#include <stdarg.h>

     6

     7

#include "openttd.h"

     8

#include "debug.h"

     9

#include "gfx.h"

    10

#include "fileio.h"

    11

#include "functions.h"

    12

#include "engine.h"

    14

#include "station.h"

    15

#include "sprite.h"

    16

#include "newgrf.h"

    17

#include "variables.h"

    18

    19

/* TTDPatch extended GRF format codec

    20

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

    21

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

    22

 *

    23

 * Contains portions of documentation by TTDPatch team.

    24

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

    25

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

    26

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

    27

    28

    32

extern int _traininfo_vehicle_pitch;

    33

    34

static GRFFile *_cur_grffile;

    35

GRFFile *_first_grffile;

    36

int _grffile_count;

    37

static int _cur_spriteid;

    38

static int _cur_stage;

    39

    40

static int32 _paramlist[0x7f];

    41

static int _param_max;

    42

    43

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

    44

static uint32 _ttdpatch_flags[8];

    45

    46

    47

typedef enum grfspec_feature {

    48

	GSF_TRAIN,

    49

	GSF_ROAD,

    50

	GSF_SHIP,

    51

	GSF_AIRCRAFT,

    52

	GSF_STATION,

    53

	GSF_BRIDGE,

    54

	GSF_TOWNHOUSE,

    55

} grfspec_feature;

    56

    57

    58

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

    59

    60

static const int _vehcounts[4] = {

    61

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    62

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    63

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    64

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    65

};

    66

    67

static const int _vehshifts[4] = {

    68

	/* GSF_TRAIN */    0,

    69

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    70

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    71

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    72

};

    73

    74

    75

/* Debugging messages policy:

    76

 *

    77

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

    78

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

    79

 *

    80

 * 0..2 - dedicated to grfmsg()

    81

 * 3

    82

 * 4

    83

 * 5

    84

 * 6 - action handler entry reporting - one per action

    85

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

    86

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

    87

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

    88

 */

    89

    90

    91

typedef enum grfmsg_severity {

    92

	GMS_NOTICE,

    93

	GMS_WARN,

    94

	GMS_ERROR,

    95

	GMS_FATAL,

    96

} grfmsg_severity;

    97

    98

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

    99

{

   100

	static const char* const severitystr[] = {

   101

		"Notice",

   102

		"Warning",

   103

		"Error",

   104

		"Fatal"

   105

	};

   106

	int export_severity = 0;

   107

	char buf[1024];

   108

	va_list va;

   109

   110

	va_start(va, str);

   111

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

   112

	va_end(va);

   113

   114

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

   115

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

   116

}

   117

   118

   119

#define check_length(real, wanted, where) \

   120

do { \

   121

	if (real < wanted) { \

   122

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

   123

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

   124

		return; \

   125

	} \

   126

} while (0)

   127

   128

   129

static inline byte grf_load_byte(byte **buf)

   130

{

   131

	return *(*buf)++;

   132

}

   133

   134

static uint16 grf_load_word(byte **buf)

   135

{

   136

	uint16 val;

   137

	byte *p = *buf;

   138

	val = p[0];

   139

	val |= p[1] << 8;

   140

	*buf = p + 2;

   141

	return val;

   142

}

   143

   144

static uint32 grf_load_dword(byte **buf)

   145

{

   146

	uint32 val;

   147

	byte *p = *buf;

   148

	val = p[0];

   149

	val |= p[1] << 8;

   150

	val |= p[2] << 16;

   151

	val |= p[3] << 24;

   152

	*buf = p + 4;

   153

	return val;

   154

}

   155

   156

   157

static GRFFile *GetFileByGRFID(uint32 grfid)

   158

{

   159

	GRFFile *file;

   160

   161

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

   162

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

   163

	}

   164

	return file;

   165

}

   166

   167

static GRFFile *GetFileByFilename(const char *filename)

   168

{

   169

	GRFFile *file;

   170

   171

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

   172

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

   173

	}

   174

	return file;

   175

}

   176

   177

   178

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

   179

   180

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

   181

   182

static void dewagonize(int condition, int engine)

   183

{

   184

	EngineInfo *ei = &_engine_info[engine];

   185

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   186

   187

	if (condition != 0) {

   188

		ei->unk2 &= ~0x80;

   189

		rvi->flags &= ~2;

   190

	} else {

   191

		ei->unk2 |= 0x80;

   192

		rvi->flags |= 2;

   193

	}

   194

}

   195

   196

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

   197

{

   198

	EngineInfo *ei = &_engine_info[engine];

   199

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   200

	byte *buf = *bufp;

   201

	int i;

   202

	bool ret = false;

   203

   204

	switch (prop) {

   205

		case 0x05: { /* Track type */

   206

			FOR_EACH_OBJECT {

   207

				uint8 tracktype = grf_load_byte(&buf);

   208

   209

				ei[i].railtype_climates &= 0xf;

   210

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

   211

			}

   212

		} break;

   213

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

   214

			/* TODO */

   215

			FOR_EACH_OBJECT {

   216

				grf_load_byte(&buf);

   217

			}

   218

			ret = true;

   219

		} break;

   220

		case 0x09: { /* Speed */

   221

			FOR_EACH_OBJECT {

   222

				uint16 speed = grf_load_word(&buf);

   223

   224

				rvi[i].max_speed = speed;

   225

				dewagonize(speed, engine + i);

   226

			}

   227

		} break;

   228

		case 0x0B: { /* Power */

   229

			FOR_EACH_OBJECT {

   230

				uint16 power = grf_load_word(&buf);

   231

   232

				if (rvi[i].flags & RVI_MULTIHEAD)

   233

					power /= 2;

   234

   235

				rvi[i].power = power;

   236

				dewagonize(power, engine + i);

   237

			}

   238

		} break;

   239

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

   240

			FOR_EACH_OBJECT {

   241

				uint8 runcostfact = grf_load_byte(&buf);

   242

   243

				rvi[i].running_cost_base = runcostfact;

   244

				dewagonize(runcostfact, engine + i);

   245

			}

   246

		} break;

   247

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

   248

			FOR_EACH_OBJECT {

   249

				uint32 base = grf_load_dword(&buf);

   250

   251

				switch (base) {

   252

				case 0x4C30:

   253

					rvi[i].engclass = 0;

   254

					break;

   255

				case 0x4C36:

   256

					rvi[i].engclass = 1;

   257

					break;

   258

				case 0x4C3C:

   259

					rvi[i].engclass = 2;

   260

					break;

   261

				}

   262

				dewagonize(base, engine + i);

   263

			}

   264

		} break;

   265

		case 0x12: { /* Sprite ID */

   266

			FOR_EACH_OBJECT {

   267

				uint8 spriteid = grf_load_byte(&buf);

   268

   269

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

   270

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

   271

				rvi[i].image_index = spriteid;

   272

			}

   273

		} break;

   274

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

   275

			FOR_EACH_OBJECT {

   276

				uint8 dual = grf_load_byte(&buf);

   277

   278

				if (dual != 0) {

   279

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

   280

						rvi[i].power /= 2;

   281

					rvi[i].flags |= RVI_MULTIHEAD;

   282

				} else {

   283

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

   284

						rvi[i].power *= 2;

   285

					rvi[i].flags &= ~RVI_MULTIHEAD;

   286

				}

   287

			}

   288

		} break;

   289

		case 0x14: { /* Cargo capacity */

   290

			FOR_EACH_OBJECT {

   291

				uint8 capacity = grf_load_byte(&buf);

   292

   293

				rvi[i].capacity = capacity;

   294

			}

   295

		} break;

   296

		case 0x15: { /* Cargo type */

   297

			FOR_EACH_OBJECT {

   298

				uint8 ctype = grf_load_byte(&buf);

   299

   300

				rvi[i].cargo_type = ctype;

   301

			}

   302

		} break;

   303

		case 0x16: { /* Weight */

   304

			FOR_EACH_OBJECT {

   305

				uint8 weight = grf_load_byte(&buf);

   306

   307

				rvi[i].weight = weight;

   308

			}

   309

		} break;

   310

		case 0x17: { /* Cost factor */

   311

			FOR_EACH_OBJECT {

   312

				uint8 cfactor = grf_load_byte(&buf);

   313

   314

				rvi[i].base_cost = cfactor;

   315

			}

   316

		} break;

   317

		case 0x18: { /* AI rank */

   318

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

   319

			FOR_EACH_OBJECT {

   320

				grf_load_byte(&buf);

   321

			}

   322

			ret = true;

   323

		} break;

   324

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

   325

			/* TODO: What do the individual numbers mean?

   326

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

   327

			FOR_EACH_OBJECT {

   328

				uint8 traction = grf_load_byte(&buf);

   329

				int engclass;

   330

   331

				if (traction <= 0x07)

   332

					engclass = 0;

   333

				else if (traction <= 0x27)

   334

					engclass = 1;

   335

				else if (traction <= 0x31)

   336

					engclass = 2;

   337

				else

   338

					break;

   339

   340

				rvi[i].engclass = engclass;

   341

			}

   342

		} break;

   343

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

   344

			FOR_EACH_OBJECT {

   345

				uint16 wag_power = grf_load_word(&buf);

   346

   347

				rvi[i].pow_wag_power = wag_power;

   348

			}

   349

		} break;

   350

		case 0x1D: { /* Refit cargo */

   351

			FOR_EACH_OBJECT {

   352

				uint32 refit_mask = grf_load_dword(&buf);

   353

   354

				_engine_refit_masks[engine + i] = refit_mask;

   355

			}

   356

		} break;

   357

		case 0x1E: { /* Callback */

   358

			FOR_EACH_OBJECT {

   359

				byte callbacks = grf_load_byte(&buf);

   360

   361

				rvi[i].callbackmask = callbacks;

   362

			}

   363

		} break;

   364

		case 0x21: { /* Shorter vehicle */

   365

			FOR_EACH_OBJECT {

   366

				byte shorten_factor = grf_load_byte(&buf);

   367

   368

				rvi[i].shorten_factor = shorten_factor;

   369

			}

   370

		} break;

   371

		case 0x22: { /* Visual effect */

   372

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

   373

			FOR_EACH_OBJECT {

   374

				byte visual = grf_load_byte(&buf);

   375

   376

				rvi[i].visual_effect = visual;

   377

			}

   378

		} break;

   379

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

   380

			FOR_EACH_OBJECT {

   381

				byte wag_weight = grf_load_byte(&buf);

   382

   383

				rvi[i].pow_wag_weight = wag_weight;

   384

			}

   385

		} break;

   386

		/* TODO */

   387

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

   388

		case 0x1A:	/* Sort order */

   389

		case 0x1C:	/* Refit cost */

   390

		case 0x1F:	/* Tractive effort */

   391

		case 0x20:	/* Air drag */

   392

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

   393

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

   394

		case 0x26:	/* Retire vehicle early */

   395

			{

   396

			/* TODO */

   397

			FOR_EACH_OBJECT {

   398

				grf_load_byte(&buf);

   399

			}

   400

			ret = true;

   401

		}	break;

   402

		default:

   403

			ret = true;

   404

	}

   405

	*bufp = buf;

   406

	return ret;

   407

}

   408

   409

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

   410

{

   411

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   412

	byte *buf = *bufp;

   413

	int i;

   414

	bool ret = false;

   415

   416

	switch (prop) {

   417

		case 0x08: { /* Speed */

   418

			FOR_EACH_OBJECT {

   419

				uint8 speed = grf_load_byte(&buf);

   420

   421

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

   422

			}

   423

		} break;

   424

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

   425

			FOR_EACH_OBJECT {

   426

				uint8 runcost = grf_load_byte(&buf);

   427

   428

				rvi[i].running_cost = runcost;

   429

			}

   430

		} break;

   431

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

   432

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

   433

			FOR_EACH_OBJECT {

   434

				grf_load_dword(&buf);

   435

			}

   436

			ret = true;

   437

		} break;

   438

		case 0x0E: { /* Sprite ID */

   439

			FOR_EACH_OBJECT {

   440

				uint8 spriteid = grf_load_byte(&buf);

   441

   442

				if (spriteid == 0xFF)

   443

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

   444

   445

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

   446

				// in not having it here for the future.

   447

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

   448

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

   449

   450

				rvi[i].image_index = spriteid;

   451

			}

   452

		} break;

   453

		case 0x0F: { /* Cargo capacity */

   454

			FOR_EACH_OBJECT {

   455

				uint16 capacity = grf_load_byte(&buf);

   456

   457

				rvi[i].capacity = capacity;

   458

			}

   459

		} break;

   460

		case 0x10: { /* Cargo type */

   461

			FOR_EACH_OBJECT {

   462

				uint8 cargo = grf_load_byte(&buf);

   463

   464

				rvi[i].cargo_type = cargo;

   465

			}

   466

		} break;

   467

		case 0x11: { /* Cost factor */

   468

			FOR_EACH_OBJECT {

   469

				uint8 cost_factor = grf_load_byte(&buf);

   470

   471

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

   472

			}

   473

		} break;

   474

		case 0x12: { /* SFX */

   475

			FOR_EACH_OBJECT {

   476

				uint8 sfx = grf_load_byte(&buf);

   477

   478

				rvi[i].sfx = sfx;

   479

			}

   480

		} break;

   481

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

   482

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

   483

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

   484

			/* TODO: Support for road vehicles realistic power

   485

			 * computations (called rvpower in TTDPatch) is just

   486

			 * missing in OTTD yet. --pasky */

   487

			FOR_EACH_OBJECT {

   488

				grf_load_byte(&buf);

   489

			}

   490

			ret = true;

   491

			break;

   492

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

   493

			FOR_EACH_OBJECT {

   494

				uint32 refit_mask = grf_load_dword(&buf);