1

/* $Id$ */

     2

     3

/** @file spritecache.cpp Caching of sprites. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "debug.h"

     9

#include "spritecache.h"

    10

#include "fileio.h"

    11

#include "spriteloader/grf.hpp"

    12

#include "core/alloc_func.hpp"

    13

#include "core/math_func.hpp"

    14

#ifdef WITH_PNG

    15

#include "spriteloader/png.hpp"

    16

#endif /* WITH_PNG */

    17

#include "blitter/factory.hpp"

    18

    19

#include "table/sprites.h"

    20

    21

/* Default of 4MB spritecache */

    22

uint _sprite_cache_size = 4;

    23

    24

    25

struct SpriteCache {

    26

	void *ptr;

    27

	uint32 id;

    28

	size_t file_pos;

    29

	uint16 file_slot;

    30

	int16 lru;

    31

};

    32

    33

    34

static uint _spritecache_items = 0;

    35

static SpriteCache *_spritecache = NULL;

    36

    37

    38

static inline SpriteCache *GetSpriteCache(uint index)

    39

{

    40

	return &_spritecache[index];

    41

}

    42

    43

    44

static SpriteCache *AllocateSpriteCache(uint index)

    45

{

    46

	if (index >= _spritecache_items) {

    47

		/* Add another 1024 items to the 'pool' */

    48

		uint items = Align(index + 1, 1024);

    49

    50

		DEBUG(sprite, 4, "Increasing sprite cache to %d items (%d bytes)", items, items * sizeof(*_spritecache));

    51

    52

		_spritecache = ReallocT(_spritecache, items);

    53

    54

		/* Reset the new items and update the count */

    55

		memset(_spritecache + _spritecache_items, 0, (items - _spritecache_items) * sizeof(*_spritecache));

    56

		_spritecache_items = items;

    57

	}

    58

    59

	return GetSpriteCache(index);

    60

}

    61

    62

    63

struct MemBlock {

    64

	size_t size;

    65

	byte data[VARARRAY_SIZE];

    66

};

    67

    68

static uint _sprite_lru_counter;

    69

static MemBlock *_spritecache_ptr;

    70

static int _compact_cache_counter;

    71

    72

static void CompactSpriteCache();

    73

    74

static bool ReadSpriteHeaderSkipData()

    75

{

    76

	uint16 num = FioReadWord();

    77

	byte type;

    78

    79

	if (num == 0) return false;

    80

    81

	type = FioReadByte();

    82

	if (type == 0xFF) {

    83

		FioSkipBytes(num);

    84

		/* Some NewGRF files have "empty" pseudo-sprites which are 1

    85

		 * byte long. Catch these so the sprites won't be displayed. */

    86

		return num != 1;

    87

	}

    88

    89

	FioSkipBytes(7);

    90

	num -= 8;

    91

	if (num == 0) return true;

    92

    93

	if (type & 2) {

    94

		FioSkipBytes(num);

    95

	} else {

    96

		while (num > 0) {

    97

			int8 i = FioReadByte();

    98

			if (i >= 0) {

    99

				num -= i;

   100

				FioSkipBytes(i);

   101

			} else {

   102

				i = -(i >> 3);

   103

				num -= i;

   104

				FioReadByte();

   105

			}

   106

		}

   107

	}

   108

   109

	return true;

   110

}

   111

   112

/* Check if the given Sprite ID exists */

   113

bool SpriteExists(SpriteID id)

   114

{

   115

	/* Special case for Sprite ID zero -- its position is also 0... */

   116

	if (id == 0) return true;

   117

	if (id >= _spritecache_items) return false;

   118

	return !(GetSpriteCache(id)->file_pos == 0 && GetSpriteCache(id)->file_slot == 0);

   119

}

   120

   121

void* AllocSprite(size_t);

   122

   123

static void* ReadSprite(SpriteCache *sc, SpriteID id, bool real_sprite)

   124

