1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "gfx.h"

     8

#include "spritecache.h"

     9

#include "table/sprites.h"

    10

#include "fileio.h"

    11

#include "newgrf.h"

    12

#include "md5.h"

    13

#include "variables.h"

    14

#include <ctype.h>

    15

    16

#define SPRITE_CACHE_SIZE 1024*1024

    17

    18

    19

//#define WANT_SPRITESIZES

    20

#define WANT_NEW_LRU

    21

    22

    23

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

    24

    25

int _skip_sprites = 0;

    26

int _replace_sprites_count[16];

    27

int _replace_sprites_offset[16];

    28

    29

static const char *_cur_grffile;

    30

static int _loading_stage;

    31

static int _skip_specials;

    32

uint16 _custom_sprites_base;

    33

static Sprite _cur_sprite;

    34

    35

    36

static void* _sprite_ptr[MAX_SPRITES];

    37

static uint16 _sprite_size[MAX_SPRITES];

    38

static uint32 _sprite_file_pos[MAX_SPRITES];

    39

    40

#if defined(WANT_NEW_LRU)

    41

static int16 _sprite_lru_new[MAX_SPRITES];

    42

#else

    43

static uint16 _sprite_lru[MAX_SPRITES];

    44

static uint16 _sprite_lru_cur[MAX_SPRITES];

    45

#endif

    46

    47

#ifdef WANT_SPRITESIZES

    48

static int8 _sprite_xoffs[MAX_SPRITES];

    49

static int8 _sprite_yoffs[MAX_SPRITES];

    50

static uint16 _sprite_xsize[MAX_SPRITES];

    51

static uint8 _sprite_ysize[MAX_SPRITES];

    52

#endif

    53

    54

typedef struct MemBlock {

    55

	uint32 size;

    56

	byte data[VARARRAY_SIZE];

    57

} MemBlock;

    58

    59

static uint _sprite_lru_counter;

    60

static MemBlock *_spritecache_ptr;

    61

static uint32 _spritecache_size;

    62

static int _compact_cache_counter;

    63

    64

typedef struct MD5File {

    65

	const char * const filename;     // filename

    66

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

    67

} MD5File;

    68

    69

typedef struct FileList {

    70

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

    71

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

    72

} FileList;

    73

    74

#include "table/files.h"

    75

#include "table/landscape_sprite.h"

    76

    77

static const SpriteID * const _landscape_spriteindexes[] = {

    78

	_landscape_spriteindexes_1,

    79

	_landscape_spriteindexes_2,

    80

	_landscape_spriteindexes_3,

    81

};

    82

    83

static const SpriteID * const _slopes_spriteindexes[] = {

    84

	_slopes_spriteindexes_0,

    85

	_slopes_spriteindexes_1,

    86

	_slopes_spriteindexes_2,

    87

	_slopes_spriteindexes_3,

    88

};

    89

    90

static void CompactSpriteCache(void);

    91

    92

static void ReadSpriteHeaderSkipData(int num, int load_index)

    93

{

    94

	byte type;

    95

	int deaf = 0;

    96

    97

	if (_skip_sprites) {

    98

		if (_skip_sprites > 0)

    99

			_skip_sprites--;

   100

		deaf = 1;

   101

	}

   102

   103

	type = FioReadByte();

   104

	_cur_sprite.info = type;

   105

	if (type == 0xFF) {

   106

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

   107

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

   108

		 * because if no special sprite referencing to them is

   109

		 * processed, they themselves are never referenced and loaded

   110

		 * on their own. */

   111

		if (_skip_specials || deaf) {

   112

			FioSkipBytes(num);

   113

		} else {

   114

			DecodeSpecialSprite(_cur_grffile, num, load_index, _loading_stage);

   115

		}

   116

		return;

   117

	}

   118

   119

#ifdef WANT_SPRITESIZES

   120

	_cur_sprite.height = FioReadByte();

   121

	_cur_sprite.width = FioReadWord();

   122

	_cur_sprite.x_offs = FioReadWord();

   123

	_cur_sprite.y_offs = FioReadWord();

   124

#else

   125

	FioSkipBytes(7);

   126

#endif

   127

	num -= 8;

   128

	if (num == 0)

   129

		return;

   130

   131

	if (type & 2) {

   132

		FioSkipBytes(num);

   133

	} else {

   134

		while (num > 0) {

   135

			int8 i = FioReadByte();

   136

			if (i >= 0) {

   137

				num -= i;

   138

				FioSkipBytes(i);

   139

			} else {

   140

				i = -(i >> 3);

   141

				num -= i;

   142

				FioReadByte();

   143

			}

   144

		}

   145

	}

   146

}

   147

   148

static void* AllocSprite(size_t);

   149

   150

static void* ReadSprite(SpriteID id)

   151

