1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "debug.h"

     4

#include "gfx.h"

     5

#include "spritecache.h"

     6

#include "table/sprites.h"

     7

#include "fileio.h"

     8

#include "newgrf.h"

     9

#include "md5.h"

    10

#include <ctype.h>

    11

    12

#define SPRITECACHE_ID 0xF00F0006

    13

#define SPRITE_CACHE_SIZE 1024*1024

    14

    15

    16

//#define WANT_SPRITESIZES

    17

#define WANT_NEW_LRU

    18

//#define WANT_LOCKED

    19

    20

    21

/* These are used in newgrf.c: */

    22

    23

int _skip_sprites = 0;

    24

int _replace_sprites_count[16];

    25

int _replace_sprites_offset[16];

    26

    27

static const char *_cur_grffile;

    28

static int _loading_stage;

    29

static int _skip_specials;

    30

uint16 _custom_sprites_base;

    31

static Sprite _cur_sprite;

    32

    33

    35

static uint16 _sprite_size[NUM_SPRITES];

    36

static uint32 _sprite_file_pos[NUM_SPRITES];

    37

    38

// This one is probably not needed.

    39

#if defined(WANT_LOCKED)

    40

static bool _sprite_locked[NUM_SPRITES];

    41

#endif

    42

    43

#if defined(WANT_NEW_LRU)

    44

static int16 _sprite_lru_new[NUM_SPRITES];

    45

#else

    46

static uint16 _sprite_lru[NUM_SPRITES];

    47

static uint16 _sprite_lru_cur[NUM_SPRITES];

    48

#endif

    49

    50

#ifdef WANT_SPRITESIZES

    51

static int8 _sprite_xoffs[NUM_SPRITES];

    52

static int8 _sprite_yoffs[NUM_SPRITES];

    53

static uint16 _sprite_xsize[NUM_SPRITES];

    54

static uint8 _sprite_ysize[NUM_SPRITES];

    55

#endif

    56

    57

typedef struct MemBlock {

    58

	uint32 size;

    59

	byte data[VARARRAY_SIZE];

    60

} MemBlock;

    61

    62

static uint _sprite_lru_counter;

    63

static MemBlock *_spritecache_ptr;

    64

static uint32 _spritecache_size;

    65

static int _compact_cache_counter;

    66

    67

typedef struct MD5File {

    68

	const char * const filename;     // filename

    69

	const md5_byte_t hash[16]; // md5 sum of the file

    70

} MD5File;

    71

    72

typedef struct FileList {

    73

	const MD5File basic[5];     // grf files that always have to be loaded

    74

	const MD5File landscape[3]; // landscape specific grf files

    75

} FileList;

    76

    77

#include "table/files.h"

    78

#include "table/landscape_sprite.h"

    79

    80

static const uint16 * const _landscape_spriteindexes[] = {

    81

	_landscape_spriteindexes_1,

    82

	_landscape_spriteindexes_2,

    83

	_landscape_spriteindexes_3,

    84

};

    85

    86

static const uint16 * const _slopes_spriteindexes[] = {

    87

	_slopes_spriteindexes_0,

    88

	_slopes_spriteindexes_1,

    89

	_slopes_spriteindexes_2,

    90

	_slopes_spriteindexes_3,

    91

};

    92

    93

static void CompactSpriteCache(void);

    94

    95

static void ReadSpriteHeaderSkipData(int num, int load_index)

    96

