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

#include "string.h"

    19

#include "bridge.h"

    20

#include "economy.h"

    21

#include "newgrf_engine.h"

    22

#include "vehicle.h"

    23

#include "newgrf_text.h"

    24

    25

#include "newgrf_spritegroup.h"

    26

    27

/* TTDPatch extended GRF format codec

    28

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

    29

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

    30

 *

    31

 * Contains portions of documentation by TTDPatch team.

    32

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

    33

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

    34

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

    35

    36

    37

uint16 _custom_sprites_base;

    38

static int _skip_sprites; // XXX

    39

static uint _file_index; // XXX

    40

extern int _traininfo_vehicle_pitch;

    41

    42

static GRFFile *_cur_grffile;

    43

GRFFile *_first_grffile;

    44

GRFConfig *_first_grfconfig;

    45

static int _cur_spriteid;

    46

static int _cur_stage;

    47

static uint32 _nfo_line;

    48

    49

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

    50

static uint32 _ttdpatch_flags[8];

    51

    52

    53

typedef enum grfspec_feature {

    54

	GSF_TRAIN,

    55

	GSF_ROAD,

    56

	GSF_SHIP,

    57

	GSF_AIRCRAFT,

    58

	GSF_STATION,

    59

	GSF_CANAL,

    60

	GSF_BRIDGE,

    61

	GSF_TOWNHOUSE,

    62

	GSF_GLOBALVAR,

    63

	GSF_INDUSTRYTILES,

    64

	GSF_INDUSTRIES,

    65

	GSF_CARGOS,

    66

	GSF_SOUNDFX,

    67

} grfspec_feature;

    68

    69

    70

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

    71

    72

static const int _vehcounts[4] = {

    73

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    74

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    75

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    76

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    77

};

    78

    79

static const int _vehshifts[4] = {

    80

	/* GSF_TRAIN */    0,

    81

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    82

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    83

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    84

};

    85

    86

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    87

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    88

    89

/* Debugging messages policy:

    90

 *

    91

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

    92

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

    93

 *

    94

 * 0..2 - dedicated to grfmsg()

    95

 * 3

    96

 * 4

    97

 * 5

    98

 * 6 - action handler entry reporting - one per action

    99

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

   100

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

   101

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

   102

 */

   103

   104

   105

typedef enum grfmsg_severity {

   106

	GMS_NOTICE,

   107

	GMS_WARN,

   108

	GMS_ERROR,

   109

	GMS_FATAL,

   110

} grfmsg_severity;

   111

   112

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

   113

{

   114

	static const char* const severitystr[] = {

   115

		"Notice",

   116

		"Warning",

   117

		"Error",

   118

		"Fatal"

   119

	};

   120

	int export_severity = 0;

   121

	char buf[1024];

   122

	va_list va;

   123

   124

	va_start(va, str);

   125

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

   126

	va_end(va);

   127

   128

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

   129

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

   130

}

   131

   132

   133

#define check_length(real, wanted, where) \

   134

do { \

   135

	if (real < wanted) { \

   136

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

   137

		       where, real, wanted); \

   138

		return; \

   139

	} \

   140

} while (0)

   141

   142

   143

static inline byte grf_load_byte(byte **buf)

   144

{

   145

	return *(*buf)++;

   146

}

   147

   148

static uint16 grf_load_word(byte **buf)

   149

{

   150

	uint16 val;

   151

	byte *p = *buf;

   152

	val = p[0];

   153

	val |= p[1] << 8;

   154

	*buf = p + 2;

   155

	return val;

   156

}

   157

   158

static uint16 grf_load_extended(byte** buf)

   159

{

   160

	uint16 val;

   161

	val = grf_load_byte(buf);

   162

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

   163

	return val;

   164

}

   165

   166

static uint32 grf_load_dword(byte **buf)

   167

{

   168

	uint32 val;

   169

	byte *p = *buf;

   170

	val = p[0];

   171

	val |= p[1] << 8;

   172

	val |= p[2] << 16;

   173

	val |= p[3] << 24;

   174

	*buf = p + 4;

   175

	return val;

   176

}

   177

   178

   179

static GRFFile *GetFileByGRFID(uint32 grfid)

   180

{

   181

	GRFFile *file;

   182

   183

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

   184

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

   185

	}

   186

	return file;

   187

}

   188

   189

static GRFFile *GetFileByFilename(const char *filename)

   190

{

   191

	GRFFile *file;

   192

   193

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

   194

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

   195

	}

   196

	return file;

   197

}

   198

   199

   200

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

   201

   202

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

   203

   204

static void dewagonize(int condition, int engine)

   205

{

   206

	EngineInfo *ei = &_engine_info[engine];

   207

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   208

   209

	if (condition != 0) {

   210

		ei->unk2 &= ~0x80;

   211

		rvi->flags &= ~2;

   212

	} else {

   213

		ei->unk2 |= 0x80;

   214

		rvi->flags |= 2;

   215

	}

   216

}

   217

   218

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

   219