{

   152

	uint num = _sprite_size[id];

   153

	byte type;

   154

   155

	DEBUG(spritecache, 9) ("load sprite %d", id);

   156

   157

	if (_sprite_file_pos[id] == 0) {

   158

		error(

   159

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

   160

			"Probable cause: Wrong/missing NewGRFs",

   161

			id

   162

		);

   163

	}

   164

   165

	FioSeekToFile(_sprite_file_pos[id]);

   166

   167

	type = FioReadByte();

   168

	if (type == 0xFF) {

   169

		byte* dest = AllocSprite(num);

   170

   171

		_sprite_ptr[id] = dest;

   172

		FioReadBlock(dest, num);

   173

   174

		return dest;

   175

	} else {

   176

		uint height = FioReadByte();

   177

		uint width  = FioReadWord();

   178

		Sprite* sprite;

   179

		byte* dest;

   180

   181

		num = (type & 0x02) ? width * height : num - 8;

   182

		sprite = AllocSprite(sizeof(*sprite) + num);

   183

		_sprite_ptr[id] = sprite;

   184

		sprite->info   = type;

   185

		sprite->height = (id != 142) ? height : 10; // Compensate for a TTD bug

   186

		sprite->width  = width;

   187

		sprite->x_offs = FioReadWord();

   188

		sprite->y_offs = FioReadWord();

   189

   190

		dest = sprite->data;

   191

		while (num > 0) {

   192

			int8 i = FioReadByte();

   193

   194

			if (i >= 0) {

   195

				num -= i;

   196

				for (; i > 0; --i) *dest++ = FioReadByte();

   197

			} else {

   198

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

   199

   200

				i = -(i >> 3);

   201

				num -= i;

   202

   203

				for (; i > 0; --i) *dest++ = *rel++;

   204

			}

   205

		}

   206

   207

		return sprite;

   208

	}

   209

}

   210

   211

   212

static bool LoadNextSprite(int load_index, byte file_index)

   213

{

   214

	uint16 size;

   215

	uint32 file_pos;

   216

   217

	size = FioReadWord();

   218

	if (size == 0)

   219

		return false;

   220

   221

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

   222

   223

	ReadSpriteHeaderSkipData(size, load_index);

   224

   225

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

   226

		int count = _replace_sprites_count[0];

   227

		int offset = _replace_sprites_offset[0];

   228

   229

		_replace_sprites_offset[0]++;

   230

		_replace_sprites_count[0]--;

   231

   232

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

   233

			load_index = offset;

   234

		} else {

   235

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

   236

					count, offset);

   237

			_replace_sprites_offset[0] = 0;

   238

			_replace_sprites_count[0] = 0;

   239

		}

   240

   241

		if (_replace_sprites_count[0] == 0) {

   242

			int i;

   243

   244

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

   245

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

   246

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

   247

			}

   248

			_replace_sprites_count[i] = 0;

   249

			_replace_sprites_offset[i] = 0;

   250

		}

   251

	}

   252

   253

	_sprite_size[load_index] = size;

   254

	_sprite_file_pos[load_index] = file_pos;

   255

   256

#ifdef WANT_SPRITESIZES

   257

	_sprite_xsize[load_index] = _cur_sprite.width;

   258

	_sprite_ysize[load_index] = _cur_sprite.height;

   259

   260

	_sprite_xoffs[load_index] = _cur_sprite.x_offs;

   261

	_sprite_yoffs[load_index] = _cur_sprite.y_offs;

   262

#endif

   263

   264

	_sprite_ptr[load_index] = NULL;

   265

   266

#if defined(WANT_NEW_LRU)

   267

	_sprite_lru_new[load_index] = 0;

   268

#else

   269

	_sprite_lru[load_index] = 0xFFFF;

   270

	_sprite_lru_cur[load_index] = 0;

   271

#endif

   272

   273

	return true;

   274

}

   275

   276

static void SkipSprites(uint count)

   277

{

   278

	for (; count > 0; --count)

   279

	{

   280

		uint16 size = FioReadWord();

   281

   282

		if (size == 0)

   283

			return;

   284

   285

		ReadSpriteHeaderSkipData(size, MAX_SPRITES - 1);

   286

	}

   287

}

   288

   289

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

   290

{

   291

	int load_index_org = load_index;

   292

   293

	FioOpenFile(file_index, filename);

   294

   295

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

   296

	 * might contain some special sprites. */

   297

	_skip_specials = 1;

   298

	_skip_sprites = 0;

   299

   300

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

   301

   302

	while (LoadNextSprite(load_index, file_index)) {

   303

		load_index++;

   304

		if (load_index >= MAX_SPRITES) {

   305

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

   306

		}

   307

	}

   308

	DEBUG(spritecache, 2) ("Currently %i sprites are loaded", load_index);

   309

   310

	return load_index - load_index_org;

   311

}

   312

   313

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

   314

