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 "date.h"

    27

#include "currency.h"

    28

#include "sound.h"

    29

#include "newgrf_sound.h"

    30

#include "newgrf_spritegroup.h"

    31

    32

/* TTDPatch extended GRF format codec

    33

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

    34

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

    35

 *

    36

 * Contains portions of documentation by TTDPatch team.

    37

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

    38

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

    39

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

    40

    41

    42

static int _skip_sprites; // XXX

    43

static uint _file_index; // XXX

    44

SpriteID _signal_base = 0;

    45

    46

static GRFFile *_cur_grffile;

    47

GRFFile *_first_grffile;

    48

GRFConfig *_first_grfconfig;

    49

static SpriteID _cur_spriteid;

    50

static int _cur_stage;

    51

static uint32 _nfo_line;

    52

    53

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

    54

static byte _misc_grf_features = 0;

    55

    56

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

    57

static uint32 _ttdpatch_flags[8];

    58

    59

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

    60

static byte *_preload_sprite = NULL;

    61

    62

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

    63

bool _have_2cc = false;

    64

    65

    66

typedef enum GrfDataType {

    67

	GDT_SOUND,

    68

} GrfDataType;

    69

    70

static byte _grf_data_blocks;

    71

static GrfDataType _grf_data_type;

    72

    73

    74

typedef enum grfspec_feature {

    75

	GSF_TRAIN,

    76

	GSF_ROAD,

    77

	GSF_SHIP,

    78

	GSF_AIRCRAFT,

    79

	GSF_STATION,

    80

	GSF_CANAL,

    81

	GSF_BRIDGE,

    82

	GSF_TOWNHOUSE,

    83

	GSF_GLOBALVAR,

    84

	GSF_INDUSTRYTILES,

    85

	GSF_INDUSTRIES,

    86

	GSF_CARGOS,

    87

	GSF_SOUNDFX,

    88

} grfspec_feature;

    89

    90

    91

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

    92

    93

static const int _vehcounts[4] = {

    94

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    95

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    96

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    97

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    98

};

    99

   100

static const int _vehshifts[4] = {

   101

	/* GSF_TRAIN */    0,

   102

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   103

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   104

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   105

};

   106

   107

enum {

   108

	MAX_STATIONS = 256,

   109

};

   110

   111

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   112

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   113

   114

/* Debugging messages policy:

   115

 *

   116

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

   117

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

   118

 *

   119

 * 0..2 - dedicated to grfmsg()

   120

 * 3

   121

 * 4

   122

 * 5

   123

 * 6 - action handler entry reporting - one per action

   124

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

   125

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

   126

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

   127

 */

   128

   129

   130

typedef enum grfmsg_severity {

   131

	GMS_NOTICE,

   132

	GMS_WARN,

   133

	GMS_ERROR,

   134

	GMS_FATAL,

   135

} grfmsg_severity;

   136

   137

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

   138

{

   139

	static const char* const severitystr[] = {

   140

		"Notice",

   141

		"Warning",

   142

		"Error",

   143

		"Fatal"

   144

	};

   145

	int export_severity = 0;

   146

	char buf[1024];

   147

	va_list va;

   148

   149

	va_start(va, str);

   150

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

   151

	va_end(va);

   152

   153

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

   154

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

   155

}

   156

   157

   158

#define check_length(real, wanted, where) \

   159

do { \

   160

	if (real < wanted) { \

   161

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

   162

		       where, real, wanted); \

   163

		return; \

   164

	} \

   165

} while (0)

   166

   167

   168

static inline byte grf_load_byte(byte **buf)

   169

{

   170

	return *(*buf)++;

   171

}

   172

   173

static uint16 grf_load_word(byte **buf)

   174

{

   175

	uint16 val = grf_load_byte(buf);

   176

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

   177

}

   178

   179

static uint16 grf_load_extended(byte** buf)

   180

{

   181

	uint16 val;

   182

	val = grf_load_byte(buf);

   183

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

   184

	return val;

   185

}

   186

   187