{

    97

	byte type;

    98

	int deaf = 0;

    99

   100

	if (_skip_sprites) {

   101

		if (_skip_sprites > 0)

   102

			_skip_sprites--;

   103

		deaf = 1;

   104

	}

   105

   106

	type = FioReadByte();

   107

	_cur_sprite.info = type;

   108

	if (type == 0xFF) {

   109

		/* We need to really skip only special sprites in the deaf

   110

		 * mode.  It won't hurt to proceed regular sprites as usual

   111

		 * because if no special sprite referencing to them is

   112

		 * processed, they themselves are never referenced and loaded

   113

		 * on their own. */

   114

		if (_skip_specials || deaf) {

   115

			FioSkipBytes(num);

   116

		} else {

   117

			DecodeSpecialSprite(_cur_grffile, num, load_index, _loading_stage);

   118

		}

   119

		return;

   120

	}

   121

   122

#ifdef WANT_SPRITESIZES

   123

	_cur_sprite.height = FioReadByte();

   124

	_cur_sprite.width = FioReadWord();

   125

	_cur_sprite.x_offs = FioReadWord();

   126

	_cur_sprite.y_offs = FioReadWord();

   127

#else

   128

	FioSkipBytes(7);

   129

#endif

   130

	num -= 8;

   131

	if (num == 0)

   132

		return;

   133

   134

	if (type & 2) {

   135

		FioSkipBytes(num);

   136

	} else {

   137

		while (num > 0) {

   138

			int8 i = FioReadByte();

   139

			if (i >= 0) {

   140

				num -= i;

   141

				FioSkipBytes(i);

   142

			} else {

   143

				i = -(i >> 3);

   144

				num -= i;

   145

				FioReadByte();

   146

			}

   147

		}

   148

	}

   149

}

   150

   154

{

   155

	uint num = _sprite_size[id];

   156

	byte type;

   159

   160

	if (_sprite_file_pos[id] == 0) {

   161

		error(

   162

			"Tried to load non-existing sprite #%d.\n"

   163

			"Probable cause: Wrong/missing NewGRFs",

   164

			id

   165

		);

   166

	}

   167

   168

	FioSeekToFile(_sprite_file_pos[id]);

   169

   170

	type = FioReadByte();

   190

		sprite->x_offs = FioReadWord();

   191

		sprite->y_offs = FioReadWord();

   193

		dest = sprite->data;

   194

		while (num > 0) {

   195

			int8 i = FioReadByte();

   196

   197

			if (i >= 0) {

   198

				num -= i;

   200

			} else {

   201

				const byte* rel = dest - (((i & 7) << 8) | FioReadByte());

   202

   203

				i = -(i >> 3);

   204

				num -= i;

   205

   207

			}

   208

		}

   211

	}

   212

}

   213

   214

   215

static bool LoadNextSprite(int load_index, byte file_index)

   216

{

   217

	uint16 size;

   218

	uint32 file_pos;

   219

   220

	size = FioReadWord();

   221

	if (size == 0)

   222

		return false;

   223

   224

	file_pos = FioGetPos() | (file_index << 24);

   225

   226

	ReadSpriteHeaderSkipData(size, load_index);

   227

   228

	if (_replace_sprites_count[0] > 0 && _cur_sprite.info != 0xFF) {

   229

		int count = _replace_sprites_count[0];

   230

		int offset = _replace_sprites_offset[0];

   231

   232

		_replace_sprites_offset[0]++;

   233

		_replace_sprites_count[0]--;

   234

   235

		if ((offset + count) <= NUM_SPRITES) {

   236

			load_index = offset;

   237

		} else {

   238

			DEBUG(spritecache, 1) ("Sprites to be replaced are out of range: %x+%x",

   239

					count, offset);

   240

			_replace_sprites_offset[0] = 0;

   241

			_replace_sprites_count[0] = 0;

   242

		}

   243

   244

		if (_replace_sprites_count[0] == 0) {

   245

			int i;

   246

   247

			for (i = 0; i < 15; i++) {

   248

				_replace_sprites_count[i] = _replace_sprites_count[i + 1];

   249

				_replace_sprites_offset[i] = _replace_sprites_offset[i + 1];

   250

			}

   251

			_replace_sprites_count[i] = 0;

   252

			_replace_sprites_offset[i] = 0;

   253

		}

   254

	}

   255

   256

	_sprite_size[load_index] = size;

   257

	_sprite_file_pos[load_index] = file_pos;

   258

   259

#ifdef WANT_SPRITESIZES

   260

	_sprite_xsize[load_index] = _cur_sprite.width;

   261

	_sprite_ysize[load_index] = _cur_sprite.height;

   262

   263

	_sprite_xoffs[load_index] = _cur_sprite.x_offs;

   264

	_sprite_yoffs[load_index] = _cur_sprite.y_offs;

   265

#endif

   266

   267

	_sprite_ptr[load_index] = NULL;

   268

#if defined(WANT_LOCKED)

   269

	_sprite_locked[load_index] = false;

   270

#endif

   271

   272

#if defined(WANT_NEW_LRU)

   273

	_sprite_lru_new[load_index] = 0;

   274

#else

   275

	_sprite_lru[load_index] = 0xFFFF;

   276

	_sprite_lru_cur[load_index] = 0;

   277

#endif

   278

   279

	return true;

   280

}

   281

   282

