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

	size_t file_pos;

    28

	uint32 id;

    29

	uint16 file_slot;

    30

	int16 lru;

    31

	bool real_sprite; ///< In some cases a single sprite is misused by two NewGRFs. Once as real sprite and once as non-real sprite. If the non-real sprite gets into the cache it might be drawn as real sprite which causes enormous trouble.

    32

};

    33

    34

    35

static uint _spritecache_items = 0;

    36

static SpriteCache *_spritecache = NULL;

    37

    38

    39

static inline SpriteCache *GetSpriteCache(uint index)

    40

{

    41

	return &_spritecache[index];

    42

}

    43

    44

    45

static SpriteCache *AllocateSpriteCache(uint index)

    46

{

    47

	if (index >= _spritecache_items) {

    48

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

    49

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

    50

    51

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

    52

    53

		_spritecache = ReallocT(_spritecache, items);

    54

    55

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

    56

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

    57

		_spritecache_items = items;

    58

	}

    59

    60

	return GetSpriteCache(index);

    61

}

    62

    63

    64

struct MemBlock {

    65

	size_t size;

    66

	byte data[VARARRAY_SIZE];

    67

};

    68

    69

static uint _sprite_lru_counter;

    70

static MemBlock *_spritecache_ptr;

    71

static int _compact_cache_counter;

    72

    73

static void CompactSpriteCache();

    74

    75

static bool ReadSpriteHeaderSkipData()

    76

{

    77

	uint16 num = FioReadWord();

    78

	byte type;

    79

    80

	if (num == 0) return false;

    81

    82

	type = FioReadByte();

    83

	if (type == 0xFF) {

    84

		FioSkipBytes(num);

    85

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

    86

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

    87

		return num != 1;

    88

	}

    89

    90

	FioSkipBytes(7);

    91

	num -= 8;

    92

	if (num == 0) return true;

    93

    94

	if (type & 2) {

    95

		FioSkipBytes(num);

    96

	} else {

    97

		while (num > 0) {

    98

			int8 i = FioReadByte();

    99

			if (i >= 0) {

   100

				num -= i;

   101

				FioSkipBytes(i);

   102

			} else {

   103

				i = -(i >> 3);

   104

				num -= i;

   105

				FioReadByte();

   106

			}

   107

		}

   108

	}

   109

   110

	return true;

   111

}

   112

   113

/* Check if the given Sprite ID exists */

   114

bool SpriteExists(SpriteID id)

   115

{

   116

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

   117

	if (id == 0) return true;

   118

	if (id >= _spritecache_items) return false;

   119

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

   120

}

   121

   122

void* AllocSprite(size_t);

   123

   124

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

   125

{

   126

	uint8 file_slot = sc->file_slot;

   127

	size_t file_pos = sc->file_pos;

   128

   129

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

   130

   131

	if (!SpriteExists(id)) {

   132

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

   133

   134

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   135

		id = SPR_IMG_QUERY;

   136

		file_slot = GetSpriteCache(SPR_IMG_QUERY)->file_slot;

   137

		file_pos  = GetSpriteCache(SPR_IMG_QUERY)->file_pos;

   138

	}

   139

   140

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

   141

#ifdef WITH_PNG

   142

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

   143

		SpriteLoaderPNG sprite_loader;

   144

		SpriteLoader::Sprite sprite;

   145

   146

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

   147

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

   148

			free(sprite.data);

   149

   150

			sc->real_sprite = true;

   151

   152

			return sc->ptr;

   153

		}

   154

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

   155

#else

   156

		static bool show_once = true;

   157

		if (show_once) {

   158

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

   159

			show_once = false;

   160

		}

   161