static uint32 grf_load_dword(byte **buf)

   188

{

   189

	uint32 val = grf_load_word(buf);

   190

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

   191

}

   192

   193

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

   194

{

   195

	switch (size) {

   196

		case 1: return grf_load_byte(buf);

   197

		case 2: return grf_load_word(buf);

   198

		case 4: return grf_load_dword(buf);

   199

		default:

   200

			NOT_REACHED();

   201

			return 0;

   202

	}

   203

}

   204

   205

static GRFFile *GetFileByGRFID(uint32 grfid)

   206

{

   207

	GRFFile *file;

   208

   209

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

   210

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

   211

	}

   212

	return file;

   213

}

   214

   215

static GRFFile *GetFileByFilename(const char *filename)

   216

{

   217

	GRFFile *file;

   218

   219

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

   220

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

   221

	}

   222

	return file;

   223

}

   224

   225

   226

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

   227

   228

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

   229

   230

static void dewagonize(int condition, int engine)

   231

{

   232

	EngineInfo *ei = &_engine_info[engine];

   233

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   234

   235

	if (condition != 0) {

   236

		ei->unk2 &= ~0x80;

   237

		rvi->flags &= ~2;

   238

	} else {

   239

		ei->unk2 |= 0x80;

   240

		rvi->flags |= 2;

   241

	}

   242

}

   243

   244

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

   245

