1

/* $Id$ */

     2

     3

/** @file spritecache.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "string.h"

     9

#include "debug.h"

    10

#include "functions.h"

    11

#include "macros.h"

    12

#include "spritecache.h"

    13

#include "table/sprites.h"

    14

#include "fileio.h"

    15

#include "helpers.hpp"

    16

#include "spriteloader/grf.hpp"

    17

#ifdef WITH_PNG

    18

#include "spriteloader/png.hpp"

    19

#endif /* WITH_PNG */

    20

#include "blitter/factory.hpp"

    21

    22

/* Default of 4MB spritecache */

    23

uint _sprite_cache_size = 4;

    24

    25

    26

struct SpriteCache {

    27

	void *ptr;

    28

	uint8 file_slot;

    29

	uint32 file_pos;

    30

	int16 lru;

    31

	uint32 id;

    32

	const char *grf_name;

    33

};

    34

    35

    36

static uint _spritecache_items = 0;

    37

static SpriteCache *_spritecache = NULL;

    38

    39

    40

static inline SpriteCache *GetSpriteCache(uint index)

    41

{

    42

	return &_spritecache[index];

    43

}

    44

    45

    46

static SpriteCache *AllocateSpriteCache(uint index)

    47

{

    48

	if (index >= _spritecache_items) {

    49

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

    50

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

    51

    52

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

    53

    54

		_spritecache = ReallocT(_spritecache, items);

    55

    56

		if (_spritecache == NULL) {

    57

			error("Unable to allocate sprite cache of %d items (%d bytes)", items, items * sizeof(*_spritecache));

    58

		}

    59

    60

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

    61

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

    62

		_spritecache_items = items;

    63

	}

    64

    65

	return GetSpriteCache(index);

    66

}

    67

    68

    69

struct MemBlock {

    70

	uint32 size;

    71

	byte data[VARARRAY_SIZE];

    72

};

    73

    74

static uint _sprite_lru_counter;

    75

static MemBlock *_spritecache_ptr;

    76

static int _compact_cache_counter;

    77

    78

static void CompactSpriteCache();

    79

    80

static bool ReadSpriteHeaderSkipData()

    81

{

    82

	uint16 num = FioReadWord();

    83

	byte type;

    84

    85

	if (num == 0) return false;

    86

    87

	type = FioReadByte();

    88

	if (type == 0xFF) {

    89

		FioSkipBytes(num);

    90

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

    91

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

    92

		return num != 1;

    93

	}

    94

    95

	FioSkipBytes(7);

    96

	num -= 8;

    97

	if (num == 0) return true;

    98

    99

	if (type & 2) {

   100

		FioSkipBytes(num);

   101

	} else {

   102

		while (num > 0) {

   103

			int8 i = FioReadByte();

   104

			if (i >= 0) {

   105

				num -= i;

   106

				FioSkipBytes(i);

   107

			} else {

   108

				i = -(i >> 3);

   109

				num -= i;

   110

				FioReadByte();

   111

			}

   112

		}

   113

	}

   114

   115

	return true;

   116

}

   117

   118

/* Check if the given Sprite ID exists */

   119

bool SpriteExists(SpriteID id)

   120

{

   121

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

   122

	if (id == 0) return true;

   123

	if (id >= _spritecache_items) return false;

   124

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

   125

}

   126

   127

void* AllocSprite(size_t);

   128

   129

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

   130

{

   131

	uint8 file_slot = sc->file_slot;

   132

	uint32 file_pos = sc->file_pos;

   133

   134

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

   135

   136

	if (!SpriteExists(id)) {

   137

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

   138

   139

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   140

		id = SPR_IMG_QUERY;

   141

		file_slot = GetSpriteCache(SPR_IMG_QUERY)->file_slot;

   142

		file_pos  = GetSpriteCache(SPR_IMG_QUERY)->file_pos;

   143

	}

   144

   145

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

   146

#ifdef WITH_PNG

   147

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

   148

		SpriteLoaderPNG sprite_loader;

   149

		SpriteLoader::Sprite sprite;

   150

   151

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

   152

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

   153

			free(sprite.data);

   154

   155

			return sc->ptr;

   156

		}

   157

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

   158

