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"

    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

/**

    76

 * Skip the given amount of sprite graphics data.

    77

 * @param type the type of sprite (compressed etc)

    78

 * @param num the amount of sprites to skip

    79

 */

    80

void SkipSpriteData(byte type, uint16 num)

    81

{

    82

	if (type & 2) {

    83

		FioSkipBytes(num);

    84

	} else {

    85

		while (num > 0) {

    86

			int8 i = FioReadByte();

    87

			if (i >= 0) {

    88

				int size = (i == 0) ? 0x80 : i;

    89

				num -= size;

    90

				FioSkipBytes(size);

    91

			} else {

    92

				i = -(i >> 3);

    93

				num -= i;

    94

				FioReadByte();

    95

			}

    96

		}

    97

	}

    98

}

    99

   100

/**

   101

 * Read the sprite header data and then skip the real payload.

   102

 * @return true if the sprite is a pseudo sprite.

   103

 */

   104

static bool ReadSpriteHeaderSkipData()

   105

{

   106

	uint16 num = FioReadWord();

   107

	byte type;

   108

   109

	if (num == 0) return false;

   110

   111

	type = FioReadByte();

   112

	if (type == 0xFF) {

   113

		FioSkipBytes(num);

   114

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

   115

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

   116

		return num != 1;

   117

	}

   118

   119

	FioSkipBytes(7);

   120

	SkipSpriteData(type, num - 8);

   121

   122

	return true;

   123

}

   124

   125

/* Check if the given Sprite ID exists */

   126

bool SpriteExists(SpriteID id)

   127

{

   128

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

   129

	if (id == 0) return true;

   130

	if (id >= _spritecache_items) return false;

   131

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

   132

}

   133

   134

void* AllocSprite(size_t);

   135

   136

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

   137

{

   138

	uint8 file_slot = sc->file_slot;

   139

	size_t file_pos = sc->file_pos;

   140

   141

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

   142

   143

	if (!SpriteExists(id)) {

   144

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

   145

   146

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   147

		id = SPR_IMG_QUERY;

   148

		file_slot = GetSpriteCache(SPR_IMG_QUERY)->file_slot;

   149

		file_pos  = GetSpriteCache(SPR_IMG_QUERY)->file_pos;

   150

	}

   151

   152

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

   153

#ifdef WITH_PNG

   154

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

   155

		SpriteLoaderPNG sprite_loader;

   156

		SpriteLoader::Sprite sprite;

   157

   158

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

   159

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

   160

			free(sprite.data);

   161

   162

			sc->real_sprite = real_sprite;

   163

   164

			return sc->ptr;

   165

		}

   166

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

   167

#else

   168

		static bool show_once = true;

   169

		if (show_once) {

   170

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

   171

			show_once = false;

   172

		}

   173

#endif /* WITH_PNG */

   174

	}

   175

   176

	FioSeekToFile(file_slot, file_pos);

   177

   178

	/* Read the size and type */

   179

	int num  = FioReadWord();

   180

	byte type = FioReadByte();

   181

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

   182

	if (type == 0xFF) {

   183

		if (real_sprite) {

   184

			static byte warning_level = 0;

   185

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

   186

			warning_level = 6;

   187

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

   188

			return (void*)GetRawSprite(SPR_IMG_QUERY, true);

   189

		}

   190

   191

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

   192

   193

		sc->ptr = dest;

   194

		sc->real_sprite = real_sprite;

   195

		FioReadBlock(dest, num);

   196

   197

		return sc->ptr;

   198

	}

   199

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

   200

	 *  generator assumes that those sprites are stored uncompressed in

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

		assert(real_sprite);

   210

		uint height = FioReadByte();

   211

		uint width  = FioReadWord();

   212

		Sprite *sprite;

   213

		byte *dest;

   214

   215

		num = width * height;

   216

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

   217

		sc->ptr = sprite;

   218

		sprite->height = height;

   219

		sprite->width  = width;

   220

		sprite->x_offs = FioReadWord();

   221

		sprite->y_offs = FioReadWord();

   222

   223

		dest = sprite->data;

   224

		while (num > 0) {

   225

			int8 i = FioReadByte();

   226

			if (i >= 0) {

   227

				num -= i;

   228

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

   229

			} else {

   230

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

   231

				i = -(i >> 3);

   232

				num -= i;

   233

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

   234

			}

   235

		}

   236

   237

		sc->real_sprite = real_sprite;

   238

   239

		return sc->ptr;

   240

	}

   241

   242

	if (!real_sprite) {

   243

		static byte warning_level = 0;

   244

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

   245

		warning_level = 6;

   246

		return (void*)GetRawSprite(id, true);

   247

	}

   248

   249

	SpriteLoaderGrf sprite_loader;

   250

	SpriteLoader::Sprite sprite;

   251

   252

	sc->real_sprite = real_sprite;

   253

   254

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

   255

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

   256

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

   257

	free(sprite.data);

   258

   259

	return sc->ptr;

   260

}

   261

   262

   263

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

   264

