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"

    13

#include "spritecache.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

    29

uint16 _custom_sprites_base;

    30

static int _skip_sprites; // XXX

    31

static uint _file_index; // XXX

    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

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

    41

static uint32 _ttdpatch_flags[8];

    42

    43

    44

typedef enum grfspec_feature {

    45

	GSF_TRAIN,

    46

	GSF_ROAD,

    47

	GSF_SHIP,

    48

	GSF_AIRCRAFT,

    49

	GSF_STATION,

    50

	GSF_CANAL,

    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_extended(byte** buf)

   143

{

   144

	uint16 val;

   145

	val = grf_load_byte(buf);

   146

	if (val == 0xFF) val = grf_load_word(buf);

   147

	return val;

   148

}

   149

   150

static uint32 grf_load_dword(byte **buf)

   151

{

   152

	uint32 val;

   153

	byte *p = *buf;

   154

	val = p[0];

   155

	val |= p[1] << 8;

   156

	val |= p[2] << 16;

   157

	val |= p[3] << 24;

   158

	*buf = p + 4;

   159

	return val;

   160

}

   161

   162

   163

static GRFFile *GetFileByGRFID(uint32 grfid)

   164

{

   165

	GRFFile *file;

   166

   167

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

   168

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

   169

	}

   170

	return file;

   171

}

   172

   173

static GRFFile *GetFileByFilename(const char *filename)

   174

{

   175

	GRFFile *file;

   176

   177

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

   178

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

   179

	}

   180

	return file;

   181

}

   182

   183

   184

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

   185

   186

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

   187

   188

static void dewagonize(int condition, int engine)

   189

{

   190

	EngineInfo *ei = &_engine_info[engine];

   191

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   192

   193

	if (condition != 0) {

   194

		ei->unk2 &= ~0x80;

   195

		rvi->flags &= ~2;

   196

	} else {

   197

		ei->unk2 |= 0x80;

   198

		rvi->flags |= 2;

   199

	}

   200

}

   201

   202

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

   203