static void SkipSprites(uint count)

   283

{

   284

	for (; count > 0; --count)

   285

	{

   286

		uint16 size = FioReadWord();

   287

   288

		if (size == 0)

   289

			return;

   290

   291

		ReadSpriteHeaderSkipData(size, NUM_SPRITES - 1);

   292

	}

   293

}

   294

   295

static int LoadGrfFile(const char *filename, int load_index, int file_index)

   296

{

   297

	int load_index_org = load_index;

   298

   299

	FioOpenFile(file_index, filename);

   300

   301

	/* Thou shalt use LoadNewGrfFile() if thou loadeth a GRF file that

   302

	 * might contain some special sprites. */

   303

	_skip_specials = 1;

   304

	_skip_sprites = 0;

   305

   306

	DEBUG(spritecache, 2) ("Reading grf-file ``%s''", filename);

   307

   308

	while (LoadNextSprite(load_index, file_index)) {

   309

		load_index++;

   310

		if (load_index >= NUM_SPRITES) {

   311

			error("Too many sprites. Recompile with higher NUM_SPRITES value or remove some custom GRF files.");

   312

		}

   313

	}

   314

   315

	return load_index - load_index_org;

   316

}

   317

   318

static int LoadNewGrfFile(const char *filename, int load_index, int file_index)

   319

{

   320

	int i;

   321

   322

	FioOpenFile(file_index, filename);

   323

	_cur_grffile = filename;

   324

	_skip_specials = 0;

   325

	_skip_sprites = 0;

   326

   327

	DEBUG(spritecache, 2) ("Reading newgrf-file ``%s'' [offset: %u]",

   328

			filename, load_index);

   329

   330

	/* Skip the first sprite; we don't care about how many sprites this

   331

	 * does contain; newest TTDPatches and George's longvehicles don't

   332

	 * neither, apparently. */

   333

	{

   334

		int length;

   335

		byte type;

   336

   337

		length = FioReadWord();

   338

		type = FioReadByte();

   339

   340

		if (length == 4 && type == 0xFF) {

   341

			FioReadDword();

   342

		} else {

   343

			error("Custom .grf has invalid format.");

   344

		}

   345

	}

   346

   347

	for (i = 0; LoadNextSprite(load_index + i, file_index); i++) {

   348

		if (load_index + i >= NUM_SPRITES)

   349

			error("Too many sprites (%x). Recompile with higher NUM_SPRITES value or remove some custom GRF files.",

   350

			      load_index + i);

   351

	}

   352

   353

	/* Clean up. */

   354

	_skip_sprites = 0;

   355

	memset(_replace_sprites_count, 0, 16 * sizeof(*_replace_sprites_count));

   356

	memset(_replace_sprites_offset, 0, 16 * sizeof(*_replace_sprites_offset));

   357

   358

	return i;

   359

}

   360

   361

static void LoadGrfIndexed(const char *filename, const uint16 *index_tbl, int file_index)

   362

{

   363

	int start;

   364

   365

	FioOpenFile(file_index, filename);

   366

	_skip_specials = 1;

   367

	_skip_sprites = 0;

   368

   369

	DEBUG(spritecache, 2) ("Reading indexed grf-file ``%s''", filename);

   370

   371

	for (; (start = *index_tbl++) != 0xffff;) {

   372

		int end = *index_tbl++;

   373

		if(start == 0xfffe) { // skip sprites (amount in second var)

   374

			SkipSprites(end);

   375

		} else { // load sprites and use indexes from start to end

   376

			do {

   377

			#ifdef NDEBUG

   378

				LoadNextSprite(start, file_index);

   379

			#else

   380

				bool b = LoadNextSprite(start, file_index);

   381

				assert(b);

   382

			#endif

   383

			} while (++start <= end);

   384

		}

   385

	}

   386

}

   387

   388

typedef size_t CDECL fread_t(void*, size_t, size_t, FILE*);

   389

   390