{

   265

	SpriteCache *sc;

   266

	size_t file_pos = FioGetPos();

   267

   268

	if (!ReadSpriteHeaderSkipData()) return false;

   269

   270

	if (load_index >= MAX_SPRITES) {

   271

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

   272

	}

   273

   274

	sc = AllocateSpriteCache(load_index);

   275

	sc->file_slot = file_slot;

   276

	sc->file_pos = file_pos;

   277

	sc->ptr = NULL;

   278

	sc->lru = 0;

   279

	sc->id = file_sprite_id;

   280

	sc->real_sprite = false;

   281

   282

	return true;

   283

}

   284

   285

   286

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   287

{

   288

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

   289

	SpriteCache *scold = GetSpriteCache(old_spr);

   290

   291

	scnew->file_slot = scold->file_slot;

   292

	scnew->file_pos = scold->file_pos;

   293

	scnew->ptr = NULL;

   294

	scnew->id = scold->id;

   295

	scnew->real_sprite = scold->real_sprite;

   296

}

   297

   298

   299

#define S_FREE_MASK 1

   300

   301

static inline MemBlock* NextBlock(MemBlock* block)

   302

{

   303

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

   304

}

   305

   306

static size_t GetSpriteCacheUsage()

   307

{

   308

	size_t tot_size = 0;

   309

	MemBlock* s;

   310

   311

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

   312

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

   313

	}

   314

   315

	return tot_size;

   316

}

   317

   318

   319

void IncreaseSpriteLRU()

   320

{

   321

	/* Increase all LRU values */

   322

	if (_sprite_lru_counter > 16384) {

   323

		SpriteID i;

   324

   325

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

   326

   327

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

   328

			SpriteCache *sc = GetSpriteCache(i);

   329

			if (sc->ptr != NULL) {

   330

				if (sc->lru >= 0) {

   331

					sc->lru = -1;

   332

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

   333

					sc->lru--;

   334

				}

   335

			}

   336

		}

   337

		_sprite_lru_counter = 0;

   338

	}

   339

   340

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

   341

	if (++_compact_cache_counter >= 740) {

   342

		CompactSpriteCache();

   343

		_compact_cache_counter = 0;

   344

	}

   345

}

   346

   347

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

   348

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

   349

static void CompactSpriteCache()

   350

{

   351

	MemBlock *s;

   352

   353

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

   354

   355

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

   356

		if (s->size & S_FREE_MASK) {

   357

			MemBlock* next = NextBlock(s);

   358

			MemBlock temp;

   359

			SpriteID i;

   360

   361

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

   362

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

   363

   364

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

   365

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

   366

   367

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

   368

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

   369

				assert(i != _spritecache_items);

   370

			}

   371

   372

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

   373

			/* Swap this and the next block */

   374

			temp = *s;

   375

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

   376

			s = NextBlock(s);

   377

			*s = temp;

   378

   379

			/* Coalesce free blocks */

   380

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

   381

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

   382

			}

   383

		} else {

   384

			s = NextBlock(s);

   385

		}

   386

	}

   387

}

   388

   389

static void DeleteEntryFromSpriteCache()

   390

{

   391

	SpriteID i;

   392

	uint best = UINT_MAX;

   393

	MemBlock* s;

   394

	int cur_lru;

   395

   396

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

   397

   398

	cur_lru = 0xffff;

   399

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

   400

		SpriteCache *sc = GetSpriteCache(i);

   401

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

   402

			cur_lru = sc->lru;

   403

			best = i;

   404

		}

   405

	}

   406

   407

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

   408

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

   409

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

   410

   411

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

   412

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

   413

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

   414

	s->size |= S_FREE_MASK;

   415

	GetSpriteCache(best)->ptr = NULL;

   416

   417

	/* And coalesce adjacent free blocks */

   418

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

   419

		if (s->size & S_FREE_MASK) {

   420

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

   421

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

   422

			}

   423

		}

   424

	}

   425

}

   426

   427

void* AllocSprite(size_t mem_req)

   428

{

   429

	mem_req += sizeof(MemBlock);

   430

   431

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

   432

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

   433

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

   434

   435

	for (;;) {

   436

		MemBlock* s;

   437

   438

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

   439

			if (s->size & S_FREE_MASK) {

   440

				size_t cur_size = s->size & ~S_FREE_MASK;

   441

   442

				/* Is the block exactly the size we need or

   443

				 * big enough for an additional free block? */

   444

				if (cur_size == mem_req ||

   445

						cur_size >= mem_req + sizeof(MemBlock)) {

   446

					/* Set size and in use */

   447

					s->size = mem_req;

   448

   449

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

   450

					if (cur_size != mem_req) {

   451

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

   452

					}

   453

   454

					return s->data;

   455

				}

   456

			}

   457

		}

   458

   459

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

   460

		DeleteEntryFromSpriteCache();

   461

	}

   462

}

   463

   464

   465

const void *GetRawSprite(SpriteID sprite, bool real_sprite)

   466

{

   467

	SpriteCache *sc;

   468

	void* p;

   469

   470

	assert(sprite < _spritecache_items);

   471

   472

	sc = GetSpriteCache(sprite);

   473

   474

	/* Update LRU */

   475

	sc->lru = ++_sprite_lru_counter;

   476

   477

	p = sc->ptr;

   478

   479

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

   480

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

   481

   482

	return p;

   483

}

   484

   485

   486