#else

   159

		static bool show_once = true;

   160

		if (show_once) {

   161

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

   162

			show_once = false;

   163

		}

   164

#endif /* WITH_PNG */

   165

	}

   166

   167

	FioSeekToFile(file_slot, file_pos);

   168

   169

	/* Read the size and type */

   170

	int num  = FioReadWord();

   171

	byte type = FioReadByte();

   172

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

   173

	if (type == 0xFF) {

   174

		if (real_sprite) {

   175

			static byte warning_level = 0;

   176

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

   177

			warning_level = 6;

   178

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

   179

			return (void*)GetSprite(SPR_IMG_QUERY);

   180

		}

   181

   182

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

   183

   184

		sc->ptr = dest;

   185

		FioReadBlock(dest, num);

   186

   187

		return sc->ptr;

   188

	}

   189

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

   190

	 *  generator assumes that those sprites are stored uncompressed in

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

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

   199

		uint height = FioReadByte();

   200

		uint width  = FioReadWord();

   201

		Sprite *sprite;

   202

		byte *dest;

   203

   204

		num = width * height;

   205

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

   206

		sc->ptr = sprite;

   207

		sprite->height = height;

   208

		sprite->width  = width;

   209

		sprite->x_offs = FioReadWord();

   210

		sprite->y_offs = FioReadWord();

   211

   212

		dest = sprite->data;

   213

		while (num > 0) {

   214

			int8 i = FioReadByte();

   215

			if (i >= 0) {

   216

				num -= i;

   217

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

   218

			} else {

   219

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

   220

				i = -(i >> 3);

   221

				num -= i;

   222

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

   223

			}

   224

		}

   225

   226

		return sc->ptr;

   227

	}

   228

   229

	if (!real_sprite) {

   230

		static byte warning_level = 0;

   231

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

   232

		warning_level = 6;

   233

	}

   234

   235

	SpriteLoaderGrf sprite_loader;

   236

	SpriteLoader::Sprite sprite;

   237

   238

	if (!sprite_loader.LoadSprite(&sprite, sc->grf_name, file_slot, file_pos)) return NULL;

   239

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

   240

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

   241

	free(sprite.data);

   242

   243

	return sc->ptr;

   244

}

   245

   246

   247

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

   248

{

   249

	SpriteCache *sc;

   250

	uint32 file_pos = FioGetPos();

   251

   252

	if (!ReadSpriteHeaderSkipData()) return false;

   253

   254

	if (load_index >= MAX_SPRITES) {

   255

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

   256

	}

   257

   258

	sc = AllocateSpriteCache(load_index);

   259

	sc->file_slot = file_slot;

   260

	sc->file_pos = file_pos;

   261

	sc->ptr = NULL;

   262

	sc->lru = 0;

   263

	sc->id = file_sprite_id;

   264

   265

	const char *fio_grf_name = FioGetFilename();

   266

	const char *t = strrchr(fio_grf_name, PATHSEPCHAR);

   267

	char *grf_name;

   268

	if (t == NULL) grf_name = strdup(fio_grf_name);

   269

	else           grf_name = strdup(t);

   270

	/* Make the string lowercase and strip extension */

   271

	char *t2 = strrchr(grf_name, '.');

   272

	if (t2 != NULL) *t2 = '\0';

   273

	strtolower(grf_name);

   274

   275

	free((char *)sc->grf_name);

   276

	sc->grf_name = grf_name;

   277

   278

	return true;

   279

}

   280

   281

   282

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   283

{

   284

	SpriteCache *scold = GetSpriteCache(old_spr);

   285

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   286

   287

	scnew->file_slot = scold->file_slot;

   288

	scnew->file_pos = scold->file_pos;

   289

	scnew->ptr = NULL;

   290

	scnew->id = scold->id;

   291

	free((char *)scnew->grf_name);

   292

	scnew->grf_name = strdup(scold->grf_name);

   293

}

   294

   295

   296

void SkipSprites(uint count)

   297

{

   298

	for (; count > 0; --count) {

   299

		if (!ReadSpriteHeaderSkipData()) return;

   300

	}

   301

}

   302

   303

   304

#define S_FREE_MASK 1

   305

   306

static inline MemBlock* NextBlock(MemBlock* block)

   307

{

   308

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

   309

}

   310

   311

