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 "table/strings.h"

    20

#include "bridge.h"

    21

#include "economy.h"

    22

#include "newgrf_engine.h"

    23

#include "vehicle.h"

    24

#include "newgrf_text.h"

    25

#include "table/sprites.h"

    26

#include "fontcache.h"

    27

#include "date.h"

    28

#include "currency.h"

    29

#include "sound.h"

    30

#include "newgrf_sound.h"

    31

#include "newgrf_spritegroup.h"

    32

    33

/* TTDPatch extended GRF format codec

    34

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

    35

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

    36

 *

    37

 * Contains portions of documentation by TTDPatch team.

    38

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

    39

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

    40

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

    41

    42

    43

static int _skip_sprites; // XXX

    44

static uint _file_index; // XXX

    45

SpriteID _signal_base;

    46

SpriteID _coast_base;

    47

    48

static GRFFile *_cur_grffile;

    49

GRFFile *_first_grffile;

    50

GRFConfig *_first_grfconfig;

    51

static SpriteID _cur_spriteid;

    52

static GrfLoadingStage _cur_stage;

    53

static uint32 _nfo_line;

    54

    55

/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */

    56

static byte _misc_grf_features = 0;

    57

    58

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

    59

static uint32 _ttdpatch_flags[8];

    60

    61

/* Used by Action 0x06 to preload a pseudo sprite and modify its content */

    62

static byte *_preload_sprite = NULL;

    63

    64

/* Set if any vehicle is loaded which uses 2cc (two company colours) */

    65

bool _have_2cc = false;

    66

    67

    68

typedef enum GrfDataType {

    69

	GDT_SOUND,

    70

} GrfDataType;

    71

    72

static byte _grf_data_blocks;

    73

static GrfDataType _grf_data_type;

    74

    75

    76

typedef enum grfspec_feature {

    77

	GSF_TRAIN,

    78

	GSF_ROAD,

    79

	GSF_SHIP,

    80

	GSF_AIRCRAFT,

    81

	GSF_STATION,

    82

	GSF_CANAL,

    83

	GSF_BRIDGE,

    84

	GSF_TOWNHOUSE,

    85

	GSF_GLOBALVAR,

    86

	GSF_INDUSTRYTILES,

    87

	GSF_INDUSTRIES,

    88

	GSF_CARGOS,

    89

	GSF_SOUNDFX,

    90

} grfspec_feature;

    91

    92

    93

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

    94

    95

static const int _vehcounts[4] = {

    96

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    97

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    98

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    99

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   100

};

   101

   102

static const int _vehshifts[4] = {

   103

	/* GSF_TRAIN */    0,

   104

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   105

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   106

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   107

};

   108

   109

enum {

   110

	MAX_STATIONS = 256,

   111

};

   112

   113

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   114

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   115

   116

/* Contains the GRF ID of the owner of a vehicle if it has been reserved */

   117

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   118

   119

/* Debugging messages policy:

   120

 *

   121

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

   122

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

   123

 *

   124

 * 0..2 - dedicated to grfmsg()

   125

 * 3

   126

 * 4

   127

 * 5

   128

 * 6 - action handler entry reporting - one per action

   129

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

   130

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

   131

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

   132

 */

   133

   134

   135

typedef enum grfmsg_severity {

   136

	GMS_NOTICE,

   137

	GMS_WARN,

   138

	GMS_ERROR,

   139

	GMS_FATAL,

   140

} grfmsg_severity;

   141

   142

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

   143

{

   144

	static const char* const severitystr[] = {

   145

		"Notice",

   146

		"Warning",

   147

		"Error",

   148

		"Fatal"

   149

	};

   150

	int export_severity = 0;

   151

	char buf[1024];

   152

	va_list va;

   153

   154

	va_start(va, str);

   155

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

   156

	va_end(va);

   157

   158

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

   159

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

   160

}

   161

   162

   163

#define check_length(real, wanted, where) \

   164

do { \

   165

	if (real < wanted) { \

   166

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

   167

		       where, real, wanted); \

   168

		return; \

   169

	} \

   170

} while (0)

   171

   172

   173

static inline byte grf_load_byte(byte **buf)

   174

{

   175

	return *(*buf)++;

   176

}

   177

   178

static uint16 grf_load_word(byte **buf)

   179