{

   125

	uint8 file_slot = sc->file_slot;

   126

	size_t file_pos = sc->file_pos;

   127

   128

	DEBUG(sprite, 9, "Load sprite %d", id);

   129

   130

	if (!SpriteExists(id)) {

   131

		DEBUG(sprite, 1, "Tried to load non-existing sprite #%d. Probable cause: Wrong/missing NewGRFs", id);

   132

   133

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   134

		id = SPR_IMG_QUERY;

   135

		file_slot = GetSpriteCache(SPR_IMG_QUERY)->file_slot;

   136

		file_pos  = GetSpriteCache(SPR_IMG_QUERY)->file_pos;

   137

	}

   138

   139

	if (BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth() == 32) {

   140

#ifdef WITH_PNG

   141

		/* Try loading 32bpp graphics in case we are 32bpp output */

   142

		SpriteLoaderPNG sprite_loader;

   143

		SpriteLoader::Sprite sprite;

   144

   145

		if (sprite_loader.LoadSprite(&sprite, file_slot, sc->id)) {

   146

			sc->ptr = BlitterFactoryBase::GetCurrentBlitter()->Encode(&sprite, &AllocSprite);

   147

			free(sprite.data);

   148

   149

			return sc->ptr;

   150

		}

   151

		/* If the PNG couldn't be loaded, fall back to 8bpp grfs */

   152

#else

   153

		static bool show_once = true;

   154

		if (show_once) {

   155

			DEBUG(misc, 0, "You are running a 32bpp blitter, but this build is without libpng support; falling back to 8bpp graphics");

   156

			show_once = false;

   157

		}

   158

#endif /* WITH_PNG */

   159

	}

   160

   161

	FioSeekToFile(file_slot, file_pos);

   162

   163

	/* Read the size and type */

   164

	int num  = FioReadWord();

   165

	byte type = FioReadByte();

   166

	/* Type 0xFF indicates either a colormap or some other non-sprite info */

   167

	if (type == 0xFF) {

   168

		if (real_sprite) {

   169

			static byte warning_level = 0;

   170

			DEBUG(sprite, warning_level, "Tried to load non sprite #%d as a real sprite. Probable cause: NewGRF interference", id);

   171

			warning_level = 6;

   172

			if (id == SPR_IMG_QUERY) usererror("Uhm, would you be so kind not to load a NewGRF that makes the 'query' sprite a non- sprite?");

   173

			return (void*)GetSprite(SPR_IMG_QUERY);

   174

		}

   175

   176

		byte *dest = (byte *)AllocSprite(num);

   177

   178

		sc->ptr = dest;

   179

		FioReadBlock(dest, num);

   180

   181

		return sc->ptr;

   182

	}

   183

	/* Ugly hack to work around the problem that the old landscape

   184

	 *  generator assumes that those sprites are stored uncompressed in

   185

	 *  the memory, and they are only read directly by the code, never

   186

	 *  send to the blitter. So do not send it to the blitter (which will

   187

	 *  result in a data array in the format the blitter likes most), but

   188

	 *  read the data directly from disk and store that as sprite.

   189

	 * Ugly: yes. Other solution: no. Blame the original author or

   190

	 *  something ;) The image should really have been a data-stream

   191

	 *  (so type = 0xFF basicly). */

   192

	if (id >= 4845 && id <= 4881) {

   193

		uint height = FioReadByte();

   194

		uint width  = FioReadWord();

   195

		Sprite *sprite;

   196

		byte *dest;

   197

   198

		num = width * height;

   199

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

   200

		sc->ptr = sprite;

   201

		sprite->height = height;

   202

		sprite->width  = width;

   203

		sprite->x_offs = FioReadWord();

   204

		sprite->y_offs = FioReadWord();

   205

   206

		dest = sprite->data;

   207

		while (num > 0) {

   208

			int8 i = FioReadByte();

   209

			if (i >= 0) {

   210

				num -= i;

   211

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

   212

			} else {

   213

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

   214

				i = -(i >> 3);

   215

				num -= i;

   216

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

   217

			}

   218

		}

   219

   220

		return sc->ptr;

   221

	}

   222

   223

	if (!real_sprite) {

   224

		static byte warning_level = 0;

   225

		DEBUG(sprite, warning_level, "Tried to load real sprite #%d as a non sprite. Probable cause: NewGRF interference", id);

   226

		warning_level = 6;

   227

	}

   228

   229

	SpriteLoaderGrf sprite_loader;

   230

	SpriteLoader::Sprite sprite;

   231

   232

	if (!sprite_loader.LoadSprite(&sprite, file_slot, file_pos)) return NULL;

   233

	if (id == 142) sprite.height = 10; // Compensate for a TTD bug

   234

	sc->ptr = BlitterFactoryBase::GetCurrentBlitter()->Encode(&sprite, &AllocSprite);

   235

	free(sprite.data);

   236

   237

	return sc->ptr;

   238

}

   239

   240

   241