static uint32 GetSpriteCacheUsage()

   312

{

   313

	uint32 tot_size = 0;

   314

	MemBlock* s;

   315

   316

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

   317

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

   318

   319

	return tot_size;

   320

}

   321

   322

   323

void IncreaseSpriteLRU()

   324

{

   325

	/* Increase all LRU values */

   326

	if (_sprite_lru_counter > 16384) {

   327

		SpriteID i;

   328

   329

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

   330

   331

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

   332

			SpriteCache *sc = GetSpriteCache(i);

   333

			if (sc->ptr != NULL) {

   334

				if (sc->lru >= 0) {

   335

					sc->lru = -1;

   336

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

   337

					sc->lru--;

   338

				}

   339

			}

   340

		}

   341

		_sprite_lru_counter = 0;

   342

	}

   343

   344

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

   345

	if (++_compact_cache_counter >= 740) {

   346

		CompactSpriteCache();

   347

		_compact_cache_counter = 0;

   348

	}

   349

}

   350

   351

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

   352

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

   353

static void CompactSpriteCache()

   354

{

   355

	MemBlock *s;

   356

   357

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

   358

   359

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

   360

		if (s->size & S_FREE_MASK) {

   361

			MemBlock* next = NextBlock(s);

   362

			MemBlock temp;

   363

			SpriteID i;

   364

   365

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

   366

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

   367

   368

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

   369

			if (next->size == 0)

   370

				break;

   371

   372

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

   373

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

   374

				assert(i != _spritecache_items);

   375

			}

   376

   377

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

   378

			/* Swap this and the next block */

   379

			temp = *s;

   380

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

   381

			s = NextBlock(s);

   382

			*s = temp;

   383

   384

			/* Coalesce free blocks */

   385

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

   386

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

   387

			}

   388

		} else {

   389

			s = NextBlock(s);

   390

		}

   391

	}

   392

}

   393

   394

static void DeleteEntryFromSpriteCache()

   395

{

   396

	SpriteID i;

   397

	uint best = UINT_MAX;

   398

	MemBlock* s;

   399

	int cur_lru;

   400

   401

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

   402

   403

	cur_lru = 0xffff;

   404

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

   405

		SpriteCache *sc = GetSpriteCache(i);

   406

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

   407

			cur_lru = sc->lru;

   408

			best = i;

   409

		}

   410

	}

   411

   412

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

   413

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

   414

	if (best == (uint)-1)

   415

		error("Out of sprite memory");

   416

   417

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

   418

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

   419

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

   420

	s->size |= S_FREE_MASK;

   421

	GetSpriteCache(best)->ptr = NULL;

   422

   423

	/* And coalesce adjacent free blocks */

   424

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

   425

		if (s->size & S_FREE_MASK) {

   426

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

   427

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

   428

			}

   429

		}

   430

	}

   431

}

   432

   433

void* AllocSprite(size_t mem_req)

   434

{

   435

	mem_req += sizeof(MemBlock);

   436

   437

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

   438

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

   439

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

   440

   441

	for (;;) {

   442

		MemBlock* s;

   443

   444

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

   445

			if (s->size & S_FREE_MASK) {

   446

				size_t cur_size = s->size & ~S_FREE_MASK;

   447

   448

				/* Is the block exactly the size we need or

   449

				 * big enough for an additional free block? */

   450

				if (cur_size == mem_req ||

   451

						cur_size >= mem_req + sizeof(MemBlock)) {

   452

					/* Set size and in use */

   453

					s->size = mem_req;

   454

   455

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

   456

					if (cur_size != mem_req) {

   457

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

   458

					}

   459

   460

					return s->data;

   461

				}

   462

			}

   463

		}

   464

   465

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

   466

		DeleteEntryFromSpriteCache();

   467

	}

   468

}

   469

   470

   471

const void *GetRawSprite(SpriteID sprite, bool real_sprite)

   472

{

   473

	SpriteCache *sc;

   474

	void* p;

   475

   476

	assert(sprite < _spritecache_items);

   477

   478

	sc = GetSpriteCache(sprite);

   479

   480

	/* Update LRU */

   481

	sc->lru = ++_sprite_lru_counter;

   482

   483

	p = sc->ptr;

   484

   485

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

   486

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

   487

	return p;