#endif /* WITH_PNG */

   162

	}

   163

   164

	FioSeekToFile(file_slot, file_pos);

   165

   166

	/* Read the size and type */

   167

	int num  = FioReadWord();

   168

	byte type = FioReadByte();

   169

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

   170

	if (type == 0xFF) {

   171

		if (real_sprite) {

   172

			static byte warning_level = 0;

   173

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

   174

			warning_level = 6;

   175

			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?");

   176

			return (void*)GetSprite(SPR_IMG_QUERY);

   177

		}

   178

   179

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

   180

   181

		sc->ptr = dest;

   182

		sc->real_sprite = false;

   183

		FioReadBlock(dest, num);

   184

   185

		return sc->ptr;

   186

	}

   187

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

   188

	 *  generator assumes that those sprites are stored uncompressed in

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

		uint height = FioReadByte();

   198

		uint width  = FioReadWord();

   199

		Sprite *sprite;

   200

		byte *dest;

   201

   202

		num = width * height;

   203

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

   204

		sc->ptr = sprite;

   205

		sprite->height = height;

   206

		sprite->width  = width;

   207

		sprite->x_offs = FioReadWord();

   208

		sprite->y_offs = FioReadWord();

   209

   210

		dest = sprite->data;

   211

		while (num > 0) {

   212

			int8 i = FioReadByte();

   213

			if (i >= 0) {

   214

				num -= i;

   215

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

   216

			} else {

   217

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

   218

				i = -(i >> 3);

   219

				num -= i;

   220

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

   221

			}

   222

		}

   223

   224

		sc->real_sprite = false;

   225

   226

		return sc->ptr;

   227

	}

   228

   229

	sc->real_sprite = true;

   230

   231

	if (!real_sprite) {

   232

		static byte warning_level = 0;

   233

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

   234

		warning_level = 6;

   235

	}

   236

   237

	SpriteLoaderGrf sprite_loader;

   238

	SpriteLoader::Sprite sprite;

   239

   240

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

   241

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

   242

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

   243

	free(sprite.data);

   244

   245

	return sc->ptr;

   246

}

   247

   248

   249

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

   250

{

   251

	SpriteCache *sc;

   252

	size_t file_pos = FioGetPos();

   253

   254

	if (!ReadSpriteHeaderSkipData()) return false;

   255

   256

	if (load_index >= MAX_SPRITES) {

   257

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

   258

	}

   259

   260

	sc = AllocateSpriteCache(load_index);

   261

	sc->file_slot = file_slot;

   262

	sc->file_pos = file_pos;

   263

	sc->ptr = NULL;

   264

	sc->lru = 0;

   265

	sc->id = file_sprite_id;

   266

	sc->real_sprite = false;

   267

   268

	return true;

   269

}

   270

   271

   272

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   273

{

   274

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

   275

	SpriteCache *scold = GetSpriteCache(old_spr);

   276

   277

	scnew->file_slot = scold->file_slot;

   278

	scnew->file_pos = scold->file_pos;

   279

	scnew->ptr = NULL;

   280

	scnew->id = scold->id;

   281

	scnew->real_sprite = scold->real_sprite;

   282

}

   283

   284

   285

#define S_FREE_MASK 1

   286

   287

static inline MemBlock* NextBlock(MemBlock* block)

   288

{

   289

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

   290

}

   291

   292

static size_t GetSpriteCacheUsage()

   293

{

   294

	size_t tot_size = 0;

   295

	MemBlock* s;

   296

   297

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

   298

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

   299

	}

   300

   301

	return tot_size;

   302

}

   303

   304

   305

void IncreaseSpriteLRU()

   306

{

   307

	/* Increase all LRU values */

   308

	if (_sprite_lru_counter > 16384) {

   309

		SpriteID i;

   310

   311

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

   312

   313

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

   314

			SpriteCache *sc = GetSpriteCache(i);

   315

			if (sc->ptr != NULL) {

   316

				if (sc->lru >= 0) {

   317

					sc->lru = -1;

   318

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

   319

					sc->lru--;

   320

				}

   321

			}

   322

		}

   323

		_sprite_lru_counter = 0;

   324

	}

   325

   326

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

   327

	if (++_compact_cache_counter >= 740) {

   328

		CompactSpriteCache();

   329

		_compact_cache_counter = 0;

   330

	}

   331

}

   332

   333

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

   334

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

   335

