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

    63

typedef enum GrfDataType {

    64

	GDT_SOUND,

    65

} GrfDataType;

    66

    67

static byte _grf_data_blocks;

    68

static GrfDataType _grf_data_type;

    69

    70

    71

typedef enum grfspec_feature {

    72

	GSF_TRAIN,

    73

	GSF_ROAD,

    74

	GSF_SHIP,

    75

	GSF_AIRCRAFT,

    76

	GSF_STATION,

    77

	GSF_CANAL,

    78

	GSF_BRIDGE,

    79

	GSF_TOWNHOUSE,

    80

	GSF_GLOBALVAR,

    81

	GSF_INDUSTRYTILES,

    82

	GSF_INDUSTRIES,

    83

	GSF_CARGOS,

    84

	GSF_SOUNDFX,

    85

} grfspec_feature;

    86

    87

    88

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

    89

    90

static const int _vehcounts[4] = {

    91

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    92

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    93

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    94

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    95

};

    96

    97

static const int _vehshifts[4] = {

    98

	/* GSF_TRAIN */    0,

    99

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   100

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   101

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   102

};

   103

   104

enum {

   105

	MAX_STATIONS = 256,

   106

};

   107

   108

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   109

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   110

   111

/* Debugging messages policy:

   112

 *

   113

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

   114

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

   115

 *

   116

 * 0..2 - dedicated to grfmsg()

   117

 * 3

   118

 * 4

   119

 * 5

   120

 * 6 - action handler entry reporting - one per action

   121

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

   122

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

   123

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

   124

 */

   125

   126

   127

typedef enum grfmsg_severity {

   128

	GMS_NOTICE,

   129

	GMS_WARN,

   130

	GMS_ERROR,

   131

	GMS_FATAL,

   132

} grfmsg_severity;

   133

   134

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

   135

{

   136

	static const char* const severitystr[] = {

   137

		"Notice",

   138

		"Warning",

   139

		"Error",

   140

		"Fatal"

   141

	};

   142

	int export_severity = 0;

   143

	char buf[1024];

   144

	va_list va;

   145

   146

	va_start(va, str);

   147

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

   148

	va_end(va);

   149

   150

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

   151

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

   152

}

   153

   154

   155

#define check_length(real, wanted, where) \

   156

do { \

   157

	if (real < wanted) { \

   158

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

   159

		       where, real, wanted); \

   160

		return; \

   161

	} \

   162

} while (0)

   163

   164

   165

static inline byte grf_load_byte(byte **buf)

   166

{

   167

	return *(*buf)++;

   168

}

   169

   170

static uint16 grf_load_word(byte **buf)

   171

{

   172

	uint16 val = grf_load_byte(buf);

   173

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

   174

}

   175

   176

static uint16 grf_load_extended(byte** buf)

   177

{

   178

	uint16 val;

   179

	val = grf_load_byte(buf);

   180

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

   181

	return val;

   182

}

   183

   184

static uint32 grf_load_dword(byte **buf)

   185

{

   186

	uint32 val = grf_load_word(buf);

   187

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

   188

}

   189

   190

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

   191

{

   192

	switch (size) {

   193

		case 1: return grf_load_byte(buf);

   194

		case 2: return grf_load_word(buf);

   195

		case 4: return grf_load_dword(buf);

   196

		default:

   197

			NOT_REACHED();

   198

			return 0;

   199

	}

   200

}

   201

   202

static GRFFile *GetFileByGRFID(uint32 grfid)

   203

{

   204

	GRFFile *file;

   205

   206

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

   207

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

   208

	}

   209

	return file;

   210

}

   211

   212

static GRFFile *GetFileByFilename(const char *filename)

   213

{

   214

	GRFFile *file;

   215

   216

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

   217

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

   218

	}

   219

	return file;

   220

}

   221

   222

   223

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

   224

   225

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

   226

   227

static void dewagonize(int condition, int engine)

   228

{

   229

	EngineInfo *ei = &_engine_info[engine];

   230

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   231

   232

	if (condition != 0) {

   233

		ei->unk2 &= ~0x80;

   234

		rvi->flags &= ~2;

   235

	} else {

   236

		ei->unk2 |= 0x80;

   237

		rvi->flags |= 2;

   238

	}

   239

}

   240

   241

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

   242