static bool HandleCachedSpriteHeaders(const char *filename, bool read)

   391

{

   392

	FILE *f;

   393

	fread_t *proc;

   394

	uint32 hdr;

   395

   396

	if (!_cache_sprites)

   397

		return false;

   398

   399

	if (read) {

   400

		f = fopen(filename, "rb");

   401

		proc = fread;

   402

   403

		if (f == NULL)

   404

			return false;

   405

   406

		proc(&hdr, sizeof(hdr), 1, f);

   407

		if (hdr != SPRITECACHE_ID) {

   408

			fclose(f);

   409

			return false;

   410

		}

   411

	} else {

   412

		f = fopen(filename, "wb");

   413

		proc = (fread_t*) fwrite;

   414

   415

		if (f == NULL)

   416

			return false;

   417

   418

		hdr = SPRITECACHE_ID;

   419

		proc(&hdr, sizeof(hdr), 1, f);

   420

	}

   421

   422

	proc(_sprite_size, 1, sizeof(_sprite_size), f);

   423

	proc(_sprite_file_pos, 1, sizeof(_sprite_file_pos), f);

   424

   425

#if 0

   426

	proc(_sprite_xsize, 1, sizeof(_sprite_xsize), f);

   427

	proc(_sprite_ysize, 1, sizeof(_sprite_ysize), f);

   428

	proc(_sprite_xoffs, 1, sizeof(_sprite_xoffs), f);

   429

	proc(_sprite_yoffs, 1, sizeof(_sprite_yoffs), f);

   430

#endif

   431

   432

#if !defined(WANT_NEW_LRU)

   433

	if (read)

   434

		memset(_sprite_lru, 0xFF, sizeof(_sprite_lru));

   435

#endif

   436

   437

	fclose(f);

   438

	return true;

   439

}

   440

   441

#define S_FREE_MASK 1

   442

   443

static inline MemBlock* NextBlock(MemBlock* block)

   444

{

   445

	return (MemBlock*)((byte*)block + (block->size & ~S_FREE_MASK));

   446

}

   447

   448

static uint32 GetSpriteCacheUsage(void)

   449

{

   450

	size_t tot_size = 0;

   451

	MemBlock* s;

   452

   453

	for (s = _spritecache_ptr; s->size != 0; s = NextBlock(s))

   454

		if (!(s->size & S_FREE_MASK)) tot_size += s->size;

   455

   456

	return tot_size;

   457

}

   458

   459

   460

void IncreaseSpriteLRU(void)

   461

{

   462

	int i;

   463

   464

	// Increase all LRU values

   465

#if defined(WANT_NEW_LRU)

   466

	if (_sprite_lru_counter > 16384) {

   467

		DEBUG(spritecache, 2) ("fixing lru %d, inuse=%d", _sprite_lru_counter, GetSpriteCacheUsage());

   468

   469

		for (i = 0; i != NUM_SPRITES; i++)

   470

			if (_sprite_ptr[i] != NULL) {

   471

				if (_sprite_lru_new[i] >= 0) {

   472

					_sprite_lru_new[i] = -1;

   473

				} else if (_sprite_lru_new[i] != -32768) {

   474

					_sprite_lru_new[i]--;

   475

				}

   476

			}

   477

		_sprite_lru_counter = 0;

   478

	}

   479

#else

   480

	for (i = 0; i != NUM_SPRITES; i++)

   481

		if (_sprite_ptr[i] != NULL && _sprite_lru[i] != 65535)

   482

			_sprite_lru[i]++;

   483

	// Reset the lru counter.

   484

	_sprite_lru_counter = 0;

   485

#endif

   486

   487

	// Compact sprite cache every now and then.

   488

	if (++_compact_cache_counter >= 740) {

   489

		CompactSpriteCache();

   490

		_compact_cache_counter = 0;

   491

	}

   492

}

   493

   494

// Called when holes in the sprite cache should be removed.

   495

// That is accomplished by moving the cached data.

   496

static void CompactSpriteCache(void)

   497

{

   498

	MemBlock *s;

   499

   500

	DEBUG(spritecache, 2) (

   501

		"compacting sprite cache, inuse=%d", GetSpriteCacheUsage()

   502

	);

   503