{

   204

	EngineInfo *ei = &_engine_info[engine];

   205

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   206

	byte *buf = *bufp;

   207

	int i;

   208

	bool ret = false;

   209

   210

	switch (prop) {

   211

		case 0x05: { /* Track type */

   212

			FOR_EACH_OBJECT {

   213

				uint8 tracktype = grf_load_byte(&buf);

   214

   215

				ei[i].railtype_climates &= 0xf;

   216

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

   217

			}

   218

		} break;

   219

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

   220

			/* TODO */

   221

			FOR_EACH_OBJECT {

   222

				grf_load_byte(&buf);

   223

			}

   224

			ret = true;

   225

		} break;

   226

		case 0x09: { /* Speed */

   227

			FOR_EACH_OBJECT {

   228

				uint16 speed = grf_load_word(&buf);

   229

   230

				rvi[i].max_speed = speed;

   231

				dewagonize(speed, engine + i);

   232

			}

   233

		} break;

   234

		case 0x0B: { /* Power */

   235

			FOR_EACH_OBJECT {

   236

				uint16 power = grf_load_word(&buf);

   237

   238

				if (rvi[i].flags & RVI_MULTIHEAD)

   239

					power /= 2;

   240

   241

				rvi[i].power = power;

   242

				dewagonize(power, engine + i);

   243

			}

   244

		} break;

   245

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

   246

			FOR_EACH_OBJECT {

   247

				uint8 runcostfact = grf_load_byte(&buf);

   248

   249

				rvi[i].running_cost_base = runcostfact;

   250

				dewagonize(runcostfact, engine + i);

   251

			}

   252

		} break;

   253

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

   254

			FOR_EACH_OBJECT {

   255

				uint32 base = grf_load_dword(&buf);

   256

   257

				switch (base) {

   258

				case 0x4C30:

   259

					rvi[i].engclass = 0;

   260

					break;

   261

				case 0x4C36:

   262

					rvi[i].engclass = 1;

   263

					break;

   264

				case 0x4C3C:

   265

					rvi[i].engclass = 2;

   266

					break;

   267

				}

   268

				dewagonize(base, engine + i);

   269

			}

   270

		} break;

   271

		case 0x12: { /* Sprite ID */

   272

			FOR_EACH_OBJECT {

   273

				uint8 spriteid = grf_load_byte(&buf);

   274

   275

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

   276

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

   277

				rvi[i].image_index = spriteid;

   278

			}

   279

		} break;

   280

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

   281

			FOR_EACH_OBJECT {

   282

				uint8 dual = grf_load_byte(&buf);

   283

   284

				if (dual != 0) {

   285

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

   286

						rvi[i].power /= 2;

   287

					rvi[i].flags |= RVI_MULTIHEAD;

   288

				} else {

   289

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

   290

						rvi[i].power *= 2;

   291

					rvi[i].flags &= ~RVI_MULTIHEAD;

   292

				}

   293

			}

   294

		} break;

   295

		case 0x14: { /* Cargo capacity */

   296

			FOR_EACH_OBJECT {

   297

				uint8 capacity = grf_load_byte(&buf);

   298

   299

				rvi[i].capacity = capacity;

   300

			}

   301

		} break;

   302

		case 0x15: { /* Cargo type */

   303

			FOR_EACH_OBJECT {

   304

				uint8 ctype = grf_load_byte(&buf);

   305

   306

				rvi[i].cargo_type = ctype;

   307

			}

   308

		} break;

   309

		case 0x16: { /* Weight */

   310

			FOR_EACH_OBJECT {

   311

				uint8 weight = grf_load_byte(&buf);

   312

   313

				rvi[i].weight = weight;

   314

			}

   315

		} break;

   316

		case 0x17: { /* Cost factor */

   317

			FOR_EACH_OBJECT {

   318

				uint8 cfactor = grf_load_byte(&buf);

   319

   320

				rvi[i].base_cost = cfactor;

   321

			}

   322

		} break;

   323

		case 0x18: { /* AI rank */

   324

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

   325

			FOR_EACH_OBJECT {

   326

				grf_load_byte(&buf);

   327

			}

   328

			ret = true;

   329

		} break;

   330

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

   331

			/* TODO: What do the individual numbers mean?

   332

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

   333

			FOR_EACH_OBJECT {

   334

				uint8 traction = grf_load_byte(&buf);

   335

				int engclass;

   336

   337

				if (traction <= 0x07)

   338

					engclass = 0;

   339

				else if (traction <= 0x27)

   340

					engclass = 1;

   341

				else if (traction <= 0x31)

   342

					engclass = 2;

   343

				else

   344

					break;

   345

   346

				rvi[i].engclass = engclass;

   347

			}

   348

		} break;

   349

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

   350

			FOR_EACH_OBJECT {

   351

				uint16 wag_power = grf_load_word(&buf);

   352

   353

				rvi[i].pow_wag_power = wag_power;

   354

			}

   355

		} break;

   356

		case 0x1D: { /* Refit cargo */

   357

			FOR_EACH_OBJECT {

   358

				uint32 refit_mask = grf_load_dword(&buf);

   359

   360

				_engine_refit_masks[engine + i] = refit_mask;

   361

			}

   362

		} break;

   363

		case 0x1E: { /* Callback */

   364

			FOR_EACH_OBJECT {

   365

				byte callbacks = grf_load_byte(&buf);

   366

   367

				rvi[i].callbackmask = callbacks;

   368

			}

   369

		} break;

   370

		case 0x21: { /* Shorter vehicle */

   371

			FOR_EACH_OBJECT {

   372

				byte shorten_factor = grf_load_byte(&buf);

   373

   374

				rvi[i].shorten_factor = shorten_factor;

   375

			}

   376

		} break;

   377

		case 0x22: { /* Visual effect */

   378

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

   379

			FOR_EACH_OBJECT {

   380

				byte visual = grf_load_byte(&buf);

   381

   382

				rvi[i].visual_effect = visual;

   383

			}

   384

		} break;

   385

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

   386

			FOR_EACH_OBJECT {

   387

				byte wag_weight = grf_load_byte(&buf);

   388

   389

				rvi[i].pow_wag_weight = wag_weight;

   390

			}

   391

		} break;

   392

		/* TODO */

   393

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

   394

		case 0x1A:	/* Sort order */

   395

		case 0x1C:	/* Refit cost */

   396

		case 0x1F:	/* Tractive effort */

   397

		case 0x20:	/* Air drag */

   398

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

   399

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

   400

		case 0x26:	/* Retire vehicle early */

   401

			{

   402

			/* TODO */

   403

			FOR_EACH_OBJECT {

   404

				grf_load_byte(&buf);

   405

			}

   406

			ret = true;

   407

		}	break;

   408

		default:

   409

			ret = true;

   410

	}

   411

	*bufp = buf;

   412

	return ret;

   413

}

   414

   415

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

   416