{

   220

	EngineInfo *ei = &_engine_info[engine];

   221

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   222

	byte *buf = *bufp;

   223

	int i;

   224

	bool ret = false;

   225

   226

	switch (prop) {

   227

		case 0x05: /* Track type */

   228

			FOR_EACH_OBJECT {

   229

				uint8 tracktype = grf_load_byte(&buf);

   230

   231

				switch (tracktype) {

   232

					case 0: ei[i].railtype = RAILTYPE_RAIL; break;

   233

					case 1: ei[i].railtype = RAILTYPE_MONO; break;

   234

					case 2: ei[i].railtype = RAILTYPE_MAGLEV; break;

   235

					default:

   236

						grfmsg(GMS_WARN, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring.", tracktype);

   237

						break;

   238

				}

   239

			}

   240

			break;

   241

   242

		case 0x08: /* AI passenger service */

   243

			/* TODO */

   244

			FOR_EACH_OBJECT grf_load_byte(&buf);

   245

			ret = true;

   246

			break;

   247

   248

		case 0x09: /* Speed (1 unit is 1 kmh) */

   249

			FOR_EACH_OBJECT {

   250

				uint16 speed = grf_load_word(&buf);

   251

				if (speed == 0xFFFF) speed = 0;

   252

   253

				rvi[i].max_speed = speed;

   254

			}

   255

			break;

   256

   257

		case 0x0B: /* Power */

   258

			FOR_EACH_OBJECT {

   259

				uint16 power = grf_load_word(&buf);

   260

   261

				if (rvi[i].flags & RVI_MULTIHEAD) power /= 2;

   262

   263

				rvi[i].power = power;

   264

				dewagonize(power, engine + i);

   265

			}

   266

			break;

   267

   268

		case 0x0D: /* Running cost factor */

   269

			FOR_EACH_OBJECT {

   270

				uint8 runcostfact = grf_load_byte(&buf);

   271

   272

				if (rvi[i].flags & RVI_MULTIHEAD) runcostfact /= 2;

   273

   274

				rvi[i].running_cost_base = runcostfact;

   275

			}

   276

			break;

   277

   278

		case 0x0E: /* Running cost base */

   279

			FOR_EACH_OBJECT {

   280

				uint32 base = grf_load_dword(&buf);

   281

   282

				switch (base) {

   283

					case 0x4C30: rvi[i].running_cost_class = 0; break;

   284

					case 0x4C36: rvi[i].running_cost_class = 1; break;

   285

					case 0x4C3C: rvi[i].running_cost_class = 2; break;

   286

				}

   287

			}

   288

			break;

   289

   290

		case 0x12: /* Sprite ID */

   291

			FOR_EACH_OBJECT {

   292

				uint8 spriteid = grf_load_byte(&buf);

   293

   294

				/* TTD sprite IDs point to a location in a 16bit array, but we use it

   295

				 * as an array index, so we need it to be half the original value. */

   296

				if (spriteid < 0xFD) spriteid >>= 1;

   297

   298

				rvi[i].image_index = spriteid;

   299

			}

   300

			break;

   301

   302

		case 0x13: /* Dual-headed */

   303

			FOR_EACH_OBJECT {

   304

				uint8 dual = grf_load_byte(&buf);

   305

   306

				if (dual != 0) {

   307

					if (!(rvi[i].flags & RVI_MULTIHEAD)) {

   308

						// adjust power and running cost if needed

   309

						rvi[i].power /= 2;

   310

						rvi[i].running_cost_base /= 2;

   311

					}

   312

					rvi[i].flags |= RVI_MULTIHEAD;

   313

				} else {

   314

					if (rvi[i].flags & RVI_MULTIHEAD) {

   315

						// adjust power and running cost if needed

   316

						rvi[i].power *= 2;

   317

						rvi[i].running_cost_base *= 2;

   318

					}

   319

					rvi[i].flags &= ~RVI_MULTIHEAD;

   320

				}

   321

			}

   322

			break;

   323

   324

		case 0x14: /* Cargo capacity */

   325

			FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf);

   326

			break;

   327

   328

		case 0x15: /* Cargo type */

   329

			FOR_EACH_OBJECT {

   330

				uint8 ctype = grf_load_byte(&buf);

   331

   332

				if (ctype < NUM_CARGO) {

   333

					rvi[i].cargo_type = ctype;

   334

				} else {

   335

					grfmsg(GMS_NOTICE, "RailVehicleChangeInfo: Invalid cargo type %d, ignoring.", ctype);

   336

				}

   337

			}

   338

			break;

   339

   340

		case 0x16: /* Weight */

   341

			FOR_EACH_OBJECT SB(rvi[i].weight, 0, 8, grf_load_byte(&buf));

   342

			break;

   343

   344

		case 0x17: /* Cost factor */

   345

			FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf);

   346

			break;

   347

   348

		case 0x18: /* AI rank */

   349

			FOR_EACH_OBJECT rvi[i].ai_rank = grf_load_byte(&buf);

   350

			break;

   351

   352

		case 0x19: /* Engine traction type */

   353

			/* What do the individual numbers mean?

   354

			 * 0x00 .. 0x07: Steam

   355

			 * 0x08 .. 0x27: Diesel

   356

			 * 0x28 .. 0x31: Electric

   357

			 * 0x32 .. 0x37: Monorail

   358

			 * 0x38 .. 0x41: Maglev

   359

			 */

   360

			FOR_EACH_OBJECT {

   361

				uint8 traction = grf_load_byte(&buf);

   362

				int engclass;

   363

   364

				if (traction <= 0x07) {

   365

					engclass = 0;

   366

				} else if (traction <= 0x27) {

   367

					engclass = 1;

   368

				} else if (traction <= 0x31) {

   369

					engclass = 2;

   370

					ei[i].railtype = RAILTYPE_ELECTRIC;

   371

				} else if (traction <= 0x41) {

   372

					engclass = 2;

   373

				} else {

   374

					break;

   375

				}

   376

   377

				rvi[i].engclass = engclass;

   378

			}

   379

			break;

   380

   381

		case 0x1A: /* Alter purchase list sort order */

   382

			FOR_EACH_OBJECT {

   383

				EngineID pos = grf_load_byte(&buf);

   384

   385

				if (pos < NUM_TRAIN_ENGINES) {

   386

					AlterRailVehListOrder(engine + i, pos);

   387

				} else {

   388

					grfmsg(GMS_NOTICE, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring.", pos);

   389

				}

   390

			}

   391

			break;

   392

   393

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

   394

			FOR_EACH_OBJECT rvi[i].pow_wag_power = grf_load_word(&buf);

   395

			break;

   396

   397

		case 0x1D: /* Refit cargo */

   398

			FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf);

   399

			break;

   400

   401

		case 0x1E: /* Callback */

   402

			FOR_EACH_OBJECT rvi[i].callbackmask = grf_load_byte(&buf);

   403

			break;

   404

   405

		case 0x21: /* Shorter vehicle */

   406

			FOR_EACH_OBJECT rvi[i].shorten_factor = grf_load_byte(&buf);

   407

			break;

   408

   409

		case 0x22: /* Visual effect */

   410

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

   411

			FOR_EACH_OBJECT rvi[i].visual_effect = grf_load_byte(&buf);

   412

			break;

   413

   414

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

   415

			FOR_EACH_OBJECT rvi[i].pow_wag_weight = grf_load_byte(&buf);

   416

			break;

   417

   418

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

   419

			FOR_EACH_OBJECT {

   420

				byte weight = grf_load_byte(&buf);

   421

   422

				if (weight > 4) {

   423

					grfmsg(GMS_NOTICE, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring.", weight << 8);

   424

				} else {

   425

					SB(rvi[i].weight, 8, 8, weight);

   426

				}

   427

			}

   428

			break;

   429

   430

		case 0x27: /* Miscellaneous flags */

   431

			FOR_EACH_OBJECT ei[i].misc_flags = grf_load_byte(&buf);

   432

			break;

   433

   434

		case 0x28: /* Cargo classes allowed */

   435

			FOR_EACH_OBJECT cargo_allowed[engine + i] = grf_load_word(&buf);

   436

			break;

   437

   438

		case 0x29: /* Cargo classes disallowed */

   439

			FOR_EACH_OBJECT cargo_disallowed[engine + i] = grf_load_word(&buf);

   440

			break;

   441

   442

		/* TODO */

   443

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

   444

		case 0x1C: /* Refit cost */

   445

		case 0x1F: /* Tractive effort */

   446

		case 0x20: /* Air drag */

   447

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

   448

		case 0x26: /* Retire vehicle early */

   449

			/* TODO */

   450

			FOR_EACH_OBJECT grf_load_byte(&buf);

   451

			ret = true;

   452

			break;

   453

   454

		default:

   455

			ret = true;

   456

			break;

   457

	}

   458

	*bufp = buf;

   459

	return ret;

   460

}

   461

   462

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

   463

