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_BRIDGE,

    51

	GSF_TOWNHOUSE,

    52

} grfspec_feature;

    53

    54

    55

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

    56

    57

static const int _vehcounts[4] = {

    58

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    59

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    60

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    61

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    62

};

    63

    64

static const int _vehshifts[4] = {

    65

	/* GSF_TRAIN */    0,

    66

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    67

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    68

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    69

};

    70

    71

    72

/* Debugging messages policy:

    73

 *

    74

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

    75

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

    76

 *

    77

 * 0..2 - dedicated to grfmsg()

    78

 * 3

    79

 * 4

    80

 * 5

    81

 * 6 - action handler entry reporting - one per action

    82

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

    83

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

    84

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

    85

 */

    86

    87

    88

typedef enum grfmsg_severity {

    89

	GMS_NOTICE,

    90

	GMS_WARN,

    91

	GMS_ERROR,

    92

	GMS_FATAL,

    93

} grfmsg_severity;

    94

    95

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

    96

{

    97

	static const char* const severitystr[] = {

    98

		"Notice",

    99

		"Warning",

   100

		"Error",

   101

		"Fatal"

   102

	};

   103

	int export_severity = 0;

   104

	char buf[1024];

   105

	va_list va;

   106

   107

	va_start(va, str);

   108

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

   109

	va_end(va);

   110

   111

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

   112

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

   113

}

   114

   115

   116

#define check_length(real, wanted, where) \

   117

do { \

   118

	if (real < wanted) { \

   119

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

   120

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

   121

		return; \

   122

	} \

   123

} while (0)

   124

   125

   126

static inline byte grf_load_byte(byte **buf)

   127

{

   128

	return *(*buf)++;

   129

}

   130

   131

static uint16 grf_load_word(byte **buf)

   132

{

   133

	uint16 val;

   134

	byte *p = *buf;

   135

	val = p[0];

   136

	val |= p[1] << 8;

   137

	*buf = p + 2;

   138

	return val;

   139

}

   140

   141

static uint16 grf_load_extended(byte** buf)

   142

{

   143

	uint16 val;

   144

	val = grf_load_byte(buf);

   145

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

   146

	return val;

   147

}

   148

   149

static uint32 grf_load_dword(byte **buf)

   150

{

   151

	uint32 val;

   152

	byte *p = *buf;

   153

	val = p[0];

   154

	val |= p[1] << 8;

   155

	val |= p[2] << 16;

   156

	val |= p[3] << 24;

   157

	*buf = p + 4;

   158

	return val;

   159

}

   160

   161

   162

static GRFFile *GetFileByGRFID(uint32 grfid)

   163

{

   164

	GRFFile *file;

   165

   166

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

   167

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

   168

	}

   169

	return file;

   170

}

   171

   172

static GRFFile *GetFileByFilename(const char *filename)

   173

{

   174

	GRFFile *file;

   175

   176

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

   177

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

   178

	}

   179

	return file;

   180

}

   181

   182

   183

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

   184

   185

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

   186

   187

static void dewagonize(int condition, int engine)

   188

{

   189

	EngineInfo *ei = &_engine_info[engine];

   190

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   191

   192

	if (condition != 0) {

   193

		ei->unk2 &= ~0x80;

   194

		rvi->flags &= ~2;

   195

	} else {

   196

		ei->unk2 |= 0x80;

   197

		rvi->flags |= 2;

   198

	}

   199

}

   200

   201

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

   202