{

   180

	uint16 val = grf_load_byte(buf);

   181

	return val | (grf_load_byte(buf) << 8);

   182

}

   183

   184

static uint16 grf_load_extended(byte** buf)

   185

{

   186

	uint16 val;

   187

	val = grf_load_byte(buf);

   188

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

   189

	return val;

   190

}

   191

   192

static uint32 grf_load_dword(byte **buf)

   193

{

   194

	uint32 val = grf_load_word(buf);

   195

	return val | (grf_load_word(buf) << 16);

   196

}

   197

   198

static uint32 grf_load_var(byte size, byte **buf)

   199

{

   200

	switch (size) {

   201

		case 1: return grf_load_byte(buf);

   202

		case 2: return grf_load_word(buf);

   203

		case 4: return grf_load_dword(buf);

   204

		default:

   205

			NOT_REACHED();

   206

			return 0;

   207

	}

   208

}

   209

   210

static GRFFile *GetFileByGRFID(uint32 grfid)

   211

{

   212

	GRFFile *file;

   213

   214

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

   215

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

   216

	}

   217

	return file;

   218

}

   219

   220

static GRFFile *GetFileByFilename(const char *filename)

   221

{

   222

	GRFFile *file;

   223

   224

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

   225

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

   226

	}

   227

	return file;

   228

}

   229

   230

   231

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

   232

   233

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

   234

   235

static void dewagonize(int condition, int engine)

   236

{

   237

	EngineInfo *ei = &_engine_info[engine];

   238

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   239

   240

	if (condition != 0) {

   241

		ei->unk2 &= ~0x80;

   242

		rvi->flags &= ~2;

   243

	} else {

   244

		ei->unk2 |= 0x80;

   245

		rvi->flags |= 2;

   246

	}

   247

}

   248

   249

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

   250