bool LoadNextSprite(int load_index, byte file_slot, uint file_sprite_id)

   242

{

   243

	SpriteCache *sc;

   244

	size_t file_pos = FioGetPos();

   245

   246

	if (!ReadSpriteHeaderSkipData()) return false;

   247

   248

	if (load_index >= MAX_SPRITES) {

   249

		usererror("Tried to load too many sprites (#%d; max %d)", load_index, MAX_SPRITES);

   250

	}

   251

   252

	sc = AllocateSpriteCache(load_index);

   253

	sc->file_slot = file_slot;

   254

	sc->file_pos = file_pos;

   255

	sc->ptr = NULL;

   256

	sc->lru = 0;

   257

	sc->id = file_sprite_id;

   258

   259

	return true;

   260

}

   261

   262

   263

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   264

{

   265

	SpriteCache *scnew = AllocateSpriteCache(new_spr); // may reallocate: so put it first

   266

	SpriteCache *scold = GetSpriteCache(old_spr);

   267

   268

	scnew->file_slot = scold->file_slot;

   269

	scnew->file_pos = scold->file_pos;

   270

	scnew->ptr = NULL;

   271

	scnew->id = scold->id;

   272

}

   273

   274

   275

#define S_FREE_MASK 1

   276

   277

static inline MemBlock* NextBlock(MemBlock* block)

   278

{

   279

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

   280

}

   281

   282

static size_t GetSpriteCacheUsage()

   283

{

   284

	size_t tot_size = 0;

   285

	MemBlock* s;

   286

   287

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

   288

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

   289

	}

   290

   291

	return tot_size;

   292

}

   293

   294

   295

void IncreaseSpriteLRU()

   296

{

   297

	/* Increase all LRU values */

   298

	if (_sprite_lru_counter > 16384) {

   299

		SpriteID i;

   300

   301

		DEBUG(sprite, 3, "Fixing lru %d, inuse=%d", _sprite_lru_counter, GetSpriteCacheUsage());

   302

   303

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

   304

			SpriteCache *sc = GetSpriteCache(i);

   305

			if (sc->ptr != NULL) {

   306

				if (sc->lru >= 0) {

   307

					sc->lru = -1;

   308

				} else if (sc->lru != -32768) {

   309

					sc->lru--;

   310

				}

   311

			}

   312

		}

   313

		_sprite_lru_counter = 0;

   314

	}

   315

   316

	/* Compact sprite cache every now and then. */

   317

	if (++_compact_cache_counter >= 740) {

   318

		CompactSpriteCache();

   319

		_compact_cache_counter = 0;

   320

	}

   321

}

   322

   323

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

   324

 * That is accomplished by moving the cached data. */

   325

static void CompactSpriteCache()

   326

{

   327

	MemBlock *s;

   328

   329

	DEBUG(sprite, 3, "Compacting sprite cache, inuse=%d", GetSpriteCacheUsage());

   330

   331

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

   332

		if (s->size & S_FREE_MASK) {

   333

			MemBlock* next = NextBlock(s);

   334

			MemBlock temp;

   335

			SpriteID i;

   336

   337

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

   338

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

   339

   340

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

   341

			if (next->size == 0) break;

   342

   343

			/* Locate the sprite belonging to the next pointer. */

   344

			for (i = 0; GetSpriteCache(i)->ptr != next->data; i++) {

   345

				assert(i != _spritecache_items);

   346

			}

   347

   348

			GetSpriteCache(i)->ptr = s->data; // Adjust sprite array entry

   349

			/* Swap this and the next block */

   350

			temp = *s;

   351

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

   352

			s = NextBlock(s);

   353

			*s = temp;

   354

   355

			/* Coalesce free blocks */

   356

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

   357

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

   358

			}

   359

		} else {

   360

			s = NextBlock(s);

   361

		}

   362

	}

   363

}

   364

   365