{

   203

	EngineInfo *ei = &_engine_info[engine];

   204

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   205

	byte *buf = *bufp;

   206

	int i;

   207

	bool ret = false;

   208

   209

	switch (prop) {

   210

		case 0x05: { /* Track type */

   211

			FOR_EACH_OBJECT {

   212

				uint8 tracktype = grf_load_byte(&buf);

   213

   214

				ei[i].railtype_climates &= 0xf;

   215

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

   216

			}

   217

		} break;

   218

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

   219

			/* TODO */

   220

			FOR_EACH_OBJECT {

   221

				grf_load_byte(&buf);

   222

			}

   223

			ret = true;

   224

		} break;

   225

		case 0x09: { /* Speed */

   226

			FOR_EACH_OBJECT {

   227

				uint16 speed = grf_load_word(&buf);

   228

   229

				rvi[i].max_speed = speed;

   230

				dewagonize(speed, engine + i);

   231

			}

   232

		} break;

   233

		case 0x0B: { /* Power */

   234

			FOR_EACH_OBJECT {

   235

				uint16 power = grf_load_word(&buf);

   236

   237

				if (rvi[i].flags & RVI_MULTIHEAD)

   238

					power /= 2;

   239

   240

				rvi[i].power = power;

   241

				dewagonize(power, engine + i);

   242

			}

   243

		} break;

   244

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

   245

			FOR_EACH_OBJECT {

   246

				uint8 runcostfact = grf_load_byte(&buf);

   247

   248

				rvi[i].running_cost_base = runcostfact;

   249

				dewagonize(runcostfact, engine + i);

   250

			}

   251

		} break;

   252

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

   253

			FOR_EACH_OBJECT {

   254

				uint32 base = grf_load_dword(&buf);

   255

   256

				switch (base) {

   257

				case 0x4C30:

   258

					rvi[i].engclass = 0;

   259

					break;

   260

				case 0x4C36:

   261

					rvi[i].engclass = 1;

   262

					break;

   263

				case 0x4C3C:

   264

					rvi[i].engclass = 2;

   265

					break;

   266

				}

   267

				dewagonize(base, engine + i);

   268

			}

   269

		} break;

   270

		case 0x12: { /* Sprite ID */

   271

			FOR_EACH_OBJECT {

   272

				uint8 spriteid = grf_load_byte(&buf);

   273

   274

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

   275

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

   276

				rvi[i].image_index = spriteid;

   277

			}

   278

		} break;

   279

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

   280

			FOR_EACH_OBJECT {

   281

				uint8 dual = grf_load_byte(&buf);

   282

   283

				if (dual != 0) {

   284

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

   285

						rvi[i].power /= 2;

   286

					rvi[i].flags |= RVI_MULTIHEAD;

   287

				} else {

   288

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

   289

						rvi[i].power *= 2;

   290

					rvi[i].flags &= ~RVI_MULTIHEAD;

   291

				}

   292

			}

   293

		} break;

   294

		case 0x14: { /* Cargo capacity */

   295

			FOR_EACH_OBJECT {

   296

				uint8 capacity = grf_load_byte(&buf);

   297

   298

				rvi[i].capacity = capacity;

   299

			}

   300

		} break;

   301

		case 0x15: { /* Cargo type */

   302

			FOR_EACH_OBJECT {

   303

				uint8 ctype = grf_load_byte(&buf);

   304

   305

				rvi[i].cargo_type = ctype;

   306

			}

   307

		} break;

   308

		case 0x16: { /* Weight */

   309

			FOR_EACH_OBJECT {

   310

				uint8 weight = grf_load_byte(&buf);

   311

   312

				rvi[i].weight = weight;

   313

			}

   314

		} break;

   315

		case 0x17: { /* Cost factor */

   316

			FOR_EACH_OBJECT {

   317

				uint8 cfactor = grf_load_byte(&buf);

   318

   319

				rvi[i].base_cost = cfactor;

   320

			}

   321

		} break;

   322

		case 0x18: { /* AI rank */

   323

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

   324

			FOR_EACH_OBJECT {

   325

				grf_load_byte(&buf);

   326

			}

   327

			ret = true;

   328

		} break;

   329

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

   330

			/* TODO: What do the individual numbers mean?

   331

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

   332

			FOR_EACH_OBJECT {

   333

				uint8 traction = grf_load_byte(&buf);

   334

				int engclass;

   335

   336

				if (traction <= 0x07)

   337

					engclass = 0;

   338

				else if (traction <= 0x27)

   339

					engclass = 1;

   340

				else if (traction <= 0x31)

   341

					engclass = 2;

   342

				else

   343

					break;

   344

   345

				rvi[i].engclass = engclass;

   346

			}

   347

		} break;

   348

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

   349

			FOR_EACH_OBJECT {

   350

				uint16 wag_power = grf_load_word(&buf);

   351

   352

				rvi[i].pow_wag_power = wag_power;

   353

			}

   354

		} break;

   355

		case 0x1D: { /* Refit cargo */

   356

			FOR_EACH_OBJECT {

   357

				uint32 refit_mask = grf_load_dword(&buf);

   358

   359

				_engine_refit_masks[engine + i] = refit_mask;

   360

			}

   361

		} break;

   362

		case 0x1E: { /* Callback */

   363

			FOR_EACH_OBJECT {

   364

				byte callbacks = grf_load_byte(&buf);

   365

   366

				rvi[i].callbackmask = callbacks;

   367

			}

   368

		} break;

   369

		case 0x21: { /* Shorter vehicle */

   370

			FOR_EACH_OBJECT {

   371

				byte shorten_factor = grf_load_byte(&buf);

   372

   373

				rvi[i].shorten_factor = shorten_factor;

   374

			}

   375

		} break;

   376

		case 0x22: { /* Visual effect */

   377

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

   378

			FOR_EACH_OBJECT {

   379

				byte visual = grf_load_byte(&buf);

   380

   381

				rvi[i].visual_effect = visual;

   382

			}

   383

		} break;

   384

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

   385

			FOR_EACH_OBJECT {

   386

				byte wag_weight = grf_load_byte(&buf);

   387

   388

				rvi[i].pow_wag_weight = wag_weight;

   389

			}

   390

		} break;

   391

		/* TODO */

   392

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

   393

		case 0x1A:	/* Sort order */

   394

		case 0x1C:	/* Refit cost */

   395

		case 0x1F:	/* Tractive effort */

   396

		case 0x20:	/* Air drag */

   397

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

   398

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

   399

		case 0x26:	/* Retire vehicle early */

   400

			{

   401

			/* TODO */

   402

			FOR_EACH_OBJECT {

   403

				grf_load_byte(&buf);

   404

			}

   405

			ret = true;

   406

		}	break;

   407

		default:

   408

			ret = true;

   409

	}

   410

	*bufp = buf;

   411

	return ret;

   412

}

   413

   414

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

   415