{

   417

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   418

	byte *buf = *bufp;

   419

	int i;

   420

	bool ret = false;

   421

   422

	switch (prop) {

   423

		case 0x08: { /* Speed */

   424

			FOR_EACH_OBJECT {

   425

				uint8 speed = grf_load_byte(&buf);

   426

   427

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

   428

			}

   429

		} break;

   430

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

   431

			FOR_EACH_OBJECT {

   432

				uint8 runcost = grf_load_byte(&buf);

   433

   434

				rvi[i].running_cost = runcost;

   435

			}

   436

		} break;

   437

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

   438

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

   439

			FOR_EACH_OBJECT {

   440

				grf_load_dword(&buf);

   441

			}

   442

			ret = true;

   443

		} break;

   444

		case 0x0E: { /* Sprite ID */

   445

			FOR_EACH_OBJECT {

   446

				uint8 spriteid = grf_load_byte(&buf);

   447

   448

				if (spriteid == 0xFF)

   449

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

   450

   451

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

   452

				// in not having it here for the future.

   453

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

   454

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

   455

   456

				rvi[i].image_index = spriteid;

   457

			}

   458

		} break;

   459

		case 0x0F: { /* Cargo capacity */

   460

			FOR_EACH_OBJECT {

   461

				uint16 capacity = grf_load_byte(&buf);

   462

   463

				rvi[i].capacity = capacity;

   464

			}

   465

		} break;

   466

		case 0x10: { /* Cargo type */

   467

			FOR_EACH_OBJECT {

   468

				uint8 cargo = grf_load_byte(&buf);

   469

   470

				rvi[i].cargo_type = cargo;

   471

			}

   472

		} break;

   473

		case 0x11: { /* Cost factor */

   474

			FOR_EACH_OBJECT {

   475

				uint8 cost_factor = grf_load_byte(&buf);

   476

   477

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

   478

			}

   479

		} break;

   480

		case 0x12: { /* SFX */

   481

			FOR_EACH_OBJECT {

   482

				uint8 sfx = grf_load_byte(&buf);

   483

   484

				rvi[i].sfx = sfx;

   485

			}

   486

		} break;

   487

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

   488

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

   489

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

   490

			/* TODO: Support for road vehicles realistic power

   491

			 * computations (called rvpower in TTDPatch) is just

   492

			 * missing in OTTD yet. --pasky */

   493

			FOR_EACH_OBJECT {

   494

				grf_load_byte(&buf);

   495

			}

   496

			ret = true;

   497

			break;

   498

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

   499

			FOR_EACH_OBJECT {

   500

				uint32 refit_mask = grf_load_dword(&buf);

   501

   502

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   503

			}

   504

		} break;

   505

		case 0x17:      /* Callback */

   506

		case 0x18:      /* Tractive effort */

   507

		case 0x19:      /* Air drag */

   508

		case 0x1A:      /* Refit cost */

   509

		case 0x1B:      /* Retire vehicle early */

   510

			{

   511