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 = 0;

    46

    47

static GRFFile *_cur_grffile;

    48

GRFFile *_first_grffile;

    49

GRFConfig *_first_grfconfig;

    50

static SpriteID _cur_spriteid;

    51

static int _cur_stage;

    52

static uint32 _nfo_line;

    53

    54

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

    55

static byte _misc_grf_features = 0;

    56

    57

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

    58

static uint32 _ttdpatch_flags[8];

    59

    60

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

    61

static byte *_preload_sprite = NULL;

    62

    63

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

    64

bool _have_2cc = false;

    65

    66

    67

typedef enum GrfLoadingStage {

    68

	GLS_LABELSCAN,

    69

	GLS_INIT,

    70

	GLS_ACTIVATION,

    71

	GLS_END,

    72

} GrfLoadingStage;

    73

    74

    75

typedef enum GrfDataType {

    76

	GDT_SOUND,

    77

} GrfDataType;

    78

    79

static byte _grf_data_blocks;

    80

static GrfDataType _grf_data_type;

    81

    82

    83

typedef enum grfspec_feature {

    84

	GSF_TRAIN,

    85

	GSF_ROAD,

    86

	GSF_SHIP,

    87

	GSF_AIRCRAFT,

    88

	GSF_STATION,

    89

	GSF_CANAL,

    90

	GSF_BRIDGE,

    91

	GSF_TOWNHOUSE,

    92

	GSF_GLOBALVAR,

    93

	GSF_INDUSTRYTILES,

    94

	GSF_INDUSTRIES,

    95

	GSF_CARGOS,

    96

	GSF_SOUNDFX,

    97

} grfspec_feature;

    98

    99

   100

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

   101

   102

static const int _vehcounts[4] = {

   103

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   104

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   105

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   106

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   107

};

   108

   109

static const int _vehshifts[4] = {

   110

	/* GSF_TRAIN */    0,

   111

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   112

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   113

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   114

};

   115

   116

enum {

   117

	MAX_STATIONS = 256,

   118

};

   119

   120

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   121

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   122

   123

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

   124

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   125

   126

/* Debugging messages policy:

   127

 *

   128

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

   129

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

   130

 *

   131

 * 0..2 - dedicated to grfmsg()

   132

 * 3

   133

 * 4

   134

 * 5

   135

 * 6 - action handler entry reporting - one per action

   136

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

   137

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

   138

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

   139

 */

   140

   141

   142

typedef enum grfmsg_severity {

   143

	GMS_NOTICE,

   144

	GMS_WARN,

   145

	GMS_ERROR,

   146

	GMS_FATAL,

   147

} grfmsg_severity;

   148

   149

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

   150

{

   151

	static const char* const severitystr[] = {

   152

		"Notice",

   153

		"Warning",

   154

		"Error",

   155

		"Fatal"

   156

	};

   157

	int export_severity = 0;

   158

	char buf[1024];

   159

	va_list va;

   160

   161

	va_start(va, str);

   162

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

   163

	va_end(va);

   164

   165

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

   166

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

   167

}

   168

   169

   170

#define check_length(real, wanted, where) \

   171

do { \

   172

	if (real < wanted) { \

   173

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

   174

		       where, real, wanted); \

   175

		return; \

   176

	} \

   177

} while (0)

   178

   179

   180

static inline byte grf_load_byte(byte **buf)

   181

{

   182

	return *(*buf)++;

   183

}

   184

   185

static uint16 grf_load_word(byte **buf)

   186

{

   187

	uint16 val = grf_load_byte(buf);

   188

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

   189

}

   190

   191

static uint16 grf_load_extended(byte** buf)

   192

{

   193

	uint16 val;

   194

	val = grf_load_byte(buf);

   195

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

   196

	return val;

   197

}

   198

   199

static uint32 grf_load_dword(byte **buf)

   200

{

   201

	uint32 val = grf_load_word(buf);

   202

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

   203

}

   204

   205

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

   206

{

   207

	switch (size) {

   208

		case 1: return grf_load_byte(buf);

   209

		case 2: return grf_load_word(buf);

   210

		case 4: return grf_load_dword(buf);

   211

		default:

   212

			NOT_REACHED();

   213

			return 0;

   214

	}

   215

}

   216

   217

static GRFFile *GetFileByGRFID(uint32 grfid)

   218

{

   219

	GRFFile *file;

   220

   221

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

   222

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

   223

	}

   224

	return file;

   225

}

   226

   227

static GRFFile *GetFileByFilename(const char *filename)

   228

{

   229

	GRFFile *file;

   230

   231

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

   232

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

   233

	}

   234

	return file;

   235

}

   236

   237

   238

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

   239

   240

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

   241

   242

static void dewagonize(int condition, int engine)

   243

{

   244

	EngineInfo *ei = &_engine_info[engine];

   245

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   246

   247

	if (condition != 0) {

   248

		ei->unk2 &= ~0x80;

   249

		rvi->flags &= ~2;

   250

	} else {

   251

		ei->unk2 |= 0x80;

   252

		rvi->flags |= 2;

   253

	}

   254

}

   255

   256

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

   257

{

   258

	EngineInfo *ei = &_engine_info[engine];

   259

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   260

	byte *buf = *bufp;

   261

	int i;

   262

	bool ret = false;

   263

   264

	switch (prop) {

   265

		case 0x05: /* Track type */

   266

			FOR_EACH_OBJECT {

   267

				uint8 tracktype = grf_load_byte(&buf);

   268

   269

				switch (tracktype) {

   270

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

   271

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

   272

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

   273

					default:

   274

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

   275

						break;

   276

				}

   277

			}

   278

			break;

   279

   280

		case 0x08: /* AI passenger service */

   281

			/* TODO */

   282

			FOR_EACH_OBJECT grf_load_byte(&buf);

   283

			ret = true;

   284

			break;

   285

   286

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

   287

			FOR_EACH_OBJECT {

   288

				uint16 speed = grf_load_word(&buf);

   289

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

   290

   291

				rvi[i].max_speed = speed;

   292

			}

   293

			break;

   294

   295

		case 0x0B: /* Power */

   296

			FOR_EACH_OBJECT {

   297

				uint16 power = grf_load_word(&buf);

   298

   299

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

   300

   301

				rvi[i].power = power;

   302

				dewagonize(power, engine + i);

   303

			}

   304

			break;

   305

   306

		case 0x0D: /* Running cost factor */

   307

			FOR_EACH_OBJECT {

   308

				uint8 runcostfact = grf_load_byte(&buf);

   309

   310

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

   311

   312

				rvi[i].running_cost_base = runcostfact;

   313

			}

   314

			break;

   315

   316

		case 0x0E: /* Running cost base */

   317

			FOR_EACH_OBJECT {

   318

				uint32 base = grf_load_dword(&buf);

   319

   320

				switch (base) {

   321

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

   322

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

   323

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

   324

				}

   325

			}

   326

			break;

   327

   328

		case 0x12: /* Sprite ID */

   329

			FOR_EACH_OBJECT {

   330

				uint8 spriteid = grf_load_byte(&buf);

   331

   332

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

   333

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

   334

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

   335

   336

				rvi[i].image_index = spriteid;

   337

			}

   338

			break;

   339

   340

		case 0x13: /* Dual-headed */

   341

			FOR_EACH_OBJECT {

   342

				uint8 dual = grf_load_byte(&buf);

   343

   344

				if (dual != 0) {

   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

				} else {

   352

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

   353

						// adjust power and running cost if needed

   354

						rvi[i].power *= 2;

   355

						rvi[i].running_cost_base *= 2;

   356

					}

   357

					rvi[i].flags &= ~RVI_MULTIHEAD;

   358

				}

   359

			}

   360

			break;

   361

   362

		case 0x14: /* Cargo capacity */

   363

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

   364

			break;

   365

   366

		case 0x15: /* Cargo type */

   367

			FOR_EACH_OBJECT {

   368

				uint8 ctype = grf_load_byte(&buf);

   369

   370

				if (ctype < NUM_CARGO) {

   371

					rvi[i].cargo_type = ctype;

   372

				} else {

   373

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

   374

				}

   375

			}

   376

			break;

   377

   378

		case 0x16: /* Weight */

   379

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

   380

			break;

   381

   382

		case 0x17: /* Cost factor */

   383

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

   384

			break;

   385

   386

		case 0x18: /* AI rank */

   387

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

   388

			break;

   389

   390

		case 0x19: /* Engine traction type */

   391

			/* What do the individual numbers mean?

   392

			 * 0x00 .. 0x07: Steam

   393

			 * 0x08 .. 0x27: Diesel

   394

			 * 0x28 .. 0x31: Electric

   395

			 * 0x32 .. 0x37: Monorail

   396

			 * 0x38 .. 0x41: Maglev

   397

			 */

   398

			FOR_EACH_OBJECT {

   399

				uint8 traction = grf_load_byte(&buf);

   400

				int engclass;

   401

   402

				if (traction <= 0x07) {

   403

					engclass = 0;

   404

				} else if (traction <= 0x27) {

   405

					engclass = 1;

   406

				} else if (traction <= 0x31) {

   407

					engclass = 2;

   408

				} else if (traction <= 0x41) {

   409

					engclass = 2;

   410

				} else {

   411

					break;

   412

				}

   413

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

   414

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

   415

   416

				rvi[i].engclass = engclass;

   417

			}

   418

			break;

   419

   420

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

   421

			FOR_EACH_OBJECT {

   422

				EngineID pos = grf_load_byte(&buf);

   423

   424

				if (pos < NUM_TRAIN_ENGINES) {

   425

					AlterRailVehListOrder(engine + i, pos);

   426

				} else {

   427

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

   428

				}

   429

			}

   430

			break;

   431

   432

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

   433

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

   434

			break;

   435

   436

		case 0x1C: /* Refit cost */

   437

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

   438

			break;

   439

   440

		case 0x1D: /* Refit cargo */

   441

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

   442

			break;

   443

   444

		case 0x1E: /* Callback */

   445

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

   446

			break;

   447

   448

		case 0x21: /* Shorter vehicle */

   449

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

   450

			break;

   451

   452

		case 0x22: /* Visual effect */

   453

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

   454

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

   455

			break;

   456

   457

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

   458

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

   459

			break;

   460

   461

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

   462

			FOR_EACH_OBJECT {

   463

				byte weight = grf_load_byte(&buf);

   464

   465

				if (weight > 4) {

   466

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

   467

				} else {

   468

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

   469

				}

   470

			}

   471

			break;

   472

   473

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

   474

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

   475

			break;

   476

   477

		case 0x27: /* Miscellaneous flags */

   478

			FOR_EACH_OBJECT {

   479

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

   480

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

   481

			}

   482

			break;

   483

   484

		case 0x28: /* Cargo classes allowed */

   485

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

   486

			break;

   487

   488

		case 0x29: /* Cargo classes disallowed */

   489

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

   490