{

   315

	int i;

   316

   317

	FioOpenFile(file_index, filename);

   318

	_cur_grffile = filename;

   319

	_skip_specials = 0;

   320

	_skip_sprites = 0;

   321

   322

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

   323

			filename, load_index);

   324

   325

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

   326

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

   327

	 * neither, apparently. */

   328

	{

   329

		int length;

   330

		byte type;

   331

   332

		length = FioReadWord();

   333

		type = FioReadByte();

   334

   335

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

   336

			FioReadDword();

   337

		} else {

   338

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

   339

		}

   340

	}

   341

   342

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

   343

		if (load_index + i >= MAX_SPRITES)

   344

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

   345

			      load_index + i);

   346

	}

   347

   348

	/* Clean up. */

   349

	_skip_sprites = 0;

   352

   353

	return i;

   354

}

   355

   356

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

   357

{

   358

	int start;

   359

   360

	FioOpenFile(file_index, filename);

   361

	_skip_specials = 1;

   362

	_skip_sprites = 0;

   363

   364

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

   365

   366

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

   367

		int end = *index_tbl++;

   368

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

   369

			SkipSprites(end);

   370

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

   371

			do {

   372

			#ifdef NDEBUG

   373

				LoadNextSprite(start, file_index);

   374

			#else

   375

				bool b = LoadNextSprite(start, file_index);

   376

				assert(b);

   377

			#endif

   378

			} while (++start <= end);

   379

		}

   380

	}

   381

}

   382

   383

   384

#define S_FREE_MASK 1

   385

   386

static inline MemBlock* NextBlock(MemBlock* block)

   387

{

   388

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

   389

}

   390

   391

static uint32 GetSpriteCacheUsage(void)

   392

{

   393

	size_t tot_size = 0;

   394

	MemBlock* s;

   395

   396

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

   397

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

   398

   399

	return tot_size;

   400

}

   401

   402

   403

void IncreaseSpriteLRU(void)

   404

{

   405

	int i;

   406

   407

	// Increase all LRU values

   408

#if defined(WANT_NEW_LRU)

   409

	if (_sprite_lru_counter > 16384) {

   410

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

   411

   412

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

   413

			if (_sprite_ptr[i] != NULL) {

   414

				if (_sprite_lru_new[i] >= 0) {

   415

					_sprite_lru_new[i] = -1;

   416

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

   417

					_sprite_lru_new[i]--;

   418

				}

   419

			}

   420

		_sprite_lru_counter = 0;

   421

	}

   422

#else

   423

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

   424

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

   425

			_sprite_lru[i]++;

   426

	// Reset the lru counter.

   427

	_sprite_lru_counter = 0;

   428

#endif

   429

   430

	// Compact sprite cache every now and then.

   431

	if (++_compact_cache_counter >= 740) {

   432

		CompactSpriteCache();

   433

		_compact_cache_counter = 0;

   434

	}

   435

}

   436

   437

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

   438

// That is accomplished by moving the cached data.

   439

static void CompactSpriteCache(void)

   440

{

   441

	MemBlock *s;

   442

   443

	DEBUG(spritecache, 2) (

   444

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

   445

	);

   446

   447

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

   448

		if (s->size & S_FREE_MASK) {

   449

			MemBlock* next = NextBlock(s);

   450

			MemBlock temp;

   451

			void** i;

   452

   453

			// Since free blocks are automatically coalesced, this should hold true.

   454

			assert(!(next->size & S_FREE_MASK));

   455

   456

			// If the next block is the sentinel block, we can safely return

   457

			if (next->size == 0)

   458

				break;

   459

   460

			// Locate the sprite belonging to the next pointer.

   461

			for (i = _sprite_ptr; *i != next->data; ++i) {

   462

				assert(i != endof(_sprite_ptr));

   463

			}

   464

   465

			*i = s->data; // Adjust sprite array entry

   466

			// Swap this and the next block

   467

			temp = *s;

   468

			memmove(s, next, next->size);

   469

			s = NextBlock(s);

   470

			*s = temp;

   471

   472

			// Coalesce free blocks

   473

			while (NextBlock(s)->size & S_FREE_MASK) {

   474

				s->size += NextBlock(s)->size & ~S_FREE_MASK;

   475

			}

   476

		} else {

   477

			s = NextBlock(s);

   478

		}

   479

	}

   480

}

   481

   482

static void DeleteEntryFromSpriteCache(void)

   483

{

   484

	int i;

   485

	int best = -1;

   486

	MemBlock* s;

   487

	int cur_lru;

   488

   489

	DEBUG(spritecache, 2) ("DeleteEntryFromSpriteCache, inuse=%d", GetSpriteCacheUsage());

   490

   491

#if defined(WANT_NEW_LRU)

   492

	cur_lru = 0xffff;

   493

	for (i = 0; i != MAX_SPRITES; i++) {

   494

		if (_sprite_ptr[i] != NULL && _sprite_lru_new[i] < cur_lru) {

   495

			cur_lru = _sprite_lru_new[i];

   496

			best = i;

   497