{

   243

	EngineInfo *ei = &_engine_info[engine];

   244

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   245

	byte *buf = *bufp;

   246

	int i;

   247

	bool ret = false;

   248

   249

	switch (prop) {

   250

		case 0x05: /* Track type */

   251

			FOR_EACH_OBJECT {

   252

				uint8 tracktype = grf_load_byte(&buf);

   253

   254

				switch (tracktype) {

   255

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

   256

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

   257

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

   258

					default:

   259

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

   260

						break;

   261

				}

   262

			}

   263

			break;

   264

   265

		case 0x08: /* AI passenger service */

   266

			/* TODO */

   267

			FOR_EACH_OBJECT grf_load_byte(&buf);

   268

			ret = true;

   269

			break;

   270

   271

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

   272

			FOR_EACH_OBJECT {

   273

				uint16 speed = grf_load_word(&buf);

   274

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

   275

   276

				rvi[i].max_speed = speed;

   277

			}

   278

			break;

   279

   280

		case 0x0B: /* Power */

   281

			FOR_EACH_OBJECT {

   282

				uint16 power = grf_load_word(&buf);

   283

   284

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

   285

   286

				rvi[i].power = power;

   287

				dewagonize(power, engine + i);

   288

			}

   289

			break;

   290

   291

		case 0x0D: /* Running cost factor */

   292

			FOR_EACH_OBJECT {

   293

				uint8 runcostfact = grf_load_byte(&buf);

   294

   295

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

   296

   297

				rvi[i].running_cost_base = runcostfact;

   298

			}

   299

			break;

   300

   301

		case 0x0E: /* Running cost base */

   302

			FOR_EACH_OBJECT {

   303

				uint32 base = grf_load_dword(&buf);

   304

   305

				switch (base) {

   306

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

   307

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

   308

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

   309

				}

   310

			}

   311

			break;

   312

   313

		case 0x12: /* Sprite ID */

   314

			FOR_EACH_OBJECT {

   315

				uint8 spriteid = grf_load_byte(&buf);

   316

   317

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

   318

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

   319

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

   320

   321

				rvi[i].image_index = spriteid;

   322

			}

   323

			break;

   324

   325

		case 0x13: /* Dual-headed */

   326

			FOR_EACH_OBJECT {

   327

				uint8 dual = grf_load_byte(&buf);

   328

   329

				if (dual != 0) {

   330

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

   331

						// adjust power and running cost if needed

   332

						rvi[i].power /= 2;

   333

						rvi[i].running_cost_base /= 2;

   334

					}

   335

					rvi[i].flags |= RVI_MULTIHEAD;

   336

				} else {

   337

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

   338

						// adjust power and running cost if needed

   339

						rvi[i].power *= 2;

   340

						rvi[i].running_cost_base *= 2;

   341

					}

   342

					rvi[i].flags &= ~RVI_MULTIHEAD;

   343

				}

   344

			}

   345

			break;

   346

   347

		case 0x14: /* Cargo capacity */

   348

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

   349

			break;

   350

   351

		case 0x15: /* Cargo type */

   352

			FOR_EACH_OBJECT {

   353

				uint8 ctype = grf_load_byte(&buf);

   354

   355

				if (ctype < NUM_CARGO) {

   356

					rvi[i].cargo_type = ctype;

   357

				} else {

   358

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

   359

				}

   360

			}

   361

			break;

   362

   363

		case 0x16: /* Weight */

   364

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

   365

			break;

   366

   367

		case 0x17: /* Cost factor */

   368

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

   369

			break;

   370

   371

		case 0x18: /* AI rank */

   372

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

   373

			break;

   374

   375

		case 0x19: /* Engine traction type */

   376

			/* What do the individual numbers mean?

   377

			 * 0x00 .. 0x07: Steam

   378

			 * 0x08 .. 0x27: Diesel

   379

			 * 0x28 .. 0x31: Electric

   380

			 * 0x32 .. 0x37: Monorail

   381

			 * 0x38 .. 0x41: Maglev

   382

			 */

   383

			FOR_EACH_OBJECT {

   384

				uint8 traction = grf_load_byte(&buf);

   385

				int engclass;

   386

   387

				if (traction <= 0x07) {

   388

					engclass = 0;

   389

				} else if (traction <= 0x27) {

   390

					engclass = 1;

   391

				} else if (traction <= 0x31) {

   392

					engclass = 2;

   393

					ei[i].railtype = RAILTYPE_ELECTRIC;

   394

				} else if (traction <= 0x41) {

   395

					engclass = 2;

   396

				} else {

   397

					break;

   398

				}

   399

   400

				rvi[i].engclass = engclass;

   401

			}

   402

			break;

   403

   404

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

   405

			FOR_EACH_OBJECT {

   406

				EngineID pos = grf_load_byte(&buf);

   407

   408

				if (pos < NUM_TRAIN_ENGINES) {

   409

					AlterRailVehListOrder(engine + i, pos);

   410

				} else {

   411

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

   412

				}

   413

			}

   414

			break;

   415

   416

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

   417

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

   418

			break;

   419

   420

		case 0x1C: /* Refit cost */

   421

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

   422

			break;

   423

   424

		case 0x1D: /* Refit cargo */

   425

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

   426

			break;

   427

   428

		case 0x1E: /* Callback */

   429

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

   430

			break;

   431

   432

		case 0x21: /* Shorter vehicle */

   433

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

   434

			break;

   435

   436

		case 0x22: /* Visual effect */

   437

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

   438

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

   439

			break;

   440

   441

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

   442

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

   443

			break;

   444

   445

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

   446

			FOR_EACH_OBJECT {

   447

				byte weight = grf_load_byte(&buf);

   448

   449

				if (weight > 4) {

   450

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

   451

				} else {

   452

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

   453

				}

   454

			}

   455

			break;

   456

   457

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

   458

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

   459

			break;

   460

   461

		case 0x27: /* Miscellaneous flags */

   462

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

   463

			break;

   464

   465

		case 0x28: /* Cargo classes allowed */

   466

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

   467

			break;

   468

   469

		case 0x29: /* Cargo classes disallowed */

   470

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

   471

			break;

   472

   473

		/* TODO */

   474

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

   475

		case 0x1F: /* Tractive effort */

   476

		case 0x20: /* Air drag */

   477

		case 0x26: /* Retire vehicle early */

   478

			/* TODO */

   479

			FOR_EACH_OBJECT grf_load_byte(&buf);

   480

			ret = true;

   481

			break;

   482

   483

		default:

   484

			ret = true;

   485

			break;

   486

	}

   487

	*bufp = buf;

   488

	return ret;

   489

}

   490