static void CompactSpriteCache()

   336

{

   337

	MemBlock *s;

   338

   339

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

   340

   341

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

   342

		if (s->size & S_FREE_MASK) {

   343

			MemBlock* next = NextBlock(s);

   344

			MemBlock temp;

   345

			SpriteID i;

   346

   347

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

   348

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

   349

   350

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

   351

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

   352

   353

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

   354

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

   355

				assert(i != _spritecache_items);

   356

			}

   357

   358

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

   359

			/* Swap this and the next block */

   360

			temp = *s;

   361

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

   362

			s = NextBlock(s);

   363

			*s = temp;

   364

   365

			/* Coalesce free blocks */

   366

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

   367

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

   368

			}

   369

		} else {

   370

			s = NextBlock(s);

   371

		}

   372

	}

   373

}

   374

   375

static void DeleteEntryFromSpriteCache()

   376

{

   377

	SpriteID i;

   378

	uint best = UINT_MAX;

   379

	MemBlock* s;

   380

	int cur_lru;

   381

   382

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

   383

   384

	cur_lru = 0xffff;

   385

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

   386

		SpriteCache *sc = GetSpriteCache(i);

   387

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

   388

			cur_lru = sc->lru;

   389

			best = i;

   390

		}

   391

	}

   392

   393

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

   394

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

   395

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

   396

   397

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

   398

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

   399

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

   400

	s->size |= S_FREE_MASK;

   401

	GetSpriteCache(best)->ptr = NULL;

   402

   403

	/* And coalesce adjacent free blocks */

   404

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

   405

		if (s->size & S_FREE_MASK) {

   406

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

   407

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

   408

			}

   409

		}

   410

	}

   411

}

   412

   413

void* AllocSprite(size_t mem_req)

   414

{

   415

	mem_req += sizeof(MemBlock);

   416

   417

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

   418

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

   419

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

   420

   421

	for (;;) {

   422

		MemBlock* s;

   423

   424

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

   425

			if (s->size & S_FREE_MASK) {

   426

				size_t cur_size = s->size & ~S_FREE_MASK;

   427

   428

				/* Is the block exactly the size we need or

   429

				 * big enough for an additional free block? */

   430

				if (cur_size == mem_req ||

   431

						cur_size >= mem_req + sizeof(MemBlock)) {

   432

					/* Set size and in use */

   433

					s->size = mem_req;

   434

   435

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

   436

					if (cur_size != mem_req) {

   437

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

   438

					}

   439

   440

					return s->data;

   441

				}

   442

			}

   443

		}

   444

   445

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

   446

		DeleteEntryFromSpriteCache();

   447

	}

   448

}

   449

   450

   451

const void *GetRawSprite(SpriteID sprite, bool real_sprite)

   452

{

   453

	SpriteCache *sc;

   454

	void* p;

   455

   456

	assert(sprite < _spritecache_items);

   457

   458

	sc = GetSpriteCache(sprite);

   459

   460

	/* Update LRU */

   461

	sc->lru = ++_sprite_lru_counter;

   462

   463

	p = sc->ptr;

   464

   465

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

   466

	if (p == NULL || sc->real_sprite != real_sprite) p = ReadSprite(sc, sprite, real_sprite);

   467

   468

	return p;

   469

}

   470

   471

   472

void GfxInitSpriteMem()

   473

{

   474

	/* initialize sprite cache heap */

   475

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

   476

   477

	/* A big free block */

   478

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

   479

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

   480

	NextBlock(_spritecache_ptr)->size = 0;

   481

   482

	/* Reset the spritecache 'pool' */

   483

	free(_spritecache);

   484

	_spritecache_items = 0;

   485

	_spritecache = NULL;

   486