{

   464

	EngineInfo *ei = &_engine_info[ROAD_ENGINES_INDEX + engine];

   465

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   466

	byte *buf = *bufp;

   467

	int i;

   468

	bool ret = false;

   469

   470

	switch (prop) {

   471

		case 0x08: /* Speed (1 unit is 0.5 kmh) */

   472

			FOR_EACH_OBJECT rvi[i].max_speed = grf_load_byte(&buf);

   473

			break;

   474

   475

		case 0x09: /* Running cost factor */

   476

			FOR_EACH_OBJECT rvi[i].running_cost = grf_load_byte(&buf);

   477

			break;

   478

   479

		case 0x0A: /* Running cost base */

   480

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

   481

			FOR_EACH_OBJECT grf_load_dword(&buf);

   482

			ret = true;

   483

			break;

   484

   485

		case 0x0E: /* Sprite ID */

   486

			FOR_EACH_OBJECT {

   487

				uint8 spriteid = grf_load_byte(&buf);

   488

   489

				// cars have different custom id in the GRF file

   490

				if (spriteid == 0xFF) spriteid = 0xFD;

   491

   492

				if (spriteid < 0xFD) spriteid >>= 1;

   493

   494

				rvi[i].image_index = spriteid;

   495

			}

   496

			break;

   497

   498

		case 0x0F: /* Cargo capacity */

   499

			FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf);

   500

			break;

   501