{

   416

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   417

	byte *buf = *bufp;

   418

	int i;

   419

	bool ret = false;

   420

   421

	switch (prop) {

   422

		case 0x08: { /* Speed */

   423

			FOR_EACH_OBJECT {

   424

				uint8 speed = grf_load_byte(&buf);

   425

   426

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

   427

			}

   428

		} break;

   429

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

   430

			FOR_EACH_OBJECT {

   431

				uint8 runcost = grf_load_byte(&buf);

   432

   433

				rvi[i].running_cost = runcost;

   434

			}

   435

		} break;

   436

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

   437

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

   438

			FOR_EACH_OBJECT {

   439

				grf_load_dword(&buf);

   440

			}

   441

			ret = true;

   442

		} break;

   443

		case 0x0E: { /* Sprite ID */

   444

			FOR_EACH_OBJECT {

   445

				uint8 spriteid = grf_load_byte(&buf);

   446

   447

				if (spriteid == 0xFF)

   448

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

   449

   450

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

   451

				// in not having it here for the future.

   452

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

   453

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

   454

   455

				rvi[i].image_index = spriteid;

   456

			}

   457

		} break;

   458

		case 0x0F: { /* Cargo capacity */

   459

			FOR_EACH_OBJECT {

   460

				uint16 capacity = grf_load_byte(&buf);

   461

   462

				rvi[i].capacity = capacity;

   463

			}

   464

		} break;

   465

		case 0x10: { /* Cargo type */

   466

			FOR_EACH_OBJECT {

   467

				uint8 cargo = grf_load_byte(&buf);

   468

   469

				rvi[i].cargo_type = cargo;

   470

			}

   471

		} break;

   472

		case 0x11: { /* Cost factor */

   473

			FOR_EACH_OBJECT {

   474

				uint8 cost_factor = grf_load_byte(&buf);

   475

   476

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

   477

			}

   478

		} break;

   479

		case 0x12: { /* SFX */

   480

			FOR_EACH_OBJECT {

   481

				uint8 sfx = grf_load_byte(&buf);

   482

   483

				rvi[i].sfx = sfx;

   484

			}

   485

		} break;

   486

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

   487

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

   488

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

   489

			/* TODO: Support for road vehicles realistic power

   490

			 * computations (called rvpower in TTDPatch) is just

   491

			 * missing in OTTD yet. --pasky */

   492

			FOR_EACH_OBJECT {

   493

				grf_load_byte(&buf);

   494

			}