static void DeleteEntryFromSpriteCache()

   366

{

   367

	SpriteID i;

   368

	uint best = UINT_MAX;

   369

	MemBlock* s;

   370

	int cur_lru;

   371

   372

	DEBUG(sprite, 3, "DeleteEntryFromSpriteCache, inuse=%d", GetSpriteCacheUsage());

   373

   374

	cur_lru = 0xffff;

   375

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

   376

		SpriteCache *sc = GetSpriteCache(i);

   377

		if (sc->ptr != NULL && sc->lru < cur_lru) {

   378

			cur_lru = sc->lru;

   379

			best = i;

   380

		}

   381

	}

   382

   383

	/* Display an error message and die, in case we found no sprite at all.

   384

	 * This shouldn't really happen, unless all sprites are locked. */

   385

	if (best == (uint)-1) error("Out of sprite memory");

   386

   387

	/* Mark the block as free (the block must be in use) */

   388

	s = (MemBlock*)GetSpriteCache(best)->ptr - 1;

   389

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

   390

	s->size |= S_FREE_MASK;

   391

	GetSpriteCache(best)->ptr = NULL;

   392

   393

	/* And coalesce adjacent free blocks */

   394

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

   395

		if (s->size & S_FREE_MASK) {

   396

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

   397

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

   398

			}

   399

		}

   400

	}

   401

}

   402

   403

void* AllocSprite(size_t mem_req)

   404

{

   405

	mem_req += sizeof(MemBlock);

   406

   407

	/* Align this to an uint32 boundary. This also makes sure that the 2 least

   408

	 * bits are not used, so we could use those for other things. */

   409

	mem_req = Align(mem_req, sizeof(uint32));

   410

   411

	for (;;) {

   412

		MemBlock* s;

   413

   414

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

   415

			if (s->size & S_FREE_MASK) {

   416

				size_t cur_size = s->size & ~S_FREE_MASK;

   417

   418

				/* Is the block exactly the size we need or

   419

				 * big enough for an additional free block? */

   420

				if (cur_size == mem_req ||

   421

						cur_size >= mem_req + sizeof(MemBlock)) {

   422

					/* Set size and in use */

   423

					s->size = mem_req;

   424

   425

					/* Do we need to inject a free block too? */

   426

					if (cur_size != mem_req) {

   427

						NextBlock(s)->size = (cur_size - mem_req) | S_FREE_MASK;

   428

					}

   429

   430

					return s->data;

   431

				}

   432

			}

   433

		}

   434

   435

		/* Reached sentinel, but no block found yet. Delete some old entry. */

   436

		DeleteEntryFromSpriteCache();

   437

	}

   438

}

   439

   440

   441

const void *GetRawSprite(SpriteID sprite, bool real_sprite)

   442

{

   443

	SpriteCache *sc;

   444

	void* p;

   445

   446

	assert(sprite < _spritecache_items);

   447

   448

	sc = GetSpriteCache(sprite);

   449

   450

	/* Update LRU */

   451

	sc->lru = ++_sprite_lru_counter;

   452

   453

	p = sc->ptr;

   454

   455

	/* Load the sprite, if it is not loaded, yet */

   456

	if (p == NULL) p = ReadSprite(sc, sprite, real_sprite);

   457

   458

	return p;

   459

}

   460

   461

   462

void GfxInitSpriteMem()

   463

{

   464

	/* initialize sprite cache heap */

   465

	if (_spritecache_ptr == NULL) _spritecache_ptr = (MemBlock*)MallocT<byte>(_sprite_cache_size * 1024 * 1024);

   466

   467

	/* A big free block */

   468

	_spritecache_ptr->size = ((_sprite_cache_size * 1024 * 1024) - sizeof(MemBlock)) | S_FREE_MASK;

   469

	/* Sentinel block (identified by size == 0) */

   470

	NextBlock(_spritecache_ptr)->size = 0;

   471

   472

	/* Reset the spritecache 'pool' */

   473

	free(_spritecache);

   474

	_spritecache_items = 0;

   475

	_spritecache = NULL;

   476

   477

	_compact_cache_counter = 0;

   478

}