{

   251

	EngineInfo *ei = &_engine_info[engine];

   252

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   253

	byte *buf = *bufp;

   254

	int i;

   255

	bool ret = false;

   256

   257

	switch (prop) {

   258

		case 0x05: /* Track type */

   259

			FOR_EACH_OBJECT {

   260

				uint8 tracktype = grf_load_byte(&buf);

   261

   262

				switch (tracktype) {

   263

					case 0: ei[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   264

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

   265

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

   266

					default:

   267

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

   268

						break;

   269

				}

   270

			}

   271

			break;

   272

   273

		case 0x08: /* AI passenger service */

   274

			/* TODO */

   275

			FOR_EACH_OBJECT grf_load_byte(&buf);

   276

			ret = true;

   277

			break;

   278

   279

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

   280

			FOR_EACH_OBJECT {

   281

				uint16 speed = grf_load_word(&buf);

   282

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

   283

   284

				rvi[i].max_speed = speed;

   285

			}

   286

			break;

   287

   288

		case 0x0B: /* Power */

   289

			FOR_EACH_OBJECT {

   290

				uint16 power = grf_load_word(&buf);

   291

   292

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

   293

   294

				rvi[i].power = power;

   295

				dewagonize(power, engine + i);

   296

			}

   297

			break;

   298

   299

		case 0x0D: /* Running cost factor */

   300

			FOR_EACH_OBJECT {

   301

				uint8 runcostfact = grf_load_byte(&buf);

   302

   303

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

   304

   305

				rvi[i].running_cost_base = runcostfact;

   306

			}

   307

			break;

   308

   309

		case 0x0E: /* Running cost base */

   310

			FOR_EACH_OBJECT {

   311

				uint32 base = grf_load_dword(&buf);

   312

   313

				switch (base) {

   314

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

   315

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

   316

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

   317

				}

   318

			}

   319

			break;

   320

   321

		case 0x12: /* Sprite ID */

   322

			FOR_EACH_OBJECT {

   323

				uint8 spriteid = grf_load_byte(&buf);

   324

   325

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

   326

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

   327

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

   328

   329

				rvi[i].image_index = spriteid;

   330

			}

   331

			break;

   332

   333

		case 0x13: /* Dual-headed */

   334

			FOR_EACH_OBJECT {

   335

				uint8 dual = grf_load_byte(&buf);

   336

   337

				if (dual != 0) {

   338

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

   339

						// adjust power and running cost if needed

   340

						rvi[i].power /= 2;

   341

						rvi[i].running_cost_base /= 2;

   342

					}

   343

					rvi[i].flags |= RVI_MULTIHEAD;

   344

				} else {

   345

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

   346

						// adjust power and running cost if needed

   347

						rvi[i].power *= 2;

   348

						rvi[i].running_cost_base *= 2;

   349

					}

   350

					rvi[i].flags &= ~RVI_MULTIHEAD;

   351

				}

   352

			}

   353

			break;

   354

   355

		case 0x14: /* Cargo capacity */

   356

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

   357

			break;

   358

   359

		case 0x15: /* Cargo type */

   360

			FOR_EACH_OBJECT {

   361

				uint8 ctype = grf_load_byte(&buf);

   362

   363

				if (ctype < NUM_CARGO) {

   364

					rvi[i].cargo_type = ctype;

   365

				} else {

   366

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

   367

				}

   368

			}

   369

			break;

   370

   371

		case 0x16: /* Weight */

   372

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

   373

			break;

   374

   375

		case 0x17: /* Cost factor */

   376

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

   377

			break;

   378

   379

		case 0x18: /* AI rank */

   380

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

   381

			break;

   382

   383

		case 0x19: /* Engine traction type */

   384

			/* What do the individual numbers mean?

   385

			 * 0x00 .. 0x07: Steam

   386

			 * 0x08 .. 0x27: Diesel

   387

			 * 0x28 .. 0x31: Electric

   388

			 * 0x32 .. 0x37: Monorail

   389

			 * 0x38 .. 0x41: Maglev

   390

			 */

   391

			FOR_EACH_OBJECT {

   392

				uint8 traction = grf_load_byte(&buf);

   393

				int engclass;

   394

   395

				if (traction <= 0x07) {

   396

					engclass = 0;

   397

				} else if (traction <= 0x27) {

   398

					engclass = 1;

   399

				} else if (traction <= 0x31) {

   400

					engclass = 2;

   401

				} else if (traction <= 0x41) {

   402

					engclass = 2;

   403

				} else {

   404

					break;

   405

				}

   406

				if (ei[i].railtype == RAILTYPE_RAIL     && engclass == 2) ei[i].railtype = RAILTYPE_ELECTRIC;

   407

				if (ei[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) ei[i].railtype = RAILTYPE_RAIL;

   408

   409

				rvi[i].engclass = engclass;

   410

			}

   411

			break;

   412

   413

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

   414

			FOR_EACH_OBJECT {

   415

				EngineID pos = grf_load_byte(&buf);

   416

   417

				if (pos < NUM_TRAIN_ENGINES) {

   418

					AlterRailVehListOrder(engine + i, pos);

   419

				} else {

   420

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

   421

				}

   422

			}

   423

			break;

   424

   425

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

   426

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

   427

			break;

   428

   429

		case 0x1C: /* Refit cost */

   430

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

   431

			break;

   432

   433

		case 0x1D: /* Refit cargo */

   434

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

   435

			break;

   436

   437

		case 0x1E: /* Callback */

   438

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

   439

			break;

   440

   441

		case 0x21: /* Shorter vehicle */

   442

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

   443

			break;

   444

   445

		case 0x22: /* Visual effect */

   446

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

   447

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

   448

			break;

   449

   450

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

   451

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

   452

			break;

   453

   454

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

   455

			FOR_EACH_OBJECT {

   456

				byte weight = grf_load_byte(&buf);

   457

   458

				if (weight > 4) {

   459

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

   460

				} else {

   461

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

   462

				}

   463

			}

   464

			break;

   465

   466

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

   467

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

   468

			break;

   469

   470

		case 0x27: /* Miscellaneous flags */

   471

			FOR_EACH_OBJECT {

   472

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

   473

				if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true;

   474

			}

   475

			break;

   476

   477

		case 0x28: /* Cargo classes allowed */

   478

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

   479

			break;

   480

   481

		case 0x29: /* Cargo classes disallowed */

   482

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

   483

			break;

   484

   485

		case 0x2A: /* Long format introduction date (days since year 0) */

   486

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

   487

			break;

   488

   489

		/* TODO */

   490

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

   491

		case 0x1F: /* Tractive effort */

   492

		case 0x20: /* Air drag */

   493

		case 0x26: /* Retire vehicle early */

   494

			/* TODO */

   495

			FOR_EACH_OBJECT grf_load_byte(&buf);

   496

			ret = true;