{

   246

	EngineInfo *ei = &_engine_info[engine];

   247

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   248

	byte *buf = *bufp;

   249

	int i;

   250

	bool ret = false;

   251

   252

	switch (prop) {

   253

		case 0x05: /* Track type */

   254

			FOR_EACH_OBJECT {

   255

				uint8 tracktype = grf_load_byte(&buf);

   256

   257

				switch (tracktype) {

   258

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

   259

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

   260

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

   261

					default:

   262

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

   263

						break;

   264

				}

   265

			}

   266

			break;

   267

   268

		case 0x08: /* AI passenger service */

   269

			/* TODO */

   270

			FOR_EACH_OBJECT grf_load_byte(&buf);

   271

			ret = true;

   272

			break;

   273

   274

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

   275

			FOR_EACH_OBJECT {

   276

				uint16 speed = grf_load_word(&buf);

   277

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

   278

   279

				rvi[i].max_speed = speed;

   280

			}

   281

			break;

   282

   283

		case 0x0B: /* Power */

   284

			FOR_EACH_OBJECT {

   285

				uint16 power = grf_load_word(&buf);

   286

   287

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

   288

   289

				rvi[i].power = power;

   290

				dewagonize(power, engine + i);

   291

			}

   292

			break;

   293

   294

		case 0x0D: /* Running cost factor */

   295

			FOR_EACH_OBJECT {

   296

				uint8 runcostfact = grf_load_byte(&buf);

   297

   298

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

   299

   300

				rvi[i].running_cost_base = runcostfact;

   301

			}

   302

			break;

   303

   304

		case 0x0E: /* Running cost base */

   305

			FOR_EACH_OBJECT {

   306

				uint32 base = grf_load_dword(&buf);

   307

   308

				switch (base) {

   309

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

   310

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

   311

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

   312

				}

   313

			}

   314

			break;

   315

   316

		case 0x12: /* Sprite ID */

   317

			FOR_EACH_OBJECT {

   318

				uint8 spriteid = grf_load_byte(&buf);

   319

   320

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

   321

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

   322

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

   323

   324

				rvi[i].image_index = spriteid;

   325

			}

   326

			break;

   327

   328

		case 0x13: /* Dual-headed */

   329

			FOR_EACH_OBJECT {

   330

				uint8 dual = grf_load_byte(&buf);

   331

   332

				if (dual != 0) {

   333

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

   334

						// adjust power and running cost if needed

   335

						rvi[i].power /= 2;

   336

						rvi[i].running_cost_base /= 2;

   337

					}

   338

					rvi[i].flags |= RVI_MULTIHEAD;

   339

				} else {

   340

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

   341

						// adjust power and running cost if needed

   342

						rvi[i].power *= 2;

   343

						rvi[i].running_cost_base *= 2;

   344

					}

   345

					rvi[i].flags &= ~RVI_MULTIHEAD;

   346

				}

   347

			}

   348

			break;

   349

   350

		case 0x14: /* Cargo capacity */

   351

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

   352

			break;

   353

   354

		case 0x15: /* Cargo type */

   355

			FOR_EACH_OBJECT {

   356

				uint8 ctype = grf_load_byte(&buf);

   357

   358

				if (ctype < NUM_CARGO) {

   359

					rvi[i].cargo_type = ctype;

   360

				} else {

   361

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

   362

				}

   363

			}

   364

			break;

   365

   366

		case 0x16: /* Weight */

   367

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

   368

			break;

   369

   370

		case 0x17: /* Cost factor */

   371

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

   372

			break;

   373

   374

		case 0x18: /* AI rank */

   375

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

   376

			break;

   377

   378

		case 0x19: /* Engine traction type */

   379

			/* What do the individual numbers mean?

   380

			 * 0x00 .. 0x07: Steam

   381

			 * 0x08 .. 0x27: Diesel

   382

			 * 0x28 .. 0x31: Electric

   383

			 * 0x32 .. 0x37: Monorail

   384

			 * 0x38 .. 0x41: Maglev

   385

			 */

   386

			FOR_EACH_OBJECT {

   387

				uint8 traction = grf_load_byte(&buf);

   388

				int engclass;

   389

   390

				if (traction <= 0x07) {

   391

					engclass = 0;

   392

				} else if (traction <= 0x27) {

   393

					engclass = 1;

   394

				} else if (traction <= 0x31) {

   395

					engclass = 2;

   396

					ei[i].railtype = RAILTYPE_ELECTRIC;

   397

				} else if (traction <= 0x41) {

   398

					engclass = 2;

   399

				} else {

   400

					break;

   401

				}

   402

   403

				rvi[i].engclass = engclass;

   404

			}

   405

			break;

   406

   407

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

   408

			FOR_EACH_OBJECT {

   409

				EngineID pos = grf_load_byte(&buf);

   410

   411

				if (pos < NUM_TRAIN_ENGINES) {

   412

					AlterRailVehListOrder(engine + i, pos);

   413

				} else {

   414

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

   415

				}

   416

			}

   417

			break;

   418

   419

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

   420

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

   421

			break;

   422

   423

		case 0x1C: /* Refit cost */

   424

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

   425

			break;

   426

   427

		case 0x1D: /* Refit cargo */

   428

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

   429

			break;

   430

   431

		case 0x1E: /* Callback */

   432

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

   433

			break;

   434

   435

		case 0x21: /* Shorter vehicle */

   436

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

   437

			break;

   438

   439

		case 0x22: /* Visual effect */

   440

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

   441

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

   442

			break;

   443

   444

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

   445

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

   446

			break;

   447

   448

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

   449

			FOR_EACH_OBJECT {

   450

				byte weight = grf_load_byte(&buf);

   451

   452

				if (weight > 4) {

   453

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

   454

				} else {

   455

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

   456

				}

   457

			}

   458

			break;

   459

   460

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

   461

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

   462

			break;

   463

   464

		case 0x27: /* Miscellaneous flags */

   465

			FOR_EACH_OBJECT {

   466

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

   467

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

   468

			}

   469

			break;

   470

   471

		case 0x28: /* Cargo classes allowed */

   472

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

   473

			break;

   474

   475

		case 0x29: /* Cargo classes disallowed */

   476

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

   477

			break;

   478

   479

		/* TODO */

   480

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

   481

		case 0x1F: /* Tractive effort */

   482

		case 0x20: /* Air drag */

   483

		case 0x26: /* Retire vehicle early */

   484

			/* TODO */

   485

			FOR_EACH_OBJECT grf_load_byte(&buf);

   486

			ret = true;

   487

			break;

   488

   489

		default